阿⾥巴巴Java开发⼿册（2021泰⼭版整理）
阿⾥巴巴Java开发⼿册（2021泰⼭版整理）
（⼀）命名风格
1. 【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。
2. 【强制】常量命名全部⼤写，单词间⽤下划线隔开，⼒求语义表达完整清楚，不要嫌名字长。
正例：MAX_STOCK_COUNT / CACHE_EXPIRED_TIME
反例：MAX_COUNT / EXPIRED_TIME
3. 【强制】抽象类命名使⽤Abstract 或Base开头；
异常类命名使⽤Exception结尾；
测试类命名以它要测试的类的名称开始，以Test结尾
4. 【强制】POJO 类中的任何布尔类型的变量，都不要加 is 前缀，否则部分框架解析会引起序列化错误。
说明：在本⽂ MySQL 规约中的建表约定第⼀条，表达是与否的值采⽤ is_xxx 的命名⽅式，所以，需要在
设置从 is_xxx 到 xxx 的映射关系。
反例：定义为基本数据类型 Boolean isDeleted 的属性，它的⽅法也是 isDeleted()，框架在反向解析的时
候，“误以为”对应的属性名称是 deleted，导致属性获取不到，进⽽抛出异常。
5. 【强制】包名统⼀使⽤⼩写，点分隔符之间有且仅有⼀个⾃然语义的英语单词。
包名统⼀使⽤单数形式，但是类名如果有复数含义，类名可以使⽤复数形式。
正例：应⽤⼯具类包名为 com.alibaba.ei.kunlun.aap.util、类名为 MessageUtils
（此规则参考 spring 的框架结构）
6. 【强制】杜绝完全不规范的缩写，避免望⽂不知义。
反例：AbstractClass“缩写”命名成 AbsClass；condition“缩写”命名成 condi，
此类随意缩写严重降低了代码的可阅读性。
7. 【推荐】为了达到代码⾃解释的⽬标，任何⾃定义编程元素在命名时，使⽤尽量完整的单词组合来表达。
正例：在 JDK 中，对某个对象引⽤的 volatile 字段进⾏原⼦更新的类名为：AtomicReferenceFieldUpdater。
反例：常见的⽅法内变量为 int a；的定义⽅式。
8. 【推荐】在常量与变量的命名时，表⽰类型的名词放在词尾，以提升辨识度。
正例：startTime / workQueue / nameList / TERMINATED_THREAD_COUNT
反例：startedAt / QueueOfWork / listName / COUNT_TERMINATED_THREAD
9. 【推荐】如果模块、接⼝、类、⽅法使⽤了设计模式，在命名时需体现出具体模式。
说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。
正例： public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;
10. 【推荐】接⼝类中的⽅法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上有效的Javadoc 注释。
尽量不要在接⼝⾥定义变量，如果⼀定要定义变量，确定与接⼝⽅法相关，并且是整个应⽤的基础常量。
正例：接⼝⽅法签名 void commit();
接⼝基础常量 String COMPANY = "alibaba";
反例：接⼝⽅法定义 public abstract void f();
说明：JDK8 中接⼝允许有默认实现，那么这个 default ⽅法，是对所有实现类都有价值的默认实现。
11. 接⼝和实现类的命名有两套规则：
1）【强制】对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务⼀定是接⼝，内部的实现类
⽤ Impl 的后缀与接⼝区别。
正例：CacheServiceImpl 实现 CacheService 接⼝。
2）【推荐】如果是形容能⼒的接⼝名称，取对应的形容词为接⼝名（通常是–able 的形容词）。
正例：AbstractTranslator 实现 Translatable 接⼝。
12. 【参考】枚举类名带上 Enum 后缀，枚举成员名称需要全⼤写，单词间⽤下划线隔开。
说明：枚举其实就是特殊的常量类，且构造⽅法被默认强制是私有。
正例：枚举名字为 ProcessStatusEnum 的成员名称：SUCCESS / UNKNOWN_REASON。
13. 【参考】各层命名规约：
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. 【强制】不允许任何魔法值（即未经预先定义的常量）直接出现在代码中
2. 【强制】在 long 或者 Long 赋值时，数值后使⽤⼤写的 L，不能是⼩写的 l，⼩写容易跟数字混淆，造成误解。
3. 【推荐】不要使⽤⼀个常量类维护所有常量，要按常量功能进⾏归类，分开维护。
说明：⼤⽽全的常量类，杂乱⽆章，使⽤查功能才能定位到修改的常量，不利于理解，也不利于维护。
正例：缓存相关常量放在类 CacheConsts 下；系统配置相关常量放在类 ConfigConsts 下。
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) {
this.seq = seq;
}
public int getSeq() {
return seq;
}
（三）代码格式
1. 【强制】如果是⼤括号内为空，则简洁地写成{}即可，⼤括号中间⽆需换⾏和空格；
2. 【强制】左⼩括号和右边相邻字符之间不出现空格；右⼩括号和左边相邻字符之间也不出现空格；⽽左⼤括号前需要加空格。
3. 【强制】任何⼆⽬、三⽬运算符的左右两边都需要加⼀个空格。
说明：包括赋值运算符=、逻辑运算符&&、加减乘除符号等。
4. 【强制】if/for/while/switch/do 等保留字与括号之间都必须加空格。
5. 【强制】采⽤ 4 个空格缩进，禁⽌使⽤ tab 字符。
说明：如果使⽤ tab 缩进，必须设置 1 个 tab 为 4 个空格。 IDEA 设置 tab 为 4 个空格时，请勿勾选 Use tab
character；⽽在 eclipse 中，必须勾选 insert spaces for tabs。
6. 【强制】注释的双斜线与注释内容之间有且仅有⼀个空格。
7. 【强制】在进⾏类型强制转换时，右括号与强制转换值之间不需要任何空格隔开。
8. 【强制】单⾏字符数限制不超过 120 个，超出需要换⾏，换⾏时遵循如下原则：
1）第⼆⾏相对第⼀⾏缩进 4 个空格，从第三⾏开始，不再继续缩进，参考⽰例。
2）运算符与下⽂⼀起换⾏。
3）⽅法调⽤的点符号与下⽂⼀起换⾏。
4）⽅法调⽤中的多个参数需要换⾏时，在逗号后进⾏。
5）在括号前不要换⾏，见反例。
正例:
StringBuilder sb = new StringBuilder();
// 超过 120 个字符的情况下，换⾏缩进 4 个空格，并且⽅法前的点号⼀起换⾏
sb.append("zi").append("xin")...
.append("huang")...
spring framework 开发参考手册.append("huang")...
.append("huang");
反例:
StringBuilder sb = new StringBuilder();
/
/ 超过 120 个字符的情况下，不要在括号前换⾏
sb.append("you").append("are")...append
("lucky");
// 参数很多的⽅法调⽤可能超过 120 个字符，逗号后才是换⾏处
method(args1, args2, args3, ...
, argsX);
9. 【强制】⽅法参数在定义和传⼊时，多个参数逗号后边必须加空格。
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. 【推荐】不同逻辑、不同语义、不同业务的代码之间插⼊⼀个空⾏分隔开来以提升可读性。
说明：任何情形，没有必要插⼊多个空⾏进⾏隔开。
持续更新

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