《阿里开发手册》总结

目录

一. 编程规约
二. 异常日志
三. MySQL数据库
四. 工程结构
五. 安全规约

1、 编程规约

• (一)接口方法定义

  1. 接口类中的方法和属性不要加任何修饰符号（public 也不要加）

• (二)命名规则

  1. Service/DAO 层方法命名规约
     1） 获取单个对象的方法用 get 作前缀。
     2） 获取多个对象的方法用 list 作前缀。
     3） 获取统计值的方法用 count 作前缀。
     4） 插入的方法用 save（推荐） 或 insert 作前缀。
     5） 删除的方法用 remove（推荐） 或 delete 作前缀。
     6） 修改的方法用 update 作前缀。

2. 领域模型命名规约
   1） 数据对象： xxxDO， xxx 即为数据表名。
   2） 数据传输对象： xxxDTO， xxx 为业务领域相关的名称。
   3） 展现对象： xxxVO， xxx 通常为网页名称。
   4） POJO 是 DO/DTO/BO/VO 的统称，禁止命名成 xxxPOJO。

• (三)常量定义

  1. 【强制】 long 或者 Long 初始赋值时，必须使用大写的 L，不能是小写的 l，小写容易跟数字
     1 混淆，形成误解。
     说明： Long a = 2l; 写的是数字的 21，仍是 Long 型的 2?

2. 【强制】单行字符数限制不超过 120 个，超出须要换行，换行时遵循以下原则：
   1） 第二行相对第一行缩进 4 个空格，从第三行开始，再也不继续缩进，参考示例。
   2） 运算符与下文一块儿换行。
   3） 方法调用的点符号与下文一块儿换行。
   4） 在多个参数超长， 在逗号后换行。
   5） 在括号前不要换行
3. 【强制】 IDE 的 text file encoding 设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式，不要使用 windows 格式
4. 【推荐】方法体内的执行语句组、变量的定义语句组、不一样的业务逻辑之间或者不一样的语义之间插入一个空行。相同业务逻辑和语义之间不须要插入空行。
   说明： 没有必要插入多个空行进行隔开

• (四)OOP 规约

  1. 【强制】全部的覆写方法，必须加@Override 注解。
     说明： getObject()与 get0bject()的问题。一个是字母的 O，一个是数字的 0，加@Override能够准确判断是否覆盖成功。另外，若是在抽象类中对方法签名进行修改，其实现类会立刻编译报错
  2. 【强制】 相同参数类型，相同业务含义，才可使用 Java 的可变参数，避免使用 Object。
     说明： 可变参数必须放置在参数列表的最后（提倡尽可能不用可变参数编程）
  3. 【强制】外部正在调用或者二方库依赖的接口，不容许修改方法签名，避免对接口调用方产生影响。接口过期必须加@Deprecated 注解，并清晰地说明采用的新接口或者新服务是什么
  4. 【强制】不能使用过期的类或方法。
     说明： java.net.URLDecoder 中的方法 decode(String encodeStr) 这个方法已通过时，应该使用双参数 decode(String source, String encode)。接口提供方既然明确是过期接口，那么有义务同时提供新的接口； 做为调用方来讲，有义务去考证过期方法的新实现是什么
  5. 【强制】 Object 的 equals 方法容易抛空指针异常，应使用常量或肯定有值的对象来调用equals。
     正例： “test”.equals(object);
     反例： object.equals(“test”);
     说明： 推荐使用 java.util.Objects#equals （JDK7 引入的工具类）

