阿里巴巴Java开发...1528284352.pdf

1、 前言 阿里 巴 巴 Java 开发手册是阿里 巴巴集团 技术团队的集体 智慧 结晶 和 经验总结， 经历了多次大规模一线实战 的 检验及 不断 完善， 系统 化地整理成 册 ， 回馈 给广大开发 者。 现代 软件行业 的 高速发展对开发 者的综合 素质要求越来越高 ， 因为 不仅 是 编程 知识 点 ，其它维度的知识 点 也 会影响到 软件 的 最终交付质量 。比如： 数据库的表 结构和 索引设计缺陷可能 带 来 软件 上的架构缺陷或性能风险 ； 工程结构混乱导致 后续维护 艰难 ；没有鉴权 的 漏洞 代码 易 被黑客 攻击等 等。 所以 本 手册以 Java 开发者为中心视角，划 分为编程

2、规约、异常日志 、 单元 测试、 安全规约 、 MySQL 数据 库 、 工程结构 、 设计 规约 七 个 维度 ，再根据内容特 征，细分成若干二级子目录。根据约束力强弱及 故障敏感性，规约依次分为强制、推荐、参考三大类。 对于规约 条目 的 延伸信息 中 ，“ 说明 ” 对 规约 做了 适当 扩展 和解释； “ 正例 ” 提倡 什么样的编码 和 实现 方式 ； “ 反例 ”说明 需要提防的雷区 ， 以及 真实的 错误案例 。 本 手册 的 旨 在 码出高效 ， 码出质量 。 现代 软件架构 的 复杂性需要 协同 开 发完成，如何高 效地 协同 呢？ 无规矩不成方圆，无规范难 以 协同 ， 比

3、如， 制订交通法规表面上是要限制行 车权， 实际上是保障公众的人身安全， 试想如果没有限速，没有红绿灯 ，谁还敢上路行驶。对软件来说，适当的规范和标准绝不是消灭代码内容的创造性、优雅性，而是限制过度个性化，以一种普遍认可的 统一 方式一起做事，提升协作效率 ，降低沟通成本 。 代码 的字里行间 流淌的 是 软件 系统的血液 ， 质量 的提升 是尽 可能少踩坑 ，杜绝 踩重复的坑， 切实 提升 系统 稳定性 ， 码出质量 。 考虑到可以零距离地与众多开发同学进行互动，决定 未来 在线维护 手册内容，此 1.4.0的 PDF版本 ， 是 最为 详尽的版本 ， 新增设计规约大章节 ， 并增加若干条目

4、 ； 我们 已经 在 2017 杭州 云栖 大会 上发 布 了 阿里巴巴 Java 开 发规约 插件 （ 点此下载 ） ， 阿 里云 效 （一站式企业协同研发 云 ） 也 集成 了 代码 规约 扫描引擎 。 最 后， 码出高效 阿里巴巴 Java 开发手册详解 即将 出版，敬请关注。 目录 前言 一 、 编程规约 . 1 (一 ) 命名风格 . 1 (二 ) 常量定义 . 3 (三 ) 代码格式 . 4 (四 ) OOP规约 . 6 (五 ) 集合处理 . 9 (六 ) 并发处理 . 12 (七 ) 控制语句 . 14 (八 ) 注释规约 . 16 (九 ) 其它 . 18 二、异常日志 .

5、19 (一 ) 异常处理 . 19 (二 ) 日志规约 . 20 三、单元测试 . 22 四、安全规约 . 24 五、 MySQL数据库 . 25 (一 ) 建表规约 . 25 (二 ) 索引规约 . 26 (三 ) SQL语句 . 28 (四 ) ORM映射 . 29 六、工程结构 . 31 (一 ) 应用分层 . 31 (二 ) 二方库依赖 . 32 (三 ) 服务器 . 33 七、设计规约 . 35 附 1：版本历史 . 37 附 2：专有名词解释 . 38 （注 ： 浏览 时请使用 PDF左侧导航栏） 阿里巴巴 Java开发手册 1/38 Java开发 手册 版本号 制定团队 更新日期

