JAVA编码规范

1.编程规约

A.命名风格

【1】不能以下划线或美元符号开始或结束

【2】双峰命名法（类名首字母大写，其余首字母小写，常量全大写以下划线间隔）

【3】抽象类：AbstractXXX、BaseXXX；异常类：XXXException；测试类XXXTest

【4】数组命名：int[] arrayDemo;

【5】POJO类中布尔类型变量不能加is前缀，框架解析时可能会引起序列化错误导致出错

【6】包名统一小写，eg：com.guigu.utry.xxx(util/dao/impl......)

【7】命名必须规范，尽量使用完整的单词组合，提高代码可读性

【8】与设计模式相关的类、接口、模块，在命名时需体现设计的模式

【9】接口类中的方法和属性不加任何修饰符号，一般不在接口中定义变量（除非是整个应用的基础常量）

【10】接口和实现类的命名区别：XXXService、XXXServiceImpl，如果是形容能力的接口名称则有“AbstractTranslator 实现 Translatable 接口”

【11】枚举类型全大写，加上Enum后缀，以下划线间隔（枚举名字为 ProcessStatusEnum 的成员名称：SUCCESS / UNKNOWN_REASON）

【12】各层命名规约：

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。

B.常量定义

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

【2】在 long 或者 Long 赋值时，数值后使用大写的 L

【3】按常量功能进行归类，分开维护(缓存相关常量放在类 CacheConsts 下；系统配置相关常量放在类 ConfigConsts 下)

【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;
    }
}

C.代码格式

【1】大括号

无内容：{}

有内容：

{

具体内容

}

有else：

{

具体内容}else...

表示终止的右大括号后必须换行

【2】左、右小括号和字符之间不出现空格；而左大括号前需要空格。

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

【4】任何二目、三目运算符的左右两边都需要加一个空格；运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号等。

【5】采用 4 个空格缩进，禁止使用 tab 字符(除非设置1 个 tab 为 4 个空)。

IDEA 设置时请勿勾选 Use tab character；而在 eclipse 中，必须勾选 insert spaces for tabs。

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

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

1） 第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。

2） 运算符与下文一起换行。

3） 方法调用的点符号与下文一起换行。

4） 方法调用中的多个参数需要换行时，在逗号后进行。

5） 在括号前不要换行

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

【9】IDE 的 text file encoding 设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式，

不要使用 Windows 格式

【10】单个方法的总行数不超过80行

D.OOP规约

【1】通过“类名”直接访问类的静态变量或者静态方法

【2】所有覆写方法必须加@Override注解

【3】相同参数类型，相同业务含义，才可以使用 Java 的可变参数，避免使用 Object

【4】外部正在调用或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方产生

影响。接口过时必须加@Deprecated 注解，并清晰地说明采用的新接口或者新服务是什么

【5】不能使用过时的类或者方法

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

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

正例："test".equals(object);

【7】关于基本数据类型与包装数据类型的使用标准如下：

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

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

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

【8】定义 DO/DTO/VO 等 POJO 类时，不要设定任何属性默认值。

【9】序列化类新增属性时，请不要修改 serialVersionUID 字段，避免反序列失败；如

果完全不兼容升级，避免反序列化混乱，那么请修改 serialVersionUID 值。

说明：注意 serialVersionUID 不一致会抛出序列化运行时异常。

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

【11】POJO 类必须写 toString 方法。使用 IDE 中的工具：source> generate toString

时，如果继承了另一个 POJO 类，注意在前面加一下 super.toString

【12】禁止在 POJO 类中，同时存在对应属性 xxx 的 isXxx()和 getXxx()方法。

说明：框架在调用属性 xxx 的提取方法时，并不能确定哪个方法一定是被优先调用到

【13】使用索引访问用 String 的 split 方法得到的数组时，需做最后一个分隔符后有无

内容的检查，否则会有抛 IndexOutOfBoundsException 的风险。

【14】当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起.

类内方法定义的顺序依次是：公有方法或保护方法 > 私有方法 > getter/setter

方法。

说明：公有方法是类的调用者和维护者最关心的方法，首屏展示最好；保护方法虽然只是子类

