再读阿⾥JAVA开发⼿册（嵩⼭版）
阿⾥的JAVA开发规范是阿⾥多位优秀的⼯程师多年经验的累积，其中⼤多数规范都是值得学习的。但是并不是说我们要100%按⾥⾯规范去写代码，有些部分还是要按照⾃⼰公司的规范来。
阿⾥JAVA开发⼿册
（嵩⼭版）
编程规约
(⼀) 命名风格
1. 【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。
反例：_name / __name / $name / name_ / name$ / name__
2. 【强制】所有编程相关的命名严禁使⽤拼⾳与英⽂混合的⽅式，更不允许直接使⽤中⽂的⽅式。
说明：正确的英⽂拼写和语法可以让阅读者易于理解，避免歧义。注意，纯拼⾳命名⽅式更要避免采⽤。
正例：ali / alibaba / taobao / cainiao/ aliyun/ youku / hangzhou 等国际通⽤的名称，可视同英⽂。
反例：DaZhePromotion [打折] / getPingfenByName() [评分] / String fw[福娃] / int 某变量 = 3
3. 【强制】代码和注释中都要避免使⽤任何语⾔的种族歧视性词语。
正例：⽇本⼈ / 印度⼈ / blockList / allowList / secondary
反例：RIBENGUIZI / Asan / blackList / whiteList / slave
4. 【强制】类名使⽤ UpperCamelCase 风格，但以下情形例外：DO / BO / DTO / VO / AO /
PO / 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 规约中的建表约定第⼀条，表达是与否的变量采⽤ is_xxx 的命名⽅式，所以，需要
在<resultMap>设置从 is_xxx 到 xxx 的映射关系。
反例：定义为基本数据类型 Boolean isDeleted 的属性，它的⽅法也是 isDeleted()，框架在反向解析的时
候，“误以为”对应的属性名称是 deleted，导致属性获取不到，进⽽抛出异常。
10. 【强制】包名统⼀使⽤⼩写，点分隔符之间有且仅有⼀个⾃然语义的英语单词。包名统⼀使⽤
单数形式，但是类名如果有复数含义，类名可以使⽤复数形式。
正例：应⽤⼯具类包名为 com.alibaba.ei.kunlun.aap.util、类名为 MessageUtils（此规则参考 spring 的
框架结构）
11. 【强制】避免在⼦⽗类的成员变量之间、或者不同代码块的局部变量之间采⽤完全相同的命名，
使可理解性降低。
说明：⼦类、⽗类成员变量名相同，即使是 public 类型的变量也能够通过编译，另外，局部变量在同
⼀⽅
法内的不同代码块中同名也是合法的，这些情况都要避免。对于⾮ setter/getter 的参数名称也要避免与成
员变量名称相同。
反例：
public class ConfusingName {
public int stock;
// ⾮ setter/getter 的参数名称，不允许与本类成员变量同名
public void get(String alibaba) {
if (condition) {
final int money = 666;
// ...
}
for (int i = 0; i < 10; i++) {
// 在同⼀⽅法体中，不允许与其它代码块中的 money 命名相同
final int money = 15978;
// ...
}
}
}
class Son extends ConfusingName {
// 不允许与⽗类的成员变量名称相同
public int stock;
}
12. 【强制】杜绝完全不规范的缩写，避免望⽂不知义。
反例：AbstractClass“缩写”成 AbsClass；condition“缩写”成 condi；Function 缩写”成 Fu，此类
随意缩写严重降低了代码的可阅读性。
13. 【推荐】为了达到代码⾃解释的⽬标，任何⾃定义编程元素在命名时，使⽤尽量完整的单词组
合来表达。
正例：对某个对象引⽤的 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 f();
说明：JDK8 中接⼝允许有默认实现，那么这个 default ⽅法，是对所有实现类都有价值的默认实现。
17. 接⼝和实现类的命名有两套规则：
1）【强制】对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务⼀定是接⼝，内部的实现类⽤
Impl 的后缀与接⼝区别。
正例：CacheServiceImpl 实现 CacheService 接⼝。
2）【推荐】如果是形容能⼒的接⼝名称，取对应的形容词为接⼝名（通常是–able 的形容词）。
正例：AbstractTranslator 实现 Translatable 接⼝。
18. 【参考】枚举类名带上 Enum 后缀，枚举成员名称需要全⼤写，单词间⽤下划线隔开。
说明：枚举其实就是特殊的常量类，且构造⽅法被默认强制是私有。
正例：枚举名字为 ProcessStatusEnum 的成员名称：SUCCESS / UNKNOWN_REASON。
19. 【参考】各层命名规约：
A) Service/DAO 层⽅法命名规约
1）获取单个对象的⽅法⽤ 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 的统称，禁⽌命名成 xxxPOJO。
(⼆) 常量定义
1. 【强制】不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。
反例：
// 本例中，开发者 A 定义了缓存的 key，然后开发者 B 使⽤缓存时少了下划线，即 key 是"Id#taobao"+tradeId，导致出现故障
String key = "Id#taobao_" + tradeId;
cache.put(key, value);
2. 【强制】在 long 或者 Long 赋值时，数值后使⽤⼤写字母 L，不能是⼩写字母 l，⼩写容易跟
数字混淆，造成误解。
说明：Long a = 2l; 写的是数字的 21，还是 Long 型的 2？
3. 【推荐】不要使⽤⼀个常量类维护所有常量，要按常量功能进⾏归类，分开维护。
说明：⼤⽽全的常量类，杂乱⽆章，使⽤查功能才能定位到修改的常量，不利于理解，也不利于维护。
正例：缓存相关常量放在类 CacheConsts 下；系统配置相关常量放在类 SystemConfigConsts 下。
4. 【推荐】常量的复⽤层次有五层：跨应⽤共享常量、应⽤内共享常量、⼦⼯程内共享常量、包
内共享常量、类内共享常量。
1）跨应⽤共享常量：放置在⼆⽅库中，通常是 client.jar 中的 constant ⽬录下。
2）应⽤内共享常量：放置在⼀⽅库中，通常是⼦模块中的 constant ⽬录下。
反例：易懂变量也要统⼀定义成应⽤内共享常量，两位⼯程师在两个类中分别定义了“YES”的变量：
类 A 中：public static final String YES = "yes";
类 B 中：public static final String YES = "y";
A.YES.equals(
B.YES)，预期是 true，但实际返回为 false，导致线上问题。
3）⼦⼯程内部共享常量：即在当前⼦⼯程的 constant ⽬录下。
4）包内共享常量：即在当前包下单独的 constant ⽬录下。
5）类内共享常量：直接在类内部 private static final 定义。
5. 【推荐】如果变量值仅在⼀个固定范围内变化⽤ enum 类型来定义。
说明：如果存在名称之外的延伸属性应使⽤ enum 类型，下⾯正例中的数字就是延伸信息，表⽰⼀年中的第⼏个季节。
正例：
public enum SeasonEnum {
SPRING(1), SUMMER(2), AUTUMN(3), WINTER(4);
private int seq;
SeasonEnum(int seq) {
Java 开发⼿册
5/59
this.seq = seq;
}
public int getSeq() {
return seq;
}
}
(三) 代码格式
1. 【强制】如果是⼤括号内为空，则简洁地写成{}即可，⼤括号中间⽆需换⾏和空格；如果是⾮
空代码块则：
1）左⼤括号前不换⾏。
2）左⼤括号后换⾏。
3）右⼤括号前换⾏。
4）右⼤括号后还有 else 等代码则不换⾏；表⽰终⽌的右⼤括号后必须换⾏。
2. 【强制】左⼩括号和右边相邻字符之间不出现空格；右⼩括号和左边相邻字符之间也不出现空
格；⽽左⼤括号前需要加空格。详见第 5 条下⽅正例提⽰。
反例：if (空格 a == b 空格)
3. 【强制】if/for/while/switch/do 等保留字与括号之间都必须加空格。
4. 【强制】任何⼆⽬、三⽬运算符的左右两边都需要加⼀个空格。
说明：包括赋值运算符=、逻辑运算符&&、加减乘除符号等。
5. 【强制】采⽤ 4 个空格缩进，禁⽌使⽤ Tab 字符。
说明：如果使⽤ Tab 缩进，必须设置 1 个 Tab 为 4 个空格。IDEA 设置 Tab 为 4 个空格时，请勿勾选 Use tab character；⽽在 Eclipse 中，必须勾选 insert spaces for tabs。
正例：（涉及 1-5 点）
public static void main(String[] args) {
// 缩进 4 个空格
String say = "hello";
// 运算符的左右必须有⼀个空格
int flag = 0;
// 关键词 if 与括号之间必须有⼀个空格，括号内的 f 与左括号，0 与右括号不需要空格
if (flag == 0) {
System.out.println(say);
}
// 左⼤括号前加空格且不换⾏；左⼤括号后换⾏
if (flag == 1) {
System.out.println("world");
// 右⼤括号前换⾏，右⼤括号后有 else，不⽤换⾏
} else {
System.out.println("ok");
// 在右⼤括号后直接结束，则必须换⾏
}
}
6. 【强制】注释的双斜线与注释内容之间有且仅有⼀个空格。
正例：
// 这是⽰例注释，请注意在双斜线之后有⼀个空格
String commentString = new String();
7. 【强制】在进⾏类型强制转换时，右括号与强制转换值之间不需要任何空格隔开。
正例：
double first = 3.2d;
int second = (int)first + 2;
8. 【强制】单⾏字符数限制不超过 120 个，超出需要换⾏，换⾏时遵循如下原则：
1）第⼆⾏相对第⼀⾏缩进 4 个空格，从第三⾏开始，不再继续缩进，参考⽰例。
2）运算符与下⽂⼀起换⾏。
3）⽅法调⽤的点符号与下⽂⼀起换⾏。
4）⽅法调⽤中的多个参数需要换⾏时，在逗号后进⾏。
5）在括号前不要换⾏，见反例。
正例：
StringBuilder sb = new StringBuilder();
// 超过 120 个字符的情况下，换⾏缩进 4 个空格，并且⽅法前的点号⼀起换⾏
sb.append("yang").append("hao")...
.append("chen")...
.append("chen")...
.append("chen");
反例：
StringBuilder sb = new StringBuilder();
// 超过 120 个字符的情况下，不要在括号前换⾏
sb.append("you").append("are")...append
("lucky");
// 参数很多的⽅法调⽤可能超过 120 个字符，逗号后才是换⾏处
method(args1, args2, args3, ...
, argsX);
9. 【强制】⽅法参数在定义和传⼊时，多个参数逗号后⾯必须加空格。
正例：下例中实参的 args1，后边必须要有⼀个空格。
method(args1, args2, args3);
10. 【强制】IDE 的 text file encoding 设置为 UTF-8; IDE 中⽂件的换⾏符使⽤ Unix 格式，不要
使⽤ Windows 格式。
11. 【推荐】单个⽅法的总⾏数不超过 80 ⾏。
说明：除注释之外的⽅法签名、左右⼤括号、⽅法内代码、空⾏、回车及任何不可见字符的总⾏数不超过80 ⾏。
正例：代码逻辑分清红花和绿叶，个性和共性，绿叶逻辑单独出来成为额外⽅法，使主⼲代码更加清晰；共性逻辑抽取成为共性⽅法，便于复⽤和维护。
12. 【推荐】没有必要增加若⼲空格来使变量的赋值等号与上⼀⾏对应位置的等号对齐。
正例：
int one = 1;
long two = 2L;
float three = 3F;
StringBuilder sb = new StringBuilder();
说明：增加 sb 这个变量，如果需要对齐，则给 one、two、three 都要增加⼏个空格，在变量⽐较多的情
况下，是⾮常累赘的事情。
13. 【推荐】不同逻辑、不同语义、不同业务的代码之间插⼊⼀个空⾏分隔开来以提升可读性。
说明：任何情形，没有必要插⼊多个空⾏进⾏隔开。
(四) OOP 规约
1. 【强制】避免通过⼀个类的对象引⽤访问此类的静态变量或静态⽅法，⽆谓增加编译器解析成
本，直接⽤类名来访问即可。
2. 【强制】所有的覆写⽅法，必须加@ Override 注解。
说明：getObject()与 get0bject()的问题。⼀个是字母的 O，⼀个是数字的 0，加@Override 可以准确判
java编译器ide最新版下载
断是否覆盖成功。另外，如果在抽象类中对⽅法签名进⾏修改，其实现类会马上编译报错。
3. 【强制】相同参数类型，相同业务含义，才可以使⽤ Java 的可变参数，避免使⽤ Object 。
说明：可变参数必须放置在参数列表的最后。（建议开发者尽量不⽤可变参数编程）
正例：public List<User> listUsers(String type, ids) {...}
4. 【强制】外部正在调⽤或者⼆⽅库依赖的接⼝，不允许修改⽅法签名，避免对接⼝调⽤⽅产⽣
影响。接⼝过时必须加@ Deprecated 注解，并清晰地说明采⽤的新接⼝或者新服务是什么。
5. 【强制】不能使⽤过时的类或⽅法。
说明：java.URLDecoder 中的⽅法 decode(String encodeStr) 这个⽅法已经过时，应该使⽤双参数decode(String source, String encode)。接⼝提供⽅既然明确是过时接⼝，那么有义务同时提供新的接⼝；作为调⽤⽅来说，有义务去考证过时⽅法的新实现是什么。
6. 【强制】 Object 的 equals ⽅法容易抛空指针异常，应使⽤常量或确定有值的对象来调⽤ equals 。
正例："test".equals(object);
反例：object.equals("test");
说明：推荐使⽤ JDK7 引⼊的⼯具类 java.util.Objects#equals(Object a, Object b)
7. 【强制】所有整型包装类对象之间值的⽐较，全部使⽤ equals ⽅法⽐较。
说明：对于 Integer var = ? 在-128 ⾄ 127 之间的赋值，Integer 对象是在 IntegerCache.cache 产⽣，
会复⽤已有对象，这个区间内的 Integer 值可以直接使⽤==进⾏判断，但是这个区间之外的所有数据，
都
会在堆上产⽣，并不会复⽤已有对象，这是⼀个⼤坑，推荐使⽤ equals ⽅法进⾏判断。
8. 【强制】任何货币⾦额，均以最⼩货币单位且整型类型来进⾏存储。
9. 【强制】浮点数之间的等值判断，基本数据类型不能⽤==来⽐较，包装数据类型不能⽤ equals
来判断。
说明：浮点数采⽤“尾数+阶码”的编码⽅式，类似于科学计数法的“有效数字+指数”的表⽰⽅式。⼆进
制⽆法精确表⽰⼤部分的⼗进制⼩数，具体原理参考《码出⾼效》。
反例：
float a = 1.0F - 0.9F;
float b = 0.9F - 0.8F;
if (a == b) {
/
/ 预期进⼊此代码块，执⾏其它业务逻辑
// 但事实上 a==b 的结果为 false
}
Float x = Float.valueOf(a);
Float y = Float.valueOf(b);
if (x.equals(y)) {
// 预期进⼊此代码块，执⾏其它业务逻辑
// 但事实上 equals 的结果为 false
}
正例：
(1) 指定⼀个误差范围，两个浮点数的差值在此范围之内，则认为是相等的。
float a = 1.0F - 0.9F;
float b = 0.9F - 0.8F;
float diff = 1e-6F;
if (Math.abs(a - b) < diff) {
System.out.println("true");
}
(2) 使⽤ BigDecimal 来定义值，再进⾏浮点数的运算操作。
BigDecimal a = new BigDecimal("1.0");
BigDecimal b = new BigDecimal("0.9");
BigDecimal c = new BigDecimal("0.8");
BigDecimal x = a.subtract(b);
BigDecimal y = b.subtract(c);
if (xpareTo(y) == 0) {
System.out.println("true");
}
10. 【强制】如上所⽰ BigDecimal 的等值⽐较应使⽤ compareTo()⽅法，⽽不是 equals()⽅法。
说明：equals()⽅法会⽐较值和精度（1.0 与 1.00 返回结果为 false），⽽ compareTo()则会忽略精度。11. 【强制】定义数据对象 DO 类时，属性类型要与数据库字段类型相匹配。
正例：数据库字段的 bigint 必须与类属性的 Long 类型相对应。
反例：某个案例的数据库表 id 字段定义类型 bigint unsigned，实际类对象属性为 Integer，随着 id 越来
越⼤，超过 Integer 的表⽰范围⽽溢出成为负数。
12. 【强制】禁⽌使⽤构造⽅法 BigDecimal(double) 的⽅式把 double 值转化为 BigDecimal 对象。
说明：BigDecimal(double)存在精度损失风险，在精确计算或值⽐较的场景中可能会导致业务逻辑异常。如：BigDecimal g = new BigDecimal(0.1F); 实际的存储值为：0.10000000149
正例：优先推荐⼊参为 String 的构造⽅法，或使⽤ BigDecimal 的 valueOf ⽅法，此⽅法内部其实执⾏了Double 的 toString，⽽ Double 的 toString 按 double 的实际能表达的精度对尾数进⾏了截断。BigDecimal recommend1 = new BigDecimal("0.1");
BigDecimal recommend2 = BigDecimal.valueOf(0.1);
13. 关于基本数据类型与包装数据类型的使⽤标准如下：
1）【强制】所有的 POJO 类属性必须使⽤包装数据类型。
2）【强制】RPC ⽅法的返回值和参数必须使⽤包装数据类型。
3）【推荐】所有的局部变量使⽤基本数据类型。
说明：POJO 类属性没有初值是提醒使⽤者在需要使⽤时，必须⾃⼰显式地进⾏赋值，任何 NPE 问题，或者⼊库检查，都由使⽤者来保证。
正例：数据库的查询结果可能是 null，因为⾃动拆箱，⽤基本数据类型接收有 NPE 风险。
反例：某业务的交易报表上显⽰成交总额涨跌情况，即正负 x%，x 为基本数据类型，调⽤的 RPC 服务，调⽤不成功时，返回的是默认值，页⾯显⽰为 0%，这是不合理的，应该显⽰成中划线-。所以包装数据类型的 null 值，能够表⽰额外的信息，如：远程调⽤失败，异常退出。
14. 【强制】定义 DO/DTO/VO 等 POJO 类时，不要设定任何属性默认值。
反例：POJO 类的 createTime 默认值为 new Date()，但是这个属性在数据提取时并没有置⼊具体值，在
更新其它字段时⼜附带更新了此字段，导致创建时间被修改成当前时间。
15. 【强制】序列化类新增属性时，请不要修改 serialVersionUID 字段，避免反序列失败；如果
完全不兼容升级，避免反序列化混乱，那么请修改 serialVersionUID 值。
说明：注意 serialVersionUID 不⼀致会抛出序列化运⾏时异常。
16. 【强制】构造⽅法⾥⾯禁⽌加⼊任何业务逻辑，如果有初始化逻辑，请放在 init ⽅法中。
17. 【强制】POJO 类必须写 toString ⽅法。使⽤ IDE 中的⼯具：source> generate toString
时，如果继承了另⼀个 POJO 类，注意在前⾯加⼀下 String。
说明：在⽅法执⾏抛出异常时，可以直接调⽤ POJO 的 toString()⽅法打印其属性值，便于排查问题。18. 【强制】禁⽌在 POJO 类中，同时存在对应属性 xxx 的 isXxx()和 getXxx()⽅法。
说明：框架在调⽤属性 xxx 的提取⽅法时，并不能确定哪个⽅法⼀定是被优先调⽤到的。
19. 【推荐】使⽤索引访问⽤ String 的 split ⽅法得到的数组时，需做最后⼀个分隔符后有⽆内容
的检查，否则会有抛 IndexOutOfBoundsException 的风险。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。