good-code-smell

好的代码习惯（部分摘自Java开发手册-黄山版）

Java方法签名包括两部分：方法名和参数列表。

参考文献

• 使用【unknow】去跟踪不太理解的点
• 使用【important】去跟踪比较重要的点

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

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

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

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

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

【强制】相同参数类型，相同业务含义，才可以使用的可变参数，参数类型避免定义为Object。 说明：可变参数必须放置在参数列表的最后。（建议开发者尽量不用可变参数编程）

正例：public List<User> listUsers(String type, Long... ids) {...}

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

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

说明：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进行判断。

说明：浮点数采用“尾数+阶码”的编码方式，类似于科学计数法的“有效数字+指数”的表示方式。二进制无法精确表示大部分的十进制小数，具体原理参考《码出高效》。

反例：

代码详情

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()；但是这个属性在数据提取时并没有置入具体值，在更新其它字段时又附带更新了此字段，导致创建时间被修改成当前时间。

【强制】构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在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);

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

正例：

代码详情

public int method(int param);
protected double method(int param1, int param2);
private void method();

【推荐】类内方法定义的顺序依次是：公有方法或保护方法 > 私有方法 > 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对象，造成内存资源浪费。

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

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

2）不允许修改引用的域对象，如：POJO类的域变量。

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

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

5）避免上下文重复使用一个变量，使用final关键字可以强制重新定义一个变量，方便更好地进行重构。

【推荐】慎用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类。

正例：

代码详情

// 获取今年的天数
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);

【推荐】避免公历闰年2月问题。闰年的2月份有29天，一年后的那一天不可能是2月29日。

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

【强制】关于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的处理策略。

正例：

代码详情

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));

【unknow】【强制】在使用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异常。

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

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

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

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

正例：

代码详情

List<String> list = new ArrayList<>(2);
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隐患。

【强制】使用Collection接口任何实现类的addAll() 方法时，要对输入的集合参数进行NPE判断。

说明：在ArrayList#addAll方法的第一行代码即Object[] a = c.toArray()；其中c为输入集合参数，如果为null， 则直接抛出异常。

【强制】使用工具类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中的元素也会随之修改，反之亦然。

【unknow】【强制】泛型通配符<? extends T>来接收返回的数据，此写法的泛型集合不能使用add方法， 而<? super T>不能使用get方法，两者在接口调用赋值的场景中容易出错。

说明：扩展说一下PECS(Producer Extends Consumer Super) 原则，即频繁往外读取内容的，适合用 <? extends T>，经常往里插入的，适合用<? super T>

【unknow】【强制】在无泛型限制定义的集合赋值给泛型限制的集合时，在使用集合元素时，需要进行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);

【unknow】【强制】不要在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”会是同样的结果吗？

会报错java.util.ConcurrentModificationException

【unknow】【强制】在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;
    }
};

【推荐】泛型集合使用时，在JDK7及以上，使用diamond语法或全省略。 说明：菱形泛型，即diamond，直接使用<>来指代前边已经指定的类型。

正例：

代码详情

// diamond方式，即<>
HashMap<String, String> userCache = new HashMap<>(16);

// 全省略方式
ArrayList<User> users = new ArrayList(10);

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

说明：HashMap使用构造方法HashMap(int initialCapacity) 进行初始化时，如果暂时无法确定集合大小，那么指定默认值（16）即可。

正例：initialCapacity = (需要存储的元素个数 / 负载因子) + 1。注意负载因子（即loaderfactor）默认为0.75，如果暂时无法确定初始值大小，请设置为16（即默认值）。

反例：HashMap需要放置1024个元素，由于没有设置容量初始大小，随着元素增加而被迫不断扩容，resize() 方法总共会调用8次，反复重建哈希表和数据迁移。当放置的集合元素个数达千万级时会影响程序性能。

为什么负载因子的默认值是0.75？

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

【推荐】高度注意Map类集合K / V能不能存储null值的情况，如下表格：

集合类	Key	Value	Super	说明
Hashtable	不允许为null	不允许为null	Dictionary	线程安全
TreeMap	不允许为null	允许为null	AbstractMap	线程不安全
ConcurrentHashMap	不允许为null	不允许为null	AbstractMap	锁分段技术（JDK8:CAS）
HashMap	允许为null	允许为null	AbstractMap	线程不安全

反例：由于HashMap的干扰，很多人认为ConcurrentHashMap是可以置入null值，而事实上，存储null值时会抛出NPE异常。

【参考】合理利用好集合的有序性（sort）和稳定性（order），避免集合的无序性（unsort）和不稳定性（unorder）带来的负面影响。

说明：有序性是指遍历的结果是按某种比较规则依次排列的，稳定性指集合每次遍历的元素次序是一定的。如：ArrayList是order / unsort；HashMap是unorder / unsort；TreeSet是order / sort。

【参考】利用Set元素唯一的特性，可以快速对一个集合进行去重操作，避免使用List的contains() 进行遍历去重或者判断包含操作。

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

说明：资源驱动类、工具类、单例工厂类都需要注意。

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

正例：自定义线程工厂，并且根据外部特征进行分组，比如，来自同一机房的调用，把机房编号赋值给whatFeatureOfGroup：

代码详情

public class UserThreadFactory implements ThreadFactory {
    private final String namePrefix;
    private final AtomicInteger nextId = new AtomicInteger(1);
        // 定义线程组名称，在利用jstack来排查问题时，非常有帮助
        UserThreadFactory(String whatFeatureOfGroup) {
        namePrefix = "FromUserThreadFactory's" + whatFeatureOfGroup + "-Worker-";
    }
    @Override
    public Thread newThread(Runnable task) {
        String name = namePrefix + nextId.getAndIncrement();
        Thread thread = new Thread(null, task, name, 0, false);
        System.out.println(thread.getName());
        return thread;
    }
}

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

说明：线程池的好处是减少在创建和销毁线程上所消耗的时间以及系统资源的开销，解决资源不足的问题。如果不使用线程池，有可能造成系统创建大量同类线程而导致消耗完内存或者“过度切换”的问题。

【强制】线程池不允许使用Executors去创建，而是通过ThreadPoolExecutor的方式，这样的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。

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

1）FixedThreadPool和SingleThreadPool：

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

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

3）ScheduledThreadPool：

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

【强制】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();
}

【强制】高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁；能锁区块，就不要锁整个方法体；能用对象锁，就不要用类锁。

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

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

说明：线程一需要对表A、B、C依次全部加锁后才可以进行更新操作，那么线程二的加锁顺序也必须是A、B、C，否则可能出现死锁。

【unknow】【强制】在使用阻塞等待获取锁的方式中，必须在try代码块之外，并且在加锁方法与try代码块之间没有任何可能抛出异常的方法调用，避免加锁成功后，在finally中无法解锁。

说明一：在lock方法与try代码块之间的方法调用抛出异常，无法解锁，造成其它线程无法成功获取锁。

说明二：如果lock方法在try代码块之内，可能由于其它方法抛出异常，导致在finally代码块中，unlock对未加锁的对象解锁，它会调用AQS的tryRelease方法（取决于具体实现类），抛出IllegalMonitorStateException异常。

说明三：在Lock对象的lock方法实现中可能抛出unchecked异常，产生的后果与说明二相同。

正例：

代码详情