关心，也可能是“模板设计模式”下的核心方法；而私有方法外部一般不需要特别关心，是一个黑盒实现；因为承载的信息价值较低，所有 Service 和 DAO 的 getter/setter 方法放在类体

最后

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

【16】循环体内，字符串的连接方式，使用 StringBuilder 的 append 方法进行扩展

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

1） 不允许被继承的类，如：String 类。

2） 不允许修改引用的域对象。

3） 不允许被重写的方法，如：POJO 类的 setter 方法。

4） 不允许运行过程中重新赋值的局部变量。

5） 避免上下文重复使用一个变量，使用 final 描述可以强制重新定义一个变量，方便更好

地进行重构。

【18】慎用 Object 的 clone 方法来拷贝对象。

说明：对象的 clone 方法默认是浅拷贝，若想实现深拷贝需要重写 clone 方法实现域对象的

深度遍历式拷贝。

【19】类成员与方法访问控制从严：

1） 如果不允许外部直接通过 new 来创建对象，那么构造方法必须是 private。

2） 工具类不允许有 public 或 default 构造方法。

3） 类非 static 成员变量并且与子类共享，必须是 protected。

4） 类非 static 成员变量并且仅在本类使用，必须是 private。

5） 类 static 成员变量如果仅在本类使用，必须是 private。

6） 若是 static 成员变量，考虑是否为 final。

7） 类成员方法只供类内部调用，必须是 private。

8） 类成员方法只对继承类公开，那么限制为 protected。

说明：任何类、方法、参数、变量，严控访问范围。过于宽泛的访问范围，不利于模块解耦。

E.集合处理

【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，其它数组元素保持原值，因此最好将方法入参数组大小定义与集

合元素个数一致。

【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 对象加锁

【8】在 JDK7 版本及以上，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 比较结果相同

【9】集合泛型定义时，在 JDK7 及以上，使用 diamond 语法或全省略。

说明：菱形泛型，即 diamond，直接使用<>来指代前边已经指定的类型。

【10】集合初始化时，指定集合初始值大小。

说明：HashMap 使用 HashMap(int initialCapacity) 初始化。

正例：initialCapacity = (需要存储的元素个数 / 负载因子) + 1。注意负载因子（即 loader

factor）默认为 0.75，如果暂时无法确定初始值大小，请设置为 16（即默认值）。

反例：HashMap 需要放置 1024 个元素，由于没有设置容量初始大小，随着元素不断增加，容

量 7 次被迫扩大，resize 需要重建 hash 表，严重影响性能

【11】使用 entrySet 遍历 Map 类集合 KV，而不是 keySet 方式进行遍历。

说明：keySet 其实是遍历了 2 次，一次是转为 Iterator 对象，另一次是从 hashMap 中取出

key 所对应的 value。而 entrySet 只是遍历了一次就把 key 和 value 都放到了 entry 中，效

率更高。如果是 JDK8，使用 Map.foreach 方法。

正例：values()返回的是 V 值集合，是一个 list 集合对象；keySet()返回的是 K 值集合，是

一个 Set 集合对象；entrySet()返回的是 K-V 值组合集合

【12】高度注意 Map 类集合 K/V 能不能存储 null 值的情况

【13】合理利用好集合的有序性(sort)和稳定性(order)，避免集合的无序性(unsort)和

不稳定性(unorder)带来的负面影响。

说明：有序性是指遍历的结果是按某种比较规则依次排列的。稳定性指集合每次遍历的元素次

序是一定的。如：ArrayList 是 order/unsort；HashMap 是 unorder/unsort；TreeSet 是

order/sort

【14】利用 Set 元素唯一的特性，可以快速对一个集合进行去重操作，避免使用 List 的

contains 方法进行遍历、对比、去重操作

F.并发处理问题

【1】涉及线程安全问题

获取单例对象需要保证线程安全，其中的方法也要保证线程安全

创建线程或线程池时请指定有意义的线程名称，方便出错时回溯

线程资源必须通过线程池提供，不允许在应用中自行显式创建线程

线程池不允许使用 Executors 去创建，而是通过 ThreadPoolExecutor 的方式，这样

的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险

