阿里巴巴java开发手册1.4 主要内容整理

OOP 规约

1、强制】所有的覆写方法，必须加@Override 注解。
说明：getObject()与 get0bject()的问题。一个是字母的 O，一个是数字的 0，加@Override
可以准确判断是否覆盖成功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编
译报错。
2. 关于基本数据类型与包装数据类型的使用标准如下：
1） 【强制】所有的 POJO 类属性必须使用包装数据类型。
2） 【强制】RPC 方法的返回值和参数必须使用包装数据类型。
3） 【推荐】所有的局部变量使用基本数据类型。
说明：POJO 类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何
NPE 问题，或者入库检查，都由使用者来保证。
正例：数据库的查询结果可能是 null，因为自动拆箱，用基本数据类型接收有 NPE 风险。
反例：比如显示成交总额涨跌情况，即正负 x%，x 为基本数据类型，调用的 RPC 服务，调用
不成功时，返回的是默认值，页面显示为 0%，这是不合理的，应该显示成中划线。所以包装
数据类型的 null 值，能够表示额外的信息，如：远程调用失败，异常退出。
3. 【强制】定义 DO/DTO/VO 等 POJO 类时，不要设定任何属性默认值。
反例：POJO 类的 gmtCreate 默认值为 new Date()，但是这个属性在数据提取时并没有置入具
体值，在更新其它字段时又附带更新了此字段，导致创建时间被修改成当前时间。
4. 【强制】POJO 类必须写 toString 方法。使用 IDE 中的工具：source> generate toString
时，如果继承了另一个 POJO 类，注意在前面加一下 super.toString。
说明：在方法执行抛出异常时，可以直接调用 POJO 的 toString()方法打印其属性值，便于排
查问题。
5. 【推荐】使用索引访问用 String 的 split 方法得到的数组时，需做最后一个分隔符后有无
内容的检查，否则会有抛 IndexOutOfBoundsException 的风险。
说明：

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

6. 【推荐】循环体内，字符串的连接方式，使用 StringBuilder 的 append 方法进行扩展。
   说明：下例中，反编译出的字节码文件显示每次循环都会 new 出一个 StringBuilder 对象，
   然后进行 append 操作，最后通过 toString 方法返回 String 对象，造成内存资源浪费。
   反例：

String str = "start"; 
for (int i = 0; i < 100; i++) { 
str = str + "hello"; 
}

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

集合处理

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

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

List<String> list = new ArrayList<>(); 
list.add("1"); 
list.add("2"); 
Iterator<String> iterator = list.iterator(); 
while (iterator.hasNext()) { 
	String item = iterator.next(); 
	if (删除元素的条件) { 
		iterator.remove(); 	
	} 
}

反例：

for (String item : list) { 
	if ("1".equals(item)) { 
		list.remove(item); 	
	} 
} 

说明：以上代码的执行结果肯定会出乎大家的意料，那么试一下把“1”换成“2”，会是同样的
结果吗？
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<Student>() { 
	@Override 
	public int compare(Student o1, Student o2) { 
		return o1.getId() > o2.getId() ? 1 : -1; 	
	} 
};

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

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

10. 【推荐】集合初始化时，指定集合初始值大小。
    说明：HashMap 使用 HashMap(int initialCapacity) 初始化。 正例：initialCapacity = (需要存储的元素个数 / 负载因子) + 1。注意负载因子（即 loader
    factor）默认为 0.75，如果暂时无法确定初始值大小，请设置为 16（即默认值）。
    反例：HashMap 需要放置 1024 个元素，由于没有设置容量初始大小，随着元素不断增加，容
    量 7 次被迫扩大，resize 需要重建 hash 表，严重影响性能。
11. 【推荐】使用 entrySet 遍历 Map 类集合 KV，而不是 keySet 方式进行遍历。
    说明：keySet 其实是遍历了 2 次，一次是转为 Iterator 对象，另一次是从 hashMap 中取出
    key 所对应的 value。而 entrySet 只是遍历了一次就把 key 和 value 都放到了 entry 中，效
    率更高。如果是 JDK8，使用 Map.foreach 方法。
    正例：values()返回的是 V 值集合，是一个 list 集合对象；keySet()返回的是 K 值集合，是
    一个 Set 集合对象；entrySet()返回的是 K-V 值组合集合。