Lock lock = new XxxLock();
// ...
lock.lock();
try {
    doSomething();
    doOthers();
} finally {
    lock.unlock();
}

反例：

代码详情

    Lock lock = new XxxLock();
// ...
try {
    // 如果此处抛出异常，则直接执行finally代码块
    doSomething();
    // 无论加锁是否成功，finally代码块都会执行
    lock.lock();
    doOthers();
} finally {
    lock.unlock();
}

【unknow】【强制】在使用尝试机制来获取锁的方式中，进入业务代码块之前，必须先判断当前线程是否持有锁。锁的释放规则与锁的阻塞等待方式相同。

说明：Lock对象的unlock方法在执行时，它会调用AQS的tryRelease方法（取决于具体实现类），如果当前线程不持有锁，则抛出IllegalMonitorStateException异常。

正例：

代码详情

Lock lock = new XxxLock();
// ...
boolean isLocked = lock.tryLock();
if (isLocked) {
    try {
        doSomething();
        doOthers();
    } finally {
        lock.unlock();
    }
}

【unknow】【强制】并发修改同一记录时，避免更新丢失，需要加锁。要么在应用层加锁，要么在缓存加锁，要么在数据库层使用乐观锁，使用version作为更新依据。

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

【unknow】【强制】多线程并行处理定时任务时，Timer运行多个TimeTask时，只要其中之一没有捕获抛出的异常，其它任务便会自动终止运行，使用ScheduledExecutorService则没有这个问题。

package java.util.concurrent;

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

说明：乐观锁在获得锁的同时已经完成了更新操作，校验逻辑容易出现漏洞，另外，乐观锁对冲突的解决策略有较复杂的要求，处理不当容易造成系统压力或数据异常，所以资金相关的金融敏感信息不建议使用乐观锁更新。

正例：悲观锁遵循一锁二判三更新四释放的原则。

【unknow】【推荐】使用CountDownLatch进行异步转同步操作，每个线程退出前必须调用countDown方法，线程执行代码注意catch异常，确保countDown方法被执行到，避免主线程无法执行至await方法，直到超时才返回结果。

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

【unknow】【推荐】避免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();
                }
            }
        }
        return helper;
    }
    // other methods and fields...
}

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

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

代码详情

AtomicInteger count = new AtomicInteger(); 
count.addAndGet(1); 

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

【unknow】【参考】HashMap在容量不够进行resize时由于高并发可能出现死链，导致CPU飙升，在开发过程中注意规避此风险。

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

说明：这个变量是针对一个线程内所有操作共享的，所以设置为静态变量，所有此类实例共享此静态变量，也就是说在类第一次被使用时装载，只分配一块存储空间，所有此类的对象（只要是这个线程内定义的）都可以操控这个变量。

【强制】在一个switch块内，每个case要么通过continue / break / return等来终止，要么注释说明程序将继续执行到哪一个case为止；在一个switch块内，都必须包含一个default语句并且放在最后，即使它什么代码也没有。

说明：注意break是退出switch语句块，而return是退出方法体。

【强制】当switch括号内的变量类型为String并且此变量为外部参数时，必须先进行null判断。

代码详情

public class SwitchString {
    public static void main(String[] args) {
        method(null);
    }
    public static void method(String param) {
        switch (param) {
            // 肯定不是进入这里
            case "sth":
                System.out.println("it's sth");
            break;
            // 也不是进入这里
            case "null":
                System.out.println("it's null");
            break;
            // 也不是进入这里
            default:
                System.out.println("default");
        }
    }
}

Java中switch参数传null会引起异常

【强制】在if / else / for / while / do语句中必须使用大括号。

反例： if (condition) statements;

说明：即使只有一行代码，也要采用大括号的编码方式。

【强制】三目运算符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;
}

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();
    }
}

【推荐】不要在其它表达式（尤其是条件表达式）中，插入赋值语句。

说明：赋值点类似于人体的穴位，对于代码的理解至关重要，所以赋值语句需要清晰地单独成为一行。

反例：

代码详情

public Lock getLock(boolean fair) {
    // 算术表达式中出现赋值操作，容易忽略count值已经被改变
    threshold = (count = Integer.MAX_VALUE) - 1;
    // 条件表达式中出现赋值操作，容易误认为是sync == fair
    return (sync = fair) ? new FairSync() : new NonfairSync();
}

【推荐】循环体中的语句要考量性能，以下操作尽量移至循环体外处理，如定义对象、变量、获取数据库连接，进行不必要的try-catch操作（这个try-catch是否可以移至循环体外）。

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

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

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

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

【推荐】公开接口需要进行入参保护，尤其是批量操作的接口。

反例：某业务系统，提供一个用户批量查询的接口，API文档上有说最多查多少个，但接口实现上没做任何保护，导致调用方传了一个1000的用户id数组过来后，查询信息后，内存爆了。

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

1）调用频次低的方法。

2）执行时间开销很大的方法。此情形中，参数校验时间几乎可以忽略不计，但如果因为参数错误导致中间执行回退，或者错误，那得不偿失。

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

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

5）敏感权限入口。

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

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

2）底层调用频度比较高的方法。毕竟是像纯净水过滤的最后一道，参数错误不太可能到底层才会暴露问题。一般DAO层与Service层都在同一个应用中，部署在同一台服务器中，所以DAO的参数校验，可以省略。

3）被声明成private只会被自己代码所调用的方法，如果能够确定调用方法的代码传入参数已经做过检查或者肯定不会有问题，此时可以不校验参数。

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

说明：在IDE编辑窗口中，Javadoc方式会提示相关注释，生成Javadoc可以正确输出相应注释；在IDE中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读效率。

【强制】所有的抽象方法（包括接口中的方法）必须要用Javadoc注释、除了返回值、参数异常说明外，还必须指出该方法做什么事情，实现什么功能。

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

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

说明：在设置模板时，注意IDEA的@author为${USER}，而eclipse的@author为${user}，大小写有区别，而日期的设置统一为yyyy/MM/dd的格式。

正例：

代码详情

/**
*
* @author yangguanbao
* @date 2021/11/26
*
**/

【强制】方法内部单行注释，在被注释语句上方另起一行，使用 // 注释。方法内部多行注释使用 / / 注释，注意与代码对齐。

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

【推荐】与其用半吊子英文来注释，不如用中文注释说清楚。专有名词与关键字保持英文原文即可。

反例：“TCP连接超时”解释成“传输控制协议连接超时”，理解反而费脑筋。

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

说明：代码与注释更新不同步，就像公路网与导航软件更新不同步一样，如果导航软件严重滞后，就失去了导航的意义。

【推荐】在类中删除未使用的任何字段和方法、内部类；在方法中删除未使用的参数声明与内部变量。

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

说明：代码被注释掉有两种可能性：1）后续会恢复此段代码逻辑。2）永久不用。前者如果没有备注信息，难以知晓注释动机。后者建议直接删掉即可，假如需要查阅历史代码，登录代码仓库即可。

【参考】对于注释的要求：第一、能够准确反映设计思想和代码逻辑；第二、能够描述业务含义，使别的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者形同天书，注释是给自己看的，即使隔很长时间，也能清晰理解当时的思路；注释也是给继任者看的，使其能够快速接替自己的工作。

【参考】好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现注释的另一个极端：过多过滥的注释，代码的逻辑一旦修改，修改注释又是相当大的负担。

反例：

代码详情

// put elephant into fridge
put(elephant, fridge);

