代码规范整理(Java版)

Java代码规范整理

LengToo攀登.png

对于一个整体的软件系统而言，既需要宏观上的架构决策，设计与指导原则，也必须重视微观上的代码细节。在软件历史中，有许多影响深远的重大失败，其根源往往是编码细节出现了疏漏。

---

参考文献资料

• 《阿里巴巴开发手册》
• 《编写可读代码的艺术》
• 《代码之美》
• 《代码整洁之道》
• 《重构-改善既有代码的设计》
• 《Effective Java》
• 《Thinking in java》
• 《MySQL技术内幕》
• 《高性能MySQL》
• 《Effective MySQL》

---

目录

├──── ─表层规约
├ ├── 命名风格
├ ├── 常量定义
├ ├── 代码格式
├── ── ─控制流和逻辑规约
├ ├── 控制语句
├ ├── 注释规约
├── ── ─代码组织规约
├ ├── OOP规约
├ ├── 集合处理
├ ├── 并发处理
├ └── 异常规约
├── ── ─Mysql数据库规约
├ ├── 建表规约
├ ├── 索引规约
├ ├── SQL语句
└ └── ORM映射

---

表层规约

可读性基本定理：代码的写法应当使别人理解它所需要的时间最小化。

---

一、命名风格

1. 类或接口的声名：类、接口定义语法规范如下

   [可见性][('abstract'|'final')] [Class|Interface] class_name [('extends'|'implements')][父类或接口名]{
       //方法体
       ...
   }
   

2. 方法声明：良好的程序设计应该尽可能减小类与类之间耦合，所遵循的经验法则是：尽量限制成员函数的可见性。如果成员函数没必要公有 (public)，就定义为保护 (protected)；没必要保护 (protected)，就定义为私有 (private)；方法定义语法规范：
   声明顺序：构造方法、静态公共方法、静态私有方法、公共方法、友元方法、受保护方法、私有方法、main方法；方法参数建议顺序：(被操作者，操作内容，操作标志，其他)。

   [可见性]['abstract'] [‘static’] ['final'] ['synchronized'][返回值类型] method_name(参数列表)[('throws')][异常列表]{
       //方法体
       ...
   }
   

3. 代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。
   反例：_name / __name / $name / name_ / name$ / name__
4. 代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。

   说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式
   也要避免采用。
   正例：sinoroad / taobao / youku / hangzhou 等国际通用的名称，可视同英文。
   反例：DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3
   

5. 类名使用 UpperCamelCase 风格，但以下情形例外：DO / BO / DTO / VO / AO /PO / UID 等。
   正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion 反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion
6. 方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从驼峰形式。
   正例： localValue / getHttpMessage() / inputUserId
7. 常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
   正例：MAX_STOCK_COUNT ;反例：MAX_COUNT
8. 抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类命名以它要测试的类的名称开始，以 Test 结尾。
9. 类型与中括号紧挨相连来表示数组。

   正例：定义整形数组 int[] arrayDemo;
   反例：在 main 参数中，使用 String args[]来定义。
   

10. POJO 类中布尔类型的变量，都不要加 is 前缀，否则部分框架解析会引起序列化错误。
    框架在反向解析的时候，“误以为”对应的属性名称是 deleted，导致属性获取不到，进而抛出异常。
11. 包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。
    正例：应用工具类包名为 com.alibaba.ai.util、类名为 MessageUtils（此规则参考spring的框架结构）
12. 杜绝完全不规范的缩写，避免望文不知义。
    反例：AbstractClass“缩写”命名成 AbsClass；condition“缩写”命名成 condi，此类随意缩写严重降低了代码的可阅读性。
13. 枚举类名建议带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。

    说明：枚举其实就是特殊的类，域成员均为常量，且构造方法被默认强制是私有。
    正例：枚举名字为 ProcessStatusEnum 的成员名称：SUCCESS / UNKNOWN_REASON。
    

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

二、常量定义

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

   String key = "Id#taobao_" + tradeId;
   cache.put(key, value);
   

2. 在 long 或者 Long 赋值时，数值后使用大写的 L，不能是小写的 l，小写容易跟数字 1 混淆，造成误解。
   说明：Long a = 2l; 写的是数字的 21，还是 Long 型的 2?
3. 不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。
   说明：大而全的常量类，杂乱无章，使用查找功能才能定位到修改的常量，不利于理解和维护。 正例：缓存相关常量放在类 CacheConsts 下；系统配置相关常量放在类 ConfigConsts 下。

三、代码格式

1. 大括号的使用约定。如果是大括号内为空，则简洁地写成{}即可，不需要换行；如果是非空代码块则：
   • 左大括号前不换行。
   • 左大括号后换行。
   • 左大括号后换行。
   • 右大括号后还有 else 等代码则不换行；表示终止的右大括号后必须换行。
2. 左小括号和字符之间不出现空格；同样，右小括号和字符之间也不出现空格；而左大括号前需要空格。
   反例：if (空格 a == b 空格)
3. if/for/while/switch/do 等保留字与括号之间都必须加空格。
4. 任何二目、三目运算符的左右两边都需要加一个空格。
   说明：运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号等。
5. 采用 4 个空格缩进，禁止使用 tab 字符。
   说明：如果使用 tab 缩进，必须设置 1 个 tab 为 4 个空格。IDEA 设置 tab 为 4 个空格时， 请勿勾选 Use tab character；而在 eclipse 中，必须勾选 insert spaces for tabs。
正例:

   public static void main(String[] args) {
       // 缩进 4 个空格
       String say = "hello";
       // 运算符的左右必须有一个空格
       int flag = 0;
       // 关键词 if 与括号之间必须有一个空格，括号内的 f 与左括号，0 与右括号不需要空格
       if (flag == 0) {
           System.out.println(say);
       }
       // 左大括号前加空格且不换行；左大括号后换行
       if (flag == 1) {
           System.out.println("world");
       // 右大括号前换行，右大括号后有 else，不用换行
       } else {
           System.out.println("ok");
       // 在右大括号后直接结束，则必须换行
       }
   }
   

6. 注释的双斜线与注释内容之间有且仅有一个空格。
   正例：

   // 这是示例注释，请注意在双斜线之后有一个空格
   String ygb = new String();
   

7. 单行字符数限制不超过 120 个，超出需要换行，换行时遵循如下原则：
   • 1） 第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。
   • 2） 运算符与下文一起换行。
   • 3） 方法调用的点符号与下文一起换行。
   • 4） 方法调用中的多个参数需要换行时，在逗号后进行。
   • 5） 在括号前不要换行，见反例。
     正例：

   StringBuffer sb = new StringBuffer();
   // 超过 120 个字符的情况下，换行缩进 4 个空格，点号和方法名称一起换行
   sb.append("zi").append("xin")...
       .append("huang")...
       .append("huang")...
       .append("huang");
   

   反例：

   StringBuffer sb = new StringBuffer();
   // 超过 120 个字符的情况下，不要在括号前换行
   sb.append("zi").append("xin")...append
       ("huang");
   // 参数很多的方法调用可能超过 120 个字符，不要在逗号前换行
   method(args1, args2, args3, ...
        , argsX);
   

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

---

控制流和逻辑规约

使用符合人类自然语言的表达习惯

---

四、控制语句

1. 在一个 switch 块内，每个 case 要么通过 break/return 等来终止，要么注释说明程序将继续执行到哪一个 case 为止；在一个 switch 块内，都必须包含一个 default 语句并且放在最后，即使空代码。
2. 在 if/else/for/while/do 语句中必须使用大括号。即使只有一行代码，避免采用单行的编码方式：if (condition) statements;
3. 在高并发场景中，避免使用”等于”判断作为中断或退出的条件。
   说明：如果并发控制没有处理好，容易产生等值判断被“击穿”的情况，使用大于或小于的区间判断条件来代替。 反例：判断剩余奖品数量等于 0 时，终止发放奖品，但因为并发处理错误导致奖品数量瞬间变成了负数，这样的话，活动无法终止。
4. 表达异常的分支时，少用 if-else 方式，这种方式可以改写成：

   if (condition) {
       ...
       return obj;
   }
   // 接着写 else 的业务逻辑代码;
   说明：如果非得使用 if()...else if()...else...方式表达逻辑，【强制】避免后续代码维护困难，请勿超过 3 层。
   正例：超过 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;
   }
   

5. 除常用方法（如 getXxx/isXxx）等外，不要在条件判断中执行其它复杂的语句，将复杂逻辑判断的结果赋值给一个有意义的布尔变量名，以提高可读性。
   说明：很多 if 语句内的逻辑相当复杂，阅读者需要分析条件表达式的最终结果，才能明确什么样的条件执行什么样的语句，那么，如果阅读者分析逻辑表达式错误呢？

   正例：
   // 伪代码如下
   final boolean existed = (file.open(fileName, "w") != null) && (...) || (...);
   if (existed) {
       ...
   }
   反例：
   if ((file.open(fileName, "w") != null) && (...) || (...)) {
       ...
   }
   

五、注释规约

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

   // xxx 方式。
   

   说明：在 IDE 编辑窗口中，Javadoc 方式会提示相关注释，生成 Javadoc 可以正确输出相应注释；在 IDE 中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读效率。
2. 所有的抽象方法（包括接口中的方法）必须要用 Javadoc 注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。
   说明：对子类的实现要求，或者调用注意事项，请一并说明。
3. 所有的类都必须添加创建者和创建日期。
4. 方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/* */注释，注意与代码对齐。
5. 所有的枚举类型字段必须要有注释，说明每个数据项的用途。
6. 与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。
   反例：“TCP 连接超时”解释成“传输控制协议连接超时”，理解反而费脑筋。
7. 代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改。
   说明：代码与注释更新不同步，就像路网与导航软件更新不同步一样，如果导航软件严重滞后，就失去了导航的意义。
8. 谨慎注释掉代码。在上方详细说明，而不是简单地注释掉。如果无用，则删除。
   说明：代码被注释掉有两种可能性：
   • 1）后续会恢复此段代码逻辑。
   • 2）永久不用。前者如果没有备注信息，难以知晓注释动机。后者建议直接删掉（代码仓库保存了历史代码）。
9. 对于注释的要求：第一、能够准确反应设计思想和代码逻辑；第二、能够描述业务含义，使别的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者形同天书，注释是给自己看的，即使隔很长时间，也能清晰理解当时的思路；注释也是给继任者看的，使其能够快速接替自己的工作。
10. 好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现注释的一个极端：过多过滥的注释，代码的逻辑一旦修改，修改注释是相当大的负担。

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

11. 特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描，经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。
    • 1） 待办事宜（TODO）:（ 标记人，标记时间，[预计处理时间]）表示需要实现，但目前还未实现的功能。这实际上是一个 Javadoc 的标签，目前的 Javadoc还没有实现，但已经被广泛使用。只能应用于类，接口和方法（因为它是一个 Javadoc 标签）。
    • 2） 错误，不能工作（FIXME）:（标记人，标记时间，[预计处理时间]）在注释中用 FIXME 标记某代码是错误的，而且不能工作，需要及时纠正的情况。

---

代码组织规约

抽取出与程序主要目的“不相关的子逻辑”

---

六、OOP 规约

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

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

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

   说明：可变参数必须放置在参数列表的最后。（提倡同学们尽量不用可变参数编程）
   正例：public List listUsers(String type, Long... ids) {...}
   

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

   说明：java.net.URLDecoder 中的方法 decode(String encodeStr) 这个方法已经过时，应阿里巴巴 Java 开发手册7/38该使用双参数 decode(String source, String encode)。接口提供方既然明确是过时接口，那么有义务同时提供新的接口；作为调用方来说，有义务去考证过时方法的新实现是什么。
   

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

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

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

    public Integer getData() {
        if (condition) {
            return this.data + 100;
        } else {
            return this.data - 100;
        }
    }
    

七、集合处理

1. 关于 hashCode 和 equals 的处理，遵循如下规则：
   1） 只要重写 equals，就必须重写 hashCode。
2） 因为 Set 存储的是不重复的对象，依据 hashCode 和 equals 进行判断，所以 Set 存储的对象必须重写这两个方法。
3） 如果自定义对象作为 Map 的键，那么必须重写 hashCode 和 equals。
说明：String 重写了 hashCode 和 equals 方法，所以我们可以非常愉快地使用 String 对象作为 key 来使用。
2. ArrayList的subList结果不可强转成ArrayList，否则会抛出ClassCastException异常，即 java.util.RandomAccessSubList cannot be cast to java.util.ArrayList。
   说明：subList 返回的是 ArrayList 的内部类 SubList，并不是 ArrayList 而是 ArrayList的一个视图，对于 SubList 子列表的所有操作最终会反映到原列表上。