6、 备注 1.4.0 阿 里巴巴 集团 技术团队 2018.5.20 增加设计规约 （ 详尽 版） 一 、 编程规约 (一 ) 命名 风格 1. 【强制】 代码中的 命名均不能以 下划线或美元符号 开始，也不能以 下划线或美元符号 结束。 反例： _name / _name / $name / name_ / name$ / name_ 2. 【强制】 代码中的 命名 严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。 说明： 正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用。 正例： alibaba / taobao / youku / hang

7、zhou 等国际通用的名称， 可 视 同 英文。 反例： DaZhePromotion 打折 / getPingfenByName() 评分 / int 某 变量 = 3 3. 【强制】类名使用 UpperCamelCase风格，但以下情形例外： DO / BO / DTO / VO / AO / PO / UID等。 正例： MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion 反例： macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion 4. 【强制】方法名、参数

8、名、成员变量、局部变量都统一使用 lowerCamelCase风格，必须遵从驼峰形式。 正例： localValue / getHttpMessage() / inputUserId 5. 【 强制】常量命名 全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。 正例： MAX_STOCK_COUNT 反例： MAX_COUNT 6. 【强制】抽象类命名使用 Abstract或 Base开头 ； 异常类命名使用 Exception结尾 ； 测试类命名以它要测试的类 的名称 开始，以 Test结尾。 7. 【强制】类型与中括号紧挨相连来 表示 数组。 正例： 定义整形数组 int

9、arrayDemo; 反例： 在 main 参数中，使用 String args来定义。 8. 【强制】 POJO类中 布尔类型的变量，都不要加 is前缀 ，否则部分框架解析会引起序列化错误。 反例： 定义为基本数据类型 Boolean isDeleted的属性，它的方法也是 isDeleted()， RPC阿里巴巴 Java开发手册 2/38 框架在反向解析的时候， “误 以为 ” 对应的属性名称是 deleted，导致属性获取不到，进而抛出异常。 9. 【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数 形式，但是类名如果有复数含义，类名可以使用复数形式

10、。 正例： 应用工具类包名为 com.alibaba.ai.util、类名为 MessageUtils（ 此规则参考 spring的框架结构 ） 10. 【强制】杜绝完全不规范的缩写， 避免望文不知义 。 反例： AbstractClass“ 缩写 ” 命名成 AbsClass； condition“ 缩写 ” 命名成 condi，此类随意缩写严重降低了代码的可阅读性。 11. 【推荐】为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达其意。 正例： 在 JDK 中， 表达 原子更新的类名为： AtomicReferenceFieldUpdater。 反例： 变

11、量 int a 的 随 意命名 方式。 12. 【推荐】如果 模块 、 接口 、类、方法使用了设计模式，在 命名时 需 体现出具体模式。 说明： 将设计模式体现在名字中，有利于阅读者快速理解架构设计 理念 。 正例： public class OrderFactory; public class LoginProxy; public class ResourceObserver; 13. 【推荐】接口类中的方法和属性不要加任何修饰符号 （ public 也不要加 ） ，保持代码的简洁性，并加上有效的 Javadoc注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是

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

13、形容能力的接口名称，取对应的形容词 为 接口名 （ 通常是 able的形式 ） 。 正例： AbstractTranslator实现 Translatable接口 。 阿里巴巴 Java开发手册 3/38 15. 【参考】枚举类名建议带上 Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开。 说明： 枚举其实就是特殊的 类， 域成员均 为常量 ， 且构造方法被默认强制是私有。 正例： 枚举名字 为 ProcessStatusEnum的 成员名称 ： SUCCESS / UNKNOWN_REASON。 16. 【参考】各层命名规约： A) Service/DAO层方法命名规约 1） 获取单

14、个对象的方法用 get做 前缀。 2） 获取多个对象的方法用 list做 前缀 ，复数 形式结 尾 如： listObjects。 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的统称，禁止

