前言
《Java 开发手册》是阿里巴巴和开课吧技术团队的集体智慧结晶和经验总结，经历了多次大
规模一线实战的检验及不断完善，公开到业界后，众多社区开发者踊跃参与打磨完善，系统化地整
理成册，当前的最新版本是黄山版。现代软件行业的高速发展对开发者的综合素质要求越来越高，
因为不仅是编程知识点，其它维度的知识点也会影响到软件的最终交付质量。比如：五花八门的错
误码会人为地增加排查问题的难度；数据库的表结构和索引设计缺陷带来的系统架构缺陷或性能风
险；工程结构混乱导致后续项目维护艰难；没有鉴权的漏洞代码容易被黑客攻击等。所以本手册以
Java 开发者为中心视角，划分为编程规约、异常日志、单元测试、安全规约、MySQL 数据库、工
程结构、设计规约七个维度，再根据内容特征，细分成若干二级子目录。此外，依据约束力强弱及
故障敏感性，规约依次分为【强制】、【推荐】、【参考】三大类。在延伸的信息中，“说明”对规
约做了适当扩展和解释；“正例”提倡什么样的编码和实现方式；“反例”说明需要提防的雷区，
以及真实的错误案例。
手册的愿景是码出高效，码出质量。现代软件架构的复杂性需要协同开发完成，如何高效地
协同呢？无规矩不成方圆，无规范难以协同，比如，制定交通法规表面上是要限制行车权，实际上
是保障公众的人身安全，试想如果没有限速，没有红绿灯，谁还敢上路行驶？对软件来说，适当的
规范和标准绝不是消灭代码内容的创造性、优雅性，而是限制过度个性化，以一种普遍认可的统一
方式一起做事，提升协作效率，降低沟通成本。代码的字里行间流淌的是软件系统的血液，代码质
量的提升是尽可能少踩坑，杜绝踩重复的坑，切实提升系统稳定性，码出质量。
2017 年杭州云栖大会上发布了配套的 Java 开发规约 IDE 插件，下载量已达到 275 万人次，
阿里云效也集成了代码规约扫描引擎。2018 年 9 月在云栖厅发布 36 万字的配套详解图书《码出高
效》，秉持“图胜于表，表胜于言”的理念，深入浅出地将计算机基础、面向对象思想、数据结构
与集合、JVM 探源与内存分析、并发与多线程、单元测试等知识丰富立体地呈现出来。本书紧扣学
以致用、学以精进的目标，结合一线开发的实践经验和故障案例，与底层源码解析融会贯通，娓娓
道来。《码出高效》和《Java 开发手册（第 2 版）》稿费所得收入均捐赠公益事情，希望用技术
情怀帮助到更多的人。
Java 开发手册（黄山版）
目录
一、编程规约 ................................................................................................................................................................................. 1
(一) 命名风格 ........................................................................................................................................................................ 1
(二) 常量定义 ........................................................................................................................................................................ 3
(三) 代码格式 ........................................................................................................................................................................ 4
(四) OOP 规约 ...................................................................................................................................................................... 6
(五) 日期时间 ........................................................................................................................................................................ 9
(六) 集合处理 ...................................................................................................................................................................... 10
(七) 并发处理 ...................................................................................................................................................................... 14
(八) 控制语句 ...................................................................................................................................................................... 17
(九) 注释规约 ...................................................................................................................................................................... 20
(十) 前后端规约 .................................................................................................................................................................. 21
(十一) 其他 .......................................................................................................................................................................... 23
二、异常日志 ............................................................................................................................................................................... 24
(一) 错误码 .......................................................................................................................................................................... 24
(二) 异常处理 ...................................................................................................................................................................... 25
(三) 日志规约 ...................................................................................................................................................................... 26
三、单元测试 ............................................................................................................................................................................... 29
四、安全规约 ............................................................................................................................................................................... 31
五、MySQL 数据库 .................................................................................................................................................................... 32
(一) 建表规约 ...................................................................................................................................................................... 32
(二) 索引规约 ...................................................................................................................................................................... 33
(三) SQL 语句 ..................................................................................................................................................................... 34
(四) ORM 映射 ................................................................................................................................................................... 35
六、工程结构 ............................................................................................................................................................................... 37
(一) 应用分层 ...................................................................................................................................................................... 37
(二) 二方库依赖 .................................................................................................................................................................. 38
(三) 服务器 .......................................................................................................................................................................... 39
七、设计规约 ............................................................................................................................................................................... 40
附 1：版本历史 ............................................................................................................................................................................ 42
附 2：专有名词解释.................................................................................................................................................................... 44
附 3：错误码列表 ........................................................................................................................................................................ 45
Java 开发手册（黄山版）
1/51
一、编程规约
(一) 命名风格
1.【强制】所有编程相关的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。
反例：_name / __name / $Object / name_ / name$ / Object$
2.【强制】所有编程相关的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。
说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用。
正例：ali / alibaba / taobao / kaikeba / aliyun / youku / hangzhou 等国际通用的名称，可视同英文。
反例：DaZhePromotion【打折】/ getPingfenByName()【评分】 / String fw【福娃】/ int 变量名 = 3
3.【强制】代码和注释中都要避免使用任何人类语言中的种族歧视性或侮辱性词语。
正例：blockList / allowList / secondary
反例：blackList / whiteList / slave / SB / WTF
4.【强制】类名使用 UpperCamelCase 风格，以下情形例外：DO / PO / DTO / BO / VO / UID 等。
正例：ForceCode / UserDO / HtmlDTO / XmlService / TcpUdpDeal / TaPromotion
反例：forcecode / UserDo / HTMLDto / XMLService / TCPUDPDeal / TAPromotion
5.【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格。
正例：localValue / getHttpMessage() / inputUserId
6.【强制】常量命名应该全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
正例：MAX_STOCK_COUNT / CACHE_EXPIRED_TIME
反例：MAX_COUNT / EXPIRED_TIME
7.【强制】抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾，测试类命名以它要
测试的类的名称开始，以 Test 结尾。
8.【强制】类型与中括号紧挨相连来定义数组。
正例：定义整形数组 int[] arrayDemo。
反例：在 main 参数中，使用 String args[] 来定义。
9.【强制】POJO 类中的任何布尔类型的变量，都不要加 is 前缀，否则部分框架解析会引起序列化错误。
说明：本文 MySQL 规约中的建表约定第 1 条，表达是与否的变量采用 is_xxx 的命名方式，所以需要在<resultMap>
设置从 is_xxx 到 xxx 的映射关系。
反例：定义为基本数据类型 Boolean isDeleted 的属性，它的方法也是 isDeleted()，框架在反向解析时，“误以为”对
应的属性名称是 deleted，导致属性获取不到，进而抛出异常。
10.【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形
式，但是类名如果有复数含义，类名可以使用复数形式。
正例：应用工具类包名为 com.alibaba.ei.kunlun.aap.util；类名为 MessageUtils（此规则参考 spring 的框架结构）。
11.【强制】避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名，使可理
解性降低。
版本号
制定团队
更新日期
备注
1.7.1
全球 Java 社区开发者
2022.02.03
黄山版，新增 11 条新规约。
Java 开发手册（黄山版）
2/51
说明：子类、父类成员变量名相同，即使是 public 也是能够通过编译，而局部变量在同一方法内的不同代码块中同名
也是合法的，但是要避免使用。对于非 setter / getter 的参数名称也要避免与成员变量名称相同。
反例：
public class ConfusingName {
protected int stock;
protected String alibaba;
// 非 setter/getter 的参数名称，不允许与本类成员变量同名
public void access(String alibaba) {
if (condition) {
final int money = 666;
// ...
}
for (int i = 0; i < 10; i++) {
// 在同一方法体中，不允许与其它代码块中的 money 命名相同
final int money = 15978;
// ...
}
}
}
class Son extends ConfusingName {
// 不允许与父类的成员变量名称相同
private int stock;
}
12.【强制】杜绝完全不规范的英文缩写，避免望文不知义。
反例：AbstractClass“缩写”成 AbsClass；condition“缩写”成 condi；Function“缩写”成 Fu，此类随意缩写
严重降低了代码的可阅读性。
13.【推荐】为了达到代码自解释的目标，任何自定义编程元素在命名时，使用完整的单词组合来表达。
正例：在 JDK 中，对某个对象引用的 volatile 字段进行原子更新的类名为 AtomicReferenceFieldUpdater。
反例：常见的方法内变量为 int a; 的定义方式。
14.【推荐】在常量与变量命名时，表示类型的名词放在词尾，以提升辨识度。
正例：startTime / workQueue / nameList / TERMINATED_THREAD_COUNT
反例：startedAt / QueueOfWork / listName / COUNT_TERMINATED_THREAD
15.【推荐】如果模块、接口、类、方法使用了设计模式，在命名时要体现出具体模式。
说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计思想。
正例： public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;
16.【推荐】接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上
有效的 Javadoc 注释。尽量不要在接口里定义常量，如果一定要定义，最好确定该常量与接口的方法
相关，并且是整个应用的基础常量。
正例：接口方法签名 void commit();
接口基础常量 String COMPANY = "alibaba";
反例：接口方法定义 public abstract void commit();
说明：JDK8 中接口允许有默认实现，那么这个 default 方法，是对所有实现类都有价值的默认实现。
