阿里巴巴 java 开发规约

---

《阿里巴巴 java开发手册》–随手记

---

这本开发手册是阿里巴巴开发人员的java开发规范，读了这本书后，感受到代码规范的重要性，培养自己的代码风格，养成与此手册代码风格一致的习惯。

一、编程规约

1 命名风格

1) 代码中的变量命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。

2) 代码中不允许使用中文拼音。

3) 类名尽量使用UpperCamelCase风格，即首字母要大写，其他字母小写，特殊类除外，如PO、DAO等。

4) 方法名、参数名、成员变量、局部变量等统一采用lowerCamelCase风格，驼峰形式。

5) 常量命名要全部大写，单词间用下划线隔开。

6) 抽象类命名使用Abstract或Base开头，异常类的命名使用Exception结尾，测试类命名以它要测试的类名开始，以Test结尾。

7) 类型与中括号之间无空格相连定义数组。例：int[] arrayDemo;

8) POJO类的boolean类型的变量前不要加is前缀，否则部分框架会解析错误。例：属性为isDeleted 它的方法也为isDeleted()，框架会去找Deleted属性，找不到就会报错。

9) 定义包名统一用小写，单数，类名可以使用复数：例 Utils 类。

10) 杜绝完全不规范的缩写，避免词不达意。

11) 在进行变量命名时，尽量使用完整的单词，不要嫌变量名称过长。

12) 如果使用了设计模式，那么，在定义类的时候尽量使用体现这种模式的单词，例：使用了工厂模式，则定义类名时，后缀要加Factory.

13) 接口中方法和属性不要加任何的修饰符号，保持整洁，因为接口中的方法默认为public abstract 修饰，这两个修饰可省略。字段默认为public final static 修饰。

14) 接口与实现类的命名，在实现类后面加Impl后缀。

15) 枚举类名尽量带上Enum后缀，成员变量全部大写。

2 常量定义

1) 不允许任何魔法值，即在代码中直接使用未经预先定义的常量。常量一定要在开始定义，并加上注释。

2) 定义long或Long型常量时，一定要用大写的L，不可以使用小写的l，易与1混淆。

3) 尽量不要使用一个大而全的类维护所有的常量类，可以根据类型用多个类来维护。

3 代码格式

1) 大括号的使用约定。如果大括号内为空，则简洁的写成{}即可，若非空，则

• 左大括号前不换行。
• 左大括号后换行。
• 右大括号前换行。
• 右大括号后还有else等代码则不换行；表示终止的则应换行。

2) 左小括号与字符之间不空格，右括号同此。例：if (a == b)

3) if / for / while / switch / do 等保留字与括号之间必须空格。

4) 任何二目、三目运算符的左右两边都要加空格。

5) 需要首行缩进的时候，采用4个空格，不要使用Tab控制符。

6) 注释的双斜线与内容之间有且仅有一个空格。

7) 单行字符数不超过120个，超出则需要换行，换行时遵守如下原则。

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

8) 方法参数在定义和传入时，多个参数都厚后边必须加空格。例： method(“one”, “two”, “three”);

9) IDE的text f