java开发之编程规约

目录

一、命名风格

二、常量定义

三、代码格式 

 四、OOP 规约

五、 集合处理

六、并发处理

七、控制语句

八、 注释规约

九、其它

---

一、命名风格

1、代码是由许多英文单词组成的，但是不能以下划线和美元符号开始，也不能以这两种结束。

比如像 _name/__name/$String/name_/name$/String$ 这样的都是不可以的。

2、代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。
说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式
也要避免采用。

正例： alibaba / taobao / youku / hangzhou 等国际通用的名称，可视同英文。
反例： DaZhePromotion [ 打折 ] / getPingfenByName() [ 评分 ] / int 某变量 = 3，像这样的看似好像可以看懂，但是这是站在我们角度看的，如果另一个人来看我们的代码就会感觉完全不懂。

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

正例： 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 结尾。

base关键字

       base其实最大的使用地方在面向对象开发的多态性上，base可以完成创建派生类实例时调用其基类构造函数或者调用基类上已被其他方法重写的方法。

       关于base

           base 关键字用于从派生类中访问基类的成员：
           调用基类上已被其他方法重写的方法。
           指定创建派生类实例时应调用的基类构造函数。
           基类访问只能在构造函数、实例方法或实例属性访问器中进行。

7、中括号是数组类型的一部分，数组定义如下： String[] args;
反例：使用 String args[] 的方式来定义。

数组定义中括号一般跟在类型后面

8、 POJO 类中布尔类型的变量，都不要加 is ，否则部分框架解析会引起序列化错误。
反例：定义为基本数据类型 Boolean isDeleted； 的属性，它的方法也是 isDeleted() ， RPC框架在反向解析的时候，“以为”对应的属性名称是 deleted ，导致属性获取不到，进而抛出异常。

9、包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用
单数形式，但是类名如果有复数含义，类名可以使用复数形式。
正例： 应用工具类包名为 com . alibaba . open . util 、类名为 MessageUtils（ 此规则参考
spring 的框架结构 ）

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

反例： AbstractClass “缩写”命名成 AbsClass；condition “缩写”命名成 condi ，此类随
意缩写严重降低了代码的可阅读性。

不规范的缩写只有我们自己可能理解，但是在别人角度看起来就会很难，因为每个人思维不同，所以其他人会很难理解。

11、为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词
组合来表达其意。
正例：从远程仓库拉取代码的类命名为 PullCodeFromRemoteRepository。
反例：变量 int a; 的随意命名方式。

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

正例： public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;

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

正例：接口方法签名： void f();
接口基础常量表示： String COMPANY = " alibaba " ;
反例：接口方法定义： public abstract void f();
说明： JDK 8 中接口允许有默认实现，那么这个 default 方法，是对所有实现类都有价值的默
认实现。

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

二、常量定义

1. 【强制】不允许任何魔法值 （ 即未经定义的常量 ） 直接出现在代码中。

反例： String key = " Id # taobao _" + tradeId;
cache . put(key , value);

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

三、代码格式 

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

1 ） 左大括号前不换行。
2 ） 左大括号后换行。
3 ） 右大括号前换行。
4 ） 右大括号后还有 else 等代码则不换行 ； 表示终止的右大括号后必须换行。

2. 【强制】 左小括号和字符之间不出现空格 ； 同样，右小括号和字符之间也不出现空格。详见
第 5 条下方正例提示。
反例： if (空格 a == b 空格)
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. 【强制】注释的双斜线与注释内容之间有且仅有一个空格。
正例： // 注释内容，注意在 // 和注释内容之间有一个空格。
7. 【强制】单行字符数限制不超过 120 个，超出需要换行，换行时遵循如下原则：
1） 第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。
2 ） 运算符与下文一起换行。
3 ） 方法调用的点符号与下文一起换行。
4 ） 方法调用时，多个参数，需要换行时，在逗号后进行。
5 ） 在括号前不要换行，见反例。
正例：

