阿里巴巴开发规范

阿里巴巴开发规范

前言

集团国际化、中台战略的新挑战是跨公司、跨BU、跨部门高效合作，但是由于历史隔阂与业务风格差异，导致工程结构差别很大，代码风格迥异，规范不一，沟通成本大，合作效率低，维护成本高。集团发展到现在的规模，需要专业化的技术集团军迭代式、集约式发展，而不是动辄重复造轮，而真正专业化的团队一定会有统一的开发规约，这代表效率、共鸣、情怀、可持续。

癫总在527规约生态发布仪式上指出，消防局最主要的工作不是灭火，而是为了不发生火灾建立很多规范。如果发生火灾，说明前面的工作没有做到位。前车之鉴，后车之师，集团积累的大量历史故障数据，是很好的借鉴之源，但是同样的故障，总会重复地发生。本规约力求知其然，更知其不然，定位为轻松的双向约定，而非冰冷的法律文书，以开发的视角，结合正反例和历史故障数据分析，避免在同一块石头上跌倒多次。良好的规约有利于提高程序的可读性、可维护性、可复用性，切实提高软件产品质量。

众所周知，制订交通法规表面上是要限制行车权，实际上是保障公众的人身安全。试想如果没有限速，没有红绿灯，没有靠右行驶条款，谁还敢上路。同理，对软件来说，开发规约绝不是消灭代码内容的创造性、优雅性，而是限制过度个性化，推行相对标准化，以一种普遍认可的方式一起做事。

综上所述，开发规约的目标：

一、码出高效：标准统一，提升沟通效率和研发效能。
  二、码出质量：防患未然，提升质量意识和系统可维护性，降低故障率。
  三、码出情怀：工匠精神，追求极致的卓越精神，打磨精品代码。
  开发规约从无到有，只是短期的目标；P3C项目组基本完成IDE检测插件开发、Aone实验室扫描、Code Review集成，使大家遵守开发规约的成本极大降低，发布上线的应用符合开发规约是中期目标；而远期目标是从有到无，因为人人自觉遵守，规约和谐地融入代码的字里行间，规约似乎消失了，但又无处不在。

集团在Java、C++、安全、前端、iOS开发五大方向上做相对标准化建设，本页面主要涉及Java版块，以开发为中心视角分为编程规约、异常日志规约、MySQL规约、工程规约、安全规约、单元测试、设计规约七大块，再根据内容特征，细分成若干二级子目录。根据约束力强弱，规约依次分为强制、推荐、参考三大类:
  【强制】必须遵守。是不得不遵守的约定，违反本约定或将会引起严重的后果。
  【推荐】尽量遵守。长期遵守这样的规定，有助于系统稳定性和合作效率的提升。
  【参考】充分理解。技术意识的引导，是个人学习、团队沟通、项目合作的方向。

你好！ 这是你第一次使用 Markdown编辑器 所展示的欢迎页。如果你想学习如何使用Markdown编辑器, 可以仔细阅读这篇文章，了解一下Markdown的基本语法知识。

一、编程规约

命名规约：
1、【强制】所有编程相关的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。
反例：_name / __name / $ Object / name _ / name$ / Object$

2、【强制】所有编程相关的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。
说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用。
正例：ali / alibaba / taobao / cainiao / aliyun / youku / hangzhou 等国际通用的名称，可视同英文。
反例：DaZhePromotion [打折] / getPingfenByName() [评分] / String fw [福娃] / int 变量 = 3;

3、【强制】代码和注释中都要避免使用（任何人类语言的）涉及性别、种族、地域、特定人群等的歧视性词语。

4、【强制】类名使用UpperCamelCase风格，以下情形例外：DO / BO / DTO / VO / AO / 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的命名方式，所以，需要在设置从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、【强制】杜绝完全不规范的缩写，本规约认可的缩写请参考附2。
反例：<某业务代码>AbstractClass“缩写”成AbsClass；condition“缩写”成 condi，Function“缩写”成Fu, 此类随意缩写严重降低了代码的可阅读性。

13、【强制】枚举中不能定义NAME的枚举值或name域变量。
说明：1. enum自带name()方法来获取枚举值的字符串值；2. NAME的枚举值获取是name()方法返回的是大写的NAME；3. 如果getName()方法来获取name域变量，容易与name()方法产生混淆。
反例：伪代码如下，关注两个命名点即可：

