阿里编程规范

编程规范

---

一些定义

---

1. DO(Data Object):与数据库表结构一一对应，通过DAO层向上传输数据源对象。
2. DTO(Data Transfer Object):数据传输对象，service和Manager向外传输的对象。
3. BO(Business Object):业务对象，可以由Service层输出的封装业务逻辑的对象。
4. Query:数据查询对象，各层就收上层的查询请求，超过两个参数的查询的封装，禁止使用map类传输
5. VO(View Object): 显示层对象，通常是Web向模板渲染引擎层传输的对象。

命名风格

---

1. 【强制】代码中的命名均不能以下划线或者美元符号开始，也不能以下划线或者美元符号结束

2. 【强制】代码中的命名严禁用拼音与英文混合的方式，更不允许直接使用中文的方式。说明：正确的英文拼写和语法可以让阅读者更易于理解，避免歧义。注意：纯拼音命名方式也要避免采用。

3. 【强制】类名使用UpperCamelCase风格，必须遵循驼峰形式，但是以下形式除外：DO/BO/DTO/VO/AO

4. 【强制】方法名，参数名，成员变量，局部变量都统一使用lowerCamelCase风格，必须遵循驼峰形式。

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

6. 【强制】抽象类命名使用Abstract或者Base开头：异常类使用Exception结尾：测试类命名以他要测试的类的名称开始，以Test结尾。

7. 【强制】中括号是数组类型的一部分，数组定义如下：String[] args.

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

9. 【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词，报名统一使用单数形式，若类名有复数定义，类名可以使用复数形式。

10. 【强制】杜绝完全不规范的缩写，避免望文不知义

11. 【推荐】如果在类名中使用了设计模式，建议在类名中体现出具体模式。

12. 【推荐】接口类中的方法和属性不要加任何修饰符号(public 也不要加)，保持代码的简洁性，并加上有效的 Javadoc 注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。

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

    • 【强制】对于Service和DAO类，基于SOA的概念，暴露出来的服务一定是接口，内部的实现类用Impl的后缀与接口区别。
    • 【推荐】如果是形容能力的接口名称，取对应的形容词做接口名（通常是-able的形式）

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

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

15. 【参考】各层命名规则

    • Service/DAO层方法命名规约

      获取单个对象的方法用get做前缀

      获取多个对象的方法用list做前缀

      获取统计值的方法用count做前缀

      插入方法用save(推荐)或insert做前缀

      删除的方法用remove或delete做前缀

      修改的方法用update做前缀

    • 领域模型命名规则

      数据对象：xxxDO，xxx为表明

      数据传输对象：xxxDTO，xxx为业务领域相关的名称

      展示对象：xxxVO，xxx为网页名称

      POJO是统称：禁止命名成POJO

常量定义

---

1. 【强制】不允许任何魔法值(即未经定义的常量)直接出现在代码中。

2. 【强制】long或者Long初始赋值时，必须使用大写的L，而不能是小写的l，小写容易跟数字1混淆，造成误解。

3. 【推荐】不要使用一个常量类维护所有常量，应该按常量功能进行归类，分开维护。如：缓存相关的常量放在类：CacheConsts下；系统配置相关的常量放在类：ConfigConsts下。

   说明：大而全的常量类，非得使用查找功能才能定位到修改的常量，不利于理解和维护。

4. 【推荐】常量的复用层次有五层：跨应用共享常量，应用内存共享常量，子工程共享常量，包内共享常量，类内共享常量。

   • 跨应用共享常量：放在二方库中
   • 应用内共享常量：放置在一方库的modules中的constant目录下
   • 子工程内部共享常量：在子工程的constant下
   • 包内共享常量：即在当前包下单独的constant目录下
   • 类内共享常量

5. 【推荐】如果变量值仅在一个范围内变化，且带有名称之外的延伸属性，定义为枚举类。

代码格式

---