StringBuffer sb = new StringBuffer();
// 超过 120 个字符的情况下，换行缩进 4 个空格，点号和方法名称一起换行
sb.append("zi").append("xin")...
.append("huang")...
.append("huang")...
.append("huang");
反例：
StringBuffer sb = new StringBuffer();
// 超过 120 个字符的情况下，不要在括号前换行
sb.append("zi").append("xin")...append
("huang");
// 参数很多的方法调用可能超过 120 个字符，不要在逗号前换行
method(args1, args2, args3, ...
, argsX);

8. 【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。
正例：下例中实参的" a ",后边必须要有一个空格。
method("a", "b", "c");
9. 【强制】 IDE 的 text file encoding 设置为 UTF -8 ; IDE 中文件的换行符使用 Unix 格式，
不要使用 Windows 格式。

10. 【推荐】没有必要增加若干空格来使某一行的字符与上一行对应位置的字符对齐。
正例：
int a = 3;
long b = 4L;
float c = 5F;
StringBuffer sb = new StringBuffer();
说明：增加 sb 这个变量，如果需要对齐，则给 a 、 b 、 c 都要增加几个空格，在变量比较多的
情况下，是一种累赘的事情。
11. 【推荐】方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义
之间插入一个空行。相同业务逻辑和语义之间不需要插入空行。
说明：没有必要插入多个空行进行隔开。

 四、OOP 规约

1. 【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成
本，直接用类名来访问即可。
2. 【强制】所有的覆写方法，必须加@ Override 注解。

说明： getObject() 与 get 0 bject() 的问题。一个是字母的 O ，一个是数字的 0，加@ Override
可以准确判断是否覆盖成功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错。

3. 【强制】相同参数类型，相同业务含义，才可以使用 Java 的可变参数，避免使用 Object 。
说明：可变参数必须放置在参数列表的最后。 （ 提倡同学们尽量不用可变参数编程 ）
正例： public User getUsers(String type, Integer... ids) {...}
4. 【强制】外部正在调用或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方产生
影响。接口过时必须加@ Deprecated 注解，并清晰地说明采用的新接口或者新服务是什么。
5. 【强制】不能使用过时的类或方法。
说明： java . net . URLDecoder 中的方法 decode(String encodeStr) 这个方法已经过时，应
该使用双参数 decode(String source, String encode) 。接口提供方既然明确是过时接口，
那么有义务同时提供新的接口 ； 作为调用方来说，有义务去考证过时方法的新实现是什么。
6. 【强制】 Object 的 equals 方法容易抛空指针异常，应使用常量或确定有值的对象来调用
equals 。
正例：" test " .equals(object);
反例： object.equals( " test " );
说明：推荐使用 java . util . Objects # equals（JDK 7 引入的工具类 ）
7. 【强制】所有的相同类型的包装类对象之间值的比较，全部使用 equals 方法比较。
说明：对于 Integer var = ? 在-128 至 127 范围内的赋值， Integer 对象是在IntegerCache . cache 产生，会复用已有对象，这个区间内的 Integer 值可以直接使用==进行
判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大坑，
推荐使用 equals 方法进行判断。
8. 关于基本数据类型与包装数据类型的使用标准如下：
1 ） 【强制】所有的 POJO 类属性必须使用包装数据类型。
2 ） 【强制】 RPC 方法的返回值和参数必须使用包装数据类型。
3 ） 【推荐】所有的局部变量使用基本数据类型。
说明： POJO 类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何
NPE 问题，或者入库检查，都由使用者来保证。
正例：数据库的查询结果可能是 null ，因为自动拆箱，用基本数据类型接收有 NPE 风险。
反例：比如显示成交总额涨跌情况，即正负 x %， x 为基本数据类型，调用的 RPC 服务，调用
不成功时，返回的是默认值，页面显示为 0%，这是不合理的，应该显示成中划线。所以包装
数据类型的 null 值，能够表示额外的信息，如：远程调用失败，异常退出。
9. 【强制】定义 DO / DTO / VO 等 POJO 类时，不要设定任何属性默认值。
反例： POJO 类的 gmtCreate 默认值为 new Date(); 但是这个属性在数据提取时并没有置入具
体值，在更新其它字段时又附带更新了此字段，导致创建时间被修改成当前时间。
10. 【强制】序列化类新增属性时，请不要修改 serialVersionUID 字段，避免反序列失败 ； 如
果完全不兼容升级，避免反序列化混乱，那么请修改 serialVersionUID 值。
说明：注意 serialVersionUID 不一致会抛出序列化运行时异常。
11. 【强制】构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在 init 方法中。
12. 【强制】 POJO 类必须写 toString 方法。使用 IDE 的中工具： source > generate toString
时，如果继承了另一个 POJO 类，注意在前面加一下 super . toString 。
说明：在方法执行抛出异常时，可以直接调用 POJO 的 toString() 方法打印其属性值，便于排
查问题。
13. 【推荐】使用索引访问用 String 的 split 方法得到的数组时，需做最后一个分隔符后有无
内容的检查，否则会有抛 IndexOutOfBoundsException 的风险。
说明：

