命名规范

命名规范

1. 代码的命名不能以下划线或者$符号开始,也不能以下划线或美元字符结束.
2. 代码中的命名严禁使用拼音和英文混合的模式,更不允许直接用中文的方式.
3. 类名使用大驼峰命风格
4. 方法名,参数名,成员变量局部变量统一使用小驼峰命名风格,必须遵从驼峰形式
5. 常亮命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长
6. 抽象类名以 Abstract 或 Base 开头;异常类名以 Exception 结尾;测试类命名以他要测试的类名开始以Test结尾
7. 避免在子父类的成员变量之间,或者代码块的局部变量之间采用相同的命名使可读性降低
子类父类的成员变量名相同,即使是public类型的变量能够通过编译,而局部变量在同一方法内的不同代码块中命名相同也是合法的,但是要避免使用.对于 setter/getter的参数名也要避免与成员变量名相同
8. 杜绝完全不规范的缩写,避免望文不知义
9. 为了达到代码自解释的目标,任何自定义元素在命名时,尽量使用完整的单词组合来表达其义.
10. 在常量与变量命名时,表示类型的放在词尾提升辨识度.
11. 如果模块,接口,类,方法使用了设计模式,在命名时需体现出具体模式 (有利于其他人快速理解架构设计理念)
12. 接口类中的方法和属性不要加任何的修饰符号 ( public 也不要加 ) ,保持代码的简洁性 ,并加上有效的注释.尽量不要在接口里定义变量,如果一定要定义变量,肯定是与接口方法相关,并且是整个应用场景的基础变量
13. 接口与实现类的命名
1) 对于 Service 和 DAO 类,基于 SOA 理念,暴露出来的服务一定是接口 ,内部的实现类用 Impl 的后缀与接口区别
2) 如果是形容能力的接口名称,取对应的形容词为接口名(通常是-able的形容词)
14. 枚举类型后缀带上 Enum ,枚举成员名称需要全部大写,单词间用下划线隔开
枚举其实就是特殊的类,域成员均为常量 ,且构造方法被默认强制私有
15. 各层命名规范

• Service/DAO 层命名规范
  • 获取单个对象用 get 做前缀
  • 获取多个对象的方法用 list 做前缀,复数形式如 listObjects
  • 获取统计值的方法用 count 做前缀
  • 插入的方法用 save/insert做前缀
  • 删除方法用 remove 或 delete 做前缀
  • 更新的方法用 update 做前缀
• 领域模型命名规范
  • 数据对象:xxxDO xxx 即表名
  • 数据传输对象: xxxDTO ,xxx为业务领域相关的名称
  • 展示对象: xxxVO xxx一般为网页名称
  • POJO 是DO/DTO/BO/VO 的统称,禁止命名成 xxxPOJO