1. 【强制】大括号的使用约定。如果大括号内为空，则简洁的写成{}即可，不需要换行；如果是非空代码块则：

   • 左大括号前不换行
   • 左大括号后换行
   • 右大括号前换行
   • 右大括号后还有else等代码则不换行；表示终止的大括号后必换行

2. 【强制】左小括号和字符之间不出现空格，同样，右小括号和字符之间也不出现空格

3. 【强制】for/if/while/switch/do等保留字与括号之间都需要加一个空格。

4. 【强制】任何二目，三目运算符两边都需要加一个空格

   说明：运算符包括赋值运算符=，逻辑运算符&&，加减乘除符号等

5. 【强制】缩进采用4个空格，禁止使用tab字符

例子：
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. 【强制】单行字符限制不能超过120个，超出需要换行，换行时遵循如下原则：

   • 第二行相对第一行缩进4个空格，从第三行开始，不再继续缩进，参考示例
   • 运算符和上下文一起换行
   • 方法调用的点符号和下文一起换行
   • 在多个超长参数时，在逗号后换行
   • 在逗号前不要换行

7. 【强制】方法参数在定义和传入时，多个参数逗号后必定加空格

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

9. 【推荐】没有必要增加若干空格来是某一行的字符与上一行对应位置的字符对齐。

   在变量比较多的情况下很累赘

10. 【推荐】方法体内的执行语句组，变量的定义语句组，不同的业务逻辑或者不同的语义之间插入一个空行，相同业务逻辑和语义之间不需要插入空行

    说明：没必要插入多个空行进行隔开

OOP约束(面向对象)

---

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

2. 【强制】所有的覆写方法，必须加override进行注解

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

3. 【强制】相同参数类型，相同的业务含义，才可以使用可变参数

4. 【强制】外部正在调用或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方法产生影响，通过接口时必须添加deprecated(C++14)，并清晰的说明新接口或者服务是什么？

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

6. 【推荐】当一个类拥有多个构造方法，或者多个同名方法，应该按顺序放在一起

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

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

   • 不允许被继承的类
   • 不允许修改引用的域对象
   • 不允许被重写的方法
   • 不允许在运行过程中重新赋值的局部变量
   • 避免上下文重复使用同一个变量

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

集合处理

---

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

   • 只要重写equals，就必须重写hashCode

   • 因为Set存储的是不重复的对象，根据hashCode和equals进行判断，所以Set存储的对象必须重写这两个方法

   • 如果自定义对象作为Map的键，那么必须重写hashCode和equals

     说明：String重写了hashCode和equals方法，所以可以用String对象作为key来使用

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

3. 【推荐】集合初始化时，指定集合初始大小

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

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

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

---

并发控制

---

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

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

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

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

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

4. 【强制】线程池不允许使用Executors去创造，而是通过ThreadPoolExecutor的方式，这样的处理方式让写的童鞋更加清晰线程池的运行规则，避免资源耗尽的风险。

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

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

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

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

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

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

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

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

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

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

11. 【推荐】在并发场景下，通过双检查锁实现延迟初始化的优化问题隐患

控制语句

---

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

2. 【强制】在if/else/while/do语句中必须使用大括号，即使只有一行代码，避免使用单行的形式

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

    if (condition) {
     ...
     return obj;
    }
    // 接着写 else 的业务逻辑代码;
   

   超过3层的if-else代码里可以使用卫语句，或者状态模式实现

4. 【推荐】除常用方法外，不要再条件判断语句中执行复杂的语句，将复杂的逻辑判断结果赋给一个有意义的布尔变量名，提高可读性。

5. 【推荐】循环体内的语句要靠考虑性能，以下操作尽量移至循环体外处理，如定义对象，变量，获取数据库连接，进行不必要的try-catch

注释规约

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

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

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

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

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

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

7. 【参考】合理处理注释掉的代码。在上方详细说明，而不是简单的注释掉。如果无用，则删除。
   说明 : 代码被注释掉有两种可能性: 1)后续会恢复此段代码逻辑。2)永久不用。前者如果没 有备注信息，难以知晓注释动机。后者建议直接删掉(代码仓库保存了历史代码)。

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

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

   // put elephant into fridge
   put(elephant, fridge);
     
           @pdai: 代码已经复制到剪贴板
       
   

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

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

    1. 待办事宜(TODO)标记人，标记时间，[预计处理时间])表示需要实现，但目前还未实现的功能。这实际上是一个 Javadoc 的标签，目前的 Javadoc 还没有实现，但已经被广泛使用。只能应用于类，接口和方法(因为它是一个 Javadoc 标签)。
    2. 错误，不能工作(FIXME):(标记人，标记时间，[预计处理时间])在注释中用 FIXME 标记某代码是错误的，而且不能工作，需要及时纠正的情况。

其他

1. 【强制】在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。 说明: 不要在方法体内定义: Pattern pattern = Pattern.compile(规则);
2. 【强制】velocity 调用 POJO 类的属性时，建议直接使用属性名取值即可，模板引擎会自动按规范调用 POJO 的 getXxx()，如果是 boolean 基本数据类型变量(boolean 命名不需要加 is前缀)，会自动调用 isXxx()方法。
   说明 : 注意如果是 Boolean 包装类对象，优先调用 getXxx()的方法。
3. 【强制】后台输送给页面的变量必须加$!var——中间的感叹号。\ast \ast 说明\ast \ast :如果‘var=null‘或者不存在，那么${var}会直接显示在页面上。
4. 【强制】注意 Math.random() 这个方法返回是 double 类型，注意取值的范围 0≤x<1(能够取到零值，注意除零异常)，如果想获取整数类型的随机数，不要将 x 放大 10 的若干倍然后取整，直接使用 Random 对象的 nextInt 或者 nextLong 方法。
5. 【强制】获取当前毫秒数 System.currentTimeMillis(); 而不是 new Date().getTime();
   说明 : 如果想获取更加精确的纳秒级时间值，使用 System.nanoTime()的方式。在 JDK8 中，针对统计时间等场景，推荐使用 Instant 类。
6. 【推荐】不要在视图模板中加入任何复杂的逻辑。 说明 : 根据 MVC 理论，视图的职责是展示，不要抢模型和控制器的活。
7. 【推荐】任何数据结构的构造或初始化，都应指定大小，避免数据结构无限增长吃光内存。
8. 【推荐】对于“明确停止使用的代码和配置”，如方法、变量、类、配置文件、动态配置属性等要坚决从程序中清理出去，避免造成过多垃圾。

异常日志

异常处理

1. 【强制】Java 类库中定义的一类 RuntimeException 可以通过预先检查进行规避，而不应该通过 catch 来处理，比如: IndexOutOfBoundsException ， NullPointerException 等等。
   说明 : 无法通过预检查的异常除外，如在解析一个外部传来的字符串形式数字时，通过 catch NumberFormatException 来实现。
   正例 : if (obj != null) {...}
   反例 : try { obj.method() } catch (NullPointerException e) {...}
2. 【强制】异常不要用来做流程控制，条件控制，因为异常的处理效率比条件分支低。
3. 【强制】对大段代码进行 try-catch，这是不负责任的表现。catch 时请分清稳定代码和非稳定代码，稳定代码指的是无论如何不会出错的代码。对于非稳定代码的 catch 尽可能进行区分异常类型，再做对应的异常处理。
4. 【强制】捕获异常是为了处理它，不要捕获了却什么都不处理而抛弃之，如果不想处理它，请将该异常抛给它的调用者。最外层的业务使用者，必须处理异常，将其转化为用户可以理解的内容。
5. 【强制】有 try 块放到了事务代码中，catch 异常后，如果需要回滚事务，一定要注意手动回滚事务。
6. 【强制】finally 块必须对资源对象、流对象进行关闭，有异常也要做 try-catch。
   说明 : 如果 JDK7 及以上，可以使用 try-with-resources 方式。
7. 【强制】不能在 finally 块中使用 return，finally 块中的 return 返回后方法结束执行，不会再执行 try 块中的 return 语句。
8. 【强制】捕获异常与抛异常，必须是完全匹配，或者捕获异常是抛异常的父类。
   说明 : 如果预期对方抛的是绣球，实际接到的是铅球，就会产生意外情况。
9. 【推荐】方法的返回值可以为 null，不强制返回空集合，或者空对象等，必须添加注释充分说明什么情况下会返回 null 值。调用方需要进行 null 判断防止 NPE 问题。
   说明 : 本手册明确防止 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 问题。
11. 【推荐】定义时区分 unchecked / checked 异常，避免直接抛出 new RuntimeException()，更不允许抛出 Exception 或者 Throwable，应使用有业务含义的自定义异常。推荐业界已定义过的自定义异常，如: DAOException / ServiceException 等。
12. 【参考】在代码中使用“抛异常”还是“返回错误码”，对于公司外的 http/api 开放接口必须使用“错误码”；而应用内部推荐异常抛出；跨应用间 RPC 调用优先考虑使用 Result 方式，封装 isSuccess()方法、“错误码”、“错误简短信息”。
    说明 : 关于 RPC 方法返回方式使用 Result 方式的理由:
    1)使用抛异常返回方式，调用方如果没有捕获到就会产生运行时错误。
    2)如果不加栈信息，只是 new 自定义异常，加入自己的理解的 error message，对于调用端解决问题的帮助不会太多。如果加了栈信息，在频繁调用出错的情况下，数据序列化和传输的性能损耗也是问题。
13. 【参考】避免出现重复的代码(Don’t Repeat Yourself)，即 DRY 原则。
    说明 : 随意复制和粘贴代码，必然会导致代码的重复，在以后需要修改时，需要修改所有的副本，容易遗漏。必要时抽取共性方法，或者抽象公共类，甚至是共用模块。
    正例 : 一个类中有多个 public 方法，都需要进行数行相同的参数校验操作，这个时候请抽取: private boolean checkParam(DTO dto) {...}

日志规约

1. 【强制】应用中不可直接使用日志系统(Log4j、Logback)中的 API，而应依赖使用日志框架 SLF4J 中的 API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。

    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    private static final Logger logger = LoggerFactory.getLogger(Abc.class);
     
           @pdai: 代码已经复制到剪贴板
       
   

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

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

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

    if (logger.isDebugEnabled()) {
        logger.debug("Processing trade with id: " + id + " symbol: " + symbol);
    }
     
           @pdai: 代码已经复制到剪贴板
       
   

   正例 : (占位符)

    logger.debug("Processing trade with id: {} symbol : {} ", id, symbol);
     
           @pdai: 代码已经复制到剪贴板
       
   

5. 【强制】避免重复打印日志，浪费磁盘空间，务必在 log4j.xml 中设置 additivity=false。
   正例 : <logger name="com.taobao.dubbo.config" additivity="false">

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

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

8. 【参考】可以使用 warn 日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。注意日志输出的级别，error 级别只记录系统逻辑出错、异常等重要的错误信息。如非必要，请不要在此场景打出 error 级别。

MYSQL 数据库

建表规约

1. 【强制】表达是与否概念的字段，必须使用 is_xxx 的方式命名，数据类型是 unsigned tinyint( 1 表示是，0 表示否)。
   说明 : 任何字段如果为非负数，必须是 unsigned。
   正例 : 表达逻辑删除的字段名 is_deleted，1 表示删除，0 表示未删除。
2. 【强制】表名、字段名必须使用小写字母或数字，禁止出现数字开头，禁止两个下划线中间只出现数字。数据库字段名的修改代价很大，因为无法进行预发布，所以字段名称需要慎重考虑。
   正例 : getter_admin，task_config，level3_name
   反例 : GetterAdmin，taskConfig，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 必为主键，类型为 unsigned bigint、单表时自增、步长为 1。gmt_create, gmt_modified 的类型均为 date_time 类型。
10. 【推荐】表的命名最好是加上“业务名称_表的作用”。
    正例 : tiger_task / tiger_reader / mpp_config
11. 【推荐】库名与应用名称尽量一致。
12. 【推荐】如果修改字段含义或对字段表示的状态追加时，需要及时更新字段注释。
13. 【推荐】字段允许适当冗余，以提高查询性能，但必须考虑数据一致。冗余字段应遵循:
    1)不是频繁修改的字段。
    2)不是 varchar 超长字段，更不能是 text 字段。
    正例 : 商品类目名称使用频率高，字段长度短，名称基本一成不变，可在相关联的表中冗余存 储类目名称，避免关联查询。
14. 【推荐】单表行数超过 500 万行或者单表容量超过 2GB，才推荐进行分库分表。
    说明 : 如果预计三年后的数据量根本达不到这个级别，请不要在创建表时就分库分表。
15. 【参考】合适的字符存储长度，不但节约数据库表空间、节约索引存储，更重要的是提升检索速度。
    正例 : 如下表，其中无符号值可以避免误存负数，且扩大了表示范围。

对象	年龄区间	类型	表示范围
人	150 岁之内	unsigned tinyint	无符号值: 0 到 255
龟	数百岁	unsigned smallint	无符号值: 0 到 65535
恐龙化石	数千万年	unsigned int	无符号值: 0 到约 42.9 亿
太阳	约 50 亿年	unsigned bigint	无符号值: 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. 【推荐】利用覆盖索引来进行查询操作，避免回表。
   说明 : 如果一本书需要知道第 11 章是什么标题，会翻开第 11 章对应的那一页吗? 目录浏览一下就好，这个目录就是起到覆盖索引的作用。
   正例 : 能够建立索引的种类: 主键索引、唯一索引、普通索引，而覆盖索引是一种查询的一种 效果，用 explain 的结果，extra 列会出现: using index。
7. 【推荐】利用延迟关联或者子查询优化超多分页场景。
   说明 : 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
8. 【推荐】SQL 性能优化的目标: 至少要达到 range 级别，要求是 ref 级别，如果可以是 consts 最好。
   说明 :
   \1) consts 单表中最多只有一个匹配行(主键或者唯一索引)，在优化阶段即可读取到数据。
   \2) ref 指的是使用普通的索引(normal index)。
   \3) range 对索引进行范围检索。
   反例 : explain 表的结果，type=index，索引物理文件全扫描，速度非常慢，这个 index 级别比较 range 还低，与全表扫描是小巫见大巫。
9. 【推荐】建组合索引的时候，区分度最高的在最左边。
   正例 : 如果 where a=? and b=? ，a 列的几乎接近于唯一值，那么只需要单建 idx_a 索引即可。
   说明 : 存在非等号和等号混合判断条件时，在建索引时，请把等号条件的列前置。如: where a>? and b=? 那么即使 a 的区分度更高，也必须把 b 放在索引的最前列。
10. 【推荐】防止因字段类型不同造成的隐式转换，导致索引失效。
11. 【参考】创建索引时避免有如下极端误解:
    1)宁滥勿缺。误认为一个查询就需要建一个索引。
    2)宁缺勿滥。误认为索引会消耗空间、严重拖慢更新和新增速度。
    3)抵制惟一索引。误认为业务的惟一性一律需要在应用层通过“先查后插”方式解决。

SQL 语句

1. 【强制】不要使用 count(列名)或 count(常量)来替代 count()，count()是 SQL92 定义的标准统计行数的语法，跟数据库无关，跟 NULL 和非 NULL 无关。
   说明 : count(*)会统计值为 NULL 的行，而 count(列名)不会统计此列为 NULL 值的行。