String str = "a,b,c,,";
String[] ary = str.split(",");
// 预期大于 3，结果是 3
System.out.println(ary.length);

14. 【推荐】当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起，
便于阅读，此条规则优先于第 15 条规则。
15. 【推荐】 类内方法定义顺序依次是：公有方法或保护方法 > 私有方法 > getter / setter
方法。

五、 集合处理

1. 【强制】关于 hashCode 和 equals 的处理，遵循如下规则：

1） 只要重写 equals ，就必须重写 hashCode 。
2） 因为 Set 存储的是不重复的对象，依据 hashCode 和 equals 进行判断，所以 Set 存储的
对象必须重写这两个方法。
3） 如果自定义对象做为 Map 的键，那么必须重写 hashCode 和 equals 。
说明： String 重写了 hashCode 和 equals 方法，所以我们可以非常愉快地使用 String 对象
作为 key 来使用。

2. 【强制】 ArrayList 的 subList 结果不可强转成 ArrayList ，否则会抛出 ClassCastException
异常，即 java . util . RandomAccessSubList cannot be cast to java . util . ArrayList .
说明： subList 返回的是 ArrayList 的内部类 SubList ，并不是 ArrayList ，而是
ArrayList 的一个视图，对于 SubList 子列表的所有操作最终会反映到原列表上。
3. 【强制】在 subList 场景中，高度注意对原集合元素个数的修改，会导致子列表的遍历、增加、
删除均会产生 ConcurrentModificationException 异常。
4. 【强制】使用集合转数组的方法，必须使用集合的 toArray(T[] array) ，传入的是类型完全
一样的数组，大小就是 list . size() 。
说明：使用 toArray 带参方法，入参分配的数组空间不够大时， toArray 方法内部将重新分配
内存空间，并返回新数组地址 ； 如果数组元素大于实际所需，下标为 [ list . size() ] 的数组
元素将被置为 null ，其它数组元素保持原值，因此最好将方法入参数组大小定义与集合元素
个数一致。
正例：

List<String> list = new ArrayList<String>(2);
list.add("guan");
list.add("bao");
String[] array = new String[list.size()];
array = list.toArray(array);

反例：直接使用 toArray 无参方法存在问题，此方法返回值只能是 Object[] 类，若强转其它
类型数组将出现 ClassCastException 错误。

5. 【强制】使用工具类 Arrays . asList() 把数组转换成集合时，不能使用其修改集合相关的方
法，它的 add / remove / clear 方法会抛出 UnsupportedOperationException 异常。
说明： asList 的返回对象是一个 Arrays 内部类，并没有实现集合的修改方法。 Arrays . asList
体现的是适配器模式，只是转换接口，后台的数据仍是数组。
String[] str = new String[] { "you", "wu" };
List list = Arrays.asList(str);
第一种情况： list.add("yangguanbao"); 运行时异常。
第二种情况： str[0] = "gujin"; 那么 list.get(0) 也会随之修改。
6. 【强制】泛型通配符<? extends T >来接收返回的数据，此写法的泛型集合不能使用 add 方
法，而 <? super T> 不能使用 get 方法，做为接口调用赋值时易出错。
说明：扩展说一下 PECS(Producer Extends Consumer Super) 原则：第一、频繁往外读取内
容的，适合用<? extends T >。第二、经常往里插入的，适合用 <? super T> 。
7. 【强制】不要在 foreach 循环里进行元素的 remove / add 操作。 remove 元素请使用 Iterator
方式，如果并发操作，需要对 Iterator 对象加锁。
正例：