方法名put，加上两个有意义的变量名称elephant和fridge，已经说明了这是在干什么，语义清晰的代码不需要额外的注释。

【参考】特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描，经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。

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：表明该请求被成功地完成，所请求的资源发送到客户端。

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

【强制】errorMessage是前后端错误追踪机制的体现，可以在前端输出到type=”hidden” 文字类控件中，或者用户端的日志中，帮助我们快速地定位出问题。

【强制】对于需要使用超大整数的场景，服务端一律使用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请求通过URL传递参数时，不能超过2048字节。

说明：不同浏览器对于URL的最大长度限制略有不同，并且对超出最大长度的处理逻辑也有差异，2048字节是取所有浏览器的最小值。

反例：某业务将退货的商品id列表放在URL中作为参数传递，当一次退货商品数量过多时，URL参数超长，传递到后端的参数被截断，导致部分商品未能正确退货。

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

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

【强制】在翻页场景中，用户输入参数的小于1，则前端返回第一页参数给后端；后端发现用户输入的参数大于总页数，直接返回最后一页。

【unknow】【强制】服务器内部重定向必须使用forward；外部重定向地址必须使用URL统一代理模块生成，否则会因线上采用HTTPS协议而导致浏览器提示“不安全”，并且还会带来URL维护不一致的问题。

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

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

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

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

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

说明：尽管HTTP支持使用不同的输出格式，例如纯文本，JSON，CSV，XML，RSS甚至HTML。如果我们使用的面向用户的服务，应该选择JSON作为通信中使用的标准数据交换格式，包括请求和响应。此外，application/JSON是一种通用的MIME类型，具有实用、精简、易读的特点。

【unknow】【参考】在接口路径中不要加入版本号，版本控制在HTTP头信息中体现，有利于向前兼容。

说明：当用户在低版本与高版本之间反复切换工作时，会导致迁移复杂度升高，存在数据错乱风险。

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

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

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

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

深拷贝的方式总结：

• java中关于深拷贝的几种方式总结
• Java对象深拷贝详解（List深拷贝）

【强制】velocity调用POJO类的属性时，直接使用属性名取值即可，模板引擎会自动按规范调用POJO 的getXxx()，如果是boolean基本数据类型变量（boolean命名不需要加is前缀），会自动调isXxx() 方法。

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

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

说明：如果var等于null或者不存在，那么 ${var} 会直接显示在页面上。

【强制】注意Math.random() 这个方法返回是double类型，注意取值的范围0 ≤ x < 1（能够取到零值，注意除零异常），如果想获取整数类型的随机数，不要将x放大10的若干倍然后取整，直接使用Random对象的nextInt或者nextLong方法。

【强制】枚举enum（括号内）的属性字段必须是私有且不可变。

【推荐】不要在视图模板中加入任何复杂的逻辑运算。

说明：根据MVC理论，视图的职责是展示，不要抢模型和控制器的活。

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

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

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

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

代码详情

public static void hello() {
/// 业务方通知活动暂停
// Business business = new Business();
// business.active();
System.out.println("it's finished");
}

错误日志

错误码

【强制】错误码的制定原则：快速溯源、沟通标准化。

说明：错误码想得过于完美和复杂，就像康熙字典的生僻字一样，用词似乎精准，但是字典不容易随身携带且简单易懂。

正例：错误码回答的问题是谁的错？错在哪？

1）错误码必须能够快速知晓错误来源，可快速判断是谁的问题。

2）错误码必须能够进行清晰地比对（代码中容易equals）。

3）错误码有利于团队快速对错误原因达到一致认知。

【强制】错误码不体现版本号和错误等级信息。

说明：错误码以不断追加的方式进行兼容。错误等级由日志和错误码本身的释义来决定。

【强制】全部正常，但不得不填充错误码时返回五个零：00000。

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

说明：错误产生来源分为A/B/C，A表示错误来源于用户，比如参数错误，用户安装版本过低，用户支付超时等问题；B表示错误来源于当前系统，往往是业务逻辑出错，或程序健壮性差等问题；C表示错误来源于第三方服务，比如CDN服务出错，消息投递超时等问题；四位数字编号从0001到9999，大类之间的步长间距预留100。

【强制】编号不与公司业务架构，更不与组织架构挂钩，以先到先得的原则在统一平台上进行，审批生效，编号即被永久固定。

【强制】错误码使用者避免随意定义新的错误码。

说明：尽可能在原有错误码附表中找到语义相同或者相近的错误码在代码中使用即可。

【强制】错误码不能直接输出给用户作为提示信息使用。

说明：堆栈（stack_trace）、错误信息(error_message) 、错误码（error_code）、提示信息（user_tip）是一个有效关联并互相转义的和谐整体，但是请勿互相越俎代庖。

【推荐】错误码之外的业务信息由error_message来承载，而不是让错误码本身涵盖过多具体业务属性。

【推荐】在获取第三方服务错误码时，向上抛出允许本系统转义，由C转为B，并且在错误信息上带上原有的第三方错误码。

【参考】错误码分为一级宏观错误码、二级宏观错误码、三级宏观错误码。

说明：在无法更加具体确定的错误场景中，可以直接使用一级宏观错误码，分别是：A0001（用户端错误）、B0001（系统执行出错）、C0001（调用第三方服务出错）。

正例：调用第三方服务出错是一级，中间件错误是二级，消息服务出错是三级。

【参考】错误码的后三位编号与HTTP状态码没有任何关系。

【参考】错误码的后三位编号与HTTP状态码没有任何关系。

【参考】错误码有利于不同文化背景的开发者进行交流与代码协作。

说明：英文单词形式的错误码不利于非英语母语国家（如阿拉伯语、希伯来语、俄罗斯语等）之间的开发者互相协作。

【参考】错误码即人性，感性认知+口口相传，使用纯数字来进行错误码编排不利于感性记忆和分类。

说明：数字是一个整体，每位数字的地位和含义是相同的。

反例：一个五位数字12345，第1位是错误等级，第2位是错误来源，345是编号，人的大脑不会主动地拆开并分辨每位数字的不同含义。

异常处理

【强制】Java类库中定义的可以通过预检查方式规避的RuntimeException异常不应该通过catch的方 式来处理，比如：NullPointerException，IndexOutOfBoundsException等等。

说明：无法通过预检查的异常除外，比如，在解析字符串形式的数字时，可能存在数字格式错误，不得不通过catch NumberFormatException来实现。

正例：if (obj != null) {…}

反例：try { obj.method(); } catch (NullPointerException e) {…}

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

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

【强制】catch时请分清稳定代码和非稳定代码，稳定代码指的是无论如何不会出错的代码。对于非稳定代码的catch尽可能进行区分异常类型，再做对应的异常处理。

说明：对大段代码进行try-catch，使程序无法根据不同的异常做出正确的应激反应，也不利于定位问题，这是一种不负责任的表现。

正例：用户注册的场景中，如果用户输入非法字符，或用户名称已存在，或用户输入密码过于简单，在程序上作出分门别类的判断，并提示给用户。

【强制】捕获异常是为了处理它，不要捕获了却什么都不处理而抛弃之，如果不想处理它，请将该异常抛给它的调用者。最外层的业务使用者，必须处理异常，将其转化为用户可以理解的内容。

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

【强制】finally块必须对资源对象、流对象进行关闭，有异常也要做try-catch。

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

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