2. 【强制】count(distinct col) 计算该列除 NULL 之外的不重复行数，注意 count(distinct col1, 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。  
  
        @pdai: 代码已经复制到剪贴板
    

1. 【强制】在代码中写分页查询逻辑时，若 count 为 0 应直接返回，避免执行后面的分页语句。
2. 【强制】不得使用外键与级联，一切外键概念必须在应用层解决。
   说明 : (概念解释)学生表中的 student_id 是主键，那么成绩表中的 student_id 则为外键。如果更新学生表中的 student_id，同时触发成绩表中的 student_id 更新，则为级联更新。外键与级联更新适用于单机低并发，不适合分布式、高并发集群；级联更新是强阻塞，存在数据库更新风暴的风险；外键影响数据库的插入速度。
3. 【强制】禁止使用存储过程，存储过程难以调试和扩展，更没有移植性。
4. 【强制】数据订正时，删除和修改记录时，要先 select，避免出现误删除，确认无误才能执行更新语句。
5. 【推荐】in 操作能避免则避免，若实在避免不了，需要仔细评估 in 后边的集合元素数量，控制在 1000 个之内。
6. 【参考】如果有全球化需要，所有的字符存储与表示，均以 utf-8 编码，注意字符统计函数的区别。
   说明 :
   SELECT LENGTH(“轻松工作”)； 返回为 12
   SELECT CHARACTER_LENGTH(“轻松工作”)； 返回为 4
   如果要使用表情，那么使用 utfmb4 来进行存储，注意它与 utf-8 编码的区别。
7. 【参考】TRUNCATE TABLE 比 DELETE 速度快，且使用的系统和事务日志资源少，但 TRUNCATE 无事务且不触发 trigger，有可能造成事故，故不建议在开发代码中使用此语句。
   说明 : TRUNCATE TABLE 在功能上与不带 WHERE 子句的 DELETE 语句相同。

ORM 映射

1. 【强制】在表查询中，一律不要使用 * 作为查询的字段列表，需要哪些字段必须明确写明。
   说明 : 1)增加查询分析器解析成本。2)增减字段容易与 resultMap 配置不一致。

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

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

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

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

    Map<String, Object> map = new HashMap<String, Object>();
    map.put("start", start);
    map.put("size", size);
     
           @pdai: 代码已经复制到剪贴板
       
   

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

工程结构

应用分层

1. 【推荐】图中默认上层依赖于下层，箭头关系表示可直接依赖，如: 开放接口层可以依赖于 Web 层，也可以直接依赖于 Service 层，依此类推:

   [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-mYm03fGq-1665391439382)(…/…/…/…/…/…/_images/ali_rules_app_layout.png)]

   • 开放接口层 : 可直接封装 Service 方法暴露成 RPC 接口；通过 Web 封装成 http 接口；进行网关安全控制、流量控制等。

   • 终端显示层 : 各个端的模板渲染并执行显示的层。当前主要是 velocity 渲染，JS 渲染，JSP 渲染，移动端展示等。

   • Web 层 : 主要是对访问控制进行转发，各类基本参数校验，或者不复用的业务简单处理等。

   • Service 层 : 相对具体的业务逻辑服务层。

   • Manager 层

     通用业务处理层，它有如下特征:

     1. 对第三方平台封装的层，预处理返回结果及转化异常信息；
     2. 对 Service 层通用能力的下沉，如缓存方案、中间件通用处理；
     3. 与 DAO 层交互，对多个 DAO 的组合复用。

   • DAO 层 : 数据访问层，与底层 MySQL、Oracle、Hbase 进行数据交互。

   • 外部接口或第三方平台 : 包括其它部门 RPC 开放接口，基础平台，其它公司的 HTTP 接口。

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

3. 【参考】分层领域模型规约:

   • DO(Data Object) : 与数据库表结构一一对应，通过 DAO 层向上传输数据源对象。
   • DTO(Data Transfer Object) : 数据传输对象，Service 和 Manager 向外传输的对象。
   • BO(Business Object) : 业务对象。可以由 Service 层输出的封装业务逻辑的对象。
   • Query : 数据查询对象，各层接收上层的查询请求。注: 超过 2 个参数的查询封装，禁止使用 Map 类来传输。
   • VO(View Object) : 显示层对象，通常是 Web 向模板渲染引擎层传输的对象。

二方库依赖

1. 【强制】定义 GAV 遵从以下规则:

2. GroupID 格式: com.{公司/BU }.业务线.[子业务线]，最多 4 级。
   说明 : {公司/BU} 例如: alibaba/taobao/tmall/aliexpress 等 BU 一级；子业务线可选。
   正例 : com.taobao.jstorm 或 com.alibaba.dubbo.register

3. ArtifactID 格式: 产品线名-模块名。语义不重复不遗漏，先到中央仓库去查证一下。
   正例 : dubbo-client / fastjson-api / jstorm-tool

4. Version: 详细规定参考下方。

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

6. 主版本号: 当做了不兼容的 API 修改，或者增加了能改变产品方向的新功能。

7. 次版本号: 当做了向下兼容的功能性新增(新增类、接口等)。

8. 修订号: 修复 bug，没有修改方法签名的功能加强，保持 API 兼容性。
   说明 : 注意: 起始版本号必须为: 1.0.0，而不是 0.0.1 正式发布的类库必须先去中央仓库进行查证，使版本号有延续性，正式版本号不允许覆盖升级。如当前版本: 1.3.3，那么下一个合理的版本号: 1.3.4 或 1.4.0 或 2.0.0

9. 【强制】线上应用不要依赖 SNAPSHOT 版本(安全包除外)。
   说明 : 不依赖 SNAPSHOT 版本是保证应用发布的幂等性。另外，也可以加快编译时的打包构建。

10. 【强制】二方库的新增或升级，保持除功能点之外的其它 jar 包仲裁结果不变。如果有改变， 必须明确评估和验证，建议进行 dependency:resolve 前后信息比对，如果仲裁结果完全不一 致，那么通过 dependency:tree 命令，找出差异点，进行<excludes>排除 jar 包。

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

12. 【强制】依赖于一个二方库群时，必须定义一个统一的版本变量，避免版本号不一致。 说明: 依赖 springframework-core,-context,-beans，它们都是同一个版本，可以定义一 个变量来保存版本: ${spring.version}，定义依赖的时候，引用该版本。

13. 【强制】禁止在子项目的 pom 依赖中出现相同的 GroupId，相同的 ArtifactId，但是不同的 Version。
    说明 : 在本地调试时会使用各子项目指定的版本号，但是合并成一个 war，只能有一个版本号 出现在最后的 lib 目录中。可能出现线下调试是正确的，发布到线上却出故障的问题。

14. 【推荐】所有 pom 文件中的依赖声明放在<dependencies>语句块中，所有版本仲裁放在 <dependencyManagement>语句块中。 说明: <dependencyManagement>里只是声明版本，并不实现引入，因此子项目需要显式的声 明依赖，version 和 scope 都读取自父 pom。而<dependencies>所有声明在主 pom 的 <dependencies>里的依赖都会自动引入，并默认被所有的子项目继承。

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

16. 【参考】为避免应用二方库的依赖冲突问题，二方库发布者应当遵循以下原则:
    1)精简可控原则。移除一切不必要的 API 和依赖，只包含 Service API、必要的领域模型对 象、Utils 类、常量、枚举等。如果依赖其它二方库，尽量是 provided 引入，让二方库使用 者去依赖具体版本号；无 log 具体实现，只依赖日志框架。
    2)稳定可追溯原则。每个版本的变化应该被记录，二方库由谁维护，源码在哪里，都需要能 方便查到。除非用户主动升级版本，否则公共二方库的行为不应该发生变化。

服务器

1. 【推荐】高并发服务器建议调小 TCP 协议的 time_wait 超时时间。 说明: 操作系统默认 240 秒后，才会关闭处于 time_wait 状态的连接，在高并发访问下，服 务器端会因为处于 time_wait 的连接数太多，可能无法建立新的连接，所以需要在服务器上 调小此等待值。
   正例 : 在 linux 服务器上请通过变更/etc/sysctl.conf 文件去修改该缺省值(秒): net.ipv4.tcp_fin_timeout = 30