3. 在 subList 场景中，高度注意对原集合元素的增加或删除，均会导致子列表的遍历、增加、删除产生ConcurrentModificationException 异常。
4. 使用集合转数组的方法，必须使用集合的 toArray(T[] array)，传入的是类型完全一样的数组，大小就是 list.size()。
   说明：使用 toArray 带参方法，入参分配的数组空间不够大时，toArray 方法内部将重新分配内存空间，并返回新数组地址；如果数组元素个数大于实际所需，下标为[ list.size() ]的数组元素将被置为 null，其它数组元素保持原值，因此最好将方法入参数组大小定义与集合元素个数一致。
   正例：

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

   反例：直接使用 toArray 无参方法存在问题，此方法返回值只能是 Object[]类，若强转其它类型数组将出现 ClassCastException 错误。
5. 使用工具类 Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方法，它的 add/remove/clear 方法会抛出 UnsupportedOperationException 异常。说明：asList 的返回对象是一个 Arrays 内部类，并没有实现集合的修改方法。Arrays.asList
   体现的是适配器模式，只是转换接口，后台的数据仍是数组。

    String[] str = new String[] { "you", "wu" };
    List list = Arrays.asList(str);
    第一种情况：list.add("yangguanbao"); 运行时异常。
    第二种情况：str[0] = "gujin"; 那么 list.get(0)也会随之修改。
   

6. 泛型通配符来接收返回的数据，此写法的泛型集合不能使用 add 方法，而不能使用 get 方法，作为接口调用赋值时易出错。
   说明：扩展说一下 PECS(Producer Extends Consumer Super)原则：第一、频繁往外读取内容的，适合用。第二、经常往里插入的，适合用。
7. 不要在 foreach 循环里进行元素的 remove/add 操作。remove 元素请使用 Iterator方式，如果并发操作，需要对 Iterator 对象加锁。
   正例：

   List list = new ArrayList<>(); 
   list.add("1"); 
   list.add("2"); 
   Iterator 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”，会是同样的结果吗？
8. 在 JDK7 版本及以上，Comparator 实现类要满足如下三个条件，不然 Arrays.sort，Collections.sort 会报 IllegalArgumentException 异常。
   说明：三个条件如下
   • 1） x，y 的比较结果和 y，x 的比较结果相反。
   • 2） x>y，y>z，则 x>z。
   • 3） x=y，则 x，z 比较结果和 y，z 比较结果相同。反例：下例中没有处理相等的情况，实际使用中可能会出现异常：

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

八、并发处理

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

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

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

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

   说明：如果是 JDK8 的应用，可以使用 Instant 代替 Date，LocalDateTime 代替 Calendar，DateTimeFormatter 代替 SimpleDateFormat，官方给出的解释：simple beautiful strongimmutable thread-safe。
6. 高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁；能锁区块，就不要锁整个方法体；能用对象锁，就不要用类锁。
   说明：尽可能使加锁的代码块工作量尽可能的小，避免在锁代码块中调用 RPC 方法。
7. 对多个资源、数据库表、对象同时加锁时，需要保持一致的加锁顺序，否则可能会造成死锁。
   说明：线程一需要对表 A、B、C 依次全部加锁后才可以进行更新操作，那么线程二的加锁顺序也必须是 A、B、C，否则可能出现死锁。
8. 并发修改同一记录时，避免更新丢失，需要加锁。要么在应用层加锁，要么在缓存加锁，要么在数据库层使用乐观锁，使用 version 作为更新依据。
   说明：如果每次访问冲突概率小于 20%，推荐使用乐观锁，否则使用悲观锁。乐观锁的重试次数不得小于 3 次。
9. 多线程并行处理定时任务时，Timer 运行多个 TimeTask 时，只要其中之一没有捕获抛出的异常，其它任务便会自动终止运行，使用 ScheduledExecutorService 则没有这个问题。
10. 【推荐】在并发场景下，通过双重检查锁（double-checked locking）实现延迟初始化的优化问题隐患(可参考 The "Double-Checked Locking is Broken" Declaration)，推荐解决方案中较为简单一种（适用于 JDK5 及以上版本），将目标属性声明为 volatile 型。
    反例：

    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...
    }
    

九、异常规约

1. Java 类库中定义的可以通过预检查方式规避的 RuntimeException 异常不应该通过catch 的方式来处理，比如：NullPointerException，IndexOutOfBoundsException 等等。
   说明：无法通过预检查的异常除外，比如，在解析字符串形式的数字时，不得不通过 catchNumberFormatException 来实现。
正例：if (obj != null) {...} 反例：try { obj.method(); } catch (NullPointerException e) {…}
2. 异常不要用来做流程控制，条件控制。
   说明：异常设计的初衷是解决程序运行中的各种意外情况，且异常的处理效率比条件判断方式要低很多。
3. catch 时请分清稳定代码和非稳定代码，稳定代码指的是无论如何不会出错的代码。对于非稳定代码的 catch 尽可能进行区分异常类型，再做对应的异常处理。
   说明：对大段代码进行 try-catch，使程序无法根据不同的异常做出正确的应激反应，也不利于定位问题，这是一种不负责任的表现。
正例：用户注册的场景中，如果用户输入非法字符，或用户名称已存在，或用户输入密码过于简单，在程序上作出分门别类的判断，并提示给用户。
4. 捕获异常是为了处理它，不要捕获了却什么都不处理而抛弃之，如果不想处理它，请将该异常抛给它的调用者。最外层的业务使用者，必须处理异常，将其转化为用户可以理解的内容。
5. 有 try 块放到了事务代码中，catch 异常后，如果需要回滚事务，一定要注意手动回滚事务。
6. finally 块必须对资源对象、流对象进行关闭，有异常也要做 try-catch。
   说明：如果 JDK7 及以上，可以使用 try-with-resources 方式。
7. 不要在 finally 块中使用 return。
   说明：finally 块中的 return 返回后方法结束执行，不会再执行 try 块中的 return 语句。
8. 捕获异常与抛异常，必须是完全匹配，或者捕获异常是抛异常的父类。
   说明：如果预期对方抛的是绣球，实际接到的是铅球，就会产生意外情况。
9. 方法的返回值可以为 null，不强制返回空集合，或者空对象等，必须添加注释充分说明什么情况下会返回 null 值。
   说明：本手册明确防止 NPE 是调用者的责任。即使被调用方法返回空集合或者空对象，对调用者来说，也并非高枕无忧，必须考虑到远程调用失败、序列化失败、运行时异常等场景返回null 的情况。
10. 防止 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 问题。

---

Mysql规约

---

十、建表规约

1. 表达是与否概念的字段，必须使用 is_xxx 的方式命名，数据类型是 unsigned tinyint（1 表示是，0 表示否）。
   说明：任何字段如果为非负数，必须是 unsigned。 注意：POJO 类中的任何布尔类型的变量，都不要加 is 前缀，所以，需要在设置从 is_xxx 到 Xxx 的映射关系。数据库表示是与否的值，使用 tinyint 类型，坚持 is_xxx 的命名方式是为了明确其取值含义与取值范围。 正例：表达逻辑删除的字段名 is_deleted，1 表示删除，0 表示未删除。
2. 表名、字段名必须使用小写字母或数字，禁止出现数字开头，禁止两个下划线中间只出现数字。数据库字段名的修改代价很大，因为无法进行预发布，所以字段名称需要慎重考虑。
   说明：MySQL 在 Windows 下不区分大小写，但在 Linux 下默认是区分大小写。因此，数据库名、表名、字段名，都不允许出现任何大写字母，避免节外生枝。

   正例：aliyun_admin，rdc_config，level3_name
   反例：AliyunAdmin，rdcConfig，level_3_name
   

3. 表名不使用复数名词。
   说明：表名应该仅仅表示表里面的实体内容，不应该表示实体数量，对应于 DO 类名也是单数形式，符合表达习惯。
4. 禁用保留字，如 desc、range、match、delayed 等，请参考 MySQL 官方保留字。
5. 主键索引名为 pk_字段名；唯一索引名为 uk_字段名；普通索引名则为 idx_字段名。
   说明：pk_ 即 primary key；uk_ 即 unique key；idx_ 即 index 的简称。
6. 小数类型为 decimal，禁止使用 float 和 double。
   说明：float 和 double 在存储的时候，存在精度损失的问题，很可能在值的比较时，得到不正确的结果。如果存储的数据范围超过 decimal 的范围，建议将数据拆成整数和小数分开存储。
7. 如果存储的字符串长度几乎相等，使用 char 定长字符串类型。
8. varchar 是可变长字符串，不预先分配存储空间，长度不要超过 5000，如果存储长度大于此值，定义字段类型为 text，独立出来一张表，用主键来对应，避免影响其它字段索引效率。
9. 表必备三字段：id, gmt_create, gmt_modified。
   说明：其中 id 必为主键，类型为 bigint unsigned、单表时自增、步长为 1。gmt_create,gmt_modified 的类型均为 datetime 类型，前者现在时表示主动创建，后者过去分词表示被动更新。