15、命名成 xxxPOJO。 (二 ) 常量定义 1. 【强制】不允许 任何魔法值 （ 即未经 预先 定义的常量 ） 直接出现在代码中。 反例： String key = “Id#taobao_“ + tradeId; cache.put(key, value); 2. 【强制】 在 long或者 Long赋值时， 数值 后 使用大写的 L，不能是小写的 l，小写容易跟数字1混淆，造成误解。 说明： Long a = 2l; 写的是数字的 21，还是 Long型的 2? 3. 【推荐】不要使 用一个常量类维护所有常量， 要 按常量功能进行归类，分开维护。 说明： 大而全的常量类， 杂乱无章 ， 使

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

17、blic static final String YES = “yes“; 阿里巴巴 Java开发手册 4/38 类 B中： public static final String YES = “y“; A.YES.equals(B.YES)，预期是 true，但实际返回为 false，导致 线上问题。 3） 子工程内部共享常量：即在当前子工程的 constant目录下。 4） 包内共享常量：即在当前包下单独的 constant目录下。 5） 类内共享常量：直接在类内部 private static final定义。 5. 【推荐】 如果变量值仅在一个固定范围内变化用 enum 类型来定义。 说

18、明： 如果存在名称之外的延伸属性 应 使用 enum 类型，下面正例中的数字就是延伸信息，表示一年中的第几个季节。 正例： public enum SeasonEnum SPRING(1), SUMMER(2), AUTUMN(3), WINTER(4); private int seq; SeasonEnum(int seq) this.seq = seq; (三 ) 代码 格式 1. 【强制】大括号的使用约定。如果是大括号内为空，则简洁地写成 即可，不需要换行 ； 如果是非空代码块则： 1） 左大括号前不换行。 2） 左大括号后换行。 3） 右大括号前换行。 4） 右大括号后还有 else

19、等代码则不换行 ； 表示终止 的 右大括号后必须换行。 2. 【强制】左 小 括号和 字符之间不出现空格 ； 同样，右 小 括号和字符之间也不出现空格 ；而 左大括号前 需要空格 。详 见 第 5条下方正例提示。 反例： if (空格 a = b空格 ) 3. 【强制】 if/for/while/switch/do等保留字与 括号之间都必须加空格。 4. 【强制】任何 二 目 、 三目 运算符 的 左右 两边 都需要 加一个空格。 说明： 运算符包括赋值运算符 =、逻辑运算符 / 运算符的左右必须有一个空格 int flag = 0; / 关键词 if与括号之间必须有一个空格，括号内 的 f与

20、左括号， 0与右括号不需要空格 if (flag = 0) System.out.println(say); / 左大括号前加空格且不换行；左大括号后换行 if (flag = 1) System.out.println(“world“); / 右大括号前换行，右大括号后有 else，不用换行 else System.out.println(“ok“); / 在右大括号后直接结束，则必须换行 6. 【强制】注释的双斜线与注释内容之间有且仅有一个空格。 正例： / 这是示例注释，请注意在双斜线之后有一个空格 String ygb = new String(); 7. 【强制】单行字符数限制不超过

21、 120 个，超出需要换行，换行时 遵循如下原则： 1） 第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。 2） 运算符与下文一起换行。 3） 方法调用的点符号与下文一起换行。 4） 方法 调用 中 的 多个参数 需要 换行时， 在 逗号后 进行 。 5） 在括号前不要换行，见反例。 正例： StringBuffer sb = new StringBuffer(); / 超过 120个字符的情况下，换行缩进 4个空格， 点 号 和 方法名称 一起换行 sb.append(“zi“).append(“xin“). .append(“huang“). .append(“hu

22、ang“). .append(“huang“); 反例： StringBuffer sb = new StringBuffer(); / 超过 120个字符的情况下，不要在 括号前 换行 sb.append(“zi“).append(“xin“).append (“huang“); / 参数很多的方法调用 可能 超过 120个字符， 不要 在 逗号前 换行 method(args1, args2, args3, . , argsX); 阿里巴巴 Java开发手册 6/38 8. 【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。 正例： 下例中实参的 args1， 后边必须要有一个空