【2】SimpleDateFormat 是线程不安全的类，一般不要定义为 static 变量，如果定义为

static，必须加锁，或者使用 DateUtils 工具类。

【3】高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁；能

锁区块，就不要锁整个方法体；能用对象锁，就不要用类锁。

说明：尽可能使加锁的代码块工作量尽可能的小，避免在锁代码块中调用 RPC 方法。

【4】对多个资源、数据库表、对象同时加锁时，需要保持一致的加锁顺序，否则可能会造

成死锁。

说明：线程一需要对表 A、B、C 依次全部加锁后才可以进行更新操作，那么线程二的加锁顺序

也必须是 A、B、C，否则可能出现死锁。

【5】并发修改同一记录时，避免更新丢失，需要加锁。要么在应用层加锁，要么在缓存加

锁，要么在数据库层使用乐观锁，使用 version 作为更新依据。

说明：如果每次访问冲突概率小于 20%，推荐使用乐观锁，否则使用悲观锁。乐观锁的重试次

数不得小于 3 次。

【6】多线程并行处理定时任务时，Timer 运行多个 TimeTask 时，只要其中之一没有捕获

抛出的异常，其它任务便会自动终止运行，使用 ScheduledExecutorService 则没有这个问题。

【7】使用 CountDownLatch 进行异步转同步操作，每个线程退出前必须调用 countDown

方法，线程执行代码注意 catch 异常，确保 countDown 方法被执行到，避免主线程无法执行

至 await 方法，直到超时才返回结果。

注意，子线程抛出异常堆栈，不能在主线程 try-catch 到。

【8】避免 Random 实例被多线程使用，虽然共享该实例是线程安全的，但会因竞争同一

seed 导致的性能下降

【9】在并发场景下，通过双重检查锁（double-checked locking）实现延迟初始化的优

化问题隐患(可参考 The "Double-Checked Locking is Broken" Declaration)，推荐解

决方案中较为简单一种（适用于 JDK5 及以上版本），将目标属性声明为 volatile 型

【10】volatile 解决多线程内存不可见问题。对于一写多读，是可以解决变量同步问题，

但是如果多写，同样无法解决线程安全问题。如果是 count++操作，使用如下类实现：

AtomicInteger count = new AtomicInteger(); count.addAndGet(1); 如果是 JDK8，推

荐使用 LongAdder 对象，比 AtomicLong 性能更好（减少乐观锁的重试次数）。

【11】HashMap 在容量不够进行 resize 时由于高并发可能出现死链，导致 CPU 飙升，在

开发过程中可以使用其它数据结构或加锁来规避此风险

【12】ThreadLocal 无法解决共享对象的更新问题，ThreadLocal 对象建议使用 static

修饰。这个变量是针对一个线程内所有操作共享的，所以设置为静态变量，所有此类实例共享

此静态变量 ，也就是说在类第一次被使用时装载，只分配一块存储空间，所有此类的对象(只

要是这个线程内定义的)都可以操控这个变量

G.控制语句

【1】在一个 switch 块内，每个 case 要么通过 break/return 等来终止，要么注释说明程

序将继续执行到哪一个 case 为止；在一个 switch 块内，都必须包含一个 default 语句并且

放在最后，即使空代码。

【2】在 if/else/for/while/do 语句中必须使用大括号。即使只有一行代码，避免采用

单行的编码方式：if (condition) statements;

【3】在高并发场景中，避免使用”等于”判断作为中断或退出的条件。

说明：如果并发控制没有处理好，容易产生等值判断被“击穿”的情况，使用大于或小于的区间

判断条件来代替。

反例：判断剩余奖品数量等于 0 时，终止发放奖品，但因为并发处理错误导致奖品数量瞬间变

成了负数，这样的话，活动无法终止。

【4】表达异常的分支时，少用 if-else 方式，这种方式可以改写成：

if (condition) {

...

return obj;

}

// 接着写 else 的业务逻辑代码;

说明：如果非得使用 if()...else if()...else...方式表达逻辑，【强制】避免后续代码维

护困难，请勿超过 3 层

【5】除常用方法（如 getXxx/isXxx）等外，不要在条件判断中执行其它复杂的语句，将