6. 【强制】全部的相同类型的包装类对象之间值的比较，所有使用 equals 方法比较。
   说明： 对于 Integer var = ? 在-128 至 127 范围内的赋值， Integer 对象是在IntegerCache.cache 产生，会复用已有对象，这个区间内的 Integer 值能够直接使用==进行判断，可是这个区间以外的全部数据，都会在堆上产生，并不会复用已有对象，这是一个大坑，推荐使用 equals 方法进行判断。
   举例: Integer a = 1;Integer b = 1; a == b ; //true
   Integer a = 128;Integer b = 128; a == b ; //false
   Integer a = 128;Integer b = 128; a.equals(b) ; //true
   7. 关于基本数据类型与包装数据类型的使用标准以下：
      1） 【强制】 全部的 POJO 类属性必须使用包装数据类型。
      2） 【强制】 RPC 方法的返回值和参数必须使用包装数据类型。
      3） 【推荐】 全部的局部变量使用基本数据类型。
      说明： POJO 类属性没有初值是提醒使用者在须要使用时，必须本身显式地进行赋值，任何NPE 问题，或者入库检查，都由使用者来保证。
      正例： 数据库的查询结果多是 null，由于自动拆箱，用基本数据类型接收有 NPE 风险。阿里巴巴 Java 开发手册——禁止用于商业用途，违者必究—— 7 / 33
      反例： 好比显示成交总额涨跌状况，即正负 x%， x 为基本数据类型，调用的 RPC 服务，调用不成功时， 返回的是默认值，页面显示： 0%，这是不合理的，应该显示成中划线-。因此包装类型的 null 值，可以表示额外的信息，如：远程调用失败，异常退出
   8. 【强制】定义 DO/DTO/VO 等 POJO 类时，不要设定任何属性默认值。
      反例： POJO 类的 gmtCreate 默认值为 new Date();可是这个属性在数据提取时并无置入具体值，在更新其它字段时又附带更新了此字段，致使建立时间被修改为当前时间
   9. 【强制】构造方法里面禁止加入任何业务逻辑，若是有初始化逻辑，请放在 init 方法中
   10. 【强制】 POJO 类必须写 toString 方法。使用 IDE 的中工具： source> generate toString时，若是继承了另外一个 POJO 类，注意在前面加一下 super.toString。
       说明： 在方法执行抛出异常时，能够直接调用 POJO 的 toString()方法打印其属性值，便于排查问题。
   11. 【推荐】使用索引访问用 String 的 split 方法获得的数组时，需作最后一个分隔符后有无内容的检查，不然会有抛 IndexOutOfBoundsException 的风险
   12. 【推荐】当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一块儿，便于阅读
   13. 【推荐】 类内方法定义顺序依次是：公有方法或保护方法 > 私有方法 > getter/setter方法
   14. 【推荐】 setter 方法中，参数名称与类成员变量名称一致， this.成员名 = 参数名。在getter/setter 方法中， 不要增长业务逻辑，增长排查问题的难度
   15. 【推荐】类成员与方法访问控制从严：
       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 方法，或者一个 public 的成员变量，删除一下，不得手心冒点汗吗？变量像本身的小孩，尽可能在本身的视线内，变量做用域太大，若是无限制的处处跑，那么你会担忧的。

• (五)集合处理

  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[] { “a”, “b” };
     List list = Arrays.asList(str);
     第一种状况： list.add(“c”); 运行时异常。
     第二种状况： str[0] = “gujin”; 那么 list.get(0)也会随之修改。
  6. 【强制】不要在 foreach 循环里进行元素的 remove/add 操做,不然会报错。 remove 元素请使用 Iterator方式，若是并发操做，须要对 Iterator 对象加锁。
  7. 【强制】 在 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 比较结果相同。
  8. 【推荐】集合初始化时， 指定集合初始值大小。
     说明： HashMap 使用 HashMap(int initialCapacity) 初始化，
     正例：initialCapacity = (须要存储的元素个数 / 负载因子) + 1。注意负载因子（即 loaderfactor） 默认为 0.75， 若是暂时没法肯定初始值大小， 请设置为 16
  9. 【推荐】使用 entrySet 遍历 Map 类集合 KV，而不是 keySet 方式进行遍历。
     说明： keySet 实际上是遍历了 2 次，一次是转为 Iterator 对象，另外一次是从 hashMap 中取出key 所对应的 value。而 entrySet 只是遍历了一次就把 key 和 value 都放到了 entry 中，效率更高。若是是 JDK8，使用 Map.foreach 方法
  10. 【推荐】高度注意 Map 类集合 K/V 能不能存储 null 值的状况，以下：
      集合类 Key Value Super 说明
      Hashtable 不容许为 null 不容许为 null Dictionary 线程安全
      ConcurrentHashMap 不容许为 null 不容许为 null AbstractMap 分段锁技术
      TreeMap 不容许为 null 容许为 null AbstractMap 线程不安全
      HashMap 容许为 null 容许为 null AbstractMap 线程不安全
  11. 【参考】合理利用好集合的有序性(sort)和稳定性(order)，避免集合的无序性(unsort)和不稳定性(unorder)带来的负面影响。
      说明： 有序性是指遍历的结果是按某种比较规则依次排列的。
      稳定性指集合每次遍历的元素次序是必定的。
      如： ArrayList 是 order/unsort；
      HashMap 是 unorder/unsort；
      TreeSet 是order/sort。
  12. 【参考】利用 Set 元素惟一的特性，能够快速对一个集合进行去重操做，避免使用 List 的contains 方法进行遍历、对比、 去重操做