说明：try块中的return语句执行成功后，并不马上返回，而是继续执行finally块中的语句，如果此处存在return语句，则会在此直接返回，无情丢弃掉try块中的返回点。

反例：

代码详情

private int x = 0;
public int checkReturn() {
    try {
        // x等于1，此处不返回
        return ++x;
    } finally {
        // 返回的结果是2
        return ++x;
    }
}

【强制】捕获异常与抛异常，必须是完全匹配，或者捕获异常是抛异常的父类。

说明：如果预期对方抛的是绣球，实际接到的是铅球，就会产生意外情况。

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

说明：通过反射机制来调用方法，如果找不到方法，抛出NoSuchMethodException。什么情况会抛出NoSuchMethodError呢？二方包在类冲突时，仲裁机制可能导致引入非预期的版本使类的方法签名不匹配，或者在字节码修改框架（比如：ASM）动态创建或修改类时，修改了相应的方法签名。这些情况，即使代码编译期是正确的，但在代码运行期时，会抛出NoSuchMethodError。

反例：足迹服务引入了高版本的spring，导致运行到某段核心逻辑时，抛出NoSuchMethodError错误，catch用的类却是Exception，堆栈向上抛，影响到上层业务。这是一个非核心功能点影响到核心应用的典型反例。

【推荐】方法的返回值可以为null，不强制返回空集合，或者空对象等，必须添加注释充分说明什么情况下会返回null值。

说明：本规约明确防止NPE是调用者的责任。即使被调用方法返回空集合或者空对象，对调用者来说，也并非高枕无忧，必须考虑到远程调用失败，运行时异常等场景返回null的情况。

【推荐】防止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等。

【参考】对于公司外的http / api开放接口必须使用错误码，而应用内部推荐异常抛出；跨应用间RPC调用优先考虑使用Result方式，封装isSuccess() 方法、错误码、错误简短信息；应用内部推荐异常抛出。

说明：关于RPC方法返回方式使用Result方式的理由：

1）使用抛异常返回方式，调用方如果没有捕获到就会产生运行时错误。

2）如果不加栈信息，只是new自定义异常，加入自己的理解的error message，对于调用端解决问题的帮助不会太多。如果加了栈信息，在频繁调用出错的情况下，数据序列化和传输的性能损耗也是问题。

日志规约

【强制】应用中不可直接使用日志系统（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标签中additivity属性

【强制】生产环境禁止使用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之类的唯一编号进行查询。

单元测试

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

说明：单元测试在线上运行时，感觉像空气（AIR）一样感觉不到，但在测试质量的保障上，却是非常关键的。好的单元测试宏观上来说，具有自动化、独立性、可重复执行的特点。

⚫ A：Automatic（自动化）

⚫ I：Independent（独立性）

⚫ R：Repeatable（可重复）

【强制】单元测试应该是全自动执行的，并且非交互式的。测试用例通常是被定期执行的，执行过程必须完全自动化才有意义。输出结果需要人工检查的测试不是一个好的单元测试。不允许使用System.out来进行人肉验证，单元测试必须使用assert来验证。

【强制】保持单元测试的独立性。为了保证单元测试稳定可靠且便于维护，单元测试用例之间决不能互相调用，也不能依赖执行的先后次序。

反例：method2需要依赖method1的执行，将执行结果作为method2的输入。

【强制】单元测试是可以重复执行的，不能受到外界环境的影响。

说明：单元测试通常会被放到持续集成中，每次有代码push时单元测试都会被执行。如果单测对外部环境（网络、服务、中间件等）有依赖，容易导致持续集成机制的不可用。

正例：为了不受外界环境影响，要求设计代码时就把SUT（Software under test）的依赖改成注入，在测试时用Spring这样的DI框架注入一个本地（内存）实现或者Mock实现。

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

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

【强制】核心业务、核心应用、核心模块的增量代码确保单元测试通过。

说明：新增代码及时补充单元测试，如果新增代码影响了原有单元测试，请及时修正。

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

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

【推荐】单测的基本目标：语句覆盖率达到70%；核心模块的语句覆盖率和分支覆盖率都要达到100%

说明：在工程规约的应用分层中提到的DAO层，Manager层，可重用度高的Service，都应该进行单元测试。

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

⚫ B：Border，边界值测试，包括循环边界、特殊取值、特殊时间点、数据顺序等。
⚫ C：Correct，正确的输入，并得到预期的结果。
⚫ D：Design，与设计文档相结合，来编写单元测试。
⚫ E：Error，强制错误信息输入（如：非法数据、异常流程、业务允许外等），并得到预期的结果。

【推荐】对于数据库相关的查询，更新，删除等操作，不能假设数据库里的数据是存在的，或者直接操作数据库把数据插入进去，请使用程序插入或者导入数据的方式来准备数据

反例：删除某一行数据的单元测试，在数据库中，先直接手动增加一行作为删除目标，但是这一行新增数据并不符合业务插入规则，导致测试结果异常。

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

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

【推荐】对于不可测的代码在适当的时机做必要的重构，使代码变得可测避免为了达到测试要求而书写不规范测试代码。

【推荐】在设计评审阶段，开发人员需要和测试人员一起确定单元测试范围，单元测试最好覆盖所有测试用例（UC）。

【推荐】单元测试作为一种质量保障手段，在项目提测前完成单元测试，不建议项目发布后补充单元测试用例。

【参考】为了更方便地进行单元测试，业务代码应避免以下情况：

⚫ 构造方法中做的事情过多。

⚫ 存在过多的全局变量和静态方法。

⚫ 存在过多的外部依赖。

⚫ 存在过多的条件语句。

说明：多层条件语句建议使用卫语句、策略模式、状态模式等方式重构。

【参考】不要对单元测试存在如下误解：

⚫ 那是测试同学干的事情。本文是开发手册，凡是本文内容都是与开发同学强相关的。

⚫ 单元测试代码是多余的。系统的整体功能与各单元部件的测试正常与否是强相关的。

⚫ 单元测试代码不需要维护。一年半载后，那么单元测试几乎处于废弃状态。

⚫ 单元测试与线上故障没有辩证关系。好的单元测试能够最大限度地规避线上故障。

安全规约

【强制】隶属于用户个人的页面或者功能必须进行权限控制校验。

说明：防止没有做水平权限校验就可随意访问、修改、删除别人的数据，比如查看他人的私信内容。

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

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

【强制】用户输入的SQL参数严格使用参数绑定或者METADATA字段值限定，防止SQL注入，禁止字符串拼接SQL访问数据库。

反例：某系统签名大量被恶意修改，即是因为对于危险字符#—没有进行转义，导致数据库更新时，where后边的信息被注释掉，对全库进行更新。

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

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

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

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

⚫ 缓存击穿

⚫ SSRF

⚫ 任意重定向

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

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

扩展：Java代码用正则来验证客户端的输入，有些正则写法验证普通用户输入没有问题，但是如果攻击人员使用的是特殊构造的字符串来验证，有可能导致死循环的结果。

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

说明：XSS跨站脚本攻击。它指的是恶意攻击者往Web页面里插入恶意html代码，当用户浏览时，嵌入其中Web里面的html代码会被执行，造成获取用户cookie、钓鱼、获取用户页面数据、蠕虫、挂马等危害。

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

说明：CSRF (Cross-site request forgery) 跨站请求伪造是一类常见编程漏洞。对于存在CSRF漏洞的应用/网站，攻击者可以事先构造好URL，只要受害者用户一访问，后台便在用户不知情的情况下对数据库中用户参数进行相应修改。

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

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

【unknow】【强制】在使用平台资源，譬如短信、邮件、电话、下单、支付，必须实现正确的防重放的机制，如数量限制、疲劳度控制、验证码校验，避免被滥刷而导致资损。

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

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

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

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

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

MySQL数据库

(一) 建表规约

【强制】表达是与否概念的字段，必须使用is_xxx的方式命名，数据类型是unsigned tinyint（1表示是，0表示否）。

注意：POJO类中的任何布尔类型的变量，都不要加is前缀，所以，需要在<resultMap>设置从is_xxx到Xxx的映射关系。数据库表示是与否的值，使用tinyint类型，坚持is_xxx的命名方式是为了明确其取值含义与取值范围。

说明：任何字段如果为非负数，必须是unsigned。

正例：表达逻辑删除的字段名is_deleted，1表示删除，0表示未删除。

【强制】表名、字段名必须使用小写字母或数字，禁止出现数字开头禁止两个下划线中间只出现数字。数据库字段名的修改代价很大，因为无法进行预发布，所以字段名称需要慎重考虑。

说明：MySQL在Windows下不区分大小写，但在Linux下默认是区分大小写。因此，数据库名、表名、字段名，都不允许出现任何大写字母，避免节外生枝。

正例：aliyun_admin，rdc_config，level3_name

反例：AliyunAdmin，rdcConfig，level_3_name

【强制】表名不使用复数名词。

说明：表名应该仅仅表示表里面的实体内容，不应该表示实体数量，对应于DO类名也是单数形式，符合表达习惯。

【强制】禁用保留字，如desc、range、match、delayed等，请参考MySQL官方保留字。

【强制】主键索引名为pk字段名；唯一索引名为uk字段名；普通索引名则为idx_字段名。

说明：pk即primary key；uk即unique key；idx_即index的简称。

【强制】小数类型为decimal，禁止使用float和double。

说明：在存储的时候，float和double都存在精度损失的问题，很可能在比较值的时候，得到不正确的结果。如果存储的数据范围超过decimal的范围，建议将数据拆成整数和小数并分开存储。

【强制】如果存储的字符串长度几乎相等，使用char定长字符串类型。

【强制】varchar是可变长字符串，不预先分配存储空间，长度不要超过5000，如果存储长度大于此值，定义字段类型为text，独立出来一张表，用主键来对应，避免影响其它字段索引率。

【强制】表必备三字段：id，create_time，update_time。

说明：其中id必为主键，类型为bigint unsigned、单表时自增、步长为1。create_time，update_time的类型均为datetime类型，如果要记录时区信息，那么类型设置为timestamp。

【强制】在数据库中不能使用物理删除操作，要使用逻辑删除。

说明：逻辑删除在数据删除后可以追溯到行为操作。不过会使得一些情况下的唯一主键变得不唯一，需要根据情况来酌情解决。

【推荐】表的命名最好是遵循“业务名称_表的作用”。

正例：alipay_task / force_project / trade_config / tes_question

【推荐】库名与应用名称尽量一致。

【推荐】如果修改字段含义或对字段表示的状态追加时，需要及时更新字段注释。

【推荐】字段允许适当冗余，以提高查询性能，但必须考虑数据一致。冗余字段应遵循：

1）不是频繁修改的字段。

2）不是唯一索引的字段。

3）不是varchar超长字段，更不能是text字段。

正例：各业务线经常冗余存储商品名称，避免查询时需要调用IC服务获取。

【unknow】【推荐】单表行数超过500万行或者单表容量超过2GB，才推荐进行分库分表。

说明：如果预计三年后的数据量根本达不到这个级别，请不要在创建表时就分库分表。

【参考】合适的字符存储长度，不但节约数据库表空间、节约索引存储，更重要的是提升检索速度。

正例：无符号值可以避免误存负数，且扩大了表示范围：

(二) 索引规约

【强制】业务上具有唯一特性的字段，即使是组合字段，也必须建成唯一索引。

说明：不要以为唯一索引影响了insert速度，这个速度损耗可以忽略，但提高查找速度是明显的；另外，即使在应用层做了非常完善的校验控制，只要没有唯一索引，根据墨菲定律，必然有脏数据产生。

【强制】超过三个表禁止join。需要join的字段，数据类型保持绝对一致；多表关联查询时，保证被关联的字段需要有索引。

说明：即使双表join也要注意表索引、SQL性能。

【强制】在varchar字段上建立索引时，必须指定索引长度，没必要对全字段建立索引，根据实际文本区分度决定索引长度。

说明：索引的长度与区分度是一对矛盾体，一般对字符串类型数据，长度为20的索引，区分度会高达90%以上，可以使用count(distinct left(列名，索引长度)) / count(*) 的区分度来确定。

【强制】页面搜索严禁左模糊或者全模糊，如果需要请走搜索引擎来解决。

说明：索引文件具有B-Tree的最左前缀匹配特性，如果左边的值未确定，那么无法使用此索引。

【unknown】【推荐】如果有order by的场景，请注意利用索引的有序性。order by最后的字段是组合索引的一部分，并且放在索引组合顺序的最后，避免出现filesort的情况，影响查询性能。

正例：where a = ? and b = ? order by c；索引：a_b_c

反例：索引如果存在范围查询，那么索引有序性无法利用，如：WHERE a > 10 ORDER BY b；索引a_b无法排序。

慢查询优化，filesort详细解析

【unknown】【推荐】利用覆盖索引来进行查询操作，避免回表。

说明：如果一本书需要知道第11章是什么标题，会翻开第11章对应的那一页吗？目录浏览一下就好，这个目录就是起到覆盖索引的作用。

正例：能够建立索引的种类分为主键索引、唯一索引、普通索引三种，而覆盖索引只是一种查询的一种效果，用explain的结果，extra列会出现：using index。

覆盖索引百度百科：所需字段就是索引

【推荐】利用延迟关联或者子查询优化超多分页场景。

说明：MySQL并不是跳过offset行，而是取offset+N行，然后返回放弃前offset行，返回N行，那当offset特别大的时候，效率就非常的低下，要么控制返回的总页数，要么对超过特定阈值的页数进行SQL改写。

正例：先快速定位需要获取的id段，然后再关联：

SELECT t1.* FROM表1 as t1 , (select id from表1 where条件LIMIT 100000 , 20) as t2 where t1.id = t2.id

【推荐】SQL性能优化的目标：至少要达到range级别，要求是ref级别，如果可以是const最好。

说明：

1）consts单表中最多只有一个匹配行（主键或者唯一索引），在优化阶段即可读取到数据。

2）ref指的是使用普通的索引（normal index）。

3）range对索引进行范围检索。

反例：explain表的结果，type = index，索引物理文件全扫描，速度非常慢，这个index级别比较range还低，与全表扫描是小巫见大巫。

参考文献

【unknown】【推荐】建组合索引的时候，区分度最高的在最左边。

正例：如果where a = ? and b = ?，a列的几乎接近于唯一值，那么只需要单建idx_a索引即可。

说明：存在非等号和等号混合判断条件时，在建索引时，请把等号条件的列前置。如：where c > ? and d = ? 那么即使c的区分度更高，也必须把d放在索引的最前列，即建立组合索引idx_d_c。

具体的业务场景？

【推荐】防止因字段类型不同造成的隐式转换，导致索引失效。

【参考】创建索引时避免有如下极端误解：

1）索引宁滥勿缺。认为一个查询就需要建一个索引。

2）吝啬索引的创建。认为索引会消耗空间、严重拖慢记录的更新以及行的新增速度。

3）抵制唯一索引。认为唯一索引一律需要在应用层通过“先查后插”方式解决。

(三) SQL语句

【强制】不要使用count(列名) 或count(常量) 来替代count(*)，count(*) 是SQL92定义的标准统计行数的语法，跟数据库无关，跟NULL和非NULL无关。

说明：count(*) 会统计值为NULL的行，而count(列名) 不会统计此列为NULL值的行。

【强制】count(distinct col) 计算该列除NULL之外的不重复行数，注意count(distinct col1 , col2) 如果其中一列全为NULL，那么即使另一列有不同的值，也返回为0。

【强制】当某一列的值全是NULL时，count(col) 的返回结果为0；但sum(col) 的返回结果为NULL，因此使用sum() 时需注意NPE问题。

正例：可以使用如下方式来避免sum的NPE问题：SELECT IFNULL(SUM(column) , 0) FROM table;

【强制】使用ISNULL()来判断是否为NULL值。

说明：NULL与任何值的直接比较都为NULL。

1）NULL<>NULL的返回结果是NULL，而不是false。

2）NULL=NULL的返回结果是NULL，而不是true。

3）NULL<>1的返回结果是NULL，而不是true。 反例：在SQL语句中，如果在null前换行，影响可读性。 select * from table where column1 is null and column3 is not null；而ISNULL(column) 是一个整体，简洁易懂。从性能数据上分析，ISNULL(column) 执行效率更快一些。

【强制】代码中写分页查询逻辑时，若count为0应直接返回，避免执行后面的分页语句。

【强制】不得使用外键与级联，一切外键概念必须在应用层解决。

说明：（概念解释）学生表中的student_id是主键，那么成绩表中的student_id则为外键。如果更新学生表中的student_id，同时触发成绩表中的student_id更新，即为级联更新。外键与级联更新适用于单机低并发，不适合分布式、高并发集群；级联更新是强阻塞，存在数据库更新风暴的风险；外键影响数据库的插入速度。

【强制】禁止使用存储过程，存储过程难以调试和扩展，更没有移植性。

【强制】数据订正（特别是删除或修改记录操作）时，要先select，避免出现误删除的情况，确认无误才能执行更新语句。

【important】【强制】对于数据库中表记录的查询和变更，只要涉及多个表，都需要在列名前加表的别名（或表名）进行限定。

说明：对多表进行查询记录、更新记录、删除记录时，如果对操作列没有限定表的别名（或表名），并且操作列在多个表中存在时，就会抛异常。

正例：select t1.name from first_table as t1 , second_table as t2 where t1.id = t2.id;

反例：在某业务中，由于多表关联查询语句没有加表的别名（或表名）的限制，正常运行两年后，最近在某个表中增加一个同名字段，在预发布环境做数据库变更后，线上查询语句出现出1052异常： Column ‘name’ in field list is ambiguous。

【推荐】SQL语句中表的别名前加as，并且以t1、t2、t3、…的顺序依次命名。

说明：

1）别名可以是表的简称，或者是依照表在SQL语句中出现的顺序，以t1、t2、t3的方式命名。

2）别名前加as使别名更容易识别。

正例：select t1.name from first_table as t1 , second_table as t2 where t1.id = t2.id;

【推荐】in操作能避免则避免，若实在避免不了，需要仔细评估in后边的集合元素数量，控制在1000个之内。

【参考】因国际化需要，所有的字符存储与表示，均采用utf8mb4字符集，字符计数方法需要注意。

说明：

SELECT LENGTH(“轻松工作”)；—返回为12

SELECT CHARACTER_LENGTH(“轻松工作”)；—返回为4

表情需要用utf8mb4来进行存储，注意它与utf8编码的区别。

【参考】TRUNCATE TABLE比DELETE速度快，且使用的系统和事务日志资源少，但TRUNCATE无事务且不触发trigger，有可能造成事故，故不建议在开发代码中使用此语句。

说明：TRUNCATE TABLE在功能上与不带WHERE子句的DELETE语句相同。

(四) ORM映射

【强制】在表查询中，一律不要使用 * 作为查询的字段列表，需要哪些字段必须明确写明。

说明： 1）增加查询分析器解析成本。

2）增减字段容易与resultMap配置不一致。

3）无用字段增加网络消耗，尤其是text类型的字段。

【unknown】【强制】POJO类的布尔属性不能加is，而数据库字段必须加is_，要求在resultMap中进行字段与属性之间的映射。

说明：参见定义POJO类以及数据库字段定义规定，在sql.xml增加映射，是必须的。

怎么自动映射

【unknown】【强制】不要用resultClass当返回参数，即使所有类属性名与数据库字段一一对应，也需要定义；反过来，每一个表也必然有一个与之对应。

说明：配置映射关系，使字段与DO类解耦，方便维护。

啥意思？

【unknown】【强制】sql.xml配置参数使用：#{}，#param# 不要使用 ${} 此种方式容易出现SQL注入。

具体操作

【强制】iBATIS自带的queryForList(String statementName，int start，int size) 不推荐使用。

说明：其实现方式是在数据库取到statementName对应的SQL语句的所有记录，再通过subList取start，size的子集合，线上因为这个原因曾经出现过OOM。

代码详情

Map<String, Object> map = new HashMap<>(16);
map.put("start", start);
map.put("size", size);

【unknown】【强制】不允许直接拿HashMap与Hashtable作为查询结果集的输出。

反例：某同学为避免写一个<resultMap>xxx</resultMap>，直接使用Hashtable来接收数据库返回结果，结果出现日常是把bigint转成Long值，而线上由于数据库版本不一样，解析成BigInteger，导致线上问题。

【unknown】【强制】更新数据表记录时，必须同时更新记录对应的update_time字段值为当前时间。

感觉我也没有操作过update_time自动就是最新的

【推荐】不要写一个大而全的数据更新接口。传入为POJO类，不管是不是自己的目标更新字段，都进行update table set c1 = value1 , c2 = value2 , c3 = value3；这是不对的。执行SQL时，不要更新无改动的字段，一是易出错；二是效率低；三是增加binlog存储。

【参考】@Transactional事务不要滥用。事务会影响数据库的QPS，另外使用事务的地方需要考虑各方面的回滚方案，包括缓存回滚、搜索引擎回滚、消息补偿、统计修正等。

【参考】<isEqual>中的compareValue是与属性值对比的常量，一般是数字，表示相等时带上此条件；<isNotEmpty>表示不为空且不为null时执行；<isNotNull>表示不为null值时执行。

六、工程结构

(一) 应用分层

【参考】（分层异常处理规约）在DAO层，产生的异常类型有很多，无法用细粒度的异常进行catch，使用catch(Exception e) 方式，并throw new DAOException(e)，不需要打印日志，因为日志在Manager或Service层一定需要捕获并打印到日志文件中去，如果同台服务器再打日志，浪费性能和存储。在Service层出现异常时，必须记录出错日志到磁盘，尽可能带上参数和上下文信息，相当于保护案发现场。Manager层与Service同机部署，日志方式与DAO层处理一致，如果是单独部署，则采用与Service一致的处理方式。Web层绝不应该继续往上抛异常，因为已经处于顶层，如果意识到这个异常将导致页面无法正常渲染，那么就应该直接跳转到友好错误页面，尽量加上友好的错误提示信息。开放接口层要将异常处理成错误码和错误信息方式返回。

【参考】分层领域模型规约：

⚫ DO（Data Object）：此对象与数据库表结构一一对应，通过DAO层向上传输数据源对象。

⚫ DTO（Data Transfer Object）：数据传输对象，Service或Manager向外传输的对象。

⚫ BO（Business Object）：业务对象，可以由Service层输出的封装业务逻辑的对象。

⚫ Query：数据查询对象，各层接收上层的查询请求。注意超过2个参数的查询封装，禁止使用Map类来传输。

⚫ VO（View Object）：显示层对象，通常是Web向模板渲染引擎层传输的对象。

(二) 二方库依赖

【强制】定义GAV遵从以下规则：

1）GroupId格式：com.{公司/BU}.业务线.[子业务线]，最多4级。

说明：{公司/BU}例如：alibaba / taobao / tmall / kaikeba等BU一级；子业务线可选。

正例：com.taobao.jstorm或com.alibaba.dubbo.register

2）ArtifactId格式：产品线名-模块名。语义不重复不遗漏，先到中央仓库去查证一下。

正例：dubbo-client / fastjson-api / jstorm-tool

3）Version：详细规定参考下方。

【强制】二方库版本号命名方式：主版本号.次版本号.修订号

1）主版本号：产品方向改变，或者大规模API不兼容，或者架构不兼容升级。

2）次版本号：保持相对兼容性，增加主要功能特性，影响范围极小的API不兼容修改。

3）修订号：保持完全兼容性，修复BUG、新增次要功能特性等。

说明：注意起始版本号必须为：1.0.0，而不是0.0.1。

反例：仓库内某二方库版本号从1.0.0.0开始，一直默默“升级”成1.0.0.64，完全失去版本的语义信息。

【强制】线上应用不要依赖SNAPSHOT版本（安全包除外）；正式发布的类库必须先去中央仓库进行查证，使RELEASE版本号有延续性，且版本号不允许覆盖升级。

说明：不依赖SNAPSHOT版本是保证应用发布的幂等性。另外，也可以加快编译时的打包构建。

【强制】二方库的新增或升级，保持除功能点之外的其它jar包仲裁结果不变。如果有改变，必须明确评估和验证。

说明：在升级时，进行dependency:resolve前后信息比对，如果仲裁结果完全不一致，那么通过dependency:tree命令，找出差异点，进行<exclude>排除jar包。

【强制】二方库里可以定义枚举类型，参数可以使用枚举类型，但是接口返回值不允许使用枚举类型或者包含枚举类型的POJO对象。

【强制】二方库定制包的命名方式，在规定的版本号之后加“-英文说明[序号]”，英文说明可以是部门简称、业务名称，序号直接紧跟在英文说明之后，表示此定制包的顺序号。

说明：fastjson给SCM定制的版本号：1.0.0-SCM1。注：请尽可能在应用端来解决类冲突和加载问题，避免随意发布此 类定制包。

【强制】依赖于一个二方库群时，必须定义一个统一的版本变量，避免版本号不一致。

说明：依赖springframework-core，-context，-beans，它们都是同一个版本，可以定义一个变量来保存版本：${spring.version}，定义依赖的时候，引用该版本。

【强制】禁止在子项目的pom依赖中出现相同的GroupId，相同的ArtifactId，但是不同的Version。

说明：在本地调试时会使用各子项目指定的版本号，但是合并成一个war，只能有一个版本号出现在最后的lib目录中。曾经出现过线下调试是正确的，发布到线上却出故障的先例。

【推荐】底层基础技术框架、核心数据管理平台、或近硬件端系统谨慎引入第三方实现。

【unknown】【推荐】所有pom文件中的依赖声明放在<dependencies>语句块中，所有版本仲裁放在<dependencyManagement>语句块中。

说明：<dependencyManagement>里只是声明版本，并不实现引入，因此子项目需要显式的声明依赖，version和scope都读取自父pom。而<dependencies>所有声明在主pom的<dependencies>里的依赖都会自动引入，并默认被所有的子项目继承。

什么是版本仲裁？

【推荐】二方库不要有配置项，最低限度不要再增加配置项。

【推荐】不要使用不稳定的工具包或者Utils类。

说明：不稳定指的是提供方无法做到向下兼容，在编译阶段正常，但在运行时产生异常，因此，尽量使用业界稳定的二方工具包。

【参考】为避免应用二方库的依赖冲突问题，二方库发布者应当遵循以下原则：

1）精简可控原则。移除一切不必要的API和依赖，只包含Service API、必要的领域模型对象、Utils类、常量、枚举等。如果依赖其它二方库，尽量是provided引入，让二方库使用者去依赖具体版本号；无log具体实现，只依赖日志框架。

2）稳定可追溯原则。每个版本的变化应该被记录，二方库由谁维护，源码在哪里，都需要能方便查到。除非用户主动升级版本，否则公共二方库的行为不应该发生变化。

(三) 服务器

【强制】调用远程操作必须有超时设置。

说明：类似于HttpClient的超时设置需要自己明确去设置Timeout。根据经验表明，无数次的故障都是因为没有设置 超时时间。

【unknown】【推荐】客户端设置远程接口方法的具体超时时间（单位 ms），超时设置生效顺序一般为：

1）客户 端Special Method；

2）客户端接口级别；

3）服务端Special Method；

4）服务端接口级别。

什么是special method？

【推荐】高并发服务器建议调小TCP协议的time_wait超时时间。

说明：操作系统默认240秒后，才会关闭处于time_wait状态的连接，在高并发访问下，服务器端会因为处于time_wait的连接数太多，可能无法建立新的连接，所以需要在服务器上调小此等待值。

正例：在linux服务器上请通过变更/etc/sysctl.conf文件去修改该缺省值（秒）：net.ipv4.tcp_fin_timeout=30

【推荐】调大服务器所支持的最大文件句柄数（File Descriptor，简写为fd）

说明：主流操作系统的设计是将TCP / UDP连接采用与文件一样的方式去管理，即一个连接对应于一个fd。主流的linux 服务器默认所支持最大fd数量为1024，当并发连接数很大时很容易因为fd不足而出现“open too many files”错误， 导致新的连接无法建立。建议将linux服务器所支持的最大句柄数调高数倍（与服务器的内存数量相关）。

【推荐】给JVM环境参数设置-XX：+HeapDumpOnOutOfMemoryError参数，让JVM碰到OOM场景时输出dump信息。

说明：OOM的发生是有概率的，甚至相隔数月才出现一例，出错时的堆内信息对解决问题非常有帮助。

【推荐】在线上生产环境，JVM的Xms和Xmx设置一样大小的内存容量，避免在GC后调整堆大小带来的压力。

【推荐】了解每个服务大致的平均耗时，可以通过独立配置线程池，将较慢的服务与主线程池隔离开， 免得不同服务的线程同归于尽。

