陈晨辰 · 2019年10月04日

《Java开发手册》

一、 编程规约 (一) 命名风格

  1. 【强制】抽象类命名使用Abstract或Base开头;异常类命名使用Exception 结尾;测试类 命名以它要测试的类的名称开始,以Test结尾。
  2. 【强制】POJO类中布尔类型变量都不要加is前缀,否则部分框架解析会引起序列化错误。 说明:在本文 MySQL 规约中的建表约定第一条,表达是与否的值采用 is_xxx 的命名方式,所以,需要在 <resultMap>设置从 is_xxx到 xxx的映射关系。 反例:定义为基本数据类型 Boolean isDeleted 的属性,它的方法也是 isDeleted(),RPC框架在反向解 析的时候,“误以为”对应的属性名称是 deleted,导致属性获取不到,进而抛出异常。
  3. 【参考】各层命名规约: 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. 【强制】采用4个空格缩进,禁止使用tab字符。 说明:如果使用 tab 缩进,必须设置1 个tab 为4 个空格。IDEA 设置 tab 为4 个空格时,请勿勾选 Use tab character;而在 eclipse 中,必须勾选 insert spaces for tabs。 正例: (涉及1-5 点)

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"); // 在右大括号后直接结束,则必须换行 } }

(四) OOP规约

  1. 【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法,无谓增加编译器解析 成本,直接用类名来访问即可。
  2. 【强制】浮点数之间的等值判断,基本数据类型不能用==来比较,包装数据类型不能用 equals来判断。 说明:浮点数采用“尾数+阶码”的编码方式,类似于科学计数法的“有效数字+指数”的表示方式。二进制无法精确表示大部分的十进制小数
  3. 【强制】为了防止精度损失,禁止使用构造方法 BigDecimal(double)的方式把double值转 化为 BigDecimal对象。
  4. 关于基本数据类型与包装数据类型的使用标准如下: 1) 【强制】所有的 POJO类属性必须使用包装数据类型。 2) 【强制】RPC 方法的返回值和参数必须使用包装数据类型。 3) 【推荐】所有的局部变量使用基本数据类型。 说明:POJO类属性没有初值是提醒使用者在需要使用时,必须自己显式地进行赋值,任何 NPE问题,或 者入库检查,都由使用者来保证。 正例:数据库的查询结果可能是 null,因为自动拆箱,用基本数据类型接收有 NPE 风险。 反例:比如显示成交总额涨跌情况,即正负 x%,x为基本数据类型,调用的 RPC 服务,调用不成功时, 返回的是默认值,页面显示为 0%,这是不合理的,应该显示成中划线。所以包装数据类型的 null值,能 够表示额外的信息,如:远程调用失败,异常退出。
  5. 【强制】POJO类必须写toString方法。使用IDE中的工具:source> generate toString 时,如果继承了另一个POJO类,注意在前面加一下super.toString。 说明:在方法执行抛出异常时,可以直接调用 POJO的 toString()方法打印其属性值,便于排查问题。
  6. 【强制】禁止在POJO类中,同时存在对应属性xxx的isXxx()和getXxx()方法。 说明:框架在调用属性 xxx的提取方法时,并不能确定哪个方法一定是被优先调用到。
  7. 【推荐】使用索引访问用String的split方法得到的数组时,需做最后一个分隔符后有无内 容的检查,否则会有抛IndexOutOfBoundsException 的风险。 说明: String str = "a,b,c,,"; String[] ary = str.split(","); // 预期大于3,结果是3 System.out.println(ary.length);
  8. 【推荐】循环体内,字符串的连接方式,使用StringBuilder的append方法进行扩展。 说明:下例中,反编译出的字节码文件显示每次循环都会 new出一个 StringBuilder 对象,然后进行 append 操作,最后通过 toString 方法返回 String 对象,造成内存资源浪费。 反例: String str = "start"; for (int i = 0; i < 100; i++) { str = str + "hello"; }
  9. 【推荐】final可以声明类、成员变量、方法、以及本地变量,下列情况使用 final关键字: 1) 不允许被继承的类,如:String 类。 2) 不允许修改引用的域对象。 3) 不允许被覆写的方法,如:POJO类的 setter 方法。 4) 不允许运行过程中重新赋值的局部变量。 5) 避免上下文重复使用一个变量,使用 final可以强制重新定义一个变量,方便更好地进行重构。
  10. 【推荐】慎用 Object的 clone方法来拷贝对象。 说明:对象clone 方法默认是浅拷贝,若想实现深拷贝需覆写clone 方法实现域对象的深度遍历式拷贝。
  11. 【推荐】类成员与方法访问控制从严: 1) 如果不允许外部直接通过 new来创建对象,那么构造方法必须是 private。 2) 工具类不允许有 public或default 构造方法。 3) 类非static 成员变量并且与子类共享,必须是 protected。 4) 类非static 成员变量并且仅在本类使用,必须是private。 5) 类static 成员变量如果仅在本类使用,必须是 private。 6) 若是static 成员变量,考虑是否为final。 7) 类成员方法只供类内部调用,必须是 private。 8) 类成员方法只对继承类公开,那么限制为 protected。

(五) 集合处理

  1. 【强制】关于hashCode和equals的处理,遵循如下规则: 1) 只要覆写equals,就必须覆写hashCode。 2) 因为Set 存储的是不重复的对象,依据 hashCode和equals进行判断,所以 Set 存储的对象必须覆 写这两个方法。 3) 如果自定义对象作为Map 的键,那么必须覆写hashCode 和equals。 说明:String 已覆写hashCode 和equals方法,所以我们可以愉快地使用 String 对象作为key来使用。
  2. 【强制】使用Map 的方法 keySet()/values()/entrySet()返回集合对象时,不可以对其进行添 加元素操作,否则会抛出UnsupportedOperationException 异常。

说明:entrySet()中有key和value,所以直接加入元素或者删除元素的方法都是无效的。keySet()中有key,可以对key进行操作,所以能使用remove()和equals(),所以返回true。
values()中只有value值,没有key,value值是没什么用的,所以values()方法也仅仅是获取所有value值方便。

  1. 【强制】Collections 类返回的对象,如:emptyList()/singletonList()等都是immutable list,不可对其进行添加或者删除元素的操作。 反例:如果查询无结果,返回 Collections.emptyList()空集合对象,调用方一旦进行了添加元素的操作,就 会触发 UnsupportedOperationException 异常。
  2. 【强制】在subList场景中,高度注意对原集合元素的增加或删除,均会导致子列表的遍 历、增加、删除产生ConcurrentModificationException 异常。

正例:String[] sids = sList.toArray(new String[sList.size()]);
List<String> list = new ArrayList<>(2); list.add("guan"); list.add("bao"); String[] array = list.toArray(new String[0]);

说明:使用 toArray 带参方法,数组空间大小的 length: 1) 等于 0,动态创建与 size 相同的数组,性能最好。 2) 大于 0 但小于size,重新创建大小等于 size 的数组,增加 GC负担。
Java 开发手册
12/44
3) 等于 size,在高并发情况下,数组创建完成之后,size 正在变大的情况下,负面影响与上相同。 4) 大于 size,空间浪费,且在size 处插入 null 值,存在 NPE隐患。

反例:String[] array= (String[]) list.toArray();运行,报错

  1. 【强制】使用工具类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"; 也会随之修改,反之亦然。
  2. 【强制】泛型通配符<? extends T>来接收返回的数据,此写法的泛型集合不能使用 add方 法,而<? super T>不能使用 get方法,作为接口调用赋值时易出错。

