阿里JAVA编码规范手册Word文档下载推荐.docx

阿里JAVA编码规范手册Word文档下载推荐.docx

《阿里JAVA编码规范手册Word文档下载推荐.docx》由会员分享，可在线阅读，更多相关《阿里JAVA编码规范手册Word文档下载推荐.docx（51页珍藏版）》请在冰豆网上搜索。

附1：

版本历史.........................................................................................................................................................................34

附2：

本规约专有名词...........................................................................................................................................................34

附3：

法律声明.........................................................................................................................................................................34

（注：

全文浏览时请使用PDF左侧导航栏）

阿里巴巴Java开发手册

前言

《阿里巴巴Java开发手册》是阿里巴巴集团技术团队的集体经验总结，经历了

多次大规模一线实战的检验及不断的完善，反馈给广大开发者。

现代软件行业的高速

发展对于开发者的综合素质要求越来越高，因为不仅是编程知识点，其它维度的知识

点也会影响到软件的最终交付质量。

比如：

数据库的表结构和索引设计缺陷可能带来

软件上的架构缺陷或性能风险；

工程结构混乱导致维护困难；

没有鉴权的漏洞代码被

黑客攻击等等。

所以本手册以Java开发者为中心视角，划分为编程规约、异常日志规

约、MySQL规约、工程规约、安全规约五大块，再根据内容特征，细分成若干二级子目

录。

根据约束力强弱及故障敏感性，规约依次分为强制、推荐、参考三大类。

对于规

约里的内容，“说明”对内容做了引申和解释；

“正例”提倡什么样的编码和实现方

式；

“反例”说明需要提防的雷区，以及真实的错误案例。

本手册的愿景是码出质量、码出高效。

代码的字里行间流淌的是软件生命中的血

液，质量的提升是尽可能少踩坑，杜绝踩重复的坑，切实提升质量意识。

另外，现代

软件架构都需要协同开发完成，高效考虑的是降低协同成本，所谓无规矩不成方圆，

无规范不能协作。

众所周知，制订交通法规表面上是要限制行车权，实际上是保障公

众的人身安全。

试想如果没有限速，没有红绿灯，没有规定靠右行驶，谁还敢上路行

驶。

对软件来说，适当的规范和标准绝不是消灭代码内容的创造性、优雅性，而是限

制过度个性化，以一种普遍认可的统一方式一起做事，提升协作效率。

《阿里巴巴Java开发手册》，开放包容地认真总结社区、博客、论坛的反馈，及

时修正，保持与时俱进。

请关注手册末页的“阿里技术”和“云栖社区”公众号获取

最新版。

——禁止用于商业用途，违者必究——

1/37

Java开发手册

版本号

制定团队

更新日期

备注

1.1.0

阿里巴巴集团技术团队

2017.2.27

增加前言和专有名词说明，修正部分描述。

一、编程规约

（一）命名规约

1.【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。

反例：

_name/__name/$Object/name_/name$/Object$

2.【强制】代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。

说明：

正确的英文拼写和语法可以让阅读者易于理解，避免歧义。

注意，即使纯拼音命名方式

也要避免采用。

DaZhePromotion[打折]/getPingfenByName（）[评分]/int某变量=3

正例：

alibaba/taobao/youku/hangzhou等国际通用的名称，可视同英文。

3.【强制】类名使用UpperCamelCase风格，必须遵从驼峰形式，但以下情形例外：

（领域模型

的相关命名）DO/BO/DTO/VO等。

MarcoPolo/UserDO/XmlService/TcpUdpDeal/TaPromotion

macroPolo/UserDo/XMLService/TCPUDPDeal/TAPromotion

4.【强制】方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格，必须遵从

驼峰形式。

localValue/getHttpMessage（）/inputUserId

5.【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。

MAX_STOCK_COUNT

MAX_COUNT

6.【强制】抽象类命名使用Abstract或Base开头；

异常类命名使用Exception结尾；

测试类

命名以它要测试的类的名称开始，以Test结尾。

7.【强制】中括号是数组类型的一部分，数组定义如下：

String[]args;

使用Stringargs[]的方式来定义。

2/37

8.【强制】POJO类中布尔类型的变量，都不要加is，否则部分框架解析会引起序列化错误。

定义为基本数据类型BooleanisSuccess；

的属性，它的方法也是isSuccess（），RPC

框架在反向解析的时候，“以为”对应的属性名称是success，导致属性获取不到，进而抛出异

常。

9.【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。

包名统一使用

单数形式，但是类名如果有复数含义，类名可以使用复数形式。

