编程规约之命名风格
- 【强制】 代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符结束。
- 【强制】代码中的命名严禁使用拼音与英文混合方式,更不允许直接使用中文方式。
- 【强制】类名使用UpperCamlCase风格,但以下情形例外DO/BO/DTO/VO/AO/PO等。
- 【强制】方法名、参数名、成员变量、局部变量都同意使用lowerCamelCase风格,必须遵循驼峰形式。
- 【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。
- 【强制】抽象类命名使用Abstract或Base开头;异常类命名使用Exception结尾;测试类命名以它要测试的类名开始,以Test结尾。
- 【强制】类型中扩招紧挨相连来定义数组int[] arrayDemo;
- 【强制】POJO类中布尔类型的变量,都不要加is前缀,否则部分框架解析会引起序列化错误。
- 【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式,但是类名如果有复数含义,类名可以使用复数形式。
- 【强制】杜绝完全不规范的缩写,避免望文不知义。反例:AbstractClass “缩写”命名为AbsClass。
- 【强制】为了达到代码自解释的目标,任何自定义编码元素在命名时,使用尽量完整的单词组合来表达其意。
- 【强制】如果模块、接口、类、方法使用了设计模式,在命名时体现出具体模式。如public class LoginProxy;
- 【强制】接口类中的方法不要加任何修饰符号(public 也不要加),保持代码的简洁性,并且加上有效的Javadoc注释。尽量不要在接口里定义变量,如果一定要定义变量,肯定与接口方法相关,并且是整个应用的基础常量。
- 接口和实现类的命名有两套规则:
1)【强制】对于Service和DAO类,基于SOA的理念,暴露出来的服务一定是接口,内部的实现类用Impl的后缀与接口区别。如:CacheServiceImpl 实现CacheService 接口。
2)【推荐】 如果是形容能力的接口名称,取对应的形容词为接口名(通常是-able的形式)。如:AbstractTranslator实现Translatable。
-
- 【参考】各层命名规约:
A)Service/DAO层方法命名规约
1)获取单个对象的方法用get作前缀。
2)获取多个对象的方法用list作前缀。
3)获取统计值得方法用count作前缀。
4)插入方法用save/insert作前缀。
5)删除的方法用remove/delete作前缀。
6)修改的方法用update作前缀。
B)领域模型命名规约
1)数据对象:xxxDO,xxx即为数据表名。
2)数据传输对象:xxxDTO,xxx为业务领域相关的名称。
3)展示对象:xxxVO,xxx一般为网页名称。
4)POJO是DO/DTO/BO/VO的统称,禁止命名成xxxPOJO。
对于开发过程中对于包,类,变量,方法的命名还存在一些困惑,学习了《阿里巴巴开发手册》,把其中对于编程命名这部分拿出来,和大家分享下,学习只有自己不断的实践,才会有所收获。