1、基础代码规范
1、常量统一定义一个 XxxConstant,,或者XxxEnum
2、代码请务必使用 自动格式化下,以及每个模块之前的换行,
3、请参考阿里巴巴Java开发规范无论是什么数字请使用 equals方法不用使用 ==
2、各层命名规范
2.1、service/manager/DAO 层方法命名规范
1、获取单个对象的方法用 get 做前缀
2、获取多个对象的方法用 list 做前缀
3、获取统计值的方法用 count 做前缀。
4、插入的方法用 save( 推荐) 或insert 做前缀。
5、删除的方法用 remove( 推荐) 或delete 做前缀。
6、修改的方法用 update 做前缀
2.2、领域模型命名规约
1、数据对象: xxxDO, xxx 即为数据表名数据
2、传输对象: xxxDTO, xxx 为业务领域相关的名称。
3、展示对象: xxxVO, xxx 一般为网页名称
4、POJO 是DO/DTO/BO/VO 的统称,禁止命名成 xxxPOJO
3、架构规范
1、每个表(如果存在单表操作)必须创建一个dao层
2、manager层专门用于缓存方案,中间件处理
3、service 相对具体的业务逻辑服务层。
4、xxxDO,xxxExample,专门用于dao层与数据库进行交
阿里巴巴-层次图
4、基础代码风格
4.1、DAO 层
1、dao与数据库交互使用DO领域模型,条件统一放到example实列对象中
4.2、必备方法(供参考)
1、getXxxById(Integer id);
2、getByExample(@Param("example") XxxExample example);
3、updateById(XxxDO xxx);
4、updateByExample(XxxDO xxx, @Param("example") XxxExample example);
5、listByExample(@Param("example") XxxExample example);
6、countByEaxmple(@Param("exam