【参考】服务器内部重定向必须使用forward；外部部重定向地址必须使用URL Broker生成，否则因线上采用HTTPS协议而导致浏览器提示“不安全”。此外，还会带来URL维护不一致的问题。

设计规约

【强制】存储方案和底层数据结构的设计获得评审一致通过，并沉淀成为文档。

说明：有缺陷的底层数据结构容易导致系统风险上升，可扩展性下降，重构成本也会因历史数据迁移和系统平滑过渡而陡然增加，所以，存储方案和数据结构需要认真地进行设计和评审，生产环境提交执行后，需要进行double check。

正例：评审内容包括存储介质选型、表结构设计能否满足技术方案、存取性能和存储空间能否满足业务发展、表或字段之间的辩证关系、字段名称、字段类型、索引等；数据结构变更（如在原有表中新增字段）也需要在评审通过后上线。

【强制】在需求分析阶段，如果与系统交互的User超过一类并且相关的UseCase超过5个，使用用例图来表达更加清晰的结构化需求。

【强制】如果某个业务对象的状态超过3个，使用状态图来表达并且明确状态变化的各个触发条件。

说明：状态图的核心是对象状态，首先明确对象有多少种状态，然后明确两两状态之间是否存在直接转换关系，再明确触发状态转换的条件是什么。

正例：淘宝订单状态有已下单、待付款、已付款、待发货、已发货、已收货等。比如已下单与已收货这两种状态之间是不可能有直接转换关系的。

【强制】如果系统中某个功能的调用链路上的涉及对象超过3个，使用时序图来表达并且明确各调用环节的输入与输出。

说明：时序图反映了一系列对象间的交互与协作关系，清晰立体地反映系统的调用纵深链路。

【强制】如果系统中模型类超过5个，且存在复杂的依赖关系，使用类图来表达并且明确类之间的关系。

说明：类图像建筑领域的施工图，如果搭平房，可能不需要，但如果建造蚂蚁Z空间大楼，肯定需要详细的施工图。

【unknown】【强制】如果系统中超过2个对象之间存在协作关系，并需要表示复杂的处理流程，使用活动图来表示。

说明：活动图是流程图的扩展，增加了能够体现协作关系的对象泳道，支持表示并发等。

【强制】系统设计时要准确识别出弱依赖，并针对性地设计降级和应急预案，保证核心系统正常可用。

说明：系统依赖的第三方服务被降级或屏蔽后，依然不会影响主干流程继续进行，仅影响信息展示、或消息通知等非关键功能，那么这些服务称为弱依赖。 正例：当系统弱依赖于多个外部服务时，如果下游服务耗时过长，则会严重影响当前调用者，必须采取相应降级措施，比如，当调用链路中某个下游服务调用的平均响应时间或错误率超过阈值时，系统自动进行降级或熔断操作，屏蔽弱依赖负面影响，保护当前系统主干功能可用。

反例：某个疫情相关的二维码出错：“服务器开了点小差，请稍后重试”，不可用时长持续很久，引起社会高度关注，原因可能为调用的外部依赖服务RT过高而导致系统假死，而在显示端没有做降级预案，只能直接抛错给用户。

【推荐】系统架构设计时明确以下目标：

⚫ 确定系统边界。确定系统在技术层面上的做与不做。

⚫ 确定系统内模块之间的关系。确定模块之间的依赖关系及模块的宏观输入与输出。

⚫ 确定指导后续设计与演化的原则。使后续的子系统或模块设计在一个既定的框架内和技术方向上继续演化。

⚫ 确定非功能性需求。非功能性需求是指安全性、可用性、可扩展性等。

【推荐】需求分析与系统设计在考虑主干功能的同时，需要充分评估异常流程与业务边界。

【推荐】类在设计与实现时要符合单一原则。

说明：单一原则最易理解却是最难实现的一条规则，随着系统演进，很多时候，忘记了类设计的初衷。

【推荐】谨慎使用继承的方式来进行扩展，优先使用聚合/组合的方式来实现。

说明：不得已使用继承的话，必须符合里氏代换原则，此原则说父类能够出现的地方子类一定能够出现，比如，“把钱交出来”，钱的子类美元、欧元、人民币等都可以出现。

【unknown】【推荐】系统设计阶段，根据依赖倒置原则，尽量依赖抽象类与接口，有利于扩展与维护。

说明：低层次模块依赖于高层次模块的抽象，方便系统间的解耦。

【推荐】系统设计阶段，注意对扩展开放，对修改闭合。

说明：极端情况下，交付的代码是不可修改的，同一业务域内的需求变化，通过模块或类的扩展来实现。

【推荐】系统设计阶段，共性业务或公共行为抽取出来公共模块、公共配置、公共类、公共方法等，在系统中不出现重复代码的情况，即DRY原则（Don’t Repeat Yourself）。

说明：随着代码的重复次数不断增加，维护成本指数级上升。随意复制和粘贴代码，必然会导致代码的重复，在维护代码时，需要修改所有的副本，容易遗漏。必要时抽取共性方法，或者抽象公共类，甚至是组件化。

正例：一个类中有多个public方法，都需要进行数行相同的参数校验操作，这个时候请抽取：private boolean checkParam(DTO dto) {...}

【推荐】避免如下误解：敏捷开发=讲故事+编码+发布。

说明：敏捷开发是快速交付迭代可用的系统，省略多余的设计方案，摒弃传统的审批流程，但核心关键点上的必要设计和文档沉淀是需要的。

反例：某团队为了业务快速发展，敏捷成了产品经理催进度的借口，系统中均是勉强能运行但像面条一样的代码，可维护性和可扩展性极差，一年之后，不得不进行大规模重构，得不偿失。

【参考】设计文档的作用是明确需求、理顺逻辑、后期维护，次要目的用于指导编码。

说明：避免为了设计而设计，系统设计文档有助于后期的系统维护和重构，所以设计结果需要进行分类归档保存。

【参考】可扩展性的本质是找到系统的变化点，并隔离变化点。

说明：世间众多设计模式其实就是一种设计模式即隔离变化点的模式。

正例：极致扩展性的标志，就是需求的新增，不会在原有代码交付物上进行任何形式的修改。

【参考】设计的本质就是识别和表达系统难点。

说明：识别和表达完全是两回事，很多人错误地认为识别到系统难点在哪里，表达只是自然而然的事情，但是大家在设计评审中经常出现语焉不详，甚至是词不达意的情况。准确地表达系统难点需要具备如下能力：表达规则和表达工具的熟练性。抽象思维和总结能力的局限性。基础知识体系的完备性。深入浅出的生动表达力。

【参考】代码即文档的观点是错误的，清晰的代码只是文档的某个片断，而不是全部。

说明：代码的深度调用，模块层面上的依赖关系网，业务场景逻辑，非功能性需求等问题要相应的文档来完整地呈现。

【参考】在做无障碍产品设计时，需要考虑到：

⚫ 所有可交互的控件元素必须能被tab键聚焦，并且焦点顺序需符合自然操作逻辑。

⚫ 用于登录校验和请求拦截的验证码均需提供图形验证以外的其它方式。

⚫ 自定义的控件类型需明确交互方式。

正例：登录场景中，输入框的按钮都需要考虑tab键聚焦，符合自然逻辑的操作顺序如下，”输入用户名，输入密码，输入验证码，点击登录”，其中验证码实现语音验证方式。如有自定义标签实现的控件设置控件类型可使用role属性。

pp.43