• (六)并发处理

  1. 【强制】 获取单例对象须要保证线程安全，其中的方法也要保证线程安全。
     说明： 资源驱动类、工具类、单例工厂类都须要注意
  2. 【强制】建立线程或线程池时请指定有意义的线程名称，方便出错时回溯。
  3. 【强制】 SimpleDateFormat 是线程不安全的类，通常不要定义为 static 变量，若是定义为static，必须加锁，或者使用 DateUtils 工具类
  4. 【强制】对多个资源、数据库表、对象同时加锁时，须要保持一致的加锁顺序，不然可能会形成死锁。
  5. 【强制】并发修改同一记录时，避免更新丢失， 须要加锁。 要么在应用层加锁， 要么在缓存加锁，要么在数据库层使用乐观锁，使用 version 做为更新依据。
     说明： 若是每次访问冲突几率小于 20%，推荐使用乐观锁，不然使用悲观锁。乐观锁的重试次数不得小于 3 次。
  6. 【参考】 volatile 解决多线程内存不可见问题。
     对于一写多读，是能够解决变量同步问题，可是若是多写，一样没法解决线程安全问题。
     若是是 count++操做，使用以下类实现：
     AtomicInteger count = new AtomicInteger(); count.addAndGet(1);
     若是是 JDK8，推荐使用 LongAdder 对象，比 AtomicLong 性能更好（减小乐观锁的重试次数） 。
  7. 【参考】 HashMap 在容量不够进行 resize 时因为高并发可能出现死链，致使 CPU 飙升，在开发过程当中可使用其它数据结构或加锁来规避此风险
  8. 【参考】 ThreadLocal 没法解决共享对象的更新问题， ThreadLocal 对象建议使用 static修饰。
     这个变量是针对一个线程内全部操做共有的，因此设置为静态变量，全部此类实例共享此静态变量 ，
     也就是说在类第一次被使用时装载，只分配一块存储空间，全部此类的对象(只要是这个线程内定义的)均可以操控这个变量

• (七)控制语句

  1. 【强制】在一个 switch 块内，每一个 case 要么经过 break/return 等来终止，； 在一个 switch 块内，都必须包含一个 default 语句而且放在最后，即便它什么代码也没有。
  2. 【强制】在 if/else/for/while/do 语句中必须使用大括号。 即便只有一行代码，避免使用单行的形式： if (condition) statements;
  3. 【推荐】 表达异常的分支时， 少用 if-else 方式;若是非得使用if-else 方式的话,为避免后续代码维护困难， 请勿超过 3 层 ;能够改写成卫语句，或者状态模式来实现 if()… if()… if()…
  4. 【推荐】除经常使用方法（如 getXxx/isXxx）等外，不要在条件判断中执行其它复杂的语句，将复杂逻辑判断的结果赋值给一个有意义的布尔变量名，以提升可读性。

