禁止
- _和$放首尾
- 中英混合
- 不规范的缩写
- 未经定义的常量出现在代码中
强制
- 类名 :首大写驼峰
- 抽象类名用Abstract 或Base开头(有设计模式,类名中尽量体现出设计模式),异常类名Exception结尾,测试类名Test结尾,枚举类名加上Enum(成员变量全大写,用 _ 隔开)
- 包名全用小写,用 . 隔开,全用单数
- 接口中的方法属性不加修饰符
- 接口实现类 名称在接口名称后面加上Impl
- 方法名,参数名,成员变量,局部变量 : 首小写驼峰
- 常量全大写两单词用 _ 隔开
- POJO类中布尔类型变量不加is
- Service/DAO 层方法命名规约
- 获取单个对象的方法用 get 做前缀。
- 获取多个对象的方法用 list 做前缀。
- 获取统计值的方法用 count 做前缀。
- 插入的方法用 save(推荐)或 insert 做前缀。
- 删除的方法用 remove(推荐)或 delete 做前缀。
- 修改的方法用 update 做前缀
- 领域模型命名规约
- 数据对象:xxxDO,xxx 即为数据表名。
- 数据传输对象:xxxDTO,xxx 为业务领域相关的名称。
- 展示对象:xxxVO,xxx 一般为网页名称。
- POJO 是 DO/DTO/BO/VO 的统称,禁止命名成 xxxPOJO。
- long型数值初始化时用 L 结尾
- 常量应该按功能进行分类存放