阿里巴巴Java开发手册.pdf

1、 目录 前言 . 1 一 、 编程规约 . 2 (一 ) 命名规约 . 2 (二 ) 常量定义 . 4 (三 ) 格式规约 . 5 (四 ) OOP规约 . 7 (五 ) 集合处理 . 11 (六 ) 并发处理 . 13 (七 ) 控制语句 . 16 (八 ) 注释规约 . 17 (九 ) 其它 . 18 二、异常日志 . 20 (一 ) 异常处理 . 20 (二 ) 日志规约 . 21 三、 MySQL规约 . 23 (一 ) 建表规约 . 23 (二 ) 索引规约 . 25 (三 ) SQL规约 . 27 (四 ) ORM规约 . 28 四、工程规约 . 29 (一 ) 应用分层 . 29

2、 (二 ) 二方库规约 . 30 (三 ) 服务器规约 . 32 五、安 全规约 . 33 附 1：版本历史 . 34 附 2：本规约专有名词 . 34 附 3：法律声明 . 34 （注 ： 全 文 浏览 时请使用 PDF左侧导航栏） 阿里巴巴 Java开发手册 禁止用于商业用途，违者必究 1 / 37 前言 阿里 巴 巴 Java 开发手册是阿里 巴巴 集团 技术 团队的集体 经验总结 ，经历了多次大规模一线实战 的 检验及 不断 的 完善，反馈 给广大开发 者。 现代 软件行业 的 高速发展对于开发 者的综合 素质要求越来越高 ， 因为 不仅 是 编 程 知识 点 ，其它维度的知识点 也

3、会影响到 软件 的 最终 交付质量 。 比如 ： 数据库的表 结构和 索引设计缺陷可能 带 来软件 上的架构缺陷或性能风险 ； 工程结构混乱导致维护困难 ；没有鉴权 的 漏洞 代码被黑客 攻击 等 等 。 所以 本 手册以 Java 开发者为中心视角，划 分为 编程规约、异常日 志规约、 MySQL 规约、工程规约、安全规约 五大块，再根据内容特 征，细分成若干二级子目录。根据约束力强弱及 故障敏感性，规约依次分为强制、推荐、参考三大类。 对于规约里的内容 ，“ 说明 ” 对内容做了引申和解释； “ 正例 ” 提倡 什么样的编码 和 实现 方式 ； “ 反例 ” 说明 需要提防的雷区 ， 以及

4、 真实的 错误案例 。 本 手册 的愿景 是 码出质量、码出高效 。 代码 的字里行间 流淌 的 是 软件 生命中的血液， 质量 的提升 是尽 可能少踩坑 ， 杜绝 踩重复的坑， 切实 提升质量意识 。另 外， 现代软件架构都需要协同 开 发完成，高效 考虑的 是降低协同成本 ，所谓无规矩不成方圆，无规范不 能协作。 众所周知，制订交通法规表面上是要限制行车权，实际上是保障公众的人身安全。试想如果没有限速，没有红绿灯，没有规定靠右行驶，谁还敢上路行驶。对软件来说，适当的规范和标准绝不是消灭代码内容的创造性、优雅性，而是限制过度个性化，以一种普遍认可的 统一 方式一起做事，提升协作效率。 阿里巴

5、巴 Java 开发手册 ，开放 包容 地 认 真总结 社区 、博客、论坛的反馈，及时修正， 保持 与时俱进。请 关注手册 末页的 “ 阿里技术 ” 和 “ 云栖 社区 ” 公 众 号 获取最 新版 。 阿里巴巴 Java开发手册 禁止用于商业用途，违者必究 2 / 37 Java 开发 手册 版本号 制定团队 更新日期 备注 1.1.0 阿 里巴巴 集团 技术团队 2017.2.27 增加前 言 和专有 名词 说明 ， 修正部分描述。 一 、 编程规约 (一 ) 命名规约 1. 【强制】 代码中的 命名均不能以 下划线或美元符号 开始，也不能以 下划线或美元符号 结束。 反例： _name /

6、 _name / $Object / name_ / name$ / Object$ 2. 【强制】 代码中的 命名 严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。 说明： 正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用。 反例： DaZhePromotion 打折 / getPingfenByName() 评分 / int 某 变量 = 3 正例： alibaba / taobao / youku / hangzhou 等国际通用的名称， 可 视 同 英文。 3. 【强制】类名使用 UpperCamelCase风格，必须遵从驼峰形式，但以

