前言
《阿里巴巴 Java 开发手册》是阿里巴巴集团技术团队的集体经验总结,经历了
多次大规模一线实战的检验及不断的完善,反馈给广大开发者。现代软件行业的高速
发展对开发者的综合素质要求越来越高,因为不仅是编程知识点,其它维度的知识点
也会影响到软件的最终交付质量。比如:数据库的表结构和索引设计缺陷可能带来软
件上的架构缺陷或性能风险;工程结构混乱导致后续维护艰难;没有鉴权的漏洞代码
易被黑客攻击等等。所以本手册以 Java 开发者为中心视角,划分为编程规约、异常日
志、MySQL 数据库、工程结构、安全规约五大块,再根据内容特征,细分成若干二级子
目录。根据约束力强弱及故障敏感性,规约依次分为强制、推荐、参考三大类。对于
规约条目的延伸信息中,“说明”对内容做了引申和解释;“正例”提倡什么样的编
码和实现方式;“反例”说明需要提防的雷区,以及真实的错误案例。
本手册的愿景是码出高效、码出质量。代码的字里行间流淌的是软件生命中的血
液,质量的提升是尽可能少踩坑,杜绝踩重复的坑,切实提升质量意识。另外,现代
软件架构都需要协同开发完成,高效协作即降低协同成本,提升沟通效率,所谓无规
矩不成方圆,无规范不能协作。众所周知,制订交通法规表面上是要限制行车权,实
际上是保障公众的人身安全。试想如果没有限速,没有红绿灯,谁还敢上路行驶。对
软件来说,适当的规范和标准绝不是消灭代码内容的创造性、优雅性,而是限制过度
个性化,以一种普遍认可的统一方式一起做事,提升协作效率。
《阿里巴巴 Java 开发手册》,开放包容地认真听取社区、博客、论坛的反馈,及
时修正,保持与时俱进。请关注手册末页的“阿里技术”和“云栖社区”公众号获取
最新版本。
目录
前言
一、编程规约 ........................................................................ 1
(一) 命名风格 ................................................................................................................................................................ 1
(二) 常量定义 ................................................................................................................................................................ 3
(三) 代码格式 ................................................................................................................................................................ 4
(四) OOP 规约 ................................................................................................................................................................ 6
(五) 集合处理 ................................................................................................................................................................ 9
(六) 并发处理 ............................................................................................................................................................. 11
(七) 控制语句 ............................................................................................................................................................. 14
(八) 注释规约 ............................................................................................................................................................. 15
(九) 其它 ....................................................................................................................................................................... 17
二、异常日志 ....................................................................... 18
(一) 异常处理 ............................................................................................................................................................. 18
(二) 日志规约 ............................................................................................................................................................. 19
三、MySQL 数据库 .................................................................. 21
(一) 建表规约 ............................................................................................................................................................. 21
(二) 索引规约 ............................................................................................................................................................. 22
(三) SQL 语句 ............................................................................................................................................................. 24
(四) ORM 映射 ............................................................................................................................................................. 25
四、工程结构 ....................................................................... 27
(一) 应用分层 ............................................................................................................................................................. 27
(二) 二方库依赖 ......................................................................................................................................................... 28
(三) 服务器 .................................................................................................................................................................. 29
五、安全规约 ....................................................................... 31
附 1:版本历史 ..................................................................... 32
附 2:本手册专有名词 ............................................................... 33
(注:浏览时请使用 PDF 左侧导航栏)
阿里巴巴 Java 开发手册
——禁止用于商业用途,违者必究—— 1 / 33
Java 开发手册
版本号
制定团队
更新日期
备注
1.2.0
阿里巴巴集团技术团队
2017.5.20
公开征集意见后的修正版本。
一、编程规约
(一) 命名风格
1. 【强制】 代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。
反例: _name / __name / $Object / name_ / name$ / Object$
2. 【强制】 代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。
说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,即使纯拼音命名方式
也要避免采用。
正例: alibaba / taobao / youku / hangzhou 等国际通用的名称,可视同英文。
反例: DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3
3. 【强制】类名使用 UpperCamelCase 风格,必须遵从驼峰形式,但以下情形例外:DO / BO /
DTO / VO / AO
正例:MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
反例:macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion
4. 【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格,必须遵从
驼峰形式。
正例: localValue / getHttpMessage() / inputUserId
5. 【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。
正例: MAX_STOCK_COUNT
反例: MAX_COUNT
6. 【强制】抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾;测试类
命名以它要测试的类的名称开始,以 Test 结尾。
7. 【强制】中括号是数组类型的一部分,数组定义如下:String[] args;
反例:使用 String args[]的方式来定义。
8. 【强制】POJO 类中布尔类型的变量,都不要加 is,否则部分框架解析会引起序列化错误。
反例:定义为基本数据类型 Boolean isDeleted;的属性,它的方法也是 isDeleted(),RPC
阿里巴巴 Java 开发手册
——禁止用于商业用途,违者必究—— 2 / 33
框架在反向解析的时候,“以为”对应的属性名称是 deleted,导致属性获取不到,进而抛出异
常。
9. 【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用
单数形式,但是类名如果有复数含义,类名可以使用复数形式。
正例: 应用工具类包名为 com.alibaba.open.util、类名为 MessageUtils(此规则参考
spring 的框架结构)
10. 【强制】杜绝完全不规范的缩写,避免望文不知义。
反例: AbstractClass“缩写”命名成 AbsClass;condition“缩写”命名成 condi,此类
随意缩写严重降低了代码的可阅读性。
11. 【推荐】如果使用到了设计模式,建议在类名中体现出具体模式。
说明:将设计模式体现在名字中,有利于阅读者快速理解架构设计思想。
正例:public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;
12. 【推荐】接口类中的方法和属性不要加任何修饰符号(public 也不要加),保持代码的简洁
性,并加上有效的 Javadoc 注释。尽量不要在接口里定义变量,如果一定要定义变量,肯定是
与接口方法相关,并且是整个应用的基础常量。
正例:接口方法签名:void f();
接口基础常量表示:String COMPANY = "alibaba";
反例:接口方法定义:public abstract void f();
说明:JDK8 中接口允许有默认实现,那么这个 default 方法,是对所有实现类都有价值的默
认实现。
13. 接口和实现类的命名有两套规则:
1)【强制】对于 Service 和 DAO 类,基于 SOA 的理念,暴露出来的服务一定是接口,内部
的实现类用 Impl 的后缀与接口区别。
正例:CacheServiceImpl 实现 CacheService 接口。
2) 【推荐】 如果是形容能力的接口名称,取对应的形容词做接口名(通常是–able 的形式)。
正例:AbstractTranslator 实现 Translatable。
14. 【参考】枚举类名建议带上 Enum 后缀,枚举成员名称需要全大写,单词间用下划线隔开。
说明:枚举其实就是特殊的常量类,且构造方法被默认强制是私有。
正例:枚举名字:DealStatusEnum,成员名称:SUCCESS / UNKOWN_REASON。
15. 【参考】各层命名规约:
A) Service/DAO 层方法命名规约
1) 获取单个对象的方法用 get 做前缀。