Iterator<String> iterator = list.iterator();
while (iterator.hasNext()) {
    String item = iterator.next();
    if (删除元素的条件) {
        iterator.remove();
    }
}

反例：

List<String> list = new ArrayList<String>();
list.add("1");
list.add("2");
for (String item : list) {
    if ("1".equals(item)) {
        list.remove(item);
    }
}

说明：以上代码的执行结果肯定会出乎大家的意料，那么试一下把“1”换成“2”，会是同样的
结果吗？
8. 【强制】 在 JDK 7 版本及以上， Comparator 要满足如下三个条件，不然 Arrays . sort ，
Collections . sort 会报 IllegalArgumentException 异常。
说明：三个条件如下

1 ） x ， y 的比较结果和 y ， x 的比较结果相反。

2 ） x > y ， y > z ，则 x > z 。
3 ） x = y ，则 x ， z 比较结果和 y ， z 比较结果相同。

反例：下例中没有处理相等的情况，实际使用中可能会出现异常：

new Comparator<Student>() {
    @Override
    public int compare(Student o1, Student o2) {
        return o1.getId() > o2.getId() ? 1 : -1;
    }
};

六、并发处理

1. 【强制】获取单例对象需要保证线程安全，其中的方法也要保证线程安全。
说明：资源驱动类、工具类、单例工厂类都需要注意。
2. 【强制】创建线程或线程池时请指定有意义的线程名称，方便出错时回溯。
正例：

