Java开发手册(黄山版)

这本书值得反复看、也可作为随手翻阅字典

一、编程规约

(一) 命名风格

【强制】纯拼音命名方式也要避免采用。

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

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

说明：本文 MySQL 规约中的建表约定第 1 条，表达是与否的变量采用 is_xxx 的命名方式，所以需要在<resultMap>

设置从 is_xxx 到 xxx 的映射关系。

反例：定义为基本数据类型 Boolean isDeleted 的属性，它的方法也是 isDeleted()，框架在反向解析时，“误以为 ”对应的属性名称是 deleted，导致属性获取不到，进而抛出异常

【强制】避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名，使可理

解性降低

【推荐】如果模块、接口、类、方法使用了设计模式，在命名时要体现出具体模式。

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

正例： public class OrderFactory;

public class LoginProxy;

public class ResourceObserver;

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

有效的 Javadoc 注释。尽量不要在接口里定义常量，如果一定要定义，最好确定该常量与接口的方法

相关，并且是整个应用的基础常量。

正例：接口方法签名 void commit();

接口基础常量 String COMPANY = "alibaba";

反例：接口方法定义 public abstract void commit();

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

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

1）【强制】对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务一定是接口，内部的实现类用 Impl 的后缀

与接口区别。

正例： CacheServiceImpl 实现 CacheService 接口。

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

正例： AbstractTranslator 实现 Translatable。

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

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

正例：枚举名字为 ProcessStatusEnum 的成员名称：SUCCESS / UNKNOWN_REASON

【参考】各层命名规约：

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

(二) 常量定义

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

反例：

// 开发者 A 定义了缓存的 key。

String key = " Id#taobao_ " + tradeId;

cache. put (key, value);

// 开发者 B 使用缓存时直接复制少了下划线，即 key 是"Id#taobao" + tradeId，导致出现故障。

String key = " Id#taobao " + tradeId;

cache. get (key);

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

说明： public static final Long NUM = 2l; 写的是数字的 21，还是 Long 型的 2？

【强制】浮点数类型的数值后缀统一为大写的 D 或 F。

正例： public static final double HEIGHT = 175.5D;

public static final float WEIGHT = 150.3F;

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

说明：大而全的常量类，杂乱无章，使用查找功能才能定位到要修改的常量，不利于理解，也不利于维护。

正例：缓存相关常量放在类 CacheConsts 下；系统配置相关常量放在类 SystemConfigConsts 下。

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

量、类内共享常量。

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 定义。

(三) 代码格式

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

正例：

// 这是示例注释，请注意在双斜线之后有一个空格

String commentString = new String ( "demo" );

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

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

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

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

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

5）在括号前不要换行，见反例。

正例：

StringBuilder builder = new StringBuilder ();

// 超过 120 个字符的情况下，换行缩进 4 个空格，并且方法前的点号一起换行

builder . append ( "yang" ). append ( "hao" )...

. append ( "chen" )...

. append ( "chen" );

反例：

StringBuilder builder = new StringBuilder ();

// 超过 120 个字符的情况下，不要在括号前换行

builder . append ( "you" ). append ( "are" )... append

( "lucky" );

// 参数很多的方法调用可能超过 120 个字符，逗号后才是换行处

method ( args1 , args2 , args3 , ...

, argsX );

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

Windows 格式。(Settings -- Code Style -- Line separator)

【推荐】不同逻辑、不同语义、不同业务的代码之间插入一个空行，分隔开来以提升可读性。

说明：任何情形，没有必要插入多个空行进行隔开

(四) OOP 规约

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

类名来访问即可

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

说明： getObject() 与 get0bject() 的问题。一个是字母的 O，一个是数字的 0，加 @Override 可以准确判断是否覆盖

成功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错。

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

说明： java.net.URLDecoder 中的方法 decode(String encodeStr) 这个方法已经过时，应该使用双参数

decode(String source, String encode)。接口提供方既然明确是过时接口，那么有义务同时提供新的接口；作为调用

方来说，有义务去考证过时方法的新实现是什么

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

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

反例：param.equals("test");

说明：推荐使用 JDK7 引入的工具类 java.util.Objects#equals(Object a, Object b)

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

说明：对于 Integer var = ? 在 -128 至 127 之间的赋值，Integer 对象是在 IntegerCache.cache 产生，会复用已有对

象，这个区间内的 Integer 值可以直接使用 == 进行判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复

用已有对象，这是一个大坑，推荐使用 equals 方法进行判断

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

说明：对于 Integer var = ? 在 -128 至 127 之间的赋值，Integer 对象是在 IntegerCache.cache 产生，会复用已有对

象，这个区间内的 Integer 值可以直接使用 == 进行判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复

用已有对象，这是一个大坑，推荐使用 equals 方法进行判断

【强制】任何货币金额，均以最小货币单位且为整型类型进行存储。

【强制】浮点数之间的等值判断，基本数据类型不能使用 == 进行比较，包装数据类型不能使用 equals

进行判断。

说明：浮点数采用“尾数+阶码”的编码方式，类似于科学计数法的“有效数字+指数”的表示方式。二进制无法精确表

示大部分的十进制小数，具体原理参考《码出高效》。

反例：

float a = 1.0F - 0.9F ;

float b = 0.9F - 0.8F ;

if ( a == b ) {

// 预期进入此代码块，执行其它业务逻辑

// 但事实上 a == b 的结果为 false

}

Float x = Float . valueOf ( a );

Float y = Float . valueOf ( b );

if ( x . equals ( y )) {

// 预期进入此代码块，执行其它业务逻辑

// 但事实上 equals 的结果为 false

}

正例：

(1)指定一个误差范围，两个浮点数的差值在此范围之内，则认为是相等的。

float a = 1.0F - 0.9F ;

float b = 0.9F - 0.8F ;

float diff = 1e-6F ;

if ( Math . abs ( a - b ) < diff ) {

System . out . println ( "true" );

}