7、下 情形例外： （ 领域模型的相关命名 ） DO / BO / DTO / VO等。 正例： MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion 反例： macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion 4. 【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase风格，必须遵从驼峰形式。 正例： localValue / getHttpMessage() / inputUserId 5. 【 强制】常量命名 全部大写，单词间用下划线隔

8、开，力求语义表达完整清楚，不要嫌名字长。 正例： MAX_STOCK_COUNT 反例： MAX_COUNT 6. 【强制】抽象类命名使用 Abstract或 Base开头 ； 异常类命名使用 Exception结尾 ； 测试类命名以它要测试的类的名称开始，以 Test结尾。 7. 【强制】中括号是数组类型的一部分，数组定义如下： String args; 反例： 使用 String args的方式来 定义 。 阿里巴巴 Java开发手册 禁止用于商业用途，违者必究 3 / 37 8. 【强制】 POJO类中 布尔类型的变量，都不要加 is，否则部分框架解析 会引起序列化错误。 反例： 定义为

9、基本数据类型 Boolean isSuccess； 的属性，它的方法也是 isSuccess()， RPC框架在反向解析的时候， “以为 ”对应的属性名称是 success，导致属性获取不到，进而抛出异常。 9. 【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数 形式，但是类名如果有复数含义，类名可以使用复数形式。 正例： 应用工具类包名为 com.alibaba.open.util、类名为 MessageUtils（ 此规则参考spring的框架结构 ） 10. 【强制】杜 绝完全不规范的缩写， 避免望文不知义 。 反例： AbstractClass“

10、缩写 ” 命名成 AbsClass； condition“ 缩写 ” 命名成 condi，此类随意缩写严重降低了代码的可阅读性。 11. 【推荐】如果使用到了设计模式，建议在类名中体现出具体模式。 说明： 将设计模式体现在名字中，有利于阅读者快速理解架构设计思想。 正例： public class OrderFactory; public class LoginProxy; public class ResourceObserver; 12. 【推荐】 接口类中的方法和属性不要加任何修饰符号 （ public 也不要加 ） ，保持代码的简洁性，并加上有效的 Javadoc注释。尽量不要在接口里

11、定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。 正例： 接口方法签名： void f(); 接口基础常量表示： String COMPANY = “alibaba“; 反例： 接口方法定义： public abstract void f(); 说明： JDK8中接口允许有默认实现，那么这个 default方法，是对所有实现类都有价值的默认实现。 13. 接口和 实现类的命名有两套规则： 1） 【强制】对于 Service和 DAO类，基于 SOA的理念，暴露出来的服务一定是接口，内部的实现类用 Impl的后缀与接口区别。 正例： CacheServiceImpl

12、实现 CacheService接口。 2） 【推荐】 如果是形容能力的接口名称，取对应的形容词做接口名 （ 通常是 able的形式 ） 。 正例： AbstractTranslator实现 Translatable。 14. 【参考】枚举类名建议带上 Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开。 说明： 枚举其实就是特殊的常 量类，且构造方法被默认强制是私有。 正例： 枚举名字： DealStatusEnum， 成员名称： SUCCESS / UNKOWN_REASON。 阿里巴巴 Java开发手册 禁止用于商业用途，违者必究 4 / 37 15. 【参考】各层命名规约： A)

13、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/B

14、O/VO的统称，禁止命名成 xxxPOJO。 (二 ) 常量定义 1. 【强制】不允许出现任何魔法值 （ 即未经定义的常量 ） 直接出现在代码中。 反例： String key = “Id#taobao_“+tradeId； cache.put(key, value); 2. 【强制】 long或者 Long初始赋值时，必须使用大写的 L，不能是小写的 l，小写容易跟数字1混淆，造成误解。 说明： Long a = 2l; 写的是数字的 21，还是 Long型的 2? 3. 【推荐】不要使用一个常量类维护所有常量，应该按常量功能进行归类，分开维护。如：缓存相关的常量放在类： CacheCons