复杂逻辑判断的结果赋值给一个有意义的布尔变量名，以提高可读性。

【6】循环体中的语句要考量性能，以下操作尽量移至循环体外处理，如定义对象、变量、

获取数据库连接，进行不必要的 try-catch 操作（这个 try-catch 是否可以移至循环体外）。

【7】避免采用取反逻辑运算符。

说明：取反逻辑不利于快速理解，并且取反逻辑写法必然存在对应的正向逻辑写法

【8】接口入参保护，这种场景常见的是用作批量操作的接口。

【9】下列情形，需要进行参数校验：

1） 调用频次低的方法。

2） 执行时间开销很大的方法。此情形中，参数校验时间几乎可以忽略不计，但如果因为参

数错误导致中间执行回退，或者错误，那得不偿失。

3） 需要极高稳定性和可用性的方法。

4） 对外提供的开放接口，不管是 RPC/API/HTTP 接口。

5） 敏感权限入口。

【11】下列情形，不需要进行参数校验：

1） 极有可能被循环调用的方法。但在方法说明里必须注明外部参数检查要求。

2） 底层调用频度比较高的方法。毕竟是像纯净水过滤的最后一道，参数错误不太可能到底

层才会暴露问题。一般 DAO 层与 Service 层都在同一个应用中，部署在同一台服务器中，所

以 DAO 的参数校验，可以省略。

3） 被声明成 private 只会被自己代码所调用的方法，如果能够确定调用方法的代码传入参

数已经做过检查或者肯定不会有问题，此时可以不校验参数。

H.注释规约

【1】类、类属性、类方法的注释必须使用 Javadoc 规范，使用/*内容/格式，不得使用

// xxx 方式

【2】所有的抽象方法（包括接口中的方法）必须要用 Javadoc 注释、除了返回值、参数、

异常说明外，还必须指出该方法做什么事情，实现什么功能。

说明：对子类的实现要求，或者调用注意事项，请一并说明。

【3】所有的类都必须添加创建者和创建日期。

【4】方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释

使用/* */注释，注意与代码对齐。

【5】所有的枚举类型字段必须要有注释，说明每个数据项的用途。

【6】与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持

英文原文即可。

【7】代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑

等的修改。

说明：代码与注释更新不同步，就像路网与导航软件更新不同步一样，如果导航软件严重滞后，

就失去了导航的意义。

【9】谨慎注释掉代码。在上方详细说明，而不是简单地注释掉。如果无用，则删除。

说明：代码被注释掉有两种可能性：

1）后续会恢复此段代码逻辑。

2）永久不用。前者如果没有备注信息，难以知晓注释动机。后者建议直接删掉（代码仓库保存了历史代码）。

【10】对于注释的要求：第一、能够准确反应设计思想和代码逻辑；第二、能够描述业务含

义，使别的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者形同

天书，注释是给自己看的，即使隔很长时间，也能清晰理解当时的思路；注释也是给继任者看

的，使其能够快速接替自己的工作。

【11】特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描，

经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。

1） 待办事宜（TODO）:（ 标记人，标记时间，[预计处理时间]）

表示需要实现，但目前还未实现的功能。这实际上是一个 Javadoc 的标签，目前的 Javadoc

还没有实现，但已经被广泛使用。只能应用于类，接口和方法（因为它是一个 Javadoc 标签）。

2） 错误，不能工作（FIXME）:（标记人，标记时间，[预计处理时间]）

在注释中用 FIXME 标记某代码是错误的，而且不能工作，需要及时纠正的情况。

I.其余

【1】在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。

说明：不要在方法体内定义：Pattern pattern = Pattern.compile(“规则”);

【2】后台输送给页面的变量必须加$!{var}——中间的感叹号

【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()的方式。在 JDK8 中，

针对统计时间等场景，推荐使用 Instant 类

【6】不要在视图模板中加入任何复杂的逻辑

【7】任何数据结构的构造或初始化，都应指定大小，避免数据结构无限增长吃光内存

【8】及时清理不再使用的代码段或配置信息。

2.异常日志

A.异常处理

【1】Java 类库中定义的可以通过预检查方式规避的 RuntimeException 异常不应该通过

