基于阿里巴巴 JAVA 开发规范整理
一、命名风格
1. 【强制】类名使用 UpperCamelCase 风格,必须遵从驼峰形式,但以下情形例
外:DO / BO / DTO / VO / AO
正例:MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
反例:macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion
2. 【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风
格,必须遵从 驼峰形式。
正例: localValue / getHttpMessage() / inputUserId
3. 【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要
嫌名字长。
正例:MAX_STOCK_COUNT 反例:MAX_COUNT
4. 【强制】抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception
结尾;测试类命名以它要测试的类的名称开始,以 Test 结尾。
5. 【强制】Model 类中布尔类型的变量,都不要加 is,否则部分框架解析会引起序
列化错误。
反例:定义为基本数据类型 Boolean isDeleted;的属性,它的方法也是 isDeleted(),
RPC 框架在反向解析的时候,“以为”对应的属性名称是 deleted,导致属性获取不到,进
而抛出异常。
6. 【强制】对于 Service 和 DAO 类,基于 SOA 的理念,暴露出来的服务一定是
接口,内部的实现类用 Impl 的后缀与接口区别。 正例:CacheManagerImpl 实现
CacheManager 接口。
7. 【推荐】为了达到代码自解释的目标,任何自定义编程元素在命名时,使用尽量完
整的单词组合来表达其意。
正例:从远程仓库拉取代码的类命名为 PullCodeFromRemoteRepository
反例:变量 int a;的随意命名方式。
8. 【推荐】接口类中的方法和属性不要加任何修饰符号(public 也不要加),保持
代码的简洁 性,并加上有效 的 Javadoc 注释。尽量不要在接口里定义变量,如果一定要
定义变量,肯定是 与接口方法相关,并且是整个应用的基础常量。
正例:接口方法签名:void f(); 接口基础常量表示:String COMPANY = "alibaba";
反例:接口方法定义:public abstract void f();
说明:JDK8 中接口允许有默认实现,那么这个 default 方法,是对所有实现类都有价值
的默 认实现。
9. 【参考】枚举类名建议带上 Enum 后缀,枚举成员名称需要全大写,单词间用下
划线隔开。
说明:枚举其实就是特殊的常量类,且构造方法被默认强制是私有。
正例:枚举名字为 ProcessStatusEnum 的成员名称:SUCCESS /
UNKOWN_REASON。
10. 【参考】各层命名规约:
A) Service/DAO 层方法命名规约
1) 获取单个对象的方法用 get 做前缀。
2) 获取多个对象的方法用 list 做前缀。