阿里巴巴开发手册一

一、命名

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

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

3、【强制】类名使用 UpperCamelCase 风格，必须遵从驼峰形式，但以下情形例外:DO / BO / DTO / VO / AO。

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

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

6、【强制】抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾;测试类命名以它要测试的类的名称开始，以 Test 结尾。

7、【强制】中括号是数组类型的一部分，数组定义如下:String[] args。

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

9、【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。

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

11、【推荐】为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达其意。

12、【推荐】如果模块、接口、类、方法使用了设计模式，在命名时体现出具体模式。说明:将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。

13、【推荐】接口类中的方法和属性不要加任何修饰符号(public 也不要加)，保持代码的简洁性，并加上有效的 Javadoc 注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。

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

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

16、【参考】各层命名规约:

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

2、【强制】long 或者 Long 初始赋值时，使用大写的 L，不能是小写的 l，小写容易跟数字 1 混淆，造成误解。

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

4、【推荐】常量的复用层次有五层:跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。

5、【推荐】如果变量值仅在一个范围内变化，且带有名称之外的延伸属性，定义为枚举类。

三、代码格式

1、【强制】大括号的使用约定。如果是大括号内为空，则简洁地写成{}即可，不需要换行;如果是非空代码块则

2、【强制】左小括号和字符之间不出现空格;同样，右小括号和字符之间也不出现空格。详见第5条下方正例示。

3、【强制】if/for/while/switch/do 等保留字与括号之间都必须加空格。

4、【强制】任何二目、三目运算符的左右两边都需要加一个空格。

5、【强制】采用 4 个空格缩进，禁止使用 tab 字符。

6、【强制】注释的双斜线与注释内容之间有且仅有一个空格

7、【强制】单行字符数限制不超过 120 个，超出需要换行，换行时遵循如下原则:

第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。
运算符与下文一起换行。
方法调用的点符号与下文一起换行。
方法调用时，多个参数，需要换行时，在逗号后进行。 5) 在括号前不要换行

8、【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。

9、【强制】IDE的text file encoding设置为UTF-8; IDE中文件的换行符使用Unix格式，不要使用 Windows 格式。

10、【推荐】没有必要增加若干空格来使某一行的字符与上一行对应位置的字符对齐。

11、【推荐】方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之间插入一个空行。相同业务逻辑和语义之间不需要插入空行。

四、OOP规约

1、【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可。

2、【强制】所有的覆写方法，必须加@Override 注解。

3、【强制】相同参数类型，相同业务含义，才可以使用 Java 的可变参数，避免使用 Object。说明:可变参数必须放置在参数列表的最后。(提倡同学们尽量不用可变参数编程)

4、【强制】外部正在调用或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方产生影响。接口过时必须加@Deprecated 注解，并清晰地说明采用的新接口或者新服务是什么。

5、【强制】不能使用过时的类或方法。

6、【强制】Object 的 equals 方法容易抛空指针异常，应使用常量或确定有值的对象来调用 equals。

7、【强制】所有的相同类型的包装类对象之间值的比较，全部使用 equals 方法比较。

8、关于基本数据类型与包装数据类型的使用标准如下:

【强制】所有的POJO类属性必须使用包装数据类型。

【强制】RPC方法的返回值和参数必须使用包装数据类型。

【推荐】所有的局部变量使用基本数据类型。

9、【强制】定义 DO/DTO/VO 等 POJO 类时，不要设定任何属性默认值。反例:POJO类的gmtCreate默认值为new Date();但是这个属性在数据提取时并没有置入具体值，在更新其它字段时又附带更新了此字段，导致创建时间被修改成当前时间

10、【强制】序列化类新增属性时，请不要修改 serialVersionUID 字段，避免反序列失败;如果完全不兼容升级，避免反序列化混乱，那么请修改 serialVersionUID 值。

11、【强制】构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在 init 方法中。

12、【强制】POJO 类必须写 toString 方法。使用 IDE 中的工具:source> generate toString 时，如果继承了另一个 POJO 类，注意在前面加一下 super.toString。

13、【推荐】使用索引访问用 String 的 split 方法得到的数组时，需做最后一个分隔符后有无内容的检查，否则会有抛 IndexOutOfBoundsException 的风险。

14、【推荐】当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起，便于阅读，此条规则优先于第 15 条规则。

15、【推荐】类内方法定义的顺序依次是:公有方法或保护方法 > 私有方法 > getter/setter 方法。

16、【推荐】setter 方法中，参数名称与类成员变量名称一致，this.成员名 = 参数名。在getter/setter 方法中，不要增加业务逻辑，增加排查问题的难度。

17、【推荐】循环体内，字符串的连接方式，使用 StringBuilder 的 append 方法进行扩展。说明:反编译出的字节码文件显示每次循环都会 new 出一个 StringBuilder 对象，然后进行 append 操作，最后通过 toString 方法返回 String 对象，造成内存资源浪费。

18、【推荐】final 可以声明类、成员变量、方法、以及本地变量，下列情况使用 final 关键字: