命名风格

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

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

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

正例: 应用工具类包名为 com.alibaba.ai.util、类名为 MessageUtils

  1. 【推荐】在常量与变量的命名时，表示类型的名词放在词尾，以提升辨识度。

正例: startTime / workQueue / nameList / TERMINATED_THREAD_COUNT

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

B) 领域模型命名规约

  1. 数据对象: xxxDO，xxx 即为数据表名。

  2. 数据传输对象: xxxDTO，xxx 为业务领域相关的名称。

  3. 展示对象: xxxVO，xxx 一般为网页名称。

  4. POJO 是 DO/DTO/BO/VO 的统称，禁止命名成 xxxPOJO。

常量定义

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

  2. 【推荐】如果变量值仅在一个固定范围内变化用 enum 类型来定义。

SPRING(1), SUMMER(2), AUTUMN(3), WINTER(4);

代码格式

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

IDEA 设置 tab 为 4 个空格时，请勿勾选 Use tab character

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

// 注释

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

要使用 Windows 格式。

11.【推荐】单个方法的总行数不超过 80 行

(四) OOP 规约

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

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

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

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

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

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

正例:

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

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

10.【强制】为了防止精度损失，禁止使用构造方法 BigDecimal(double) 的方式把 double 值转 化为 BigDecimal 对象。

正例: 优先推荐入参为 String 的构造方法，或使用 BigDecimal 的 valueOf 方法，此方法内部其实执行了 Double 的 toString，而 Double 的 toString 按 double 的实际能表达的精度对尾数进行了截断。

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

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

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

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

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

13.【强制】序列化类新增属性时，请不要修改 serialVersionUID 字段，避免反序列失败; 如果 完全不兼容升级，避免反序列化混乱，那么请修改 serialVersionUID 值。

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

15.【强制】POJO 类必须写 toString 方法。使用 IDE 中的工具: source> generate toString 时，如果继承了另一个 POJO 类，注意在前面加一下 super.toString。

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

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

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

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

  1. 不允许被继承的类，如: String 类。

  2. 不允许修改引用的域对象。

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

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

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

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

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

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

  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. 【强制】关于 hashCode 和 equals 的处理，遵循如下规则:

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

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

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

  1. 【强制】Collections 类返回的对象，如: emptyList()/singletonList() 等都是 immutable list，不可对其进行添加或者删除元素的操作。

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

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

正例:

List list = new ArrayList<>(2);

list.add(“guan”);

list.add(“bao”);

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

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

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

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

  2. 【强制】使用工具类 Arrays.asList() 把数组转换成集合时，不能使用其修改集合相关的方 法，它的 add/remove/clear 方法会抛出 UnsupportedOperationException 异常。

说明: asList 的返回对象是一个 Arrays 内部类，并没有实现集合的修改方法。Arrays.asList 体现的是适 配器模式，只是转换接口，后台的数据仍是数组。

String[] str = new String[] { “yang”, “hao” };

List list = Arrays.asList(str);

第一种情况: list.add(“yangguanbao”); 运行时异常。

第二种情况: str[0] = “changed”; 也会随之修改，反之亦然。

  1. 【强制】泛型通配符 <?extendsT> 来接收返回的数据，此写法的泛型集合不能使用 add 方法，而 <? super T > 不能使用 get 方法，作为接口调用赋值时易出错。

说明: 扩展说一下 PECS(Producer Extends Consumer Super)

原则:

第一、频繁往外读取内容的，适合 用 <? extends T>。

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

  1. 【强制】在无泛型限制定义的集合赋值给泛型限制的集合时，在使用集合元素时，需要进行 instanceof 判断，避免抛出 ClassCastException 异常。

11.【强制】不要在 foreach 循环里进行元素的 remove/add 操作。remove 元素请使用 Iterator 方式，如果并发操作，需要对 Iterator 对象加锁。

12.【强制】在 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. 【推荐】集合初始化时，指定集合初始值大小。

说明: HashMap 使用 HashMap(int initialCapacity) 初始化。

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

15.【推荐】使用 entrySet 遍历 Map 类集合 KV，而不是 keySet 方式进行遍历。如果是 JDK8， 使用 Map.forEach 方法。

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



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

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

(六) 并发处理

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

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

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

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

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

  1. FixedThreadPool 和 SingleThreadPool:

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

  1. CachedThreadPool:

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

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

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

  1. 【强制】必须回收自定义的 ThreadLocal 变量，尤其在线程池场景下，线程经常会被复用， 如果不清理自定义的 ThreadLocal 变量，可能会影响后续业务逻辑和造成内存泄露等问题。 尽量在代理中使用 try-finally 块进行回收。

正例:

objectThreadLocal.set(userInfo);

try {

// …

} finally {objectThreadLocal.remove();

}

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

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

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

正例:

Lock lock = new XxxLock();

// …

lock.lock();

try {

doSomething();

doOthers();}

finally {

lock.unlock();

}

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

boolean isLocked = lock.tryLock();

if (isLocked) {

try {

doSomething();

doOthers();}

finally {

lock.unlock();}

}

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

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

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

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

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

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

(七) 控制语句

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

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

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

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

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

  1. 【推荐】表达异常的分支时，少用 if-else 方式。

正例: 超过 3 层的 if-else 的逻辑判断代码可以使用卫语句、策略模式、状态模式等来实现，其中卫语句 即代码逻辑先考虑失败、异常、中断、退出等直接返回的情况，以方法多个出口的方式，解决代码中判断 分支嵌套的问题，这是逆向思维的体现。

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

  1. 【推荐】接口入参保护，这种场景常见的是用作批量操作的接口。

(八) 注释规约

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

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

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

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

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

  6. 【参考】对于注释的要求:

第一、能够准确反映设计思想和代码逻辑；

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

  1. 【参考】好的命名、代码结构是自解释的，注释力求精简准确、表达到位。

  2. 【参考】特殊注释标记，请注明标记人与标记时间。

  1. 待办事宜 (TODO):(标记人，标记时间，[预计处理时间])

  2. 错误，不能工作 (FIXME):(标记人，标记时间，[预计处理时间])

(九) 其它

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

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

说明: 如果想获取更加精确的纳秒级时间值，使用 System.nanoTime() 的方式。在 JDK8 中，针对统计时 间等场景，推荐使用 Instant 类。

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

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

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

二、异常日志

(一) 异常处理

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

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

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

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

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

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

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

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

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

(二) 日志规约

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

  2. 【强制】应用中的扩展日志 (如打点、临时监控、访问日志等) 命名方式: appName_logType_logName.log。logType: 日志类型，如 stats/monitor/access 等; logName: 日志 描述。

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

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

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

正例:

// 如果判断为真，那么可以输出 trace 和 debug 级别的日志 if (logger.isDebugEnabled()) {

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

}

  1. 【强制】异常信息应该包括两类信息: 案发现场信息和异常堆栈信息。如果不处理，那么通 过关键字 throws 往上抛出。

正例: logger.error(各类参数或者对象 toString() + “_” + e.getMessage(), e);

三、单元测试

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

A:Automatic(自动化)

I:Independent(独立性)

R:Repeatable(可重复)

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

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

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

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

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

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

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

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

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

四、安全规约

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

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

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

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

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

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

五、MySQL 数据库

(一) 建表规约

  1. 【强制】表达是与否概念的字段，必须使用 is_xxx 命名，数据类型为 unsigned tinyint (1 表示是，0 表示否)

  2. 【强制】表名、字段名必须使用小写字母或数字，禁止出现数字开头，禁止两个下划线中间 只出现数字。

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

  4. 【强制】主键索引名为 pk_字段名; 唯一索引名为 uk_字段名; 普通索引名则为 idx_字段名。

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

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

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

  8. 【强制】表必备三字段: id,create_time,update_time。

id 为 bigint unsigned，create_time 和 update_time 为 datetime。

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

正例: alipay_task / force_project / trade_config

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

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

  2. 不是 varchar 超长字段，更不能是 text 字段。

  3. 不是唯一索引的字段。

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

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

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

(二) 索引规约

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

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

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

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

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

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

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

正例: where a=? and b=? order by c; 索引: a_b_c

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

说明: 索引中字段已包含查询的所需结果，成为覆盖索引。

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

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

说明: 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

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

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

(三) SQL 语句

  1. 【强制】不要使用 count(列名) 或 count(常量) 来替代 count(*)。

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

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

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

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

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

  1. 【强制】数据订正 (特别是删除、修改记录操作) 时，要先 select，避免出现误删除，确认无误才能执行更新语句。

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

(四) ORM 映射

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

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

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

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

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

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

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

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

六、工程结构

(一) 应用分层

  1. 【参考】(分层异常处理规约) 在 DAO 层，产生的异常类型有很多，无法用细粒度的异常进 行 catch，使用 catch(Exception e) 方式，并 throw new DAOException(e)，不需要打印日志，因 为日志在 Manager/Service 层一定需要捕获并打印到日志文件中去，如果同台服务器再打日 志，浪费性能和存储。

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

• DO(Data Object): 此对象与数据库表结构一一对应，通过 DAO 层向上传输数据源对象。

• DTO(Data Transfer Object): 数据传输对象，Service 或 Manager 向外传输的对象。

• BO(Business Object): 业务对象，由 Service 层输出的封装业务逻辑的对象。

• AO(Application Object): 应用对象，在 Web 层与 Service 层之间抽象的复用对象模型，极为贴 近展示层，复用度不高。

• VO(View Object): 显示层对象，通常是 Web 向模板渲染引擎层传输的对象。

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

(二) 二方库依赖

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

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

  2. ArtifactID 格式: 产品线名 - 模块名。正例: dubbo-client / fastjson-api / jstorm-tool

  3. Version。

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

说明: 注意起始版本号必须为: 1.0.0，而不是 0.0.1，正式版本号不允许覆盖升级。如当前版本: 1.3.3，那么下一个合理的版本号: 1.3.4 或 1.4.0 或 2.0.0

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

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

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

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

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

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

(三) 服务器

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

  2. 【推荐】调大服务器所支持的最大文件句柄数 (FileDescriptor，简写为 fd)。

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

七、设计规约

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

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

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

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

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

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

  3. 【强制】如果系统中超过 2 个对象之间存在协作关系，并且需要表示复杂的处理流程，使用活动图来表示。 说明: 活动图是流程图的扩展，增加了能够体现协作关系的对象泳道，支持表示并发等。

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

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

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

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

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

  9. 【参考】设计的本质就是识别和表达系统难点，找到系统的变化点，并隔离变化点。