应用工具类包名为com.alibaba.open.util、类名为MessageUtils（此规则参考

spring的框架结构）

10.【强制】杜绝完全不规范的缩写，避免望文不知义。

AbstractClass“缩写”命名成AbsClass；

condition“缩写”命名成condi，此类

随意缩写严重降低了代码的可阅读性。

11.【推荐】如果使用到了设计模式，建议在类名中体现出具体模式。

将设计模式体现在名字中，有利于阅读者快速理解架构设计思想。

publicclassOrderFactory;

publicclassLoginProxy;

publicclassResourceObserver;

12.【推荐】接口类中的方法和属性不要加任何修饰符号（public也不要加），保持代码的简洁

性，并加上有效的Javadoc注释。

尽量不要在接口里定义变量，如果一定要定义变量，肯定是

与接口方法相关，并且是整个应用的基础常量。

接口方法签名：

voidf（）;

接口基础常量表示：

StringCOMPANY="

alibaba"

;

接口方法定义：

publicabstractvoidf（）;

JDK8中接口允许有默认实现，那么这个default方法，是对所有实现类都有价值的默

认实现。

13.接口和实现类的命名有两套规则：

1）

【强制】对于Service和DAO类，基于SOA的理念，暴露出来的服务一定是接口，内部

的实现类用Impl的后缀与接口区别。

CacheServiceImpl实现CacheService接口。

2）

【推荐】如果是形容能力的接口名称，取对应的形容词做接口名（通常是–able的形式）。

AbstractTranslator实现Translatable。

14.【参考】枚举类名建议带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开。

枚举其实就是特殊的常量类，且构造方法被默认强制是私有。

枚举名字：

DealStatusEnum，成员名称：

SUCCESS/UNKOWN_REASON。

3/37

15.【参考】各层命名规约：

A）Service/DAO层方法命名规约

1）获取单个对象的方法用get做前缀。

2）获取多个对象的方法用list做前缀。

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.【强制】不允许出现任何魔法值（即未经定义的常量）直接出现在代码中。

Stringkey="

Id#taobao_"

+tradeId；

cache.put（key,value）;

2.【强制】long或者Long初始赋值时，必须使用大写的L，不能是小写的l，小写容易跟数字

1混淆，造成误解。

Longa=2l;

写的是数字的21，还是Long型的2?

3.【推荐】不要使用一个常量类维护所有常量，应该按常量功能进行归类，分开维护。

如：

缓存

相关的常量放在类：

CacheConsts下；

系统配置相关的常量放在类：

ConfigConsts下。

大而全的常量类，非得使用查找功能才能定位到修改的常量，不利于理解和维护。

4.【推荐】常量的复用层次有五层：

跨应用共享常量、应用内共享常量、子工程内共享常量、包

内共享常量、类内共享常量。

1）跨应用共享常量：

放置在二方库中，通常是client.jar中的constant目录下。

2）应用内共享常量：

放置在一方库的modules中的constant目录下。

易懂变量也要统一定义成应用内共享常量，两位攻城师在两个类中分别定义了表示

“是”的变量：

类A中：

publicstaticfinalStringYES="

yes"

类B中：

y"

A.YES.equals（B.YES），预期是true，但实际返回为false，导致产生线上问题。

4/37

3）子工程内部共享常量：

即在当前子工程的constant目录下。

4）包内共享常量：

即在当前包下单独的constant目录下。

5）类内共享常量：

直接在类内部privatestaticfinal定义。

5.【推荐】如果变量值仅在一个范围内变化用Enum类。

如果还带有名称之外的延伸属性，必须

使用Enum类，下面正例中的数字就是延伸信息，表示星期几。

publicEnum{MONDAY

（1）,TUESDAY

（2）,WEDNESDAY（3）,THURSDAY（4）,FRIDAY（5）,SATURDAY（6）,

SUNDAY（7）;

}

（三）格式规约

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个空格时，

请勿勾选Usetabcharacter；

而在eclipse中，必须勾选insertspacesfortabs。

（涉及1-5点）

publicstaticvoidmain（String[]args）{

//缩进4个空格

Stringsay="

hello"

//运算符的左右必须有一个空格

intflag=0;

//关键词if与括号之间必须有一个空格，括号内的f与左括号，0与右括号不需要空格

if（flag==0）{

System.out.println（say）;

//左大括号前加空格且不换行；

左大括号后换行

if（flag==1）{

System.out.println（"

world"

）;

//右大括号前换行，右大括号后有else，不用换行

5/37