15、ts下 ； 系统配置相关的常量放在类： ConfigConsts下。 说明： 大而全的常量类，非得 使用查找功能 才 能 定位到修改的常量，不利于理解 和 维护。 4. 【推荐】常量的复用层次有五层：跨应用共享常量、 应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。 1） 跨应用共享常量：放置在二方库中，通常是 client.jar中的 constant目录下。 2） 应用内共享常量：放置在一方库的 modules中的 constant目录下。 反例： 易懂变量也要统一定义成应用内共享常量，两位攻城师在两个类中分别定义了表示“是 ”的变量： 类 A中： public static

16、 final String YES = “yes“; 类 B中： public static final String YES = “y“; A.YES.equals(B.YES)，预期是 true，但实际返回为 false，导致产生线上问题。 阿里巴巴 Java开发手册 禁止用于商业用途，违者必究 5 / 37 3） 子工程内部共享常量：即在当前子工程的 constant目录下。 4） 包内共享常量：即在当前包下单独的 constant目录下。 5） 类内共享常量：直接在类内部 private static final定义。 5. 【推荐】如果变量值仅在一个范围内变化用 Enum类。如果还带

17、有名称之外的延伸属性，必须使用 Enum类，下面正例中的数字就是延伸信息，表示星期几。 正例： public Enum MONDAY(1), TUESDAY(2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5), SATURDAY(6), SUNDAY(7); (三 ) 格式规约 1. 【强制】大括号的使用约定。如果是大括号内为空，则简洁地写成 即可，不需要换行 ； 如果是非空代码块则： 1） 左大括号前不换行。 2） 左大括号后换行。 3） 右大括号前换行。 4） 右大括号后还有 else等代码则不换行 ； 表示终止右大括号后必须换行。 2. 【强制】 左括号和后

18、一个字符之间不出现空格 ； 同样，右括号和前 一个字符之间也不出现空格。详见第 5条下方正例提示。 3. 【强制】 if/for/while/switch/do等保留字与左右括号之间都必须加空格。 4. 【强制】任何运算符左右必须加一个空格。 说明： 运算符包括赋值运算符 =、逻辑运算符 / 运算符的左右必须有一个空格 int flag = 0; / 关键词 if与括号之间必须有一个空格，括号内 的 f与左括号， 0与右括号不需要空格 if (flag = 0) System.out.println(say); / 左大括号前加空格且不换行；左大括号后换行 if (flag = 1) Syst

19、em.out.println(“world“); / 右大括号前换行，右大括号后有 else，不用换行 阿里巴巴 Java开发手册 禁止用于商业用途，违者必究 6 / 37 else System.out.println(“ok“); / 在右大括号后直接结束，则必须换行 6. 【强制】单行字符数限制不超过 120 个，超出需要换行，换行时 遵循如下原则： 1） 第二行相对第 一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。 2） 运算符与下文一起换行。 3） 方法调用的点符号与下文一起换行。 4） 在多个参数超长，逗号后进行换行。 5） 在括号前不要换行，见反例。 正例： Str

20、ingBuffer sb = new StringBuffer(); /超过 120个字符的情况下，换行缩进 4个空格，并且方法前的点符号一起换行 sb.append(“zi“).append(“xin“). .append(“huang“). .append(“huang“). .append(“huang“); 反例： StringBuffer sb = new StringBuffer(); /超过 120个字符的情况下，不要在 括号前 换行 sb.append(“zi“).append(“xin“).append (“huang“); /参数很多的方法调用 可能 超过 120个字符，

21、不要 在 逗号前 换行 method(args1, args2, args3, . , argsX); 7. 【强制】方法参数在定义和传入时，多个参数逗号 后边必须加空格。 正例： 下例中实参的 “a“,后边必须要有一个空格。 method(“a“, “b“, “c“); 8. 【强制】 IDE的 text file encoding设置为 UTF-8; IDE中文件的换行符使用 Unix格式，不要使用 windows格式。 9. 【推荐】没有必要增加若干空格来使某一行的字符与上一行的相应字符对齐。 正例： int a = 3; long b = 4L; float c = 5F; Strin