public enum Person {
    // 枚举值不允许定义为NAME NAME, SEX, AGE; // 域变量不允许定义为name private String name; }

14、【推荐】为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达。
正例：在JDK中，对某个对象引用的volatile字段进行原子更新的类名为AtomicReferenceFieldUpdater。
反例：常见的方法内变量为int a; 的定义方式。

15、【推荐】在常量与变量的命名时，表示类型的名词放在词尾，以提升辨识度。
正例：startTime / workQueue / nameList / TERMINATED_THREAD_COUNT
反例：startedAt / QueueOfWork / listName / COUNT_TERMINATED_THREAD

16、【推荐】如果模块、接口、类、方法使用了设计模式，在命名时体现出具体模式。
说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计思想。
正例：public class OrderFactory;
    public class LoginProxy;
    public class ResourceObserver;

17、【推荐】接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上有效的javadoc注释。尽量不要在接口里定义变量，如果一定要定义变量，确定与接口方法相关，并且是整个应用的基础常量。
正例：接口方法签名：void commit();
    接口基础常量表示：String COMPANY = “alibaba”;
反例：接口方法定义：public abstract void commit();
说明：JDK8中接口允许有默认实现，那么这个default方法，是对所有实现类都有价值的默认实现。

18、接口和实现类的命名有两套规则：
 1）【强制】对于Service和DAO类，基于SOA的理念，暴露出来的服务一定是接口，内部的实现类用Impl的后缀与接口区别。
正例：CacheServiceImpl实现CacheService接口。
 2）【推荐】如果是形容能力的接口名称，取对应的形容词做接口名（通常是–able的形式）。
正例：AbstractTranslator实现 Translatable。

19、【参考】枚举类名带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开。
说明：枚举其实就是特殊的常量类，且构造方法被默认强制是私有。
正例：枚举名字：ProcessStatusEnum；成员名称：SUCCESS / UNKNOWN_REASON。

20、【参考】各层命名规约：
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、【强制】不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。
反例：String key = “Id#taobao_” + tradeId；
    cache.put(key, value);
  本例中同学A定义了缓存的key，然后同学B使用缓存时少了下划线，即key是"Id#taobao"+tradeId，导致故障。

2、【强制】在 long 或者 Long 赋值时，数值后使用大写的 L，不能是小写的 l，小写容易跟数字混淆，造成误解。
说明：Long a = 2l; 写的是数字的21，还是Long型的2?

3、【推荐】不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。
正例：缓存相关的常量放在类CacheConsts下；系统配置相关的常量放在类SystemConfigConsts下。
说明：大而全的常量类，杂乱无章，使用查找功能才能定位到修改的常量，不利于理解，也不利于维护。

4、【推荐】常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。
 1） 跨应用共享常量：放置在二方库中，通常是client.jar中的constant目录下。
 2） 应用内共享常量：放置在一方库子模块中的constant目录下。
    反例：易懂变量也要统一定义成应用内共享常量，两位攻城师在两个类中分别定义了表示“是”的变量：
    类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、【强制】如果是大括号内为空，则简洁地写成{}即可，大括号中间无需换行和空格；如果是非空代码块则：
 1） 左大括号前不换行。
 2） 左大括号后换行。
 3） 右大括号前换行。
 4） 右大括号后还有else等代码则不换行；表示终止右大括号后必须换行。

2、【强制】左小括号和右边相邻字符之间不出现空格；右小括号和左边相邻字符之间也不出现空格；而左大括号前需要加空格。详见第5条下方正例提示。

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、【强制】在进行类型强制转换时，右括号与被强制转换的值之间不需要任何空格隔开。
正例：

long first = 1000000000000L; int second = (int)first + 2;

8、【强制】单行字符数不超过120个，超出则需要换行，换行时遵循如下原则：
 1） 第二行相对第一行缩进4个空格，从第三行开始，不再继续缩进，参考示例。
 2） 运算符与下文一起换行。
 3） 方法调用的点符号与下文一起换行。
 4） 方法调用中的多个参数需要换行时，在逗号后进行。
 5） 在括号前不要换行，见反例。
正例：

StringBuilder sb = new StringBuilder(); // 超过120个字符的情况下，换行缩进4个空格，并且方法前的点号一起换行 sb.append("zi").append("xin")... .append("huang")... .append("huang")... .append("huang");

反例：

StringBuilder sb = new StringBuilder(); // 超过120个字符的情况下，不要在括号前换行 sb.append("zi").append("xin").