本文用于总结《阿里 Java 开发手册》、《用友技术 review 手册》及个人 Java 开发工作经验，并结合这半年来的源码阅读经验进行编写。回顾那些写过的和读过的代码，回顾自己。

第一章 基础编码规范

1.1 命名规范

  • 代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。
    tips：JDK 动态代理生成的代理类 类名使用了$符号开头，如$Proxy1。

  • 代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。
    tips：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用。alibaba，yonyou，Beijing 等国际通用的名称，可视同英文。
    在我们的财务相关模块的工程代码及数据库表设计中，可以看到一些拼音首字母缩写的命名方式，如：arap_djzb，arap 是“应收应付”的英文缩写，djzb 是“单据主表”的汉语拼音首字母，zdr、shr、lrr 都是汉语拼音首字母缩写。当然，这些都是历史包袱，经历了这么多年的代码积累，很难从底层去修正咯，但在自己的实际编码中要以史为鉴，让自己的代码更加优雅规范，这也是同事是否尊重你的重要考量之一。

  • 类名使用 UpperCamelCase——大驼峰风格，但以下情形例外: DO / BO / DTO/ VO / AO / PO / UID 等。
    tips：合理的类名后缀能够让我们在开发中快速地找到自己想要的代码，想看某个业务层就 ctrl + shift + T 搜索“XXXBO”，想看某展示层代码 就搜索“XXXVO”。

  • 抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类命名以它要测试的类的名称开始，以 Test 结尾。
    例如：Spring 框架的 AbstractApplicationContext 和 Mybatis 框架的 BaseExecutor 都是抽象类。

  • 方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase——小驼峰风格。

  • 常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
    tips：实际编码中，有时确实会嫌某常量名太长，不便于使用。以后应该在语义完整清楚的情况下再考虑尽量缩短名称长度。

  • 类型与中括号紧挨相连来表示数组。
    正例：定义整形数组 int[] arrayDemo；
    反例：在 main 参数中，使用 String args[]来定义。

  • POJO 类中布尔类型的变量，都不要加 is 前缀，否则部分框架解析会引起序列化错误。
    反例：定义为基本数据类型 Boolean isDeleted 的属性，它的方法也是 isDeleted()，RPC 框架在反向解析的时候，“误以为”对应的属性名称是 deleted，导致属性获取不到，进而抛出异常。
    tips：我们的 VO 类中有很多 is 开头的 Boolean 类型变量，如：DJZBHeaderVO 中的 isjszxzf（是否结算中心支付）字段。

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

  • 杜绝完全不规范的缩写，避免望文不知义。
    反例：AbstractClass“缩写”命名成 AbsClass；condition“缩写”命名成 condi，此类随 意缩写严重降低了代码的可阅读性。

  • 为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词 组合来表达其意。
    正例：在 JDK 中，表达原子更新的类名为：AtomicReferenceFieldUpdater。
    反例：变量 int a 的随意命名方式。

  • 如果模块、接口、类、方法使用了设计模式，在命名时需体现出具体模式。
    tips：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。 如：Spring 框架的 BeanFactory（工厂模式）、JdkDynamicAopProxy（JDK 动态代理模式）。

  • 接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上有效的 Javadoc 注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。
    正例：接口方法签名 void commit();
    接口基础常量 String COMPANY = “alibaba”;
    反例：接口方法定义 public abstract void f();
    说明：JDK8 中接口允许有默认实现，那么这个 default 方法，是对所有实现类都有价值的默认实现。

  • 接口和实现类的命名有两套规则：
    【强制】对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务一定是接口，内部 的实现类用 Impl 的后缀与接口区别。
    正例：CacheServiceImpl 实现 CacheService 接口。
    【推荐】 如果是形容能力的接口名称，取对应的形容词为接口名（通常是–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。

1.2 常量定义

  • 不允许任何魔法值（意义不明的变量 / 常量）直接出现在代码中。
    反例：
    String key = “Id#taobao_” + tradeId;
    cache.put(key, value);

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

  • 不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。
    说明：大而全的常量类，杂乱无章，使用查找功能才能定位到修改的常量，不利于理解和维护。
    正例：缓存相关常量放在类 CacheConsts 下；系统配置相关常量放在类 ConfigConsts 下。

  • 常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。
    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 定义。

  • 如果变量值仅在一个固定范围内变化用 enum 类型来定义。
    说明：如果存在名称之外的延伸属性应使用 enum 类型，下面正例中的数字就是延伸信息，表示一年中的第几个季节。
    正例：

1
2
3
4
5
6
7
8

public enum SeasonEnum {
     SPRING(1), SUMMER(2), AUTUMN(3), WINTER(4);
     private int seq;

     SeasonEnum(int seq){
         this.seq = seq;
     }
}

1.3 代码格式

代码格式无非就是一些空格、换行、缩进的问题，没必要死记，直接用开发工具（eclipse、IDEA）format 一下即可，省时省力。

