1.命名规约
(1)接口和实现类命名规约:
1) 接口一般以DAO、Manager、Service为后缀;
2) 其实现类以Impl 为后缀。
正例:CacheServiceImpl 实现CacheService 接口。
(2)方法命名规约:
1) 获取单个对象的方法用get 做前缀。
2) 获取多个对象的方法用list 做前缀。
3) 获取统计值的方法用count 做前缀。
4) 分页的方法用page 做前缀。
5) 插入的方法用add 做前缀。
6) 逻辑删除的方法用remove 做前缀。
7) 物理删除的方法用del 做前缀。
8) 修改的方法用update 做前缀。
(3)领域模型命名规约
1) 持久化对象:xxxPO,xxx 即为数据表名。
2) 查询参数对象:xxxQO,xxx 为业务领域相关的名称。
3) 数据传输对象:xxxDTO,xxx 为业务领域相关的名称。
4) 业务对象:xxxBO,xxx 为业务名称。
5) 展示对象:xxxVO,xxx 一般为网页名称。
6) 分页参数对象:Criteria,Q为query对象。
7) POJO 是DO/DTO/BO/VO 的统称,禁止命名成xxxPOJO。
2.层级接口调用规约
(1) manager层只能调用DAO层接口,不能平级调用(即:manager之间相互调用),避免相互依赖;
(2) service层只能调用manager层接口和其它业务系统接口,不能跨层调用(即:直接调用DAO层接口),也不能平级调用(即:service之间相互调用),避免相互依赖;
3.领域模型对象适用规约
(1) DAO层:PO、Query;
(2) manager层:PO、Query、DTO,manager可以接收PO对象,但不能通过接口参数对外提供,必须转换成DTO对象后对外提供;
(3) service层:Query、DTO、BO,service层可以对外暴露DTO对象或者BO对象。
(4) controller层:Query、DTO、BO、VO,controller层只做业务转发,不做业务逻辑处理。
java开发规范
最新推荐文章于 2024-05-20 17:26:54 发布