9. 【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。
包名统一使用
单数形式,但是类名如果有复数含义,类名可以使用复数形式。
正例:应用工具类包名为 com.iplay.common.utils、类名为 MessageUtils(此
规则参考 spring 的框架结构)
10. 【强制】杜绝完全不规范的缩写,避免望文不知义。
反例:AbstractClass“缩写”命名成 AbsClass;condition“缩写”命名成 condi,此类
随意缩写严重降低了代码的可阅读性。
11. 【推荐】为了达到代码自解释的目标,任何自定义编程元素在命名时,使用
尽量完整的单词组合来表达其意。
正例:从远程仓库拉取代码的类命名为 ApplicationConfiguration。
反例:变量 int a; 的随意命名方式。
12. 【推荐】如果模块、接口、类、方法使用了设计模式,在命名时体现出具体
模式。
说明:将设计模式体现在名字中,有利于阅读者快速理解架构设计理念。
正例:public class UserAddressController;
13. 【推荐】接口类中的方法和属性不要加任何修饰符号(public 也不要加),
保持代码的简洁性,并加上有效的 Javadoc 注释。尽量不要在接口里定义变量,如果一
定要定义变量,肯定是与接口方法相关,并且是整个应用的基础常量。
正例:接口方法签名 void f();
接口基础常量 String COMPANY = "iplay";
反例:接口方法定义 public abstract void f();
说明:JDK8 中接口允许有默认实现,那么这个 default 方法,是对所有实现类都
有价值的默认实现。
14. 接口和实现类的命名有两套规则:
1)【强制】对于 Service 和 DAO 类,基于 SOA 的理念,暴露出来的服务一定是
接口,内部的实现类用 Impl 的后缀与接口区别。
正例:CacheServiceImpl 实现 CacheService 接口。
2)【推荐】如果是形容能力的接口名称,取对应的形容词为接口名(通常是–abl
e 的形式)。
正例:AbstractTranslator 实现 Translatable。
15. 【参考】枚举类名建议带上 Enum 后缀,枚举成员名称需要全大写,单词间
用下划线隔开。
说明:枚举其实就是特殊的常量类,且构造方法被默认强制是私有。
正例:枚举名字为 ProcessStatusEnum 的成员名称:SUCCESS / UNKNOWN_RE
ASON。
16. 【参考】各层命名规约:
A) Service/DAO 层方法命名规约
1) 获取单个对象的方法用 get 作前缀。
2) 获取多个对象的方法用 list 作前缀。
3) 获取统计值的方法用 count 作前缀。
4) 插入的方法用 save/insert 作前缀。
5) 删除的方法用 remove/delete 作前缀。