1.4 OOP 规约

  • 避免通过一个类的对象引用访问此类的静态变量或方法，增加编译器解析成本。

  • 所有的覆写方法，必须加@Override 注解。
    说明：getObject()与 get0bject()的问题。一个是字母的 O，一个是数字的 0，加@Override 可以准确判断是否覆盖成功。另外，如果在抽象类中对方法签名（由方法名、参数的类型及顺序 确定唯一的方法签名）进行修改，其实现类会马上编译报错。

  • 相同参数类型，相同业务含义，才可以使用 Java 的可变参数，避免使用 Object。
    说明：可变参数必须放置在参数列表的最后。（能用数组的就不要使用可变参数编程，可变参数在编译时会被编译成数组类型。可变参数能兼容数组类参数，但是数组类参数却无法兼容可变参数。可变参数类型必须作为参数列表的最后一项，且不能放在定长参数的前面。）
    正例：public List listUsers(String type, Long… ids) {…}

  • 外部正在调用或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方产生影响。接口过时必须加@Deprecated 注解，并清晰地说明采用的新接口或者新服务是什么。
    tips：
    一方库：本工程范围内，各个模块和包之间的相互依赖。
    二方库：引入的同一个公司内部的其他工程。
    三方库：公司以外的其他依赖，比如 apache，google 等。

  • 不能使用过时的类或方法。
    说明：java.net.URLDecoder 中的方法 decode(String encodeStr) 这个方法已经过时，应该使用双参数 decode(String source, String encode)。接口提供方既然明确是过时接口， 那么有义务同时提供新的接口；作为调用方来说，有义务去考证过时方法的新实现是什么。

  • Object 的 equals 方法容易抛空指针异常，应使用常量或确定有值的对象来调用 equals。
    正例：“test”.equals(object);
    反例：object.equals(“test”);
    说明：推荐使用 java.util.Objects#equals（JDK7 引入的工具类）。个人认为，当要比较两个不确定的对象时，可以考虑使用这个类，如果只是想确定某个对象是否为目标值，使用上面的方法并不差。

  • 所有的相同类型的包装类对象之间值的比较，全部使用 equals() 方法比较。
    说明：对于 Integer var = ? 在-128 至 127 范围内的赋值，Integer 对象是在 IntegerCache.cache 产生，会复用已有对象，这个区间内的 Integer 值可以直接使用 == 进行判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大坑， 推荐使用 equals() 方法进行判断。

  • 关于基本数据类型与包装数据类型的使用标准如下：
    1）【强制】所有的 POJO 类属性必须使用包装数据类型。
    2）【强制】RPC 方法的返回值和参数必须使用包装数据类型。
    3）【推荐】所有的局部变量使用基本数据类型。
    说明：POJO 类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何 NPE 问题，或者入库检查，都由使用者来保证。
    正例：数据库的查询结果可能是 null，因为自动拆箱，用基本数据类型接收有 NPE 风险。(不是很理解这个结论，ResultSet.getInt()等方法获得的是基本数据类型，ORM 映射时怎么就拆箱咯？)
    反例：比如显示成交总额涨跌情况，即正负 x%，x 为基本数据类型，调用的 RPC 服务，调用不成功时，返回的是默认值，页面显示为 0%，这是不合理的，应该显示成中划线。所以包装数据类型的 null 值，能够表示额外的信息，如：远程调用失败，异常退出。

  • 定义 DO/DTO/VO 等 POJO 类时，不要设定任何属性默认值。
    反例：POJO 类的 gmtCreate 默认值为 new Date()，但是这个属性在数据提取时并没有置入具 体值，在更新其它字段时又附带更新了此字段，导致创建时间被修改成当前时间。

  • 序列化类新增属性时，请不要修改 serialVersionUID 字段，避免反序列化失败；如果完全不兼容升级，避免反序列化混乱，那么请修改 serialVersionUID 值。
    说明：注意 serialVersionUID 不一致会抛出序列化运行时异常。

  • 构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在 init() 方法中。
    在很多 client 端的代码中有看到这种编码方式。

  • POJO 类必须写 toString() 方法。使用 IDE 中的工具：source -> generate toString() 时，如果继承了另一个 POJO 类，注意在前面加一下 super.toString()。
    说明：在方法执行抛出异常时，可以直接调用 POJO 的 toString()方法打印其属性值，便于排查问题。

  • 当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起， 便于阅读。

  • 类内方法定义的顺序依次是：公有方法或保护方法 > 私有方法 > getter/setter 方法。
    说明：公有方法是类的调用者和维护者最关心的方法，首屏展示最好；保护方法虽然只是子类 关心，也可能是“模板设计模式”下的核心方法；而私有方法外部一般不需要特别关心，是一个 黑盒实现；因为承载的信息价值较低，所有 Service 和 DAO 的 getter/setter 方法放在类体 最后。

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

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

  • final 可以声明类、成员变量、方法、以及本地变量，下列情况使用 final 关键字：
    1） 不允许被继承的类，如：String 类。
    2） 不允许修改引用的域对象。
    3） 不允许被重写的方法，如：POJO 类的 setter 方法。
    4） 不允许运行过程中重新赋值的局部变量，可以看到有些方法的形参中使用了 final 修饰。
    5） 避免上下文重复使用一个变量，使用 final 描述可以强制重新定义一个变量，方便更好 地进行重构。

  • 慎用 Object 的 clone 方法来拷贝对象。
    说明：对象的 clone 方法默认是浅拷贝，若想实现深拷贝需要重写 clone 方法实现域对象的 深度遍历式拷贝。

  • 类成员与方法访问控制从严（合理使用 Java 的访问修饰符）：
    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 成员方法或成员变量，删除一下，不得手心冒点汗吗？变量像自己的小孩，尽量在自己的视线内，变量作 用域太大，无限制的到处跑，那么你会担心的。

1.5 集合处理

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

  • ArrayList 的 subList 结果不可强转成 ArrayList，否则会抛出 ClassCastException 异常，即 java.util.RandomAccessSubList cannot be cast to java.util.ArrayList。
    说明：subList 返回的是 ArrayList 的内部类 SubList，并不是 ArrayList 而是 ArrayList 的一个视图，对于 SubList 子列表的所有操作最终会反映到原列表上。

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

  • 使用集合转数组的方法，必须使用集合的 toArray(T[] array)方法，传入的是类型完全一样的数组，大小就是 list.size()。
    说明：使用 toArray 带参方法，入参分配的数组空间不够大时，toArray 方法内部将重新分配 内存空间，并返回新数组地址；如果数组元素个数大于实际所需，下标为[ list.size() ] 的数组元素将被置为 null，其它数组元素保持原值，因此最好将方法入参数组大小定义与集 合元素个数一致。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