说明:
extends 可用于返回类型限定,不能用于参数类型限定(换句话说:? extends xxx 只能用于方法返回类型限定,jdk能够确定此类的最小继承边界为xxx,只要是这个类的父类都能接收,但是传入参数无法确定具体类型,只能接受null的传入)。
super 可用于参数类型限定,不能用于返回类型限定(换句话说:? supper xxx 只能用于方法传参,因为jdk能够确定传入为xxx的子类,返回只能用Object类接收)。
? 既不能用于方法参数传入,也不能用于方法返回。

  1. 【强制】不要在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();
}
}
调用iterator的删除方法:
1.首先检查集合
2.删除元素
3.下一个元素的索引位置cursor重新赋值
4.检查集合参数重新赋值

反例:
for (String item : list) {
if ("1".equals(item)) {
list.remove(item);
}
}
总结:如果我们我们用foreach删除的元素刚好是最后一个,删除完成前下一个元素的索引位置cursor刚好等于集合长度size的大小。但是,删除完成后size的数量减1,但是cursor并没有变化。导致下一次循环不相等继续向下执行,导致检查数组不通过,抛出java.util.ConcurrentModificationException

  1. 【强制】在 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;          
    }      
    };
    
    
    15. 【推荐】使用 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值组合集合。

  1. 【参考】合理利用好集合的有序性(sort)和稳定性(order),避免集合的无序性(unsort)和不稳 定性(unorder)带来的负面影响。 说明:有序性是指遍历的结果是按某种比较规则依次排列的。稳定性指集合每次遍历的元素次序是一定 的。如:ArrayList 是order/unsort;HashMap 是unorder/unsort;TreeSet是 order/sort。
  2. 【参考】利用Set元素唯一的特性,可以快速对一个集合进行去重操作,避免使用List的 contains方法进行遍历、对比、去重操作。

(六) 并发处理

  1. 【强制】线程资源必须通过线程池提供,不允许在应用中自行显式创建线程。 说明:线程池的好处是减少在创建和销毁线程上所消耗的时间以及系统资源的开销,解决资源不足的问 题。如果不使用线程池,有可能造成系统创建大量同类线程而导致消耗完内存或者“过度切换”的问题。
  2. 【强制】线程池不允许使用Executors去创建,而是通过ThreadPoolExecutor的方式,这 样的处理方式让写的同学更加明确线程池的运行规则,规避资源耗尽的风险。 说明:Executors返回的线程池对象的弊端如下: 1) FixedThreadPool和SingleThreadPool: 允许的请求队列长度为 Integer.MAX_VALUE,可能会堆积大量的请求,从而导致 OOM。 2) CachedThreadPool: 允许的创建线程数量为 Integer.MAX_VALUE,可能会创建大量的线程,从而导致 OOM。
  3. 【强制】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。
  4. 【强制】必须回收自定义的ThreadLocal变量,尤其在线程池场景下,线程经常会被复用, 如果不清理自定义的 ThreadLocal变量,可能会影响后续业务逻辑和造成内存泄露等问题。 尽量在代理中使用try-finally块进行回收。 正例: objectThreadLocal.set(userInfo); try { // ... } finally { objectThreadLocal.remove(); }
  5. 【强制】高并发时,同步调用应该去考量锁的性能损耗。能用无锁数据结构,就不要用锁; 能锁区块,就不要锁整个方法体;能用对象锁,就不要用类锁。 说明:尽可能使加锁的代码块工作量尽可能的小,避免在锁代码块中调用 RPC方法
  6. 【强制】在使用阻塞等待获取锁的方式中,必须在try 代码块之外,并且在加锁方法与try 代 码块之间没有任何可能抛出异常的方法调用,避免加锁成功后,在 finally 中无法解锁。 说明一:如果在 lock 方法与 try代码块之间的方法调用抛出异常,那么无法解锁,造成其它线程无法成功 获取锁。 说明二:如果lock 方法在try代码块之内,可能由于其它方法抛出异常,导致在 finally代码块中, unlock 对未加锁的对象解锁,它会调用AQS的tryRelease 方法(取决于具体实现类),抛出 IllegalMonitorStateException 异常。 说明三:在Lock 对象的lock 方法实现中可能抛出 unchecked 异常,产生的后果与说明二相同
  7. 【强制】在使用尝试机制来获取锁的方式中,进入业务代码块之前,必须先判断当前线程是 否持有锁。锁的释放规则与锁的阻塞等待方式相同。 说明:Lock 对象的 unlock 方法在执行时,它会调用 AQS的 tryRelease 方法(取决于具体实现类),如果 当前线程不持有锁,则抛出 IllegalMonitorStateException 异常。
  8. 【强制】并发修改同一记录时,避免更新丢失,需要加锁。要么在应用层加锁,要么在缓存 加锁,要么在数据库层使用乐观锁,使用 version作为更新依据。 说明:如果每次访问冲突概率小于 20%,推荐使用乐观锁,否则使用悲观锁。乐观锁的重试次数不得小于 3 次。
  9. 【强制】多线程并行处理定时任务时,Timer运行多个 TimeTask时,只要其中之一没有捕获 抛出的异常,其它任务便会自动终止运行,如果在处理定时任务时使用 ScheduledExecutorService 则没有这个问题。
  10. 【推荐】使用 CountDownLatch进行异步转同步操作,每个线程退出前必须调用 countDown 方法,线程执行代码注意 catch异常,确保 countDown方法被执行到,避免主线程无法执行 至 await方法,直到超时才返回结果。 说明:注意,子线程抛出异常堆栈,不能在主线程 try-catch 到。
  11. 【推荐】避免 Random实例被多线程使用,虽然共享该实例是线程安全的,但会因竞争同一 seed 导致的性能下降。 说明:Random实例包括java.util.Random 的实例或者 Math.random()的方式。 正例:在JDK7 之后,可以直接使用 API ThreadLocalRandom,而在 JDK7 之前,需要编码保证每个线 程持有一个实例。
  12. 【推荐】在并发场景下,通过双重检查锁(double-checked locking)实现延迟初始化的优化 问题隐患(可参考 The "Double
  13. 【参考】volatile解决多线程内存不可见问题。对于一写多读,是可以解决变量同步问题,但 是如果多写,同样无法解决线程安全问题。 说明:如果是count++操作,使用如下类实现:AtomicInteger count = new AtomicInteger(); count.addAndGet(1); 如果是JDK8,推荐使用LongAdder 对象,比 AtomicLong 性能更好(减少乐观 锁的重试次数)。
  14. 【参考】HashMap 在容量不够进行resize时由于高并发可能出现死链,导致CPU飙升,在 开发过程中可以使用其它数据结构或加锁来规避此风险。
  15. 【参考】ThreadLocal对象使用static修饰,ThreadLocal 无法解决共享对象的更新问题。 说明:这个变量是针对一个线程内所有操作共享的,所以设置为静态变量,所有此类实例共享此静态变 量,也就是说在类第一次被使用时装载,只分配一块存储空间,所有此类的对象(只要是这个线程内定义 的)都可以操控这个变量。

(七) 控制语句

  1. 【强制】当switch 括号内的变量类型为String并且此变量为外部参数时,必须先进行null 判断。
  2. 【强制】在高并发场景中,避免使用”等于”判断作为中断或退出的条件。 说明:如果并发控制没有处理好,容易产生等值判断被“击穿”的情况,使用大于或小于的区间判断条件 来代替。 反例:判断剩余奖品数量等于 0 时,终止发放奖品,但因为并发处理错误导致奖品数量瞬间变成了负数, 这样的话,活动无法终止。

(八) 注释规约

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

(九) 其它

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

二、异常日志
(一) 异常处理

  1. 【强制】有try块放到了事务代码中,catch异常后,如果需要回滚事务,一定要注意手动回 滚事务。
  2. 【强制】finally块必须对资源对象、流对象进行关闭,有异常也要做try-catch。 说明:如果JDK7 及以上,可以使用 try-with-resources方式。
  3. 【强制】不要在finally块中使用return。 说明:try块中的 return 语句执行成功后,并不马上返回,而是继续执行 finally块中的语句,如果此处存 在 return 语句,则在此直接返回,无情丢弃掉try块中的返回点。
  4. 【推荐】防止 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.xml中设置 additivity=false。 正例:<logger name="com.taobao.dubbo.config" additivity="false">
  2. 【推荐】谨慎地记录日志。生产环境禁止输出 debug日志;有选择地输出 info日志;如果使 用 warn来记录刚上线时的业务行为信息,一定要注意日志输出量的问题,避免把服务器磁盘 撑爆,并记得及时删除这些观察日志。 说明:大量地输出无效日志,不利于系统性能提升,也不利于快速定位错误点。记录日志时请思考:这些 日志真的有人看吗?看到这条日志你能做什么?能不能给问题排查带来好处?
  3. 【推荐】可以使用warn日志级别来记录用户输入参数错误的情况,避免用户投诉时,无所 适从。如非必要,请不要在此场景打出error级别,避免频繁报警。 说明:注意日志输出的级别,error 级别只记录系统逻辑出错、异常或者重要的错误信息。
  4. 【推荐】尽量用英文来描述日志错误信息,如果日志中的错误信息用英文描述不清楚的话使 用中文描述即可,否则容易产生歧义。

三、单元测试

  1. 【强制】好的单元测试必须遵守 AIR原则。 说明:单元测试在线上运行时,感觉像空气(AIR)一样并不存在,但在测试质量的保障上,却是非常关 键的。好的单元测试宏观上来说,具有自动化、独立性、可重复执行的特点。

⚫ A:Automatic(自动化)
⚫ I:Independent(独立性)
⚫ R:Repeatable(可重复)

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

⚫ B:Border,边界值测试,包括循环边界、特殊取值、特殊时间点、数据顺序等。
⚫ C:Correct,正确的输入,并得到预期的结果。
⚫ D:Design,与设计文档相结合,来编写单元测试。
⚫ E:Error,强制错误信息输入(如:非法数据、异常流程、业务允许外等),并得到预期的结果。

  1. 【参考】为了更方便地进行单元测试,业务代码应避免以下情况:

⚫ 构造方法中做的事情过多。
⚫ 存在过多的全局变量和静态方法。
⚫ 存在过多的外部依赖。
⚫ 存在过多的条件语句。 说明:多层条件语句建议使用卫语句、策略模式、状态模式等方式重构。

四、安全规约

  1. 【强制】隶属于用户个人的页面或者功能必须进行权限控制校验。 说明:防止没有做水平权限校验就可随意访问、修改、删除别人的数据,比如查看他人的私信内容、修改 他人的订单。
  2. 【强制】用户敏感数据禁止直接展示,必须对展示数据进行脱敏。 说明:中国大陆个人手机号码显示为:137**0969,隐藏中间 4 位,防止隐私泄露。
  3. 【强制】用户输入的 SQL参数严格使用参数绑定或者 METADATA字段值限定,防止 SQL注 入,禁止字符串拼接 SQL访问数据库。
  4. 【强制】用户请求传入的任何参数必须做有效性验证。
  5. 说明:忽略参数校验可能导致: ⚫

page size 过大导致内存溢出 ⚫ 恶意order by导致数据库慢查询 ⚫ 任意重定向 ⚫ SQL 注入 ⚫ 反序列化注入 ⚫ 正则输入源串拒绝服务 ReDoS
说明:Java代码用正则来验证客户端的输入,有些正则写法验证普通用户输入没有问题,但是如果攻 击人员使用的是特殊构造的字符串来验证,有可能导致死循环的结果。

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

五、MySQL数据库
(一) 建表规约

  1. 【强制】表达是与否概念的字段,必须使用is_xxx的方式命名,数据类型是unsigned tinyint(1表示是,0表示否)。 说明:任何字段如果为非负数,必须是 unsigned。 注意:POJO类中的任何布尔类型的变量,都不要加 is前缀,所以,需要在<resultMap>设置从 is_xxx 到 Xxx的映射关系。数据库表示是与否的值,使用 tinyint 类型,坚持 is_xxx的命名方式是为了明确其取 值含义与取值范围。 正例:表达逻辑删除的字段名 is_deleted,1 表示删除,0 表示未删除。
  2. 【强制】小数类型为 decimal,禁止使用 float和double。
  3. 【强制】varchar是可变长字符串,不预先分配存储空间,长度不要超过5000,如果存储长 度大于此值,定义字段类型为 text,独立出来一张表,用主键来对应,避免影响其它字段索 引效率。
  4. 【强制】表必备三字段:id, create_time, update_time。

(二) 索引规约

  1. 【强制】业务上具有唯一特性的字段,即使是多个字段的组合,也必须建成唯一索引。 说明:不要以为唯一索引影响了 insert 速度,这个速度损耗可以忽略,但提高查找速度是明显的;另外, 即使在应用层做了非常完善的校验控制,只要没有唯一索引,根据墨菲定律,必然有脏数据产生。
  2. 【强制】超过三个表禁止 join。需要 join的字段,数据类型必须绝对一致;多表关联查询 时,保证被关联的字段需要有索引。 说明:即使双表 join 也要注意表索引、SQL 性能。
  3. 【强制】在 varchar字段上建立索引时,必须指定索引长度,没必要对全字段建立索引,根据 实际文本区分度决定索引长度即可。

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

  1. 【强制】页面搜索严禁左模糊或者全模糊,如果需要请走搜索引擎来解决。 说明:索引文件具有 B-Tree 的最左前缀匹配特性,如果左边的值未确定,那么无法使用此索引。
  2. 【推荐】如果有order by的场景,请注意利用索引的有序性。order by 最后的字段是组合 索引的一部分,并且放在索引组合顺序的最后,避免出现file_sort的情况,影响查询性能。 正例:where a=? and b=? order by c; 索引:a_b_c 反例:索引如果存在范围查询,那么索引有序性无法利用,如:WHERE a>10 ORDER BY b; 索引a_b 无 法排序。
  3. 【推荐】利用覆盖索引来进行查询操作,避免回表。 说明:如果一本书需要知道第 11 章是什么标题,会翻开第 11 章对应的那一页吗?目录浏览一下就好,这 个目录就是起到覆盖索引的作用。 正例:能够建立索引的种类分为主键索引、唯一索引、普通索引三种,而覆盖索引只是一种查询的一种效 果,用 explain 的结果,extra列会出现:using index。
  4. 【推荐】利用延迟关联或者子查询优化超多分页场景。

说明: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 IFNULL(SUM(column), 0) 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个之内

(四) ORM映射

  1. 【强制】不要用resultClass当返回参数,即使所有类属性名与数据库字段一一对应,也需要 定义;反过来,每一个表也必然有一个POJO类与之对应。 说明:配置映射关系,使字段与 DO类解耦,方便维护。
  2. 【强制】sql.xml配置参数使用:#{},#param# 不要使用${} 此种方式容易出现 SQL注入。
  3. 【强制】不允许直接拿 HashMap与 Hashtable作为查询结果集的输出。 说明:resultClass=”Hashtable”,会置入字段名和属性值,但是值的类型不可控。
0 阅读 733
推荐阅读
0 条评论
关注数
2
文章数
95
目录
极术微信服务号
关注极术微信号
实时接收点赞提醒和评论通知
Arm中国学堂公众号
关注Arm中国学堂
实时获取免费 Arm 教学资源信息
Arm中国招聘公众号
关注Arm中国招聘
实时获取 Arm 中国职位信息