23、格。 method(args1, args2, args3); 9. 【强制】 IDE的 text file encoding设置为 UTF-8; IDE中文件的换行符使用 Unix格式，不要使用 Windows格式。 10. 【推荐】单个方法的总行数不超过 80 行。 说明： 包括方法签名、结束右大括号、方法内代码、注释、空行、回车及任何不可见字符的总行数不超过 80 行。 正例： 代码逻辑 分清 红花 和绿叶， 个性 和共性，绿叶逻辑单独 出来成 为 额外 方法 ，使 主干代码更加清晰 ； 共性逻辑抽取成为 共性 方法，便于复用和维护 。 11. 【推荐】没有必要增加若干空格来使某一行的字

24、符与上一行 对应位置 的字符 对齐。 正例： int one = 1; long two = 2L; float three = 3F; StringBuffer sb = new StringBuffer(); 说明： 增加 sb这个变量，如果需要对齐，则给 a、 b、 c都要增加几个空格，在变量比较多的情况下，是 非常 累赘的事情。 12. 【推荐】 不 同逻辑、不同语义、不同业务的代码之间插 入 一个空行 分隔 开来以提升可 读 性 。 说明： 任何 情形， 没有必要插入 多 个 空行 进行隔开。 (四 ) OOP规约 1. 【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，

25、无谓增加编译器解析成本，直接用 类名 来访问即可。 2. 【强制】所有的覆写方法，必须加 Override注解。 说明： getObject()与 get0bject()的问题。一个是字母的 O，一个是数字的 0，加 Override可以准确判断是否覆盖成功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错。 3. 【强制】相同参数类型，相同业务含义，才可以使用 Java的可变参数，避免使用 Object。 说明： 可变参数必须放置在参数列表的最后。 （ 提倡同学们尽量不用可变参数编程 ） 正例： public List listUsers(String type, Long.

26、ids) . 4. 【强制】外部正在调用或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方产生影响。接口过时必须加 Deprecated注解，并清晰地说明采用的新接口或者新服务是什么。 5. 【强制】不能使用过时的类或方法。 说明： .URLDecoder 中的方法 decode(String encodeStr) 这个方法已经过时，应阿里巴巴 Java开发手册 7/38 该使用双参数 decode(String source, String encode)。接口提供方既然明确是过时接口，那么有义务同时提供新的接口 ； 作为调用方来说，有义务去考证过时方法的新实现是什么。 6. 【强制

27、】 Object的 equals方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals。 正例： “test“.equals(object); 反例： object.equals(“test“); 说明： 推荐使用 java.util.Objects#equals（ JDK7引入的工具类 ） 7. 【强制】所有的相同类型的包装类对象之间 值的比较 ，全部使用 equals方法比较。 说明： 对于 Integer var = ? 在 -128至 127范围 内 的赋值， Integer对象是在IntegerCache.cache产生，会复用已有对象，这个区间内的 Integer值可以

28、直接使用 =进行判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大坑，推荐使用 equals方法进行判断。 8. 关于基本数据类型与包装数据类型的使用标准如下： 1） 【强制】 所有的 POJO类属性必须使用包装数据类型。 2） 【强制】 RPC方法的返回值和参数必须使用包装数据类型。 3） 【 推荐 】 所有的局部变量使用基本数据类型。 说明： POJO类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何NPE问题，或者入库检查，都由使用者来保证。 正例： 数据库的查询结果可能是 null，因为自动拆箱，用基本数据类型接收有 NPE风险。 反例：

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

30、字段，避免反序列失败 ； 如果完全不兼容升级，避免反序列化混乱，那么请修改 serialVersionUID值。 说明： 注意 serialVersionUID不一致会抛出序列化运行时异常。 11. 【强制】构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在 init方法中。 12. 【强制】 POJO类必须写 toString方法。使用 IDE中 的 工具 ： source generate toString时，如果继承了另一个 POJO类，注意在前面加一下 super.toString。 说明： 在方法执行抛出异常时，可以直接调用 POJO的 toString()方法打印其属性值，便于排查问题。