代码命名规范
说到命名规范,必提:"驼峰命名法",它分为两种。
"小驼峰命名法"(lowerCamelCase),第一个词的首字母小写,后面每个词的首字母大写;
"大驼峰命名法"(UpperCamelCase),第一个词的首字母,以及后面每个词的首字母都大写。
以下规范根据阿里的 JAVA 开发规范进行总结
包的命名:
包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用
单数形式,但是类名如果有复数含义,类名可以使用复数形式。
正例:应用工具类包名为 com.alibaba.ai.util、类名为 MessageUtils(此规则参考 spring
的框架结构)
普通类类名:
类名使用 UpperCamelCase (大驼峰命名法)风格,但以下情形例外:
DO / BO / DTO / VO / AO / PO / UID 等。
正例:MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
反例:macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion
特定类类名:
抽象类命名使用 Abstract 或 Base 开头;
异常类命名使用 Exception 结尾;
测试类命名以它要测试的类的名称开始,以 Test 结尾。
方法名、参数名、成员变量、局部变量:
统一使用 lowerCamelCase (小驼峰命名法)风格,必须遵从驼峰形式。
正例: localValue / getHttpMessage() / inputUserId
特定属性命名:
1. 类型与中括号紧挨相连来表示数组。
正例:定义整形数组 int[] arrayDemo;
反例:在 main 参数中,使用 String args[]来定义。
2. POJO 类中布尔类型的变量,都不要加 is 前缀,否则部分框架解析会引起序列化错误。
Boolean isDeleted 的属性,它的方法也是 isDeleted(),
框架在反向解析的时候,“误以为”对应的属性名称是 deleted,导致属性获取不到,进而抛
出异常。
使用设计模式:
如果模块、接口、类、方法使用了设计模式,在命名时需体现出具体模式。
说明:将设计模式体现在名字中,有利于阅读者快速理解架构设计理念。
正例: public class OrderFactory;
public class LoginProxy;
public class ResourceObserver
枚举类命名:
枚举类名建议带上 Enum 后缀,枚举成员名称需要全大写,单词间用下划线隔开。
说明:枚举其实就是特殊的类,域成员均为常量,且构造方法被默认强制是私有。
正例:枚举名字为 ProcessStatusEnum 的成员名称:SUCCESS / UNKNOWN_REASON。
接口中的权限修饰符:
接口类中的方法和属性不要加任何修饰符号(public 也不要加),保持代码的简洁
性,并加上有效的 Javadoc 注释。尽量不要在接口里定义变量,如果一定要定义变量,肯定是
与接口方法相关,并且是整个应用的基础常量。
正例:
接口方法签名 void commit();
接口基础常量 String COMPANY = "alibaba";
反例:
接口方法定义 public abstract void f();
说明:
JDK8 中接口允许有默认实现,那么这个 default 方法,是对所有实现类都有价值的默
认实现。
常用的层级规约:
Service/DAO 层方法命名规约
1) 获取单个对象的方法用 get 做前缀。
2) 获取多个对象的方法用 list 做前缀,复数形式结尾如:listObjects。
3) 获取统计值的方法用 count 做前缀。
4) 插入的方法用 save/insert 做前缀。
5) 删除的方法用 remove/delete 做前缀。
6) 修改的方法用 update 做前缀。
领域模型命名规约
1) 数据对象:xxxDO,xxx 即为数据表名。
2) 数据传输对象:xxxDTO,xxx 为业务领域相关的名称。
3) 展示对象:xxxVO,xxx 一般为网页名称。
4) POJO 是 DO/DTO/BO/VO 的统称,禁止命名成 xxxPOJO。