10. 表的命名最好是加上“业务名称_表的作用”。
    正例：alipay_task / force_project / trade_config
11. 库名与应用名称尽量一致。
12. 单表行数超过 500 万行（varchar型居多）或者1000万行（int型为主）或者单表容量超过 2GB，才推荐进行分库分表。
    说明：如果预计三年后的数据量根本达不到这个级别，请不要在创建表时就分库分表。
13. 合适的字符存储长度，不但节约数据库表空间、节约索引存储，更重要的是提升检索速度。
    正例：如下表，其中无符号值可以避免误存负数，且扩大了表示范围。

    对象	年龄区间	类型	字节	表示范围
    人	150 岁之内	tinyint unsigned	1	无符号值：0 到 255
    龟	数百岁	smallint unsigned	2	无符号值：0 到 65535
    恐龙化石	数千万年	int unsigned	4	无符号值：0 到约 42.9 亿
    太阳	约 50 亿年	bigint unsigned	8	无符号值：0 到约 10 的 19 次方

十一、索引规约

1. 业务上具有唯一特性的字段，即使是多个字段的组合，也必须建成唯一索引。
   说明：不要以为唯一索引影响了 insert 速度，这个速度损耗可以忽略，但提高查找速度是明显的；另外，即使在应用层做了非常完善的校验控制，只要没有唯一索引，根据墨菲定律，必然有脏数据产生。
2. 超过三个表禁止 join。需要 join 的字段，数据类型必须绝对一致；多表关联查询时，保证被关联的字段需要有索引。
   说明：即使双表 join 也要注意表索引、SQL 性能。
3. 在 varchar 字段上建立索引时，必须指定索引长度，没必要对全字段建立索引，根据实际文本区分度决定索引长度即可。
   说明：索引的长度与区分度是一对矛盾体，一般对字符串类型数据，长度为 20 的索引，区分度会高达 90%以上，可以使用 count(distinct left(列名, 索引长度))/count(*)的区分度来确定。
4. 页面搜索严禁左模糊或者全模糊，如果需要请走搜索引擎来解决。
   说明：索引文件具有 B-Tree 的最左前缀匹配特性，如果左边的值未确定，那么无法使用此索引。
5. 如果有 order by 的场景，请注意利用索引的有序性。order by 最后的字段是组合索引的一部分，并且放在索引组合顺序的最后，避免出现 file_sort 的情况，影响查询性能。
   正例：where a=? and b=? order by c; 索引：a_b_c 反例：索引中有范围查找，那么索引有序性无法利用，如：WHERE a>10 ORDER BY b; 索引a_b 无法排序。
6. 利用延迟关联或者子查询优化超多分页场景。
   说明：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
   

7. SQL 性能优化的目标：至少要达到 range 级别，要求是 ref 级别，如果可以是 consts最好。
   说明：
   • 1）consts 单表中最多只有一个匹配行（主键或者唯一索引），在优化阶段即可读取到数据。
   • 2）ref 指的是使用普通的索引（normal index）。
   • 3）range 对索引进行范围检索。
     反例：explain 表的结果，type=index，索引物理文件全扫描，速度非常慢，这个 index 级别比较 range 还低，与全表扫描是小巫见大巫。
8. 建组合索引的时候，区分度最高的在最左边。
   正例：如果 where a=? and b=? ，如果 a 列的几乎接近于唯一值，那么只需要单建 idx_a索引即可。 说明：存在非等号和等号混合时，在建索引时，请把等号条件的列前置。如：where c>? andd=? 那么即使 c 的区分度更高，也必须把 d 放在索引的最前列，即索引 idx_d_c。
9. 防止因字段类型不同造成的隐式转换，导致索引失效。
10. 【参考】创建索引时避免有如下极端误解：
    • 1）宁滥勿缺。认为一个查询就需要建一个索引。
    • 2）宁缺勿滥。认为索引会消耗空间、严重拖慢更新和新增速度。
    • 3）抵制惟一索引。认为业务的惟一性一律需要在应用层通过“先查后插”方式解决。

十二、SQL 语句

1. 不要使用 count(列名)或 count(常量)来替代 count()，count()是 SQL92 定义的标准统计行数的语法，跟数据库无关，跟 NULL 和非 NULL 无关。
   说明：count(*)会统计值为 NULL 的行，而 count(列名)不会统计此列为 NULL 值的行。