12. 【推荐】高度注意 Map 类集合 K/V 能不能存储 null 值的情况，如下表格：
    集合类 Key Value Super 说明
    Hashtable 不允许为 null 不允许为 null Dictionary 线程安全
    ConcurrentHashMap 不允许为 null 不允许为 null AbstractMap 锁分段技术（JDK8:CAS）
    TreeMap 不允许为 null 允许为 null AbstractMap 线程不安全
    HashMap 允许为 null 允许为 null AbstractMap 线程不安全
    反例： 由于 HashMap 的干扰，很多人认为 ConcurrentHashMap 是可以置入 null 值，而事实上，
    存储 null 值时会抛出 NPE 异常。

并发处理

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

7. 【强制】多线程并行处理定时任务时，Timer 运行多个 TimeTask 时，只要其中之一没有捕获
   抛出的异常，其它任务便会自动终止运行，使用 ScheduledExecutorService 则没有这个问题。
8. 【推荐】避免 Random 实例被多线程使用，虽然共享该实例是线程安全的，但会因竞争同一
   seed 导致的性能下降。
   说明：Random 实例包括 java.util.Random 的实例或者 Math.random()的方式。
   正例：在 JDK7 之后，可以直接使用 API ThreadLocalRandom，而在 JDK7 之前，需要编码保
   证每个线程持有一个实例。
9. 【推荐】在并发场景下，通过双重检查锁（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... 
}

10. 【参考】volatile 解决多线程内存不可见问题。对于一写多读，是可以解决变量同步问题，
    但是如果多写，同样无法解决线程安全问题。如果是 count++操作，使用如下类实现：
    AtomicInteger count = new AtomicInteger(); count.addAndGet(1); 如果是 JDK8，推
    荐使用 LongAdder 对象，比 AtomicLong 性能更好（减少乐观锁的重试次数）。

控制语句

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

final boolean existed = (file.open(fileName, "w") != null) && (...) || (...);
if (existed) {
...
} 

反例：

if ((file.open(fileName, "w") != null) && (...) || (...)) {
...
}

2. 【推荐】循环体中的语句要考量性能，以下操作尽量移至循环体外处理，如定义对象、变量、
   获取数据库连接，进行不必要的 try-catch 操作（这个 try-catch 是否可以移至循环体外）。
3. 【推荐】避免采用取反逻辑运算符。
   说明：取反逻辑不利于快速理解，并且取反逻辑写法必然存在对应的正向逻辑写法。
   正例：使用 if (x < 628) 来表达 x 小于 628。
   反例：使用 if (!(x >= 628)) 来表达 x 小于 628。
4. 【参考】下列情形，需要进行参数校验： 1） 调用频次低的方法。
   2） 执行时间开销很大的方法。此情形中，参数校验时间几乎可以忽略不计，但如果因为参
   数错误导致中间执行回退，或者错误，那得不偿失。
   3） 需要极高稳定性和可用性的方法。
   4） 对外提供的开放接口，不管是 RPC/API/HTTP 接口。
   5） 敏感权限入口。

其他

1. 【强制】后台输送给页面的变量必须加$!var——中间的感叹号。说明：如果var等于null或者不存在，那么${var}会直接显示在页面上。
2. 【强制】注意 Math.random() 这个方法返回是 double 类型，注意取值的范围 0≤x<1（能够
   取到零值，注意除零异常），如果想获取整数类型的随机数，不要将 x 放大 10 的若干倍然后
   取整，直接使用 Random 对象的 nextInt 或者 nextLong 方法。
3. 【强制】获取当前毫秒数 System.currentTimeMillis(); 而不是 new Date().getTime();
   说明：如果想获取更加精确的纳秒级时间值，使用 System.nanoTime()的方式。在 JDK8 中，
   针对统计时间等场景，推荐使用 Instant 类。

异常日志