(2)使用 BigDecimal 来定义值，再进行浮点数的运算操作。

BigDecimal a = new BigDecimal ( "1.0" );

BigDecimal b = new BigDecimal ( "0.9" );

BigDecimal c = new BigDecimal ( "0.8" );

BigDecimal x = a . subtract ( b );

BigDecimal y = b . subtract ( c );

if ( x . compareTo ( y ) == 0) {

System . out . println ( "true" );

}

【强制】 BigDecimal 的等值比较应使用 compareTo() 方法，而不是 equals() 方法。

说明： equals() 方法会比较值和精度（1.0 与 1.00 返回结果为 false），而 compareTo() 则会忽略精度。

【强制】定义数据对象 DO 类时，属性类型要与数据库字段类型相匹配。

正例：数据库字段的 bigint 必须与类属性的 Long 类型相对应。

反例：某业务的数据库表 id 字段定义类型为 bigint unsigned，实际类对象属性为 Integer，随着 id 越来越大，

超过 Integer 的表示范围而溢出成为负数，此时数据库 id 不支持存入负数抛出异常产生线上故障。

【强制】禁止使用构造方法 BigDecimal(double) 的方式把 double 值转化为 BigDecimal 对象。

说明： BigDecimal(double) 存在精度损失风险，在精确计算或值比较的场景中可能会导致业务逻辑异常。如：

BigDecimal g = new BigDecimal(0.1F)；实际的存储值为：0.100000001490116119384765625

正例：优先推荐入参为 String 的构造方法，或使用 BigDecimal 的 valueOf 方法，此方法内部其实执行了 Double 的

toString，而 Double 的 toString 按 double 的实际能表达的精度对尾数进行了截断。

BigDecimal recommend1 = new BigDecimal ( "0.1" );

BigDecimal recommend2 = BigDecimal . valueOf ( 0.1 );

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

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

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

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

说明： POJO 类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何 NPE 问题，或者入库检查，

都由使用者来保证。

正例：数据库的查询结果可能是 null，因为自动拆箱，用基本数据类型接收有 NPE 风险。

反例：某业务的交易报表上显示成交总额涨跌情况，即正负 x%，x 为基本数据类型，调用的 RPC 服务，调用不成功时，

返回的是默认值，页面显示为 0%，这是不合理的，应该显示成中划线-。所以包装数据类型的 null 值，能够表示额外的

信息，如：远程调用失败，异常退出。

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

反例：某业务的 DO 的 createTime 默认值为 new Date()；但是这个属性在数据提取时并没有置入具体值，在更新其

它字段时又附带更新了此字段，导致创建时间被修改成当前时间

【强制】序列化类新增属性时，请不要修改 serialVersionUID 字段，避免反序列失败；如果完全不兼

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

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

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

【强制】 POJO 类必须写 toString 方法。使用 IDE 中的工具 source > generate toString 时，如果继

承了另一个 POJO 类，注意在前面加一下 super.toString()。

说明：在方法执行抛出异常时，可以直接调用 POJO 的 toString() 方法打印其属性值，便于排查问题。

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

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

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

否则会有抛 IndexOutOfBoundsException 的风险。

说明：

String str = "a,b,c,," ;

String [] ary = str . split ( "," );

// 预期大于 3，结果等于 3

System . out . println ( ary . length );

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

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

计模式”下的核心方法；而私有方法外部一般不需要特别关心，是一个黑盒实现；因为承载的信息价值较低，所有

Service 和 DAO 的 getter / setter 方法放在类体最后。

【推荐】 setter 方法中，参数名称与类成员变量名称一致，this.成员名=参数名。在 getter / setter 方

法中，不要增加业务逻辑，增加排查问题的难度。

反例：