// 正例：
List<String> list = new ArrayList<String>(2);
list.add("guan");
list.add("bao");
String[] array = new String[list.size()];
array = list.toArray(array);
// 反例：直接使用 toArray 无参方法存在问题，此方法返回值只能是 Object[]类，
// 若强转其它 类型数组将出现 ClassCastException 错误。

// 这是我平时的写法，初始化一个list.size()大小的数组似乎效率更好一些，如果数组的容量
// 比list小，原来的数组对象不会被使用，浪费系统资源
String[] strs = list.toArray(new String[0]);
  • 使用工具类 Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方法，它的 add/remove/clear 方法会抛出 UnsupportedOperationException 异常。
    说明：asList() 的返回对象是一个 Arrays 的内部类 ArrayList（而不是 java.util.ArrayList），该内部类 并没有实现集合的修改/删除等方法。Arrays.asList 体现的是适配器模式，只是转换接口，后台的数据仍是数组。
1
2
3
4

String[] str = new String[] { "you", "wu" };
List list = Arrays.asList(str);
第一种情况：list.add("yangguanbao"); 运行时异常。
第二种情况：str[0] = "gujin"; 那么 list.get(0)也会随之修改。
  • 泛型通配符 <? extends T> 来接收返回的数据，此写法的泛型集合不能使用 add() 方 法，而 <? super T> 不能使用 get() 方法，作为接口调用赋值时易出错。
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

// <? extends T>:上界通配符(Upper Bounds Wildcards）
// <? super T>:下界通配符(Lower Bounds Wildcards)
List<? extends C> list1; // list1 的元素的类型只能是 C 和 C 的子类。
List<? super C> list2; // list2 的元素的类型只能是 C 和 C 的父类。
// 简单来说就是 <? extends C> 上界为 C 类型范围粗略理解为 [C,+∞)，
// 不允许添加除 null 的元素，获取的元素类型是 C ；
// <? super C> 下界为 C 类型范围粗略理解为 (-∞,C]，允许添加 C 以及 C 的子类类型元素，
// 获取的元素类型是 Object

// 扩展说一下 PECS(Producer Extends Consumer Super)原则。
// 第一、频繁往外读取内容的，适合用<? extends T>。
// 第二、经常往里插入的，适合用<? super T>。
  • 不要在 foreach 循环里进行元素的 remove/add 操作。remove 元素请使用 Iterator 方式，如果并发操作，需要对 Iterator 对象加锁。
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

// 正例：
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();
    }
}

// 反例：对比ArrayList的remove()和Iterator的remove()方法，可以找到其中的坑。
for (String item : list) {
    if ("1".equals(item)) {
        list.remove(item);
    }
}
  • 在 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 比较结果相同。
1
2
3
4
5
6
7

// 反例：下例中没有处理相等的情况，实际使用中可能会出现异常：
new Comparator<Student>() {
    @Override
    public int compare(Student o1, Student o2) {
    	return o1.getId() > o2.getId() ? 1 : -1;
    }
};
  • 集合泛型定义时，在 JDK7 及以上，使用 diamond 语法或全省略。
    说明：菱形泛型，即 diamond，直接使用<>来指代前边已经指定的类型。
1
2
3
4
5

// 正例：
// <> diamond 方式
HashMap<String, String> userCache = new HashMap<>(16);
// 全省略方式
ArrayList<User> users = new ArrayList(10);

  • 集合初始化时，指定集合初始值大小。
    说明：HashMap 使用 HashMap(int initialCapacity) 初始化。 正例：initialCapacity = (需要存储的元素个数 / 负载因子) + 1。注意负载因子（即 loader factor）默认为 0.75，如果暂时无法确定初始值大小，请设置为 16（即默认值）。
    反例：HashMap 需要放置 1024 个元素，由于没有设置容量初始大小，随着元素不断增加，容量 7 次被迫扩大，resize() 需要重建 hash 表，严重影响性能。

  • 使用 entrySet 遍历 Map 类集合 K-V，而不是 keySet 方式进行遍历。
    说明：keySet 其实是遍历了 2 次，一次是转为 Iterator 对象，另一次是从 hashMap 中取出 key 所对应的 value。而 entrySet 只是遍历了一次就把 key 和 value 都放到了 entry 中，效率更高。如果是 JDK8，使用 Map.foreach() 方法。
    正例：values()返回的是 V 值集合，是一个 list 集合对象；keySet()返回的是 K 值集合，是 一个 Set 集合对象；entrySet()返回的是 K-V 值组合集合。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

// 创建一个Map
Map<String, Object> infoMap = new HashMap<>();
infoMap.put("name", "Zebe");
infoMap.put("site", "www.zebe.me");
infoMap.put("email", "zebe@vip.qq.com");

// 传统的Map迭代方式
for (Map.Entry<String, Object> entry : infoMap.entrySet()) {
    System.out.println(entry.getKey() + "：" + entry.getValue());
}

// JDK8的迭代方式
infoMap.forEach((key, value) -> {
    System.out.println(key + "：" + value);
});
  • 高度注意 Map 类集合 K-V 能不能存储 null 值的情况，如下表格：
集合类 Key Value Super 说明
HashMap 允许为 null 允许为 null AbstractMap 线程不安全
ConcurrentHashMap 不允许为 null 不允许为 null AbstractMap 锁分段技术（JDK8:CAS）
Hashtable 不允许为 null 不允许为 null Dictionary 线程安全
TreeMap 不允许为 null 允许为 null AbstractMap 线程不安全

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

  • 合理利用好集合的有序性(sort)和稳定性(order)，避免集合的无序性(unsort)和不稳定性(unorder)带来的负面影响。
    说明：有序性是指遍历的结果是按某种比较规则依次排列的。稳定性指集合每次遍历的元素次序是一定的。如：ArrayList 是 order/unsort；HashMap 是 unorder/unsort；TreeSet 是 order/sort。

  • 利用 Set 元素唯一的特性，可以快速对一个集合进行去重操作，避免使用 List 的 contains 方法进行遍历、对比、去重操作。

1.6 并发处理

  • 获取单例对象需要保证线程安全，其中的方法也要保证线程安全。
    说明：资源驱动类、工具类、单例工厂类都需要注意。

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

1
2
3
4
5
6
7

// 正例：
public class TimerTaskThread extends Thread {
	public TimerTaskThread() {
		super.setName("TimerTaskThread");
		...
	}
}

  • 线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。
    说明：使用线程池的好处是减少在创建和销毁线程上所消耗的时间以及系统资源的开销，解决资源不足的问题。如果不使用线程池，有可能造成系统创建大量同类线程而导致消耗完内存或者“过度切换”的问题。
    tips:我们的代码中的很多线程都是自行显式创建的，很少见到通过线程池进行统一管理的。

  • 线程池不允许使用 Executors 去创建，而是通过 ThreadPoolExecutor 的方式，这样的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。
    说明：Executors 返回的线程池对象的弊端如下：
    1）FixedThreadPool 和 SingleThreadPool: 允许的请求队列长度为 Integer.MAX_VALUE，可能会堆积大量的请求，从而导致 OOM。
    2）CachedThreadPool 和 ScheduledThreadPool: 允许的创建线程数量为 Integer.MAX_VALUE，可能会创建大量的线程，从而导致 OOM。

  • SimpleDateFormat 是线程不安全的类，一般不要定义为 static 变量，如果定义为 static，必须加锁，或者使用 DateUtils 工具类。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

// 正例：注意线程安全，使用 DateUtils。亦推荐如下处理：
private static final ThreadLocal<DateFormat> df = 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。

  • 高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁；能锁区块，就不要锁整个方法体；能用对象锁，就不要用类锁。
    说明：尽可能使加锁的代码块工作量尽可能的小，避免在锁代码块中调用 RPC 方法。

  • 对多个资源、数据库表、对象同时加锁时，需要保持一致的加锁顺序，否则可能会造成死锁。
    说明：线程一需要对表 A、B、C 依次全部加锁后才可以进行更新操作，那么线程二的加锁顺序也必须是 A、B、C，否则可能出现死锁。

  • 并发修改同一记录时，避免更新丢失，需要加锁。要么在应用层加锁，要么在缓存加锁，要么在数据库层使用乐观锁，使用 version 作为更新依据。
    说明：如果每次访问冲突概率小于 20%，推荐使用乐观锁，否则使用悲观锁。乐观锁的重试次数不得小于 3 次。

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

  • 使用 CountDownLatch 进行异步转同步操作，每个线程退出前必须调用 countDown 方法，线程执行代码注意 catch 异常，确保 countDown 方法被执行到，避免主线程无法执行至 await 方法，直到超时才返回结果。
    说明：注意，子线程抛出异常堆栈，不能在主线程 try-catch 到。

  • 避免 Random 实例被多线程使用，虽然共享该实例是线程安全的，但会因竞争同一 seed 导致的性能下降。
    说明：Random 实例包括 java.util.Random 的实例或者 Math.random()的方式。
    正例：在 JDK7 之后，可以直接使用 API ThreadLocalRandom，而在 JDK7 之前，需要编码保证每个线程持有一个实例。

  • 在并发场景下，通过双重检查锁（double-checked locking）实现延迟初始化的优化问题隐患(指令重排会导致 双检锁失效，产生隐患)(可参考 The “Double-Checked Locking is Broken” Declaration)，推荐解决方案中较为简单一种（适用于 JDK5 及以上版本），将目标属性声明为 volatile 型。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

// 反例：
class LazyInitDemo {
	private Helper helper = null;
	public Helper getHelper() {
		if (helper == null)
		synchronized(this) {
			if (helper == null)
				helper = new Helper();
			}
		return helper;
	}
	// other methods and fields...
}
  • volatile 解决多线程内存不可见问题。对于一写多读，是可以解决变量同步问题， 但是如果多写，同样无法解决线程安全问题。
1
2
3
4

// 如果是 count++操作，使用如下类实现：
AtomicInteger count = new AtomicInteger();
count.addAndGet(1);
// 如果是 JDK8，推 荐使用 LongAdder 对象，比 AtomicLong 性能更好（减少乐观锁的重试次数）。

  • HashMap 在容量不够进行 resize 时由于高并发可能出现死链，导致 CPU 飙升，在开发过程中可以使用其它数据结构或加锁来规避此风险。

  • ThreadLocal 无法解决共享对象的更新问题，ThreadLocal 对象建议使用 static 修饰。这个变量是针对一个线程内所有操作共享的，所以设置为静态变量，所有此类实例共享此静态变量 ，也就是说在类第一次被使用时装载，只分配一块存储空间，所有此类的对象(只要是这个线程内定义的)都可以操控这个变量。

1.7 控制语句

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

  • 在 if/else/for/while/do 语句中必须使用大括号，即使只有一行代码。

  • 在高并发场景中，避免使用“等于”判断作为中断或退出的条件。
    说明：如果并发控制没有处理好，容易产生等值判断被“击穿”的情况，使用大于或小于的区间判断条件来代替。
    反例：判断剩余奖品数量等于 0 时，终止发放奖品，但因为并发处理错误导致奖品数量瞬间变成了负数，这样的话，活动无法终止。

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

if (condition) {
	...
	return obj;
}
// 接着写 else 的业务逻辑代码;
// 说明：如果非得使用 if()...else if()...else...方式表达逻辑，【强制】避免后续代码维护困难，
// 		请勿超过 3 层。
// 正例：超过 3 层的 if-else 的逻辑判断代码可以使用卫语句、策略模式、状态模式等来实现，其中卫语句示例如下：
public void today() {
	if (isBusy()) {
		System.out.println(“change time.”);
		return;
	}
	if (isFree()) {
		System.out.println(“go to travel.”);
		return;
	}
 	System.out.println(“stay at home to learn Alibaba Java Coding Guidelines.”);
 	return;
}
  • 除常用方法（如 getXxx/isXxx）等外，不要在条件判断中执行其它复杂的语句，将复杂逻辑判断的结果赋值给一个有意义的布尔变量名，以提高可读性。
    说明：很多 if 语句内的逻辑相当复杂，阅读者需要分析条件表达式的最终结果，才能明确什么样的条件执行什么样的语句，那么，如果阅读者分析逻辑表达式错误呢？
 1
 2
 3
 4
 5
 6
 7
 8
 9
10

// 正例：
// 伪代码如下
final boolean existed = (file.open(fileName, "w") != null) && (...) || (...);
if (existed) {
	...
}
// 反例：在我们的代码中可以看到很多这种把复杂冗长的逻辑判断写在if语句中的
if ((file.open(fileName, "w") != null) && (...) || (...)) {
    ...
}

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

  • 避免采用取反逻辑运算符。
    说明：取反逻辑不利于快速理解，并且取反逻辑写法必然存在对应的正向逻辑写法。
    正例：使用 if (x < 628) 来表达 x 小于 628。
    反例：使用 if (!(x >= 628)) 来表达 x 小于 628。

  • 接口入参保护(即，参数校验)，这种场景常见的是用作批量操作的接口。

  • 下列情形，需要进行参数校验：
    1） 调用频次低的方法。
    2） 执行时间开销很大的方法。此情形中，参数校验时间几乎可以忽略不计，但如果因为参数错误导致中间执行回退，或者错误，那得不偿失。
    3） 需要极高稳定性和可用性的方法。
    4） 对外提供的开放接口，不管是 RPC/API/HTTP 接口。
    5） 敏感权限入口。

  • 下列情形，不需要进行参数校验：
    1） 极有可能被循环调用的方法。但在方法说明里必须注明外部参数检查要求。
    2） 底层调用频度比较高的方法。毕竟是像纯净水过滤的最后一道，参数错误不太可能到底层才会暴露问题。一般 DAO 层与 Service 层都在同一个应用中，部署在同一台服务器中，所以 DAO 的参数校验，可以省略。
    3） 被声明成 private 只会被自己代码所调用的方法，如果能够确定调用方法的代码传入参数已经做过检查或者肯定不会有问题，此时可以不校验参数。

1.8 注释规约

注释感觉是我们代码规范的重灾区咯，也是大家最容易忽略的地方。

  • 类、类属性、类方法的注释必须使用 Javadoc 规范，使用/*_ 内容 _/格式，不得使用 // xxx 方式。 说明：在 IDE 编辑窗口中，Javadoc 方式会提示相关注释，生成 Javadoc 可以正确输出相应注 释；在 IDE 中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读效率。

  • 所有的抽象方法（包括接口中的方法）必须要用 Javadoc 注释、除了返回值、参数、 异常说明外，还必须指出该方法做什么事情，实现什么功能。
    说明：对子类的实现要求，或者调用注意事项，请一并说明。

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

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

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

  • 与其用“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。
    反例：“TCP 连接超时” 解释成 “传输控制协议连接超时”，理解反而费脑筋。

  • 代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改。
    说明：代码与注释更新不同步，就像路网与导航软件更新不同步一样，如果导航软件严重滞后， 就失去了导航的意义。

  • 谨慎注释掉代码。在上方详细说明，而不是简单地注释掉。如果无用，则删除。
    说明：代码被注释掉有两种可能性。
    1）后续会恢复此段代码逻辑。
    2）永久不用。前者如果没有备注信息，难以知晓注释动机。后者建议直接删掉（代码仓库保存了历史代码）。

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

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

1
2
3
4
5

// 反例：
// put elephant into fridge
put(elephant, fridge);
// 方法名 put，加上两个有意义的变量名 elephant 和 fridge，已经说明了这是在干什么，
// 语义清晰的代码不需要额外的注释。
  • 特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描， 经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。
    1） 待办事宜（TODO）:（ 标记人，标记时间，[预计处理时间] ）
    表示需要实现，但目前还未实现的功能。这实际上是一个 Javadoc 的标签，目前的 Javadoc 还没有实现，但已经被广泛使用。只能应用于类，接口和方法（因为它是一个 Javadoc 标签）。
    2） 错误，不能工作（FIXME）:（ 标记人，标记时间，[预计处理时间] ）
    在注释中用 FIXME 标记某代码是错误的，而且不能工作，需要及时纠正的情况。

1.9 其它

  • 在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。
    说明：不要在方法体内定义：Pattern pattern = Pattern.compile(“规则”);

  • velocity 调用 POJO 类的属性时，建议直接使用属性名取值即可，模板引擎会自动按规范调用 POJO 的 getXxx()，如果是 boolean 基本数据类型变量（boolean 命名不需要加 is 前缀），会自动调用 isXxx()方法。
    说明：注意如果是 Boolean 包装类对象，优先调用 getXxx()的方法。

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

  • 获取当前毫秒数 System.currentTimeMillis(); 而不是 new Date().getTime();
    说明：如果想获取更加精确的纳秒级时间值，使用 System.nanoTime()的方式。在 JDK8 中， 针对统计时间等场景，推荐使用 Instant 类。

  • 不要在视图模板中加入任何复杂的逻辑。
    说明：根据 MVC 理论，视图的职责是展示，不要抢模型和控制器的活。

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

  • 及时清理不再使用的代码段或配置信息。
    说明：对于垃圾代码或过时配置，坚决清理干净，避免程序过度臃肿，代码冗余。
    正例：对于暂时被注释掉，后续可能恢复使用的代码片断，在注释代码上方，统一规定使用三个斜杠(///)来说明注释掉代码的理由。

第二章 异常与日志规范

2.1 异常处理

  • Java 类库中定义的可以通过预检查方式规避的 RuntimeException 异常不应该通过 catch 的方式来处理，比如：NullPointerException，IndexOutOfBoundsException 等等。
    说明：无法通过预检查的异常除外，比如，在解析字符串形式的数字时，不得不通过 catch NumberFormatException 来实现。
    正例：if (obj != null) {…}
    反例：try { obj.method(); } catch (NullPointerException e) {…}

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

  • catch 时请分清稳定代码和非稳定代码，稳定代码指的是无论如何不会出错的代码。 对于非稳定代码的 catch 尽可能进行区分异常类型，再做对应的异常处理。
    说明：对大段代码进行 try-catch，使程序无法根据不同的异常做出正确的应激反应，也不利于定位问题，这是一种不负责任的表现。
    正例：用户注册的场景中，如果用户输入非法字符，或用户名称已存在，或用户输入密码过于简单，在程序上作出分门别类的判断，并提示给用户。

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

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

  • finally 块必须对资源对象、流对象进行关闭，有异常也要做 try-catch。
    说明：如果 JDK7 及以上，可以使用 try-with-resources 方式。

  • 不要在 finally 块中使用 return。
    说明：finally 块中的 return 返回后方法结束执行，不会再执行 try 块中的 return 语句。

  • 捕获异常与抛异常，必须是完全匹配，或者捕获异常是抛异常的父类。
    说明：如果预期对方抛的是绣球，实际接到的是铅球，就会产生意外情况。

  • 方法的返回值可以为 null，不强制返回空集合，或者空对象等，必须添加注释充分说明什么情况下会返回 null 值。
    说明：本手册明确防止 NPE 是调用者的责任。即使被调用方法返回空集合或者空对象，对调用者来说，也并非高枕无忧，必须考虑到远程调用失败、序列化失败、运行时异常等场景返回 null 的情况。

  • 防止 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 问题。

  • 定义时区分 unchecked / checked 异常，避免直接抛出 new RuntimeException()， 更不允许抛出 Exception 或者 Throwable，应使用有业务含义的自定义异常。推荐业界已定义过的自定义异常，如：DAOException / ServiceException 等。

  • 对于公司外的 http/api 开放接口必须使用“错误码”；而应用内部推荐异常抛出； 跨应用间 RPC 调用优先考虑使用 Result 方式，封装 isSuccess()方法、“错误码”、“错误简短信息”。
    说明：关于 RPC 方法返回方式使用 Result 方式的理由。
    1）使用抛异常返回方式，调用方如果没有捕获到就会产生运行时错误。
    2）如果不加栈信息，只是 new 自定义异常，加入自己的理解的 error message，对于调用端解决问题的帮助不会太多。如果加了栈信息，在频繁调用出错的情况下，数据序列化和传输的性能损耗也是问题。

  • 避免出现重复的代码（Don’t Repeat Yourself），即 DRY 原则。
    说明：随意复制和粘贴代码，必然会导致代码的重复，在以后需要修改时，需要修改所有的副本，容易遗漏。必要时抽取共性方法，或者抽象公共类，甚至是组件化。

1
2
3

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

2.2 日志规约

  • 应用中不可直接使用日志系统（Log4j、Logback）中的 API，而应依赖使用日志框架 SLF4J 中的 API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。
1
2
3
4

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

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

  • 日志文件至少保存 15 天，因为有些异常具备以“周”为频次发生的特点。

  • 应用中的扩展日志（如打点、临时监控、访问日志等）命名方式：appName_logType_logName.log。 logType:日志类型，如 stats/monitor/access 等；logName:日志描述。这种命名的好处： 通过文件名就可知道日志文件属于什么应用，什么类型，什么目的，也有利于归类查找。
    正例：mppserver 应用中单独监控时区转换异常，如：mppserver_monitor_timeZoneConvert.log
    说明：推荐对日志进行分类，如将错误日志和业务日志分开存放，便于开发人员查看，也便于通过日志对系统进行及时监控。

  • 对 trace/debug/info 级别的日志输出，必须使用条件输出形式或者使用占位符的方式。
    说明：logger.debug(“Processing trade with id: " + id + " and symbol: " + symbol); 如果日志级别是 warn，上述日志不会打印，但是会执行字符串拼接操作，如果 symbol 是对象， 会执行 toString()方法，浪费了系统资源，执行了上述操作，最终日志却没有打印。

1
2
3
4
5
6
7

// 正例：
//（条件）建议采用如下方式
if (logger.isDebugEnabled()) {
    logger.debug("Processing trade with id: " + id + " and symbol: " + symbol);
}
// 正例：（占位符）
logger.debug("Processing trade with id: {} and symbol : {} ", id, symbol);
  • 避免重复打印日志，浪费磁盘空间，务必在 log4j.xml 中设置 additivity=false。
1
2

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

  • 异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字 throws 往上抛出。
    正例：logger.error(各类参数或者对象 toString() + “_” + e.getMessage(), e);

  • 谨慎地记录日志。生产环境禁止输出 debug 日志；有选择地输出 info 日志；如果使用 warn 来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志。
    说明：大量地输出无效日志，不利于系统性能提升，也不利于快速定位错误点。记录日志时请思考：这些日志真的有人看吗？看到这条日志你能做什么？能不能给问题排查带来好处？

  • 可以使用 warn 日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。如非必要，请不要在此场景打出 error 级别，避免频繁报警。
    说明：注意日志输出的级别，error 级别只记录系统逻辑出错、异常或者重要的错误信息。

  • 尽量用英文来描述日志错误信息，如果日志中的错误信息用英文描述不清楚的话 使用中文描述即可，否则容易产生歧义。国际化团队或海外部署的服务器由于字符集问题，【强制】 使用全英文来注释和描述日志错误信息。

第三章 数据库规范

我们 to B 的业务主要使用的是 Oracle 和 SQL server，去年参与适配了国产的华为 GaussDB 及达梦 DM 数据库。

3.1 建表规约

  • 临时库、表名必须以 tmp 为前缀，如果是按照日期生成的，以日期为后缀

  • 备份库、表必须以 bak 为前缀，如果是按照日期生成的，以日期为后缀

  • 表达是与否概念的字段，必须使用 is_xxx 的方式命名，数据类型是 unsigned tinyint （1 表示是，0 表示否）。
    说明：任何字段如果为非负数，必须是 unsigned。
    注意：POJO 类中的任何布尔类型的变量，都不要加 is 前缀，所以，需要在<resultMap>设置从 is_xxx 到 Xxx 的映射关系。数据库表示是与否的值，使用 tinyint 类型，坚持 is_xxx 的命名方式是为了明确其取值含义与取值范围。 正例：表达逻辑删除的字段名 is_deleted，1 表示删除，0 表示未删除。
    tips：我们使用的是 dr 字段代表逻辑删除，且 POJO 和布尔字段也未使用上述规范，这也与我们的 JDBC 框架有关，我们的 JDBC 框架是自己设计的，与 mybatis 等主流框架有很大不同。

  • 表名、字段名必须使用小写字母或数字，禁止出现数字开头，禁止两个下划线中间只出现数字。数据库字段名的修改代价很大，因为无法进行预发布，所以字段名称需要慎重考虑。
    说明：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 定长字符串类型。
    tips：公司这一点倒是做的比较规范。

  • varchar 是不定长字符串，不预先分配存储空间，长度不要超过 5000，如果存储长度大于此值，定义字段类型为 text，独立出来一张表，用主键来对应，避免影响其它字段索引效率。
    tips：Oracle 的 varchar 最大长度为 4000，SQL server 8000，这是之前适配数据库时踩过的坑。

  • 表必备三字段：id, gmt_create, gmt_modified。
    说明：其中 id 必为主键，类型为 bigint unsigned、单表时自增、步长为 1。gmt_create、gmt_modified 的类型均为 datetime 类型，前者现在时表示主动创建，后者过去分词表示被动更新。

  • 表的命名最好是加上“业务名称_表的作用”。 正例：alipay_task / force_project / trade_config

  • 库名与应用名称尽量一致。

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

  • 字段允许适当冗余，以提高查询性能，但必须考虑数据一致。冗余字段应遵循：
    1）不是频繁修改的字段。
    2）不是 varchar 超长字段，更不能是 text 字段。
    正例：商品类目名称使用频率高，字段长度短，名称基本一成不变，可在相关联的表中冗余存储类目名称，避免关联查询。

  • 单表行数超过 500 万行或者单表容量超过 2GB，才推荐进行分库分表。
    说明：如果预计三年后的数据量根本达不到这个级别，请不要在创建表时就分库分表。

  • 合适的字符存储长度，不但节约数据库表空间、节约索引存储，更重要的是提升检索速度。
    正例：如下表，其中无符号值可以避免误存负数，且扩大了表示范围。

3.2 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 IF(ISNULL(SUM(g)),0,SUM(g)) FROM table;

  • 使用 ISNULL()来判断是否为 NULL 值。
    说明：NULL 与任何值的直接比较都为 NULL。
    1） NULL<>NULL 的返回结果是 NULL，而不是 false。
    2） NULL=NULL 的返回结果是 NULL，而不是 true。
    3） NULL<>1 的返回结果是 NULL，而不是 true。

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

  • 不得使用外键与级联，一切外键概念必须在应用层解决。
    说明： 以学生和成绩的关系为例，学生表中的 student_id 是主键，那么成绩表中的 student_id 则为外键。如果更新学生表中的 student_id，同时触发成绩表中的 student_id 更新，即为级联更新。外键与级联更新适用于单机低并发，不适合分布式、高并发集群；级联更新是强阻塞，存在数据库更新风暴的风险；外键影响数据库的插入速度。

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

  • 数据订正（特别是删除、修改记录操作）时，要先 select，避免出现误删除，确认无误才能执行更新语句。

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

  • 如果有国际化需要，所有的字符存储与表示，均以 utf-8 编码，注意字符统计函数 的区别。
    说明：
    SELECT LENGTH(“轻松工作”)； 返回为 12
    SELECT CHARACTER_LENGTH(“轻松工作”)； 返回为 4
    如果需要存储表情，那么选择 utf8mb4 来进行存储，注意它与 utf-8 编码的区别。

  • TRUNCATE TABLE 比 DELETE 速度快，且使用的系统和事务日志资源少，但 TRUNCATE 无事务且不触发 trigger，有可能造成事故，故不建议在开发代码中使用此语句。
    说明：TRUNCATE TABLE 在功能上与不带 WHERE 子句的 DELETE 语句相同。

3.3 ORM 映射

我们的 JDBC 框架是自己研发的，之前也有看过 Mybatis 的源码，两者的设计及使用还是差别挺大的。

  • 在表查询中，一律不要使用 * 作为查询的字段列表，需要哪些字段必须明确写明。
    说明：
    1）增加查询分析器解析成本。
    2）增减字段容易与 resultMap 配置不一致。
    3）无用字 段增加网络消耗，尤其是 text 类型的字段。

  • POJO 类的布尔属性不能加 is，而数据库字段必须加 is_，要求在 resultMap 中进行字段与属性之间的映射。
    说明：参见定义 POJO 类以及数据库字段定义规定，在<resultMap>中增加映射，是必须的。 在 MyBatis Generator 生成的代码中，需要进行对应的修改。

  • 不要用 resultClass 当返回参数，即使所有类属性名与数据库字段一一对应，也需要定义；反过来，每一个表也必然有一个 POJO 类与之对应。
    说明：配置映射关系，使字段与 DO 类解耦，方便维护。

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

  • iBATIS 自带的 queryForList(String statementName,int start,int size)不推 荐使用。
    说明：其实现方式是在数据库取到 statementName 对应的 SQL 语句的所有记录，再通过 subList 取 start,size 的子集合。

1
2
3
4

// 正例：
Map<String, Object> map = new HashMap<>();
map.put("start", start);
map.put("size", size);

  • 不允许直接拿 HashMap 与 Hashtable 作为查询结果集的输出。
    说明：resultClass=”Hashtable”，会置入字段名和属性值，但是值的类型不可控。

  • 更新数据表记录时，必须同时更新记录对应的 gmt_modified 字段值为当前时间。

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

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

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

3.4 索引规范

  • 业务上具有唯一特性的字段，即使是多个字段的组合，也必须建成唯一索引。
    说明：不要以为唯一索引影响了 insert 速度，这个速度损耗可以忽略，但提高查找速度是明显的；另外，即使在应用层做了非常完善的校验控制，只要没有唯一索引，根据墨菲定律（只要有这个可能性 就一定会发生），必然有脏数据产生。

  • 超过三个表禁止 join。需要 join 的字段，数据类型必须绝对一致；多表关联查询时，保证被关联的字段需要有索引。
    说明：即使双表 join 也要注意表索引、SQL 性能。

  • 在 varchar 字段上建立索引时，必须指定索引长度，没必要对全字段建立索引，根据实际文本区分度决定索引长度即可。
    说明：索引的长度与区分度是一对矛盾体，一般对字符串类型数据，长度为 20 的索引，区分度会高达 90%以上，可以使用 count(distinct left(列名, 索引长度))/count(*)的区分度 来确定。

  • 页面搜索严禁左模糊或者全模糊，如果需要请走搜索引擎来解决。
    说明：索引文件具有 B-Tree 的最左前缀匹配特性，如果左边的值未确定，那么无法使用此索引。

  • 如果有 order by 的场景，请注意利用索引的有序性。order by 最后的字段是组合索引的一部分，并且放在索引组合顺序的最后，避免出现 file_sort 的情况，影响查询性能。
    正例：where a=? and b=? order by c; 索引：a_b_c
    反例：索引中有范围查找，那么索引有序性无法利用，如：WHERE a>10 ORDER BY b; 索引 a_b 无法排序。

  • 利用覆盖索引来进行查询操作，避免回表。
    说明：如果一本书需要知道第 11 章是什么标题，会翻开第 11 章对应的那一页吗？目录浏览一下就好，这个目录就是起到覆盖索引的作用。
    正例：能够建立索引的种类分为主键索引、唯一索引、普通索引三种，而覆盖索引只是一种查询的一种效果，用 explain 的结果，extra 列会出现：using index。

  • 利用延迟关联或者子查询优化超多分页场景。
    说明：MySQL 并不是跳过 offset 行，而是取 offset+N 行，然后返回放弃前 offset 行，返回 N 行，那当 offset 特别大的时候，效率就非常的低下，要么控制返回的总页数，要么对超过特定阈值的页数进行 SQL 改写。
    正例：先快速定位需要获取的 id 段，然后再关联：
    SELECT a.* FROM 表 1 a, ( select id from 表 1 where 条件 LIMIT 100000,20 ) b where a.id=b.id

  • SQL 性能优化的目标：至少要达到 range 级别，要求是 ref 级别，如果可以是 consts 最好。
    说明：
    1）consts 单表中最多只有一个匹配行（主键或者唯一索引），在优化阶段即可读取到数据。
    2）ref 指的是使用普通的索引（normal index）。
    3）range 对索引进行范围检索。
    反例：explain 表的结果，type=index，索引物理文件全扫描，速度非常慢，这个 index 级别比较 range 还低，与全表扫描是小巫见大巫。

  • 建组合索引的时候，区分度最高的在最左边。
    正例：如果 where a=? and b=? ，如果 a 列的几乎接近于唯一值，那么只需要单建 idx_a 索引即可。
    说明：存在非等号和等号混合时，在建索引时，请把等号条件的列前置。如：where c>? and d=? 那么即使 c 的区分度更高，也必须把 d 放在索引的最前列，即索引 idx_d_c。

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

  • 创建索引时避免有如下极端误解：
    1）宁滥勿缺。认为一个查询就需要建一个索引。
    2）宁缺勿滥。认为索引会消耗空间、严重拖慢更新和新增速度。
    3）抵制惟一索引。认为业务的惟一性一律需要在应用层通过“先查后插”方式解决。

安全规约

  • 隶属于用户个人的页面或者功能必须进行权限控制校验。
    说明：防止没有做水平权限校验就可随意访问、修改、删除别人的数据，比如查看他人的私信 内容、修改他人的订单。

  • 用户敏感数据禁止直接展示，必须对展示数据进行脱敏。
    说明：中国大陆个人手机号码显示为:158****9119，隐藏中间 4 位，防止隐私泄露。

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

  • 用户请求传入的任何参数必须做有效性验证。
    说明：忽略参数校验可能导致：
    1）page size 过大导致内存溢出；
    2）恶意 order by 导致数据库慢查询；
    3）任意重定向；
    4）SQL 注入；
    5）反序列化注入；
    6）正则输入源串拒绝服务 ReDoS；
    说明：Java 代码用正则来验证客户端的输入，有些正则写法验证普通用户输入没有问题，但是如果攻击人员使用的是特殊构造的字符串来验证，有可能导致死循环的结果。

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

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

  • 在使用平台资源，譬如短信、邮件、电话、下单、支付，必须实现正确的防重放的机制，如数量限制、疲劳度控制、验证码校验，避免被滥刷而导致资损。
    说明：如注册时发送验证码到手机，如果没有限制次数和频率，那么可以利用此功能骚扰到其它用户，并造成短信平台资源浪费。

  • 发贴、评论、发送即时消息等用户生成内容的场景必须实现防刷、文本内容违禁词过滤等风控策略。