• (八)注释规约

  1. 【强制】类、类属性、类方法的注释必须使用 Javadoc 规范，使用/*内容/格式，不得使用//xxx 方式。
  2. 【强制】全部的类都必须添加建立者和建立日期。
  3. 【强制】全部的枚举类型字段必需要有注释，说明每一个数据项的用途。
  4. 【推荐】代码修改的同时，注释也要进行相应的修改，尤为是参数、返回值、异常、核心逻辑等的修改。
     说明： 代码与注释更新不一样步，就像路网与导航软件更新不一样步同样，若是导航软件严重滞后，就失去了导航的意义。
  5. 【参考】合理处理注释掉的代码。 在上方详细说明，而不是简单的注释掉。 若是无用，则删除。
     说明： 代码被注释掉有两种可能性：
     1） 后续会恢复此段代码逻辑。 (若是没有备注信息，难以知晓注释动机。)
     2） 永久不用。(建议直接删掉（代码仓库保存了历史代码） 。)
  6. 【参考】对于注释的要求：
     第1、可以准确反应设计思想和代码逻辑；
     第2、可以描述业务含义，使别的程序员可以迅速了解到代码背后的信息。
  7. 【参考】好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现注释的一个极端：过多过滥的注释，代码的逻辑一旦修改，修改注释是至关大的负担。
  8. 【参考】特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，经过标记扫描，常常清理此类标记。线上故障有时候就是来源于这些标记处的代码。
     1） 待办事宜（TODO） :（标记人，标记时间， [预计处理时间]）
     表示须要实现，但目前还未实现的功能。这其实是一个 Javadoc 的标签，目前的 Javadoc尚未实现，但已经被普遍使用。只能应用于类，接口和方法（由于它是一个 Javadoc 标签） 。
     2） 错误，不能工做（FIXME） :（标记人，标记时间， [预计处理时间]）
     在注释中用 FIXME 标记某代码是错误的，并且不能工做，须要及时纠正的状况。
     (九)其它
  9. 【强制】后台输送给页面的变量必须加 $!{var}——中间的感叹号。 说明： 若是 var=null 或者不存在，那么${var}会直接显示在页面上。
  10. 【强制】注意 Math.random() 这个方法返回是 double 类型，注意取值的范围 0≤x<1（可以取到零值，注意除零异常） ，
      若是想获取整数类型的随机数，不要将 x 放大 10 的若干倍而后取整，
      直接使用 Random 对象的 nextInt 或者 nextLong 方法。
  11. 【强制】获取当前毫秒数 System.currentTimeMillis(); 而不是 new Date().getTime();
      说明： 若是想获取更加精确的纳秒级时间值， 使用 System.nanoTime()的方式。在 JDK8 中，针对统计时间等场景，推荐使用 Instant 类。

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. 【推荐】方法的返回值能够为 null，不强制返回空集合，或者空对象等，必须添加注释充分说明什么状况下会返回 null 值。调用方须要进行 null 判断防止 NPE 问题。
  9. 【推荐】防止 NPE，是程序员的基本修养，可使用 JDK8 的 Optional 类来防止 NPE 问题。
  10. 【推荐】定义时区分 unchecked / checked 异常，避免直接抛出 new RuntimeException()，
      更不容许抛出 Exception 或者 Throwable，应使用有业务含义的自定义异常。
      推荐业界已定义过的自定义异常，如： DAOException / ServiceException 等。
  11. 【参考】避免出现重复的代码（Don’t Repeat Yourself） ，即 DRY 原则。
      说明： 随意复制和粘贴代码，必然会致使代码的重复，在之后须要修改时，须要修改全部的副本，容易遗漏。必要时抽取共性方法，或者抽象公共类，甚至是共用模块

• (二)日志规约

  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/desc/monitor/visit 等； logName:日志描述。这种命名的好处：经过文件名就可知道日志文件属于什么应用，什么类型，什么目的，也有利于归类查找。
     正例： mppserver 应用中单独监控时区转换异常，如：mppserver_monitor_timeZoneConvert.log
  4. 【强制】异常信息应该包括两类信息：案发现场信息和异常堆栈信息。若是不处理，那么经过关键字 throws 往上抛出。
     正例： logger.error(各种参数或者对象 toString + “_” + e.getMessage(), e);
  5. 【推荐】谨慎地记录日志。生产环境禁止输出 debug 日志； 有选择地输出 info 日志； 若是使用 warn 来记录刚上线时的业务行为信息，必定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志。
     说明： 大量地输出无效日志，不利于系统性能提高，也不利于快速定位错误点。 记录日志时请
     思考：这些日志真的有人看吗？看到这条日志你能作什么？能不能给问题排查带来好处？

3、 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. 【推荐】若是有 order by 的场景，请注意利用索引的有序性。 order by 最后的字段是组合索引的一部分，而且放在索引组合顺序的最后，避免出现 file_sort 的状况，影响查询性能。
     正例： where a=? and b=? order by c; 索引： a_b_c
     反例： 索引中有范围查找，那么索引有序性没法利用，如： WHERE a>10 ORDER BY b; 索引a_b 没法排序。
  5. 【推荐】利用覆盖索引来进行查询操做， 避免回表。
     说明： 若是一本书须要知道第 11 章是什么标题，会翻开第 11 章对应的那一页吗？目录浏览一下就好，这个目录就是起到覆盖索引的做用。
     正例： 可以创建索引的种类：主键索引、惟一索引、普通索引，而覆盖索引是一种查询的一种效果，用 explain 的结果， extra 列会出现： using index。
  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 a>?and b=? 那么即便 a 的区分度更高，也必须把 b 放在索引的最前列。
  9. 【参考】建立索引时避免有以下极端误解：
     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
       若是要使用表情，那么使用 utfmb4 来进行存储，注意它与 utf-8 编码的区别。
   11. 【参考】 TRUNCATE TABLE 比 DELETE 速度快，且使用的系统和事务日志资源少，但 TRUNCATE无事务且不触发 trigger，有可能形成事故，故不建议在开发代码中使用此语句。
       说明： TRUNCATE TABLE 在功能上与不带 WHERE 子句的 DELETE 语句相同。

• (四)ORM 映射

  1. 【强制】在表查询中，一概不要使用 * 做为查询的字段列表，须要哪些字段必须明确写明。
     说明： 1） 增长查询分析器解析成本。 2） 增减字段容易与 resultMap 配置不一致。
  2. 【强制】 POJO 类的布尔属性不能加 is，而数据库字段必须加 is_，要求在 resultMap 中进行字段与属性之间的映射。
     说明： 参见定义 POJO 类以及数据库字段定义规定，在中增长映射，是必须的。
     在 MyBatis Generator 生成的代码中，须要进行对应的修改。
  3. 【强制】sql.xml 配置参数使用： #{}， #param# 不要使用${} 此种方式容易出现 SQL 注入。
  4. 【强制】 iBATIS 自带的 queryForList(String statementName,int start,int size)不推荐使用。
     说明：其实现方式是在数据库取到 statementName对应的SQL语句的全部记录，再经过 subList取 start,size 的子集合。
  5. 【强制】不容许直接拿 HashMap 与 Hashtable 做为查询结果集的输出。
     说明： resultClass=”Hashtable”， 会置入字段名和属性值，可是值的类型不可控。

4、工程结构

1. 【参考】分层领域模型规约：
    DO（Data Object） ：与数据库表结构一一对应，经过 DAO 层向上传输数据源对象。
    DTO（Data Transfer Object） ：数据传输对象， Service 和 Manager 向外传输的对象。
    BO（Business Object） ：业务对象。 能够由 Service 层输出的封装业务逻辑的对象。
    Query：数据查询对象，各层接收上层的查询请求。 注：超过 2 个参数的查询封装，禁止使用 Map 类来传输。
    VO（View Object） ：显示层对象，一般是 Web 向模板渲染引擎层传输的对象。

5、安全规约

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