catch 的方式来处理，比如：NullPointerException，IndexOutOfBoundsException 等等。

【2】异常不要用来做流程控制，条件控制

【3】有 try 块放到了事务代码中，catch 异常后，如果需要回滚事务，一定要注意手动回

滚事务。

【4】finally 块必须对资源对象、流对象进行关闭，有异常也要做 try-catch。不要在 finally 块中使用 return语句

说明：如果 JDK7 及以上，可以使用 try-with-resources 方式

【5】防止 NPE，是程序员的基本修养，注意 NPE 产生的场景：

1）返回类型为基本数据类型，return 包装数据类型的对象时，自动拆箱有可能产生 NPE。

反例：public int f() { return Integer 对象}， 如果为 null，自动解箱抛 NPE。

2） 数据库的查询结果可能为 null。

3） 集合里的元素即使 isNotEmpty，取出的数据元素也可能为 null。

4） 远程调用返回对象时，一律要求进行空指针判断，防止 NPE。

5） 对于 Session 中获取的数据，建议 NPE 检查，避免空指针。

6） 级联调用 obj.getA().getB().getC()；一连串调用，易产生 NPE。

正例：使用 JDK8 的 Optional 类来防止 NPE 问题。

【6】避免出现重复的代码（Don’t Repeat Yourself），即 DRY 原则。

B.日志规约

【1】应用中不可直接使用日志系统（Log4j、Logback）中的 API，而应依赖使用日志框架

SLF4J 中的 API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

private static final Logger logger = LoggerFactory.getLogger(Abc.class);

【2】应用中的扩展日志（如打点、临时监控、访问日志等）命名方式：

appName_logType_logName.log,推荐对日志进行分类，如将错误日志和业务日志分开存放，便于开发人员查看，也便于通过日志对系统进行及时监控

【3】对 trace/debug/info 级别的日志输出，必须使用条件输出形式或者使用占位符的方

式。

说明：logger.debug("Processing trade with id: " + id + " and symbol: " + symbol);

如果日志级别是 warn，上述日志不会打印，但是会执行字符串拼接操作，如果 symbol 是对象，

会执行 toString()方法，浪费了系统资源，执行了上述操作，最终日志却没有打印。

【4】避免重复打印日志，浪费磁盘空间，务必在 log4j.xml 中设置 additivity=false。

正例：<logger name="com.taobao.dubbo.config" additivity="false">

【5】异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过

关键字 throws 往上抛出。

正例：logger.error(各类参数或者对象 toString() + "_" + e.getMessage(), e);

3.单元测试

【1】好的单元测试必须遵守 AIR 原则。

【2】单元测试应该是全自动执行的，并且非交互式的。测试用例通常是被定期执行的，执

行过程必须完全自动化才有意义。输出结果需要人工检查的测试不是一个好的单元测试。单元

测试中不准使用 System.out 来进行人肉验证，必须使用 assert 来验证。

【3】保持单元测试的独立性。为了保证单元测试稳定可靠且便于维护，单元测试用例之间

决不能互相调用，也不能依赖执行的先后次序

【4】单元测试是可以重复执行的，不能受到外界环境的影响,对于单元测试，要保证测试粒度足够小，有助于精确定位问题。单测粒度至多是类级别，一般是方法级别。

【5】核心业务、核心应用、核心模块的增量代码确保单元测试通过。单元测试的基本目标：语句覆盖率达到 70%；核心模块的语句覆盖率和分支覆盖率都要达到 100%

【6】编写单元测试代码遵守 BCDE 原则，以保证被测试模块的交付质量。

l B：Border，边界值测试，包括循环边界、特殊取值、特殊时间点、数据顺序等。

l C：Correct，正确的输入，并得到预期的结果。

l D：Design，与设计文档相结合，来编写单元测试。

l E：Error，强制错误信息输入（如：非法数据、异常流程、非业务允许输入等），并得到预期的结果

【7】和数据库相关的单元测试，可以设定自动回滚机制，不给数据库造成脏数据。或者对单元测试产生的数据有明确的前后缀标识。

正例：在 RDC 内部单元测试中，使用 RDC_UNIT_TEST_的前缀标识数据