Java 开发规范
1.命名规范
1.包命名规范:
1.业务模块的包命名格式如下: src/业务模块名称
2.Service接口的包命名格式如下: com.greencloud.service
3.Service接口实现类的包命名格式如下:com.greencloud.service.impl
4.Dao 接口的包命名格式如下:com.greencloud.dao
5.Dao 接口的实现类的包命名格式如下:com.greencloud.dao.impl
6.Façade接口的包命名格式如下: com.greencloud.service.facade
7.Façade接口的实现类的包命名格式如下:com.greencloud.service.facade.impl
8.业务域对象的包命名格式如下:com.greencloud.entity
9.异常类的包命名格式如下:com.greencloud.exception
10.枚举类的包命名格式如下:com.greencloud.enum
11.常量类的包命名格式如下:com.greencloud.contant
12.帮助类的包命名格式如下:com.greencloud.util
2.类命名规范:
1.Service接口的命名格式如下: I+表名+service
2.Service接口实现类的命名格式如下: 表名+serviceImpl
3.Dao 接口的命名格式如下:I+表名+dao
4.Dao 接口的实现类的包命名格式如下:表名+daoImpl
5.Façade接口的命名格式如下: I+包名+facadeService
6.Façade接口的实现类的命名格式如下:包名+facadeServiceImpl
7.业务域对象的命名格式如下:表名
8.异常类的命名格式如下:描述异常情况+exception
9.枚举类的命名格式如下:描述枚举情况+enum
10.常量类的命名格式如下: 描述常量情况+contant
11.帮助类的命名格式如下: 描述帮助类型+util
3.方法命名规范:
1.查询单个实体对象的方法命名格式:
1.查询单个的实体对象:load+实体对象名+by+字段名
2.如果类中只存在一个加载实体对象的方法:load+实体对象名
3.如果加载一个实体对象需要多个字段组合查询:load+实体对象名+by+最核
心的查询字段或者load+实体对象名+by+ 核心字段1+And+核心字段2
4.失败抛出flex.messaging.service.ServiceException异常或者它的子类
5.成功返回实体对象
例如:通过code字段查询CodeBase实体对象
public CodeBase loadCodeBaseByCode(String code) throws ServiceException
2.查询多个实体对象的方法命名格式:
1.查询多个实体对象: find+返回数据集合类型+实体对象名+by+字段名
2.如果类中只存在一个查询多个对象实体的方法: find+返回数据集合类型+
实体对象名
3.如果需要多个字段组合查询: find+返回数据类型+by+最核心的查询字段或
者find+返回数据类型+by+核心字段1+And+核心字段2
4.失败抛出flex.messaging.service.ServiceException异常或者它的子类
5.成功返回多个实体对象
例如通过hotel_group_id 和hotel_id字段联合查询多个codeBase,返回集
合类型为list<CodeBase>
public List<CodeBase> findListCodeBaseByHotelGroupIdAndHotelId(Long
hotelGroupId,Long hotelId) throws ServiceException
3.查询全部实体对象的命名格式
1.查询全部的实体对象:findAll+返回数据类型+实体对象名+by+字段名
2.如果类中只存在一个查询全部实体对象的方法:findAll
3.如果查询全部实体对象需要多个字段组合查询: findAll+返回数据类型+实体对
象名+by+最核心的查询字段或者findAll+实体对象名+by+ 核心字段1+And+核
心字段2
例如:返回所有的CodeBase数据,只要这一个查询全部实体的方法
public List<Codebase> findAll throws ServiceException
4.插入实体对象的命名格式
String save+实体对象(实体对象类) throws serviceExcception
1.保存成功返回”success”
2.失败抛出flex.messaging.service.ServiceException异常或者它的子类
3.插入的参数为实体对象类
例如:public String saveCodeBase(CodeBase codeBase) throws serviceException
5.更新实体对象的命名格式:
String update+实体对象(实体对象类) throws serviceExcception
1.更新成功返回”success”
2.失败抛出flex.messaging.service.ServiceException异常或者它的子类
3.插入的参数为实体对象类
例如:public String updateCodeBase(CodeBase codeBase) throws
serviceException
6.删除实体对象命名格式:
String Save+实体对象(实体对象类) throws serviceExcception
1.删除成功返回”success”
2.失败抛出flex.messaging.service.ServiceException异常或者它的子类
3.插入的参数为主键id
例如:public String deleteCodeBase(Long id) throws serviceException
2.开发规约:
1.实体类开发规约:
1.实体类必须继承OpertionInfo类或者它的子类
2.如果有特殊情况不能继承的,请按照OpertionInfo方式实现toString方法的
3.实体类必须实现序列化接口
2.Façade接口开发规约:
1.一个业务模块只提供一个façade接口
2.如果有特殊原因需要提供多个façade接口,联系java负责人
3. 注释规范。