2. 【推荐】调大服务器所支持的最大文件句柄数(File Descriptor，简写为 fd)。
   说明 : 主流操作系统的设计是将 TCP/UDP 连接采用与文件一样的方式去管理，即一个连接对 应于一个 fd。主流的 linux 服务器默认所支持最大 fd 数量为 1024，当并发连接数很大时很容易因为 fd 不足而出现“open too many files”错误，导致新的连接无法建立。 建议将 linux 服务器所支持的最大句柄数调高数倍(与服务器的内存数量相关)。
3. 【推荐】给 JVM 设置-XX:+HeapDumpOnOutOfMemoryError 参数，让 JVM 碰到 OOM 场景时输出 dump 信息。
   说明 : OOM 的发生是有概率的，甚至有规律地相隔数月才出现一例，出现时的现场信息对查错 非常有价值。
4. 【参考】服务器内部重定向使用 forward；外部重定向地址使用 URL 拼装工具类来生成，否则 会带来 URL 维护不一致的问题和潜在的安全风险。

安全规约

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

2. 【强制】用户敏感数据禁止直接展示，必须对展示数据进行脱敏。
   说明 : 查看个人手机号码会显示成:158****9119，隐藏中间 4 位，防止隐私泄露。

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

4. 【强制】用户请求传入的任何参数必须做有效性验证。
   说明 : 忽略参数校验可能导致:

   • page size 过大导致内存溢出
   • 恶意 order by 导致数据库慢查询
   • 任意重定向
   • SQL 注入
   • 反序列化注入
   • 正则输入源串拒绝服务 ReDoS

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

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

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

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

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

附 1: 版本历史

版本号	更新日期	备注
1.0.0	2017.2.9	阿里巴巴集团正式对外发布
1.0.1	2017.2.13	1)修正 String[]的前后矛盾。2)vm 修正成 velocity。3)修正 countdown 描述错误。
1.0.2	2017.2.20	1)去除文底水印。2)数据类型中引用太阳系年龄问题。3)修正关于异常和方法签名的部分描述。4)修正 final 描述。5)去除 Comparator 部分描述。
1.1.0	2017.2.27	1)增加前言。2)增加<? extends T>描述和说明。3)增加版本历史。4)增加专有名词解释。
1.1.1	2017.3.31	修正页码总数和部分示例
1.2.0	2017.5.20	1)根据云栖社区的“聚能聊”活动反馈，对手册的页码、排版、描述进行修正。2)增加 final的适用场景描述。3)增加关于锁的粒度的说明。4)增加“指定集合大小”的详细说明以及正反例。5)增加卫语句的示例代码。6)明确数据库表示删除概念的字段名为 is_deleted

附 2: 专有名词

1. POJO(Plain Ordinary Java Object): 在本手册中，POJO 专指只有 setter / getter / toString 的简单类，包括 DO/DTO/BO/VO 等。
2. DO(Data Object): 本手册指数据库表一一对应的 POJO 类。
3. GAV(GroupId、ArtifactctId、Version): Maven 坐标，是用来唯一标识 jar 包。
4. OOP(Object Oriented Programming): 本手册泛指类、对象的编程处理方式。
5. ORM(Object Relation Mapping): 对象关系映射，对象领域模型与底层数据之间的转换， 本文泛指 iBATIS, mybatis 等框架。
6. NPE(java.lang.NullPointerException): 空指针异常。
7. SOA(Service-Oriented Architecture): 面向服务架构，它可以根据需求通过网络对松散 耦合的粗粒度应用组件进行分布式部署、组合和使用，有利于提升组件可重用性，可维护性。
8. 一方库: 本工程内部子项目模块依赖的库(jar 包)。
9. 二方库: 公司内部发布到中央仓库，可供公司内部其它应用依赖的库(jar 包)。
10. 三方库: 公司之外的开源库(jar 包)。