1. 【强制】catch 时请分清稳定代码和非稳定代码，稳定代码指的是无论如何不会出错的代码。
   对于非稳定代码的 catch 尽可能进行区分异常类型，再做对应的异常处理。
   说明：对大段代码进行 try-catch，使程序无法根据不同的异常做出正确的应激反应，也不利
   于定位问题，这是一种不负责任的表现。
   正例：用户注册的场景中，如果用户输入非法字符，或用户名称已存在，或用户输入密码过于
   简单，在程序上作出分门别类的判断，并提示给用户。
2. 【强制】finally 块必须对资源对象、流对象进行关闭，有异常也要做 try-catch。
   说明：如果 JDK7 及以上，可以使用 try-with-resources 方式。
3. 【推荐】防止 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 问题。

日志规约

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

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

2. 【强制】日志文件至少保存 15 天，因为有些异常具备以“周”为频次发生的特点。
3. 【强制】应用中的扩展日志（如打点、临时监控、访问日志等）命名方式：
   appName_logType_logName.log。
   logType:日志类型，如 stats/monitor/access 等；logName:日志描述。这种命名的好处：
   通过文件名就可知道日志文件属于什么应用，什么类型，什么目的，也有利于归类查找。
   正例：mppserver 应用中单独监控时区转换异常，如：

mppserver_monitor_timeZoneConvert.log

说明：推荐对日志进行分类，如将错误日志和业务日志分开存放，便于开发人员查看，也便于
通过日志对系统进行及时监控。
4. 【强制】对 trace/debug/info 级别的日志输出，必须使用条件输出形式或者使用占位符的方
式。
说明：

logger.debug("Processing trade with id: " + id + " and symbol: " + symbol);

如果日志级别是 warn，上述日志不会打印，但是会执行字符串拼接操作，如果 symbol 是对象，
会执行 toString()方法，浪费了系统资源，执行了上述操作，最终日志却没有打印。
正例：（条件）建设采用如下方式

if (logger.isDebugEnabled()) { 
logger.debug("Processing trade with id: " + id + " and symbol: " + symbol); 
} 

正例：（占位符）

logger.debug("Processing trade with id: {} and symbol : {} ", id, symbol);

5. 【强制】避免重复打印日志，浪费磁盘空间，务必在 log4j.xml 中设置 additivity=false。
   正例：

<logger name="com.taobao.dubbo.config" additivity="false"> 

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

logger.error(各类参数或者对象 toString() + "_" + e.getMessage(), e);

单元测试

1. 【强制】好的单元测试必须遵守 AIR 原则。
   说明：单元测试在线上运行时，感觉像空气（AIR）一样并不存在，但在测试质量的保障上，
   却是非常关键的。好的单元测试宏观上来说，具有自动化、独立性、可重复执行的特点。
    A：Automatic（自动化）
    I：Independent（独立性）
    R：Repeatable（可重复）
2. 【强制】单元测试应该是全自动执行的，并且非交互式的。测试用例通常是被定期执行的，执
   行过程必须完全自动化才有意义。输出结果需要人工检查的测试不是一个好的单元测试。单元
   测试中不准使用 System.out 来进行人肉验证，必须使用 assert 来验证。
3. 【强制】保持单元测试的独立性。为了保证单元测试稳定可靠且便于维护，单元测试用例之间
   决不能互相调用，也不能依赖执行的先后次序。
   反例：method2 需要依赖 method1 的执行，将执行结果作为 method2 的输入。
4. 【强制】单元测试是可以重复执行的，不能受到外界环境的影响。
   说明：单元测试通常会被放到持续集成中，每次有代码 check in 时单元测试都会被执行。如
   果单测对外部环境（网络、服务、中间件等）有依赖，容易导致持续集成机制的不可用。
   正例：为了不受外界环境影响，要求设计代码时就把 SUT 的依赖改成注入，在测试时用 spring
   这样的 DI 框架注入一个本地（内存）实现或者 Mock 实现。
5. 【强制】对于单元测试，要保证测试粒度足够小，有助于精确定位问题。单测粒度至多是类级
   别，一般是方法级别。
   说明：只有测试粒度小才能在出错时尽快定位到出错位置。单测不负责检查跨类或者跨系统的
   交互逻辑，那是集成测试的领域。
6. 【强制】核心业务、核心应用、核心模块的增量代码确保单元测试通过。
   说明：新增代码及时补充单元测试，如果新增代码影响了原有单元测试，请及时修正。
7. 【强制】单元测试代码必须写在如下工程目录：src/test/java，不允许写在业务代码目录下。
   说明：源码构建时会跳过此目录，而单元测试框架默认是扫描此目录。

安全规约

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

数据库

1. 【强制】表名、字段名必须使用小写字母或数字，禁止出现数字开头，禁止两个下划线中间只
   出现数字。数据库字段名的修改代价很大，因为无法进行预发布，所以字段名称需要慎重考虑。
   说明：MySQL 在 Windows 下不区分大小写，但在 Linux 下默认是区分大小写。因此，数据库名、
   表名、字段名，都不允许出现任何大写字母，避免节外生枝。
   正例：aliyun_admin，rdc_config，level3_name
   反例：AliyunAdmin，rdcConfig，level_3_name
2. 【强制】禁用保留字，如 desc、range、match、delayed 等，请参考 MySQL 官方保留字。
3. 【强制】主键索引名为 pk_字段名；唯一索引名为 uk_字段名；普通索引名则为 idx_字段名。
   说明：pk_ 即 primary key；uk_ 即 unique key；idx_ 即 index 的简称。
4. 【强制】小数类型为 decimal，禁止使用 float 和 double。
   说明：float 和 double 在存储的时候，存在精度损失的问题，很可能在值的比较时，得到不
   正确的结果。如果存储的数据范围超过 decimal 的范围，建议将数据拆成整数和小数分开存储。
5. 【推荐】单表行数超过 500 万行或者单表容量超过 2GB，才推荐进行分库分表。
   说明：如果预计三年后的数据量根本达不到这个级别，请不要在创建表时就分库分表。
6. 【参考】合适的字符存储长度，不但节约数据库表空间、节约索引存储，更重要的是提升检
   索速度。
   正例：如下表，其中无符号值可以避免误存负数，且扩大了表示范围。
   对象 年龄区间 类型 字节 表示范围
   人 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. 【推荐】利用覆盖索引来进行查询操作，避免回表。
   说明：如果一本书需要知道第 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

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。
5. 【强制】在代码中写分页查询逻辑时，若 count 为 0 应直接返回，避免执行后面的分页语句。
6. 【强制】不得使用外键与级联，一切外键概念必须在应用层解决。
   说明：以学生和成绩的关系为例，学生表中的 student_id是主键，那么成绩表中的 student_id
   则为外键。如果更新学生表中的 student_id，同时触发成绩表中的 student_id 更新，即为
   级联更新。外键与级联更新适用于单机低并发，不适合分布式、高并发集群；级联更新是强阻
   塞，存在数据库更新风暴的风险；外键影响数据库的插入速度。
7. 【强制】禁止使用存储过程，存储过程难以调试和扩展，更没有移植性。
8. 【强制】数据订正（特别是删除、修改记录操作）时，要先 select，避免出现误删除，确认
   无误才能执行更新语句。
9. 【参考】如果有国际化需要，所有的字符存储与表示，均以 utf-8 编码，注意字符统计函数
   的区别。
   说明：
   SELECT LENGTH(“轻松工作”)； 返回为 12
   SELECT CHARACTER_LENGTH(“轻松工作”)； 返回为 4
   如果需要存储表情，那么选择 utf8mb4 来进行存储，注意它与 utf-8 编码的区别。
10. 【参考】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<String, Object> map = new HashMap<>();
   map.put(“start”, start);
   map.put(“size”, size);
6. 【强制】不允许直接拿 HashMap 与 Hashtable 作为查询结果集的输出。
   说明：resultClass=”Hashtable”，会置入字段名和属性值，但是值的类型不可控。
7. 【强制】更新数据表记录时，必须同时更新记录对应的 gmt_modified 字段值为当前时间。

服务器

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. 【推荐】在线上生产环境，JVM 的 Xms 和 Xmx 设置一样大小的内存容量，避免在 GC 后调整堆
   大小带来的压力。
5. 【参考】服务器内部重定向使用 forward；外部重定向地址使用 URL 拼装工具类来生成，否则
   会带来 URL 维护不一致的问题和潜在的安全风险。