1.代码中命名不能以下划线或美元符号作为开始或结束。
2.命名遵从驼峰形式,领域模型的相关命名除外(DO/BO/DTO/VO).
3.代码中的命名严禁使用拼音和英文混合的方式,更不允许使用中文方式。
4.方法名,参数名,成员变量,局部变量都统一使用lowerCmelCase驼峰形式。
5.常量命名全部大写,单词间用下划线隔开,力求予以表达清晰完整。
6.抽象类名使用Abstract或Base开头:异常类以Exception结尾:测试命名以Test结尾。
7.中括号是数组类型的一部分,定义如下:int[] num。
8.POJO类中的布尔类型变量,都不要加is,否则部分框架解析会引起序列化错误。
9.包名使用小写,点分隔符之间有且仅有一个自然语句的单词。包名统一使用单数形式,但是类名如果有复数含义,类名可以使用复数形式。
10.杜绝不规范的缩写,避免看不懂意思。
11.如果用到了设计模式建议在类名中体现出来。
12.接口类中的方法和属性不要加任何修饰符号,保持代码的简洁性,并加上有效的注释,尽量不要在接口里定义变量。
13.接口和实现类的命名:
对于service和dao类,给予soa的理念,暴露出来的服务一定是接口,内部的实现类用Impl作为后缀和接口区别
如果是形容能力接口名称,取对应的形容词做接口名(通常用-able的形式)。
14.枚举类名建议带上Enum后缀,枚举成员名称需要全部大写,单词间用下划线隔开。
15.各层命名:
Service/Dao层方法命名:
获取单个对象方法用get做前缀
获取多个对象用list做前缀
获取统计值的方法用count做前缀
插入方法用save做 前缀
删除方法用remove做前缀
修改方法用update做前缀
领域模型命名规范:
数据对象:xxDO xx为数据表名
数据传输对象:xxDTO xx为业务领域相关的名称
展示对象:xxVO xx为网页名称