public class TimerTaskThread extends Thread {
    public TimerTaskThread() {
        super.setName("TimerTaskThread");
        ...
}

3. 【强制】线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。
说明：使用线程池的好处是减少在创建和销毁线程上所花的时间以及系统资源的开销，解决资
源不足的问题。如果不使用线程池，有可能造成系统创建大量同类线程而导致消耗完内存或者
“过度切换”的问题。
4. 【强制】线程池不允许使用 Executors 去创建，而是通过 ThreadPoolExecutor 的方式，这样
的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。
说明： Executors 返回的线程池对象的弊端如下：
1） FixedThreadPool 和 SingleThreadPool :
允许的请求队列长度为 Integer.MAX_VALUE ，可能会堆积大量的请求，从而导致 OOM 。
2） CachedThreadPool 和 ScheduledThreadPool :
允许的创建线程数量为 Integer.MAX_VALUE ，可能会创建大量的线程，从而导致 OOM 。
5. 【强制】 SimpleDateFormat 是线程不安全的类，一般不要定义为 static 变量，如果定义为
static ，必须加锁，或者使用 DateUtils 工具类。
正例：注意线程安全，使用 DateUtils 。亦推荐如下处理：

private static final ThreadLocal<DateFormat> df = new ThreadLocal<DateFormat>() {
    @ Override
    protected DateFormat initialValue() {
        return new SimpleDateFormat("yyyy-MM-dd");
    }
};

说明：如果是 JDK 8 的应用，可以使用 Instant 代替 Date ， LocalDateTime 代替 Calendar ，
DateTimeFormatter 代替 SimpleDateFormat ，官方给出的解释： simple beautiful strong
immutable thread - safe 。

6. 【强制】高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁 ； 能
锁区块，就不要锁整个方法体 ； 能用对象锁，就不要用类锁。
说明：尽可能使加锁的代码块工作量尽可能的小，避免在锁代码块中调用 RPC 方法。
7. 【强制】对多个资源、数据库表、对象同时加锁时，需要保持一致的加锁顺序，否则可能会造
成死锁。
说明：线程一需要对表 A 、 B 、 C 依次全部加锁后才可以进行更新操作，那么线程二的加锁顺序
也必须是 A 、 B 、 C ，否则可能出现死锁。
8. 【强制】并发修改同一记录时，避免更新丢失，需要加锁。要么在应用层加锁，要么在缓存加
锁，要么在数据库层使用乐观锁，使用 version 作为更新依据。
说明：如果每次访问冲突概率小于 20%，推荐使用乐观锁，否则使用悲观锁。乐观锁的重试次
数不得小于 3 次。
9. 【强制】多线程并行处理定时任务时， Timer 运行多个 TimeTask 时，只要其中之一没有捕获
抛出的异常，其它任务便会自动终止运行，使用 ScheduledExecutorService 则没有这个问题。

七、控制语句

1. 【强制】在一个 switch 块内，每个 case 要么通过 break / return 等来终止，要么注释说明程
序将继续执行到哪一个 case 为止 ； 在一个 switch 块内，都必须包含一个 default 语句并且
放在最后，即使它什么代码也没有。
2. 【强制】在 if / else / for / while / do 语句中必须使用大括号。即使只有一行代码，避免采用
单行的编码方式： if (condition) statements;

3. 【推荐】表达异常的分支时，少用 if-else 方式 ，这种方式可以改写成：
if (condition) {
...
return obj;
}
// 接着写 else 的业务逻辑代码;
说明：如果非得使用 if()...else if()...else... 方式表达逻辑，【强制】避免后续代码维
护困难，请勿超过 3 层。
正例：超过 3 层的 if-else 的逻辑判断代码可以使用卫语句、策略模式、状态模式等来实现，
其中卫语句示例如下：

public void today() {
    if (isBusy()) {
        System.out.println(“change time.”);
        return;
    }
    if (isFree()) {
        System.out.println(“go to travel.”);
        return;
}
    System.out.println(“stay at home to learn Alibaba Java Coding Guidelines.”);
    return;
}

八、 注释规约

1. 【强制】类、类属性、类方法的注释必须使用 Javadoc 规范，使用/**内容*/格式，不得使用
// xxx 方式。
说明：在 IDE 编辑窗口中， Javadoc 方式会提示相关注释，生成 Javadoc 可以正确输出相应注
释 ； 在 IDE 中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高
阅读效率。
2. 【强制】所有的抽象方法 （ 包括接口中的方法 ） 必须要用 Javadoc 注释、除了返回值、参数、
异常说明外，还必须指出该方法做什么事情，实现什么功能。
说明：对子类的实现要求，或者调用注意事项，请一并说明。
3. 【强制】所有的类都必须添加创建者和创建日期。
4. 【强制】方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释
使用/* */注释，注意与代码对齐。
5. 【强制】所有的枚举类型字段必须要有注释，说明每个数据项的用途。

九、其它

1. 【强制】在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。
说明：不要在方法体内定义： Pattern pattern = Pattern . compile( 规则 );
2. 【强制】 velocity 调用 POJO 类的属性时，建议直接使用属性名取值即可，模板引擎会自动按
规范调用 POJO 的 getXxx() ，如果是 boolean 基本数据类型变量 （boolean 命名不需要加 is
前缀 ） ，会自动调用 isXxx() 方法。
说明：注意如果是 Boolean 包装类对象，优先调用 getXxx() 的方法。
3. 【强制】后台输送给页面的变量必须加 $!{var} ——中间的感叹号。
说明：如果 var = null 或者不存在，那么 ${var} 会直接显示在页面上。
4. 【强制】注意 Math . random() 这个方法返回是 double 类型，注意取值的范围 0≤ x <1 （ 能够
取到零值，注意除零异常 ） ，如果想获取整数类型的随机数，不要将 x 放大 10 的若干倍然后
取整，直接使用 Random 对象的 nextInt 或者 nextLong 方法。
5. 【强制】获取当前毫秒数 System . currentTimeMillis(); 而不是 new Date() . getTime();
说明：如果想获取更加精确的纳秒级时间值，使用 System . nanoTime()的方式 。在 JDK 8 中，
针对统计时间等场景，推荐使用 Instant 类。