public Integer getData () {

if ( condition ) {

return this . data + 100 ;

} else {

return this . data - 100 ;

}

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

反例：

String str = "start" ;

for ( int i = 0 ; i < 100 ; i ++ ) {

str = str + "hello" ;

}

说明：反编译出的字节码文件显示每次循环都会 new 出一个 StringBuilder 对象，然后进行 append 操作，最后通过

toString() 返回 String 对象，造成内存资源浪费。

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

说明：对象 clone 方法默认是浅拷贝，若想实现深拷贝需覆写 clone 方法实现域对象的深度遍历式拷贝。

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

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

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

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

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

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

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

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

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

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

private 的方法，想删除就删除，可是一个 public 的 service 成员方法或成员变量，删除一下，不得手心冒点汗吗？

变量像自己的小孩，尽量在自己的视线内，变量作用域太大，无限制的到处跑，那么你会担心的。

(五) 日期时间

【强制】日期格式化时，传入 pattern 中表示年份统一使用小写的 y。

说明：日期格式化时，yyyy 表示当天所在的年，而大写的 YYYY 代表是 week in which year（JDK7 之后引入的概念），

意思是当天所在的周属于的年份，一周从周日开始，周六结束，只要本周跨年，返回的 YYYY 就是下一年。

正例：表示日期和时间的格式如下所示：

new SimpleDateFormat("yyyy-MM-dd HH:mm:ss")

反例：某程序员因使用 YYYY/MM/dd 进行日期格式化，2017/12/31 执行结果为 2018/12/31，造成线上故障。

【强制】在日期格式中分清楚大写的 M 和小写的 m，大写的 H 和小写的 h 分别指代的意义。

说明：日期格式中的这两对字母表意如下：

1）表示月份是大写的 M

2）表示分钟则是小写的 m

3）24 小时制的是大写的 H

4）12 小时制的则是小写的 h

【强制】获取当前毫秒数：System.currentTimeMillis()；而不是 new Date().getTime()。

说明：获取纳秒级时间，则使用 System.nanoTime 的方式。在 JDK8 中，针对统计时间等场景，推荐使用 Instant 类。

【强制】不允许在程序任何地方中使用： 1）java.sql.Date 2）java.sql.Time 3）java.sql.Timestamp。

说明：第 1 个不记录时间，getHours() 抛出异常；第 2 个不记录日期，getYear() 抛出异常；第 3 个在构造方法

super((time / 1000) * 1000)，在 Timestamp 属性 fastTime 和 nanos 分别存储秒和纳秒信息。

反例： java.util.Date.after(Date) 进行时间比较时，当入参是 java.sql.Timestamp 时，会触发 JDK BUG （JDK9 已修复），可能导致比较时的意外结果。

【强制】禁止在程序中写死一年为 365 天，避免在公历闰年时出现日期转换错误或程序逻辑错误。

正例：

// 获取今年的天数

int daysOfThisYear = LocalDate . now (). lengthOfYear ();

// 获取指定某年的天数

LocalDate . of ( 2011 , 1 , 1 ). lengthOfYear ();

反例：

// 第一种情况：在闰年 366 天时，出现数组越界异常

int [] dayArray = new int [ 365 ];

// 第二种情况：一年有效期的会员制，2020 年 1 月 26 日注册，硬编码 365 返回的却是 2021 年 1 月 25 日

Calendar calendar = Calendar . getInstance ();

calendar . set ( 2020 , 1 , 26 );

calendar . add ( Calendar . DATE , 365 );

【推荐】使用枚举值来指代月份。如果使用数字，注意 Date，Calendar 等日期相关类的月份 month 取

值范围从 0 到 11 之间。

说明：参考 JDK 原生注释，Month value is 0-based. e.g., 0 for January.

正例： Calendar.JANUARY，Calendar.FEBRUARY，Calendar.MARCH 等来指代相应月份来进行传参或比较。

(六) 集合处理

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

1）只要覆写 equals，就必须覆写 hashCode。

2）因为 Set 存储的是不重复的对象，依据 hashCode 和 equals 进行判断，所以 Set 存储的对象必须覆写这两种方法。

3）如果自定义对象作为 Map 的键，那么必须覆写 hashCode 和 equals。

说明： String 因为覆写了 hashCode 和 equals 方法，所以可以愉快地将 String 对象作为 key 来使用。

【强制】判断所有集合内部的元素是否为空，使用 isEmpty() 方法，而不是 size() == 0 的方式。

说明：在某些集合中，前者的时间复杂度为 O(1)，而且可读性更好。

正例：

Map< String , Object > map = new HashMap <> (16);

if ( map . isEmpty ()) {

System.out. println ( "no element in this map." );

}

【强制】在使用 java.util.stream.Collectors 类的 toMap() 方法转为 Map 集合时，一定要使用参数类型

为 BinaryOperator，参数名为 mergeFunction 的方法，否则当出现相同 key 时会抛出

IllegalStateException 异常。

说明：参数 mergeFunction 的作用是当出现 key 重复时，自定义对 value 的处理策略。

正例：

10/51 Java 开发手册（黄山版）

11/51

List < Pair < String , Double > > pairArrayList = new ArrayList <> ( 3 );

pairArrayList . add ( new Pair <> ( "version" , 12.10 ));

pairArrayList . add ( new Pair <> ( "version" , 12.19 ));

pairArrayList . add ( new Pair <> ( "version" , 6.28 ));

// 生成的 map 集合中只有一个键值对：{version=6.28}

Map < String , Double > map = pairArrayList . stream ()

. collect ( Collectors . toMap ( Pair :: getKey , Pair :: getValue , ( v1 , v2 ) -> v2 ));

反例：

String [] departments = new String []{ "RDC" , "RDC" , "KKB" };

// 抛出 IllegalStateException 异常

Map < Integer , String > map = Arrays . stream ( departments )

. collect ( Collectors . toMap ( String :: hashCode , str -> str ));

【强制】在使用 java.util.stream.Collectors 类的 toMap() 方法转为 Map 集合时，一定要注意当 value

为 null 时会抛 NPE 异常。

说明：在 java.util.HashMap 的 merge 方法里会进行如下的判断：

if ( value == null || remappingFunction == null )

throw new NullPointerException ();

反例：

List < Pair < String, Double > > pairArrayList = new ArrayList <> ( 2 );

pairArrayList . add ( new Pair <> ( "version1", 8.3 ));

pairArrayList . add ( new Pair <> ( "version2", null ));

// 抛出 NullPointerException 异常

Map < String, Double > map = pairArrayList . stream ()

. collect ( Collectors . toMap ( Pair :: getKey, Pair :: getValue, ( v1, v2 ) -> v2 ));

【强制】 ArrayList 的 subList 结果不可强转成 ArrayList，否则会抛出 ClassCastException 异常：

java.util.RandomAccessSubList cannot be cast to java.util.ArrayList。

说明： subList() 返回的是 ArrayList 的内部类 SubList，并不是 ArrayList 本身，而是 ArrayList 的一个视图，对于

SubList 的所有操作最终会反映到原列表上。

【强制】使用 Map 的方法 keySet() / values() / entrySet() 返回集合对象时，不可以对其进行添加元素

操作，否则会抛出 UnsupportedOperationException 异常

【强制】 Collections 类返回的对象，如：emptyList() / singletonList() 等都是 immutable list ，不可

对其进行添加或者删除元素的操作。

反例：如果查询无结果，返回 Collections.emptyList() 空集合对象，调用方一旦在返回的集合中进行了添加元素的操

作，就会触发 UnsupportedOperationException 异常

【强制】在 subList 场景中，高度注意对父集合元素的增加或删除，均会导致子列表的遍历、增加、删

除产生 ConcurrentModificationException 异常。

说明：抽查表明，90% 的程序员对此知识点都有错误的认知。

【强制】使用集合转数组的方法，必须使用集合的 toArray(T[] array)，传入的是类型完全一致、长度为

0 的空数组。

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

ClassCastException 错误。

正例：

List < String > list = new ArrayList <> ( 2 ); Java 开发手册（黄山版）

12/51

list . add ( "guan" );

list . add ( "bao" );

String [] array = list . toArray ( new String [ 0 ]);

说明：使用 toArray 带参方法，数组空间大小的 length：

1）等于 0 ，动态创建与 size 相同的数组，性能最好。

2）大于 0 但小于 size ，重新创建大小等于 size 的数组，增加 GC 负担。

3）等于 size ，在高并发情况下，数组创建完成之后，size 正在变大的情况下，负面影响与 2 相同。

4）大于 size ，空间浪费，且在 size 处插入 null 值，存在 NPE 隐患。

【强制】使用工具类 Arrays.asList() 把数组转换成集合时，不能使用其修改集合相关的方法，它的 add

/ remove / clear 方法会抛出 UnsupportedOperationException 异常。

说明： asList 的返回对象是一个 Arrays 内部类，并没有实现集合的修改方法。Arrays.asList 体现的是适配器模式，只

是转换接口，后台的数据仍是数组。

String[] str = new String[]{ "yang", "guan", "bao" };

List list = Arrays.asList(str);

第一种情况：list.add("yangguanbao"); 运行时异常。

第二种情况：str[0] = "change"; list 中的元素也会随之修改，反之亦然

【强制】泛型通配符<? extends T>来接收返回的数据，此写法的泛型集合不能使用 add 方法，

而<? super T>不能使用 get 方法，两者在接口调用赋值的场景中容易出错。

说明：扩展说一下 PECS(Producer Extends Consumer Super) 原则，即频繁往外读取内容的，适合用

<? extends T>，经常往里插入的，适合用<? super T>

【强制】在无泛型限制定义的集合赋值给泛型限制的集合时，在使用集合元素时，需要进行

instanceof 判断，避免抛出 ClassCastException 异常。

说明：毕竟泛型是在 JDK5 后才出现，考虑到向前兼容，编译器是允许非泛型集合与泛型集合互相赋值。

反例：

List < String > generics = null ;

List notGenerics = new ArrayList ( 10 );

notGenerics . add ( new Object ());

notGenerics . add ( new Integer ( 1 ));

generics = notGenerics ;

// 此处抛出 ClassCastException 异常

String string = generics . get ( 0 );

【强制】不要在 foreach 循环里进行元素的 remove / add 操作。remove 元素请使用 iterator 方式，

如果并发操作，需要对 iterator 对象加锁。

正例：

List < String > list = new ArrayList <> ();

list . add ( "1" );

list . add ( "2" );

Iterator < String > iterator = list . iterator ();

while ( iterator . hasNext ()) {

String item = iterator . next ();

if ( 删除元素的条件 ) {

iterator . remove ();

}

反例：

for ( String item : list ) {

if ( "1" . equals ( item )) {

list . remove ( item );

}

说明：反例中的执行结果肯定会出乎大家的意料，那么试一下把“1”换成“2”会是同样的结果吗？

【强制】在 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 比较结果相同。

反例：下例中没有处理相等的情况，交换两个对象判断结果并不互反，不符合第一个条件，在实际使用中可能会出现异

常。

new Comparator < Student >() {

@Override

public int compare ( Student o1, Student o2 ) {

return o1 . getId () > o2 . getId () ? 1 : - 1 ;

}

};

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

说明： HashMap 使用构造方法 HashMap(int initialCapacity) 进行初始化时，如果暂时无法确定集合大小，那么指

定默认值（16）即可。

正例： initialCapacity = (需要存储的元素个数 / 负载因子) + 1。注意负载因子（即 loaderfactor）默认为 0.75，如果

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

反例： HashMap 需要放置 1024 个元素，由于没有设置容量初始大小，随着元素增加而被迫不断扩容，resize() 方法

总共会调用 8 次，反复重建哈希表和数据迁移。当放置的集合元素个数达千万级时会影响程序性能。

【推荐】使用 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 值组合的 Set 集合。

(七) 并发处理

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

说明：线程池的好处是减少在创建和销毁线程上所消耗的时间以及系统资源的开销，解决资源不足的问题。如果不使用

线程池，有可能造成系统创建大量同类线程而导致消耗完内存或者“过度切换”的问题。

【强制】线程池不允许使用 Executors 去创建，而是通过 ThreadPoolExecutor 的方式，这样的处理方

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

说明： Executors 返回的线程池对象的弊端如下：

1） FixedThreadPool 和 SingleThreadPool ：

允许的请求队列长度为 Integer.MAX_VALUE，可能会堆积大量的请求，从而导致 OOM。

2） CachedThreadPool ：

允许的创建线程数量为 Integer.MAX_VALUE，可能会创建大量的线程，从而导致 OOM。

3） ScheduledThreadPool ：

允许的请求队列长度为 Integer.MAX_VALUE，可能会堆积大量的请求，从而导致 OOM。

public ThreadPoolExecutor(int corePoolSize,
                              int maximumPoolSize,
                              long keepAliveTime,
                              TimeUnit unit,
                              BlockingQueue<Runnable> workQueue,
                              ThreadFactory threadFactory,
                              RejectedExecutionHandler handler) {
        if (corePoolSize < 0 ||
            maximumPoolSize <= 0 ||
            maximumPoolSize < corePoolSize ||
            keepAliveTime < 0)
            throw new IllegalArgumentException();
        if (workQueue == null || threadFactory == null || handler == null)
            throw new NullPointerException();
        this.acc = System.getSecurityManager() == null ?
                null :
                AccessController.getContext();
        this.corePoolSize = corePoolSize;
        this.maximumPoolSize = maximumPoolSize;
        this.workQueue = workQueue;
        this.keepAliveTime = unit.toNanos(keepAliveTime);
        this.threadFactory = threadFactory;
        this.handler = handler;
    }

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

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

正例：注意线程安全，使用 DateUtils。亦推荐如下处理：

private static final ThreadLocal < DateFormat > dateStyle = new ThreadLocal < DateFormat >() {

@Override

protected DateFormat initialValue () {

return new SimpleDateFormat ( "yyyy-MM-dd" );

}

};

说明：如果是 JDK8 的应用，可以使用 Instant 代替 Date，LocalDateTime 代替 Calendar，DateTimeFormatter 代替

SimpleDateFormat，官方给出的解释：simple beautiful strong immutable thread-safe。

【强制】必须回收自定义的 ThreadLocal 变量，尤其在线程池场景下，线程经常会被复用，如果不清理

自定义的 ThreadLocal 变量，可能会影响后续业务逻辑和造成内存泄露等问题。尽量在代理中使用

try-finally 块进行回收。

正例：

objectThreadLocal . set ( userInfo );

try {

// ...

} finally {

objectThreadLocal . remove ();

}

【强制】在使用尝试机制来获取锁的方式中，进入业务代码块之前，必须先判断当前线程是否持有锁。

锁的释放规则与锁的阻塞等待方式相同。

说明： Lock 对象的 unlock 方法在执行时，它会调用 AQS 的 tryRelease 方法（取决于具体实现类），如果当前线程不

持有锁，则抛出 IllegalMonitorStateException 异常。

正例：

Lock lock = new XxxLock ();

// ...

boolean isLocked = lock . tryLock ();

if ( isLocked ) {

try {

doSomething ();

doOthers ();

} finally {

lock . unlock ();

}

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

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

【推荐】资金相关的金融敏感信息，使用悲观锁策略。

说明：乐观锁在获得锁的同时已经完成了更新操作，校验逻辑容易出现漏洞，另外，乐观锁对冲突的解决策略有较复杂

的要求，处理不当容易造成系统压力或数据异常，所以资金相关的金融敏感信息不建议使用乐观锁更新。

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

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

直到超时才返回结果。

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

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

的性能下降。

说明： Random 实例包括 java.util.Random 的实例或者 Math.random() 的方式。

正例：在 JDK7 之后，可以直接使用 API ThreadLocalRandom，而在 JDK7 之前，需要编码保证每个线程持有一个

单独的 Random 实例

【推荐】通过双重检查锁（double-checked locking），实现延迟初始化需要将目标属性声明为

volatile 型，（比如修改 helper 的属性声明为 private volatile Helper helper = null;）。

正例：

public class LazyInitDemo {

private volatile Helper helper = null ;

public Helper getHelper () {

if ( helper == null ) {

synchronized ( this ) {

if ( helper == null ) {

helper = new Helper (); //new的过程并非原子操作

}

return helper ;

}

// other methods and fields...

}

【参考】 volatile 解决多线程内存不可见问题对于一写多读，是可以解决变量同步问题，但是如果多

写，同样无法解决线程安全问题。

说明：如果是 count++操作，使用如下类实现：

AtomicInteger count = new AtomicInteger();

count. addAndGet (1);

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

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

中注意规避此风险

【参考】 ThreadLocal 对象使用 static 修饰，ThreadLocal 无法解决共享对象的更新问题。

说明：这个变量是针对一个线程内所有操作共享的，所以设置为静态变量，所有此类实例共享此静态变量，也就是说在

类第一次被使用时装载，只分配一块存储空间，所有此类的对象（只要是这个线程内定义的）都可以操控这个变量

(八) 控制语句

【强制】三目运算符 condition ? 表达式 1：表达式 2 中，高度注意表达式 1 和 2 在类型对齐时，可能

抛出因自动拆箱导致的 NPE 异常。

说明：以下两种场景会触发类型对齐的拆箱操作：

1）表达式 1 或表达式 2 的值只要有一个是原始类型。

2）表达式 1 或表达式 2 的值的类型不一致，会强制拆箱升级成表示范围更大的那个类型。

反例：

Integer a = 1 ;

Integer b = 2 ;

Integer c = null ;

Boolean flag = false ;

// a*b 的结果是 int 类型，那么 c 会强制拆箱成 int 类型，抛出 NPE 异常

Integer result = ( flag ? a * b : c );

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

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

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

活动无法终止

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

if ( condition ) {

...

return obj ;

}

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

说明：如果非使用 if()...else if()...else...方式表达逻辑，避免后续代码维护困难，请勿超过 3 层。

正例：超过 3 层的 if-else 的逻辑判断代码可以使用卫语句、策略模式、状态模式等来实现，其中卫语句示例如下：

public void findBoyfriend ( Man man ) {

if ( man . isUgly ()) {

System . out . println ( "本姑娘是外貌协会的资深会员" );

return ;

} Java 开发手册（黄山版）

19/51

if ( man . isPoor ()) {

System . out . println ( "贫贱夫妻百事哀" );

return ;

}

if ( man . isBadTemper ()) {

System . out . println ( "银河有多远，你就给我滚多远" );

return ;

}

System . out . println ( "可以先交往一段时间看看" );

}

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

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

说明：很多 if 语句内的逻辑表达式相当复杂，与、或、取反混合运算，甚至各种方法纵深调用，理解成本非常高。如果赋

值一个非常好理解的布尔变量名字，则是件令人爽心悦目的事情。

正例：

// 伪代码如下

final boolean existed = ( file . open ( fileName, "w" ) != null ) && (...) || (...);

if ( existed ) {

...

}

反例：

public final void acquire ( long arg ) {

if ( ! tryAcquire ( arg ) && acquireQueued ( addWaiter ( Node . EXCLUSIVE ), arg )) {

selfInterrupt ();

}

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

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

正例：使用 if(x < 628) 来表达 x 小于 628。

反例：使用 if(!(x >= 628)) 来表达 x 小于 628。

(九) 注释规约

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

方式。

说明：在 IDE 编辑窗口中，Javadoc 方式会提示相关注释，生成 Javadoc 可以正确输出相应注释；在 IDE 中，工程调用

方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读效率

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

注释，注意与代码对齐

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

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

1）待办事宜（ TODO ）：（标记人，标记时间，[预计处理时间]）表示需要实现，但目前还未实现的功能。这实际上是

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

Javadoc 标签）。

2）错误，不能工作（ FIXME ）：（标记人，标记时间，[预计处理时间]）在注释中用 FIXME 标记某代码是错误的，而

且不能工作，需要及时纠正的情况。

(十) 前后端规约

【强制】前后端交互的 API，需要明确协议、域名、路径、请求方法、请求内容、状态码、响应体。

说明：

1）协议：生产环境必须使用 HTTPS。

2）路径：每一个 API 需对应一个路径，表示 API 具体的请求地址：

a）代表一种资源，只能为名词，推荐使用复数，不能为动词，请求方法已经表达动作意义。

b）URL 路径不能使用大写，单词如果需要分隔，统一使用下划线。

c）路径禁止携带表示请求内容类型的后缀，比如".json"，".xml"，通过 accept 头表达即可。

3）请求方法：对具体操作的定义，常见的请求方法如下：

a）GET：从服务器取出资源。

b）POST：在服务器新建一个资源。

c）PUT：在服务器更新资源。

d）DELETE：从服务器删除资源。

4）请求内容：URL 带的参数必须无敏感信息或符合安全要求；body 里带参数时必须设置 Content-Type。

5）响应体：响应体 body 可放置多种数据类型，由 Content-Type 头来确定。

【强制】前后端数据列表相关的接口返回，如果为空，则返回空数组[]或空集合{}。

说明：此条约定有利于数据层面上的协作更加高效，减少前端很多琐碎的 null 判断。

【强制】服务端发生错误时，返回给前端的响应信息必须包含 HTTP 状态码，errorCode、

errorMessage、用户提示信息四个部分。

说明：四个部分的涉众对象分别是浏览器、前端开发、错误排查人员、用户。其中输出给用户的提示信息要求：简短清

晰、提示友好，引导用户进行下一步操作或解释错误原因，提示信息可以包括错误原因、上下文环境、推荐操作等。

errorCode：参考

。errorMessage：简要描述后端出错原因，便于错误排查人员快速定位问题，注意不要包含敏

感数据信息。

正例：常见的 HTTP 状态码如下

1）200 OK：表明该请求被成功地完成，所请求的资源发送到客户端。 Java 开发手册（黄山版）

22/51

2）401 Unauthorized：请求要求身份验证，常见对于需要登录而用户未登录的情况。

3）403 Forbidden：服务器拒绝请求，常见于机密信息或复制其它登录用户链接访问服务器的情况。

4）404 NotFound：服务器无法取得所请求的网页，请求资源不存在。

5）500 InternalServerError：服务器内部错误

【强制】在前后端交互的 JSON 格式数据中，所有的 key 必须为小写字母开始的 lowerCamelCase

风格，符合英文表达习惯，且表意完整。

正例： errorCode / errorMessage / assetStatus / menuList / orderList / configFlag

反例： ERRORCODE / ERROR_CODE / error_message / error-message / errormessage

【强制】对于需要使用超大整数的场景，服务端一律使用 String 字符串类型返回，禁止使用 Long 类型。

说明： Java 服务端如果直接返回 Long 整型数据给前端，Javascript 会自动转换为 Number 类型（注：此类型为双精度浮

点数，表示原理与取值范围等同于 Java 中的 Double ）。Long 类型能表示的最大值是 2 63 -1，在取值范围之内，超过 2 53

（9007199254740992）的数值转化为 Javascript 的 Number 时，有些数值会产生精度损失。扩展说明，在 Long 取值范

围内，任何 2 的指数次的整数都是绝对不会存在精度损失的，所以说精度损失是一个概率问题。若浮点数尾数位与指数位

空间不限，则可以精确表示任何整数，但很不幸，双精度浮点数的尾数位只有 52 位。

反例：通常在订单号或交易号大于等于 16 位，大概率会出现前后端订单数据不一致的情况。

比如，后端传输的 "orderId"：362909601374617692，前端拿到的值却是：362909601374617660

【强制】 HTTP 请求通过 body 传递内容时，必须控制长度，超出最大长度后，后端解析会出错。

说明： nginx 默认限制是 1MB，tomcat 默认限制为 2MB，当确实有业务需要传较大内容时，可以调大服务器端的限制。

【推荐】服务器返回信息必须被标记是否可以缓存，如果缓存，客户端可能会重用之前的请求结果。

说明：缓存有利于减少交互次数，减少交互的平均延迟。

正例： http1.1 中，s-maxage 告诉服务器进行缓存，时间单位为秒，用法如下，

response.setHeader("Cache-Control", "s-maxage=" + cacheSeconds);

【推荐】服务端返回的数据，使用 JSON 格式而非 XML。

说明：尽管 HTTP 支持使用不同的输出格式，例如纯文本，JSON，CSV，XML，RSS 甚至 HTML。如果我们使用的面

向用户的服务，应该选择 JSON 作为通信中使用的标准数据交换格式，包括请求和响应。此外，application/JSON 是

一种通用的 MIME 类型，具有实用、精简、易读的特点。

【推荐】前后端的时间格式统一为"yyyy-MM-dd HH:mm:ss"，统一为 GMT。

(十一) 其他

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

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

【强制】避免用 ApacheBeanutils 进行属性的 copy。

说明： ApacheBeanUtils 性能较差，可以使用其他方案比如 SpringBeanUtils，CglibBeanCopier，注意均是浅拷贝。

【强制】 velocity 调用 POJO 类的属性时，直接使用属性名取值即可，模板引擎会自动按规范调用 POJO

的 getXxx()，如果是 boolean 基本数据类型变量（boolean 命名不需要加 is 前缀），会自动调 isXxx()

方法。

说明：注意如果是 Boolean 包装类对象，优先调用 getXxx() 的方法。

【强制】注意 Math.random() 这个方法返回是 double 类型，注意取值的范围 0 ≤ x < 1（能够

取到零值，注意除零异常），如果想获取整数类型的随机数，不要将 x 放大 10 的若干倍然后取

整，直接使用 Random 对象的 nextInt 或者 nextLong 方法

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

说明：对于垃圾代码或过时配置，坚决清理干净，避免程序过度臃肿，代码冗余。

正例：对于暂时被注释掉，后续可能恢复使用的代码片断，在注释代码上方，统一规定使用三个斜杠(///)

来说明注释掉代码的理由：

public static void hello () {

/// 业务方通知活动暂停

// Business business = new Business();

// business.active();

System . out . println ( "it's finished" );

}

二、异常日志

【强制】错误码为字符串类型，共 5 位，分成两个部分：错误产生来源+四位数字编号。

说明：错误产生来源分为 A/B/C，A 表示错误来源于用户，比如参数错误，用户安装版本过低，用户支付超时等问题；

B 表示错误来源于当前系统，往往是业务逻辑出错，或程序健壮性差等问题；C 表示错误来源于第三方服务，比如 CDN

服务出错，消息投递超时等问题；四位数字编号从 0001 到 9999，大类之间的步长间距预留 100，参考文末附表 3 。

(二) 异常处理

【强制】异常捕获后不要用来做流程控制，条件控制。

说明：异常设计的初衷是解决程序运行中的各种意外情况，且异常的处理效率比条件判断方式要低很多。

【强制】事务场景中，抛出异常被 catch 后，如果需要回滚，一定要注意手动回滚事务。

【强制】不要在 finally 块中使用 return

说明： try 块中的 return 语句执行成功后，并不马上返回，而是继续执行 finally 块中的语句，如果此处存在 return 语句，

则会在此直接返回，无情丢弃掉 try 块中的返回点。

反例：

private int x = 0 ;

public int checkReturn () {

try {

// x 等于 1，此处不返回

return ++ x ;

} finally {

// 返回的结果是 2

return ++ x ;

}

【强制】在调用 RPC 、二方包、或动态生成类的相关方法时，捕捉异常使用 Throwable 类进行拦截。

说明：通过反射机制来调用方法，如果找不到方法，抛出 NoSuchMethodException。什么情况会抛出

NoSuchMethodError 呢？二方包在类冲突时，仲裁机制可能导致引入非预期的版本使类的方法签名不匹配，或者在

字节码修改框架（比如：ASM）动态创建或修改类时，修改了相应的方法签名。这些情况，即使代码编译期是正确

的，但在代码运行期时，会抛出 NoSuchMethodError。

反例：足迹服务引入了高版本的 spring，导致运行到某段核心逻辑时，抛出 NoSuchMethodError 错误，catch 用的

类却是 Exception，堆栈向上抛，影响到上层业务。这是一个非核心功能点影响到核心应用的典型反例

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

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

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

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

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

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

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

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

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

【推荐】定义时区分 unchecked / checked 异常，避免直接抛出 new RuntimeException() ，更不允许

抛出 Exception 或者 Throwable ，应使用有业务含义的自定义异常。推荐业界已定义过的自定义异

常，如：DAOException / ServiceException 等

(三) 日志规约

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

JCL—Jakarta Commons Logging）中的 API，使用门面模式的日志框架，有利于维护和各个类的日志处理

方式统一。

说明：日志框架（SLF4J、JCL--Jakarta Commons Logging）的使用方式（推荐使用 SLF4J）

使用 SLF4J：

import org . slf4j . Logger ;

import org . slf4j . LoggerFactory ;

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

使用 JCL：

import org . apache . commons . logging . Log ;

import org . apache . commons . logging . LogFactory ;

private static final Log log = LogFactory . getLog ( Test . class );

【强制】日志文件至少保存 15 天，因为有些异常具备以“周”为频次发生的特点。对于当天日志，以

“应用名.log”来保存，保存在 /{统一目录}/{应用名}/logs/ 目录下，过往日志格式为：

{logname}.log.{保存日期}，日期格式：yyyy-MM-dd

正例：以 mppserver 应用为例，日志保存/home/admin/mppserver/logs/mppserver.log，历史日志名称

为 mppserver.log.2021-11-28

【强制】根据国家法律，网络运行状态、网络安全事件、个人敏感信息操作等相关记录，留存的日志不

少于六个月，并且进行网络多机备份

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

appName_logType_logName.log。logType：日志类型，如 stats / monitor / access 等；

logName：日志描述。这种命名的好处：通过文件名就可知道日志文件属于什么应用，什么类型，什

么目的，也有利于归类查找。

说明：推荐对日志进行分类，将错误日志和业务日志分开放，便于开发人员查看，也便于通过日志对系统进行及时监控。

正例： mppserver 应用中单独监控时区转换异常，如：mppserver_monitor_timeZoneConvert.log

【强制】在日志输出时，字符串变量之间的拼接使用占位符的方式。

说明：因为 String 字符串的拼接会使用 StringBuilder 的 append() 方式，有一定的性能损耗。使用占位符仅是替换动

作，可以有效提升性能。

正例： logger . debug ( "Processing trade with id : {} and symbol : {}" , id, symbol );

【强制】对于 trace / debug / info 级别的日志输出，必须进行日志级别的开关判断：

说明：虽然在 debug(参数) 的方法体内第一行代码 isDisabled(Level.DEBUG_INT) 为真时（Slf4j 的常见实现 Log4j 和

Logback），就直接 return，但是参数可能会进行字符串拼接运算。此外，如果 debug(getName()) 这种参数内有

getName() 方法调用，无谓浪费方法调用的开销。

正例：

// 如果判断为真，那么可以输出 trace 和 debug 级别的日志

if ( logger . isDebugEnabled ()) {

logger . debug ( "Current ID is: {} and name is: {}" , id, getName ());

}

【强制】避免重复打印日志，浪费磁盘空间，务必在日志配置文件中设置 additivity=false

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

【强制】生产环境禁止使用 System.out 或 System.err 输出或使用 e.printStackTrace() 打印异常堆栈。

说明：标准日志输出与标准错误输出文件每次 Jboss 重启时才滚动，如果大量输出送往这两个文件，容易造成文件大小

超过操作系统大小限制

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

throws 往上抛出。

正例： logger.error("inputParams: {} and errorMessage: {}", 各类参数或者对象 toString(), e.getMessage(), e);

【强制】日志打印时禁止直接用 JSON 工具将对象转换成 String。

说明：如果对象里某些 get 方法被覆写，存在抛出异常的情况，则可能会因为打印日志而影响正常业务流程的执行。

正例：打印日志时仅打印出业务相关属性值或者调用其对象的 toString() 方法。

【推荐】谨慎地记录日志。生产环境禁止输出 debug 日志；有选择地输出 info 日志；如果使用 warn

来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时

删除这些观察日志。

说明：大量地输出无效日志，不利于系统性能提升，也不利于快速定位错误点。记录日志时请思考：这些日志真的有

人看吗？看到这条日志你能做什么？能不能给问题排查带来好处？

【推荐】可以使用 warn 日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。如非

必要，请不要在此场景打出 error 级别，避免频繁报警。

说明：注意日志输出的级别，error 级别只记录系统逻辑出错、异常或者重要的错误信息

尽量用英文来描述日志错误信息，如果日志中的错误信息用英文描述不清楚的话使用中文描述

即可，否则容易产生歧义

说明：国际化团队或海外部署的服务器由于字符集问题，使用全英文来注释和描述日志错误信息。

【推荐】为了保护用户隐私，日志文件中的用户敏感信息需要进行脱敏处理。

说明：日志排查问题时，推荐使用订单号、UUID 之类的唯一编号进行查询。

三、单元测试

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

完全自动化才有意义。输出结果需要人工检查的测试不是一个好的单元测试。不准使用 System.out 来进

行人肉验证，单元测试必须使用 assert 来验证

【强制】对于单元测试，要保证测试粒度足够小，有助于精确定位问题。单测粒度至多是类级别，一般是

方法级别。

说明：测试粒度小才能在出错时尽快定位到出错的位置。单元测试不负责检查跨类或者跨系统的交互逻辑，那是集成测试

的领域。

【强制】单元测试代码必须写在如下工程目录： src/test/java，不允许写在业务代码目录下。

说明：源码编译时会跳过此目录，而单元测试框架默认是扫描此目录。

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

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

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

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

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

【推荐】对于数据库相关的查询，更新，删除等操作，不能假设数据库里的数据是存在的，或者直接操

作数据库把数据插入进去，请使用程序插入或者导入数据的方式来准备数据。

反例：删除某一行数据的单元测试，在数据库中，先直接手动增加一行作为删除目标，但是这一行新增数据并不符合业

务插入规则，导致测试结果异常。

【推荐】和数据库相关的单元测试，可以设定自动回滚机制，不给数据库造成脏数据。或者对单元测试

产生的数据有明确的前后缀标识。

正例：在基础技术部的内部单元测试中，使用 FOUNDATION_UNIT_TEST_的前缀来标识单元测试相关代码

四、安全规约

【强制】用户敏感数据禁止直接展示，必须对展示数据进行脱敏。

说明：中国大陆个人手机号码显示：139****1219，隐藏中间 4 位，防止隐私泄露

【强制】用户请求传入的任何参数必须做有效性验证。

说明：忽略参数校验可能导致：

⚫ 页面 page size 过大导致内存溢出

⚫ 恶意 order by 导致数据库慢查询

⚫ 缓存击穿

⚫ SSRF

⚫ 任意重定向

⚫ SQL 注入，Shell 注入，反序列化注入

⚫ 正则输入源串拒绝服务 ReDoS

扩展： Java 代码用正则来验证客户端的输入，有些正则写法验证普通用户输入没有问题，但是如果攻击人员使

用的是特殊构造的字符串来验证，有可能导致死循环的结果。

【强制】禁止向 HTML 页面输出未经安全过滤或未正确转义的用户数据。

说明： XSS 跨站脚本攻击。它指的是恶意攻击者往 Web 页面里插入恶意 html 代码，当用户浏览时，嵌入其中 Web 里

面的 html 代码会被执行，造成获取用户 cookie、钓鱼、获取用户页面数据、蠕虫、挂马等危害。

【强制】表单、AJAX 提交必须执行 CSRF 安全验证。

说明： CSRF (Cross-site request forgery) 跨站请求伪造是一类常见编程漏洞。对于存在 CSRF 漏洞的应用/网站，攻击

者可以事先构造好 URL，只要受害者用户一访问，后台便在用户不知情的情况下对数据库中用户参数进行相应修改

【强制】 URL 外部重定向传入的目标地址必须执行白名单过滤。

说明：攻击者通过恶意构造跳转的链接，可以向受害者发起钓鱼攻击。

【强制】在使用平台资源，譬如短信、邮件、电话、下单、支付，必须实现正确的防重放的机制，如数量

限制、疲劳度控制、验证码校验，避免被滥刷而导致资损。

说明：如注册时发送验证码到手机，如果没有限制次数和频率，那么可以利用此功能骚扰到其它用户，并造成短信平台

资源浪费。

【强制】对于文件上传功能，需要对于文件大小、类型进行严格检查和控制。

说明：攻击者可以利用上传漏洞，上传恶意文件到服务器，并且远程执行，达到控制网站服务器的目的

【强制】配置文件中的密码需要加密

【推荐】发贴、评论、发送等即时消息，需要用户输入内容的场景。必须实现防刷、内容违禁词过滤等

风控策略。

五、MySQL 数据库

(一) 建表规约

(二) 索引规约

(三) SQL 语句

(四) ORM 映射

六、工程结构

(一) 应用分层

(二) 二方库依赖

(三) 服务器

七、设计规约

附 1：版本历史

附 2：专有名词解释

附 3：错误码列表

Java开发手册(黄山版)

猜你喜欢