22、gBuffer sb = new StringBuffer(); 说明： 增加 sb这个 变量，如果需要对齐，则给 a、 b、 c都要增加几个空格，在变量比较多的情况下，是一种累赘的事情。 阿里巴巴 Java开发手册 禁止用于商业用途，违者必究 7 / 37 10. 【推荐】方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之间插入一个空行。相同业务逻辑和语义之间不需要插入空行。 说明： 没有必要插入 多行空格 进行隔开。 (四 ) OOP规约 1. 【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用 类名 来访问即可。 2. 【

23、强制】所有的覆写方法，必须加 Override注解。 反例： getObject()与 get0bject()的问题。一个 是字母的 O，一个是数字的 0，加 Override可以准确判断是否覆盖成功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错。 3. 【强制】相同参数类型，相同业务含义，才可以使用 Java的可变参数，避免使用 Object。 说明： 可变参数必须放置在参数列表的最后。 （ 提倡同学们尽量不用可变参数编程 ） 正例： public User getUsers(String type, Integer. ids) 4. 【强制】外部正在调用或者二方库依赖的接

24、口，不允许修改方法签名，避免对接口调用方产生影响。接口过时必须 加 Deprecated注解，并清晰地说明采用的新接口或者新服务是什么。 5. 【强制】不能使用过时的类或方法。 说明： .URLDecoder 中的方法 decode(String encodeStr) 这个方法已经过时，应该使用双参数 decode(String source, String encode)。接口提供方既然明确是过时接口，那么有义务同时提供新的接口 ； 作为调用方来说，有义务去考证过时方法的新实现是什么。 6. 【强制】 Object的 equals方法容易抛空指针异常，应使用常量或确定有值的对象 来调用equ

25、als。 正例： “test“.equals(object); 反例： object.equals(“test“); 说明： 推荐使用 java.util.Objects#equals （ JDK7引入的工具类 ） 7. 【强制】所有的相同类型的包装类对象之间 值的比较 ，全部使用 equals方法比较。 说明： 对于 Integer var = ?在 -128至 127之间的赋值， Integer对象是在IntegerCache.cache产生，会复用已有对象，这个区间内的 Integer值可以直接使用 =进行判断，但是这个 区间之外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大

26、坑，推荐使用 equals方法进行判断。 阿里巴巴 Java开发手册 禁止用于商业用途，违者必究 8 / 37 8. 关于基本数据类型与包装数据类型的使用标准如下： 1） 【强制】 所有的 POJO类属性必须使用包装数据类型。 2） 【强制】 RPC方法的返回值和参数必须使用包装数据类型。 3） 【 推荐 】 所有的局部变量使用基本数据类型。 说明： POJO类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何NPE问题，或者入库检查，都由使用者来保证。 正例： 数据库的查询结果可能是 null，因为自动拆 箱，用基本数据类型接收有 NPE风险。 反例： 比如 显示成交总额涨跌

27、情况，即正负 x%， x为基本数据类型，调用的 RPC服务，调用不成功时，返回的是默认值，页面显示： 0%，这是不合理的，应该显示成中划线 -。所以包装数据类型的 null值，能够表示额外的信息，如：远程调用失败，异常退出。 9. 【强制】定义 DO/DTO/VO等 POJO类时，不要设定任何属性 默认值 。 反例： POJO类 的 gmtCreate默认值为 new Date();但是这个属性在数据提取时并没有置入具体值，在更新其它字段时又附带更新了此字段，导致创建时间被修 改成当前时间。 10. 【强制】序列化类新增属性时，请不要修改 serialVersionUID字段，避免反序列失败

28、； 如果完全不兼容升级，避免反序列化混乱，那么请修改 serialVersionUID值。 说明： 注意 serialVersionUID不一致会抛出序列化运行时异常。 11. 【强制】构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在 init方法中。 12. 【强制】 POJO类必须写 toString方法。使用 IDE的 中工具 ： source generate toString时，如果继承了另一个 POJO类，注意在前面加 一下 super.toString。 说明： 在方法执行抛出异常时，可以直接调用 POJO的 toString()方法打印其属性值，便于排查问题。 13. 【推荐】使用索引访问用 String的 split方法得到的数组时，需做最后一个分隔符后有无内容的检查，否则会有抛 IndexOutOfBoundsException的风险。 说明： String str = “a,b,c,“; String ary = str.split(“,“); /预期大于 3，结果是 3 System.out.println(ary.length); 14. 【推荐】当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起，便于阅读。