2. count(distinct col) 计算该列除 NULL 之外的不重复行数，注意 count(distinctcol1, col2) 如果其中一列全为 NULL，那么即使另一列有不同的值，也返回为 0。
3. 当某一列的值全是 NULL 时，count(col)的返回结果为 0，但 sum(col)的返回结果为NULL，因此使用 sum()时需注意 NPE 问题。

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

4. 使用 ISNULL()来判断是否为 NULL 值。
   说明：NULL 与任何值的直接比较都为 NULL。
   • 1） NULL<>NULL 的返回结果是 NULL，而不是 false。
   • 2） NULL=NULL 的返回结果是 NULL，而不是 true。
   • 3） NULL<>1 的返回结果是 NULL，而不是 true。
5. 在代码中写分页查询逻辑时，若 count 为 0 应直接返回，避免执行后面的分页语句。
6. 不得使用外键与级联，一切外键概念必须在应用层解决。
   说明：以学生和成绩的关系为例，学生表中的 student_id是主键，那么成绩表中的 student_id则为外键。如果更新学生表中的 student_id，同时触发成绩表中的 student_id 更新，即为级联更新。外键与级联更新适用于单机低并发，不适合分布式、高并发集群；级联更新是强阻塞，存在数据库更新风暴的风险；外键影响数据库的插入速度。
7. 禁止使用存储过程，存储过程难以调试和扩展，更没有移植性。
8. 数据订正（特别是删除、修改记录操作）时，要先 select，避免出现误删除，确认无误才能执行更新语句。
9. in 操作能避免则避免，若实在避免不了，需要仔细评估 in 后边的集合元素数量，控制在 1000 个之内。
10. 【参考】如果有国际化需要，所有的字符存储与表示，均以 utf-8 编码，注意字符统计函数的区别。

    说明：
    SELECT LENGTH("轻松工作")； 返回为 12
    SELECT CHARACTER_LENGTH("轻松工作")； 返回为 4
    如果需要存储表情，那么选择 utf8mb4 来进行存储，注意它与 utf-8 编码的区别。
    

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

十三、ORM 映射

1. 在表查询中，一律不要使用 * 作为查询的字段列表，需要哪些字段必须明确写明。
   说明：1）增加查询分析器解析成本。2）增减字段容易与 resultMap 配置不一致。3）无用字段增加网络消耗，尤其是 text 类型的字段。
2. POJO 类的布尔属性不能加 is，而数据库字段必须加 is_，要求在 resultMap 中进行字段与属性之间的映射。
   说明：参见定义 POJO 类以及数据库字段定义规定，在中增加映射，是必须的。在 MyBatis Generator 生成的代码中，需要进行对应的修改。
3. 不要用 resultClass 当返回参数，即使所有类属性名与数据库字段一一对应，也需要定义；反过来，每一个表也必然有一个 POJO 类与之对应。
   说明：配置映射关系，使字段与 DO 类解耦，方便维护。
4. sql.xml 配置参数使用：#{}，#param# 不要使用${} 此种方式容易出现 SQL 注入。
5. iBATIS 自带的 queryForList(String statementName,int start,int size)不推荐使用。
   说明：其实现方式是在数据库取到statementName对应的SQL语句的所有记录，再通过subList取 start,size 的子集合。

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

6. 不允许直接拿 HashMap 与 Hashtable 作为查询结果集的输出。
   说明：resultClass=”Hashtable”，会置入字段名和属性值，但是值的类型不可控。
7. 更新数据表记录时，必须同时更新记录对应的 gmt_modified 字段值为当前时间。
8. 不要写一个大而全的数据更新接口。传入为 POJO 类，不管是不是自己的目标更新字段，都进行 update table set c1=value1,c2=value2,c3=value3; 这是不对的。执行 SQL时，不要更新无改动的字段，一是易出错；二是效率低；三是增加 binlog 存储。
9. 【参考】@Transactional 事务不要滥用。事务会影响数据库的 QPS，另外使用事务的地方需要考虑各方面的回滚方案，包括缓存回滚、搜索引擎回滚、消息补偿、统计修正等。
10. 【参考】中的 compareValue 是与属性值对比的常量，一般是数字，表示相等时带上此条件；表示不为空且不为 null 时执行；表示不为 null 值时执行。