Java开发手册

编程规约

命名风格

强制
1、代码中命名均不能以下划线或美元符号开头/结尾。
2、类名使用UpperCamelCase风格，但是BO/DO/DTO/VO/AO/PO等除外。
3、方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格。
4、常量命名全部大写，单词间用下划线隔开，力求语义表达完整不要嫌长。
5、抽象类命名使用Abstract或Base开头；异常类命名使用Exception结尾；测试类命名以它要测试的类的名称开始，以Test结尾。
6、POJO类中的任何布尔类型的变量，都不要加is前缀。
7、包名统一使用小写，通过点分隔，包名统一使用单数形式。
8、避免在子父类的成员变量之间，或者不同代码块的局部变量之间采用完全相同的命名。

推荐
9、在常量和变量的命名时，表示类型的名词放在词尾，提升辨识度。
10、接口类中的方法和属性不要加任何修饰符号（public也不要加）。
11、对于Service和DAO类，基于SOA理念，暴露出来的一定是接口，内部的实现类用Impl的后缀与接口区别。

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

常量定义

强制
1、不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。
2、在long或者Long赋值时，数值后使用大写字母L，不能使用小写l，容易和数字混淆。

推荐
3、不用使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。（CacheConsts、SystemConfigConsts等）
4、常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。

代码格式

强制
1、如果是大括号内为空，则简洁地写成{}即可，大括号中间无需换行和空格；如果是非空代码块则：
1）左大括号前不换行。
2）左大括号后换行。
3）右大括号前换行。
4）右大括号后还有 else 等代码则不换行；表示终止的右大括号后必须换行。
2、左小括号和右边相邻字符之间不出现空格；右小括号和左边相邻字符之间也不出现空格；而左大括号前需要加空格。
3、if/for/while/switch/do 等保留字与括号之间都必须加空格。
4、任何二目、三目运算符的左右两边都需要加一个空格。
5、采用 4 个空格缩进，禁止使用 Tab 字符。
6、 注释的双斜线与注释内容之间有且仅有一个空格。
7、在进行类型强制转换时，右括号与强制转换值之间不需要任何空格隔开。
8、单行字符数限制不超过 120 个，超出需要换行，换行时遵循如下原则：
1）第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。
2）运算符与下文一起换行。
3）方法调用的点符号与下文一起换行。
4）方法调用中的多个参数需要换行时，在逗号后进行。
5）在括号前不要换行。
9、方法参数在定义和传入时，多个参数逗号后面必须加空格。

推荐
10、单个方法的总行数不超过 80 行。
11、不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。

OOP规约

强制
1、避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用 类名 来访问即可。
2、所有的覆写方法，必须加@ Override 注解。
3、相同参数类型，相同业务含义，才可以使用 Java 的可变参数，避免使用 Object 。
说明： 可变参数必须放置在参数列表的最后。（建议开发者尽量不用可变参数编程）
4、Object 的 equals 方法容易抛空指针异常，应使用常量或确定有值的对象来调用 equals 。
说明： 推荐使用 JDK7 引入的工具类 java.util.Objects#equals(Object a, Object b)
5、所有整型包装类对象之间 值的比较， 全部使用 equals 方法比较。
说明： 对于 Integer var = ? 在 -128 至 127 之间的赋值，Integer 对象是在 IntegerCache.cache 产生，会复用已有对象，这个区间内的 Integer 值可以直接使用==进行判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大坑，推荐使用 equals 方法进行判断。
6、浮点数之间的等值判断，基本数据类型不能用==来比较，包装数据类型不能用 equals来判断。
(1) 指定一个误差范围，两个浮点数的差值在此范围之内，则认为是相等的。
(2) 使用 BigDecimal 来定义值，再进行浮点数的运算操作。
7、 如上所示 BigDecimal 的等值比较应使用 compareTo()方法，而不是 equals()方法。
说明： equals()方法会比较值和精度 （1.0 与 1.00 返回结果为 false） ，而 compareTo()则会忽略精度。
8、定义数据对象 DO 类时，属性类型要与数据库字段类型相匹配。
正例： 数据库字段的 bigint 必须与类属性的 Long 类型相对应。
反例： 某个案例的数据库表 id 字段定义类型 bigint unsigned，实际类对象属性为 Integer，随着 id 越来越大，超过 Integer 的表示范围而溢出成为负数。
9、禁止使用构造方法 BigDecimal(double) 的方式把 double 值 转化为 BigDecimal 对象 。
说明： BigDecimal(double)存在精度损失风险，在精确计算或值比较的场景中可能会导致业务逻辑异常。如：BigDecimal g = new BigDecimal(0.1F); 实际的存储值为0.10000000149
正例： 优先推荐入参为 String 的构造方法，或使用 BigDecimal 的 valueOf 方法，此方法内部其实执行了
Double 的 toString，而 Double 的 toString 按 double 的实际能表达的精度对尾数进行了截断。
BigDecimal recommend1 = new BigDecimal ( “0.1” );
BigDecimal recommend2 = BigDecimal . valueOf ( 0.1 );
10、关于基本数据类型与包装数据类型的使用标准如下：
1）所有的 POJO 类属性必须使用包装数据类型。
2）RPC 方法的返回值和参数必须使用包装数据类型。
3）所有的局部变量使用基本数据类型。
11、定义 DO/DTO/VO 等 POJO 类时，不要设定任何属性 默认值 。
12、序列化类新增属性时，请不要修改 serialVersionUID 字段，避免反序列失败；如果完全不兼容升级，避免反序列化混乱，那么请修serialVersionUID 值。
13、构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在 init 方法中。
14、POJO 类必须写 toString 方法。使用 IDE 中的工具：source> generate toString时，如果继承了另一个 POJO 类，注意在前面加一super.toString。
15、禁止在 POJO 类中，同时存在对应属性 xxx 的 isXxx() 和 getXxx() 方法。
说明： 框架在调用属性 xxx 的提取方法时，并不能确定哪个方法一定是被优先调用到的。

推荐
16、循环体内，字符串的连接方式，使用 StringBuilder 的 append 方法进行扩展。
说明： 下例中，反编译出的字节码文件显示每次循环都会 new 出一个StringBuilder 对象，然后进行 append操作，最后通过 toString 方法返回 String 对象，造成内存资源浪费。
17、final 可以声明类、成员变量、方法、以及本地变量，下列情况使用 final 关键字：
1）不允许被继承的类，如：String 类。
2）不允许修改引用的域对象，如：POJO 类的域变量。
3）不允许被覆写的方法，如：POJO 类的 setter 方法。
4）不允许运行过程中重新赋值的局部变量。
5）避免上下文重复使用一个变量，使用 final 关键字可以强制重新定义一个变量，方便更好地进行重构。

日期时间

强制
1、日期格式化时，传入 pattern 中表示年份统一使用小写的 y。
正例： 表示日期和时间的格式如下所示：
new SimpleDateFormat(“yyyy-MM-dd HH:mm:ss”)
2、在日期格式中分清楚大写的 M 和小写的 m，大写的 H 和小写的 h 分别指代的意义。
说明： 日期格式中的这两对字母表意如下：
1）表示月份是大写的 M；
2）表示分钟则是小写的 m；
3）24 小时制的是大写的 H；
4）12 小时制的则是小写的 h。
3、 获取当前毫秒数：System.currentTimeMillis(); 而不是 new Date().getTime()。
4、不允许在程序任何地方中使用：1）java.sql.Date。 2）java.sql.Time。
3）java.sql.Timestamp。
5、不要在程序中写死一年为 365 天，避免在公历闰年时出现日期转换错误或程序逻辑错误。

集合处理

强制
1、关于 hashCode 和 equals 的处理，遵循如下规则：
1）只要覆写 equals，就必须覆写 hashCode。
2）因为 Set 存储的是不重复的对象，依据 hashCode 和 equals 进行判断，所以 Set 存储的对象必须覆写这两种方法。
3）如果自定义对象作为 Map 的键，那么必须覆写 hashCode 和 equals。
2、判断所有集合内部的元素是否为空，使用 isEmpty()方法，而不是size()==0 的方式。
说明： 在某些集合中，前者的时间复杂度为 O(1)，而且可读性更好。
3、 在使用 java.util.stream.Collectors 类的 toMap()方法转为 Map 集合时，一定要使用含有参数类型为 BinaryOperator，参数名为 mergeFunction 的方法，否则当出现相同 key值时会抛出 IllegalStateException 异常。
说明： 参数 mergeFunction 的作用是当出现 key 重复时，自定义对 value 的处理策略。
4、在使用 java.util.stream.Collectors 类的 toMap()方法转为 Map 集合时，一定要注意当 value 为 null 时会抛 NPE 异常。
5、ArrayList 的 subList 结果不可强转成 ArrayList，否则会抛出 ClassCastException 异常： java.util.RandomAccessSubList cannot be cast to java.util.ArrayList 。
说明： subList()返回的是 ArrayList 的内部类 SubList，并不是 ArrayList 本身，而是 ArrayList 的一个视图，对于 SubList 的所有操作最终会反映到原列表上。
6、使用 Map 的方法 keySet() / values() / entrySet() 返回集合对象时，不可以对其进行添加元素操作，否则会抛出 UnsupportedOperationException 异常。
7、Collections 类返回的对象，如： emptyList() / singletonList() 等都是 immutable list ，不可对其进行添加或者删除元素的操作。
8、使用集合转数组的方法，必须使用集合的 toArray(T[] array)，传入的是类型完全一致、长度为 0 的空数组。
9、在使用 Collection 接口任何实现类的 addAll()方法时，都要对输入的集合参数进行NPE 判断。
说明： 在 ArrayList#addAll 方法的第一行代码即 Object[] a = c.toArray(); 其中 c 为输入集合参数，如果为 null，则直接抛出异常。
10、使用工具类 Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方法，它的 add/remove/clear 方法会抛出UnsupportedOperationException 异常。
说明： asList 的返回对象是一个 Arrays 内部类，并没有实现集合的修改方法。Arrays.asList 体现的是适配器模式，只是转换接口，后台的数据仍是数组。
11、泛型通配符 <? extends T> 来接收返回的数据，此写法的泛型集合不能使用 add 方法，而 <? super T> 不能使用 get 方法，两者在接口调用赋值的场景中容易出错。
说明： 扩展说一下 PECS(Producer Extends Consumer Super)原则：第一、频繁往外读取内容的，适合用<? extends T>。第二、经常往里插入的，适合用<? super T>
12、在无泛型限制定义的集合赋值给泛型限制的集合时，在使用集合元素时，需要进行instanceof 判断，避免抛出 ClassCastException 异常。
13、不要在 foreach 循环里进行元素的 remove/add 操作。remove 元素请使用 Iterator方式，如果并发操作，需要对 Iterator 对象加锁。
14、在 JDK 7 版本及以上， 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 比较结果相同。

推荐
15、 使用 entrySet 遍历 Map 类集合 KV ，而不是 keySet 方式进行遍历。
说明： keySet 其实是遍历了 2 次，一次是转为 Iterator 对象，另一次是从 hashMap 中取出 key 所对应的value。而 entrySet 只是遍历了一次就把 key 和 value 都放到了 entry 中，效率更高。如果是 JDK8，使用Map.forEach 方法。

并发处理

强制
1、获取单例对象需要保证线程安全，其中的方法也要保证线程安全。
说明： 资源驱动类、工具类、单例工厂类都需要注意。
2、创建线程或线程池时请指定有意义的线程名称，方便出错时回溯。
3、 线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。
说明： 线程池的好处是减少在创建和销毁线程上所消耗的时间以及系统资源的开销，解决资源不足的问题。如果不使用线程池，有可能造成系统创建大量同类线程而导致消耗完内存或者“过度切换”的问题。
4、线程池不允许使用 Executors 去创建，而是通过 ThreadPoolExecutor 的方式，这样的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。
说明： Executors 返回的线程池对象的弊端如下：
1）FixedThreadPool 和 SingleThreadPool ：允许的请求队列长度为 Integer.MAX_VALUE，可能会堆积大量的请求，从而导致 OOM。
2）CachedThreadPool ：允许的创建线程数量为 Integer.MAX_VALUE，可能会创建大量的线程，从而导致 OOM。
5、SimpleDateFormat 是线程不安全的类，一般不要定义为 static 变量，如果定义为 static ，必须加锁，或者使用 DateUtils 工具类。
说明： 如果是 JDK8 的应用，可以使用 Instant 代替 Date，LocalDateTime 代替 Calendar，DateTimeFormatter 代替 SimpleDateFormat。
6、必须回收自定义的 ThreadLocal 变量，尤其在线程池场景下，线程经常会被复用，如果不清理自定义的 ThreadLocal 变量，可能会影响后续业务逻辑和造成内存泄露等问题。尽量在代理中使用 try-finally 块进行回收。
7、高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁 ； 能锁区块，就不要锁整个方法体 ； 能用对象锁，就不要用类锁。
说明： 尽可能使加锁的代码块工作量尽可能的小，避免在锁代码块中调用 RPC 方法。
8、对多个资源、数据库表、对象同时加锁时，需要保持一致的加锁顺序，否则可能会造成死锁。
9、在使用阻塞等待获取锁的方式中，必须在 try 代码块之外，并且在加锁方法与 try 代码块之间没有任何可能抛出异常的方法调用，避免加锁成功后，在 finally 中无法解锁。
说明一： 如果在 lock 方法与 try 代码块之间的方法调用抛出异常，那么无法解锁，造成其它线程无法成功获取锁。
说明二： 如果 lock 方法在 try 代码块之内，可能由于其它方法抛出异常，导致在 finally 代码块中，unlock对未加锁的对象解锁，它会调用 AQS 的tryRelease 方法（取决于具体实现类），抛出IllegalMonitorStateException 异常。
说明三： 在 Lock 对象的 lock 方法实现中可能抛出 unchecked 异常，产生的后果与说明二相同。
10、在使用尝试机制来获取锁的方式中，进入业务代码块之前，必须先判断当前线程是否持有锁。锁的释放规则与锁的阻塞等待方式相同。
说明： Lock 对象的 unlock 方法在执行时，它会调用 AQS 的 tryRelease 方法（取决于具体实现类），如果当前线程不持有锁，则抛出IllegalMonitorStateException 异常。
11、并发修改同一记录时，避免更新丢失，需要加锁。要么在应用层加锁，要么在缓存加锁，要么在数据库层使用乐观锁，使用 version 作为更新依据。
说明： 如果每次访问冲突概率小于 20%，推荐使用乐观锁，否则使用悲观锁。乐观锁的重试次数不得小于3 次。
12、多线程并行处理定时任务时， Timer 运行多个 TimeTask 时，只要其中之一没有捕获抛出的异常，其它任务便会自动终止运行，使用ScheduledExecutorService 则没有这个问题。

控制语句

强制
1、在一个 switch 块内，每个 case 要么通过 continue/break/return 等来终止，要么注释说明程序将继续执行到哪一个 case 为止；在一个 switch 块内，都必须包含一个 default 语句并且放在最后，即使它什么代码也没有。
说明： 注意 break 是退出 switch 语句块，而 return 是退出方法体。
2、当 switch 括号内的变量类型为 String 并且此变量为外部参数时，必须先进行 null判断。
3、在 if / else / for / while / do 语句中必须使用大括号。
说明： 即使只有一行代码，也禁止不采用大括号的编码方式：if (condition) statements;
4、三目运算符 condition? 表达式 1 : 表达式 2 中，高度注意表达式 1 和 2 在类型对齐时，可能抛出因自动拆箱导致的 NPE 异常。
说明： 以下两种场景会触发类型对齐的拆箱操作：
1）表达式 1 或表达式 2 的值只要有一个是原始类型。
2）表达式 1 或表达式 2 的值的类型不一致，会强制拆箱升级成表示范围更大的那个类型。
5、在高并发场景中，避免使用”等于”判断作为中断或退出的条件。
说明： 如果并发控制没有处理好，容易产生等值判断被“击穿”的情况，使用大于或小于的区间判断条件来代替。

推荐
6、当某个方法的代码总行数超过 10 行时，return / throw 等中断逻辑的右大括号后均需要加一个空行。
说明： 这样做逻辑清晰，有利于代码阅读时重点关注。
7、表达异常的分支时，少用 if-else 方式 ，这种方式可以改写成：

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

说明： 如果非使用 if()…else if()…else…方式表达逻辑，避免后续代码维护困难，请勿超过 3 层。正例： 超过 3 层的 if-else 的逻辑判断代码可以使用卫语句、策略模式、状态模式等来实现。
8、 除常用方法（如 getXxx/isXxx ）等外，不要在条件判断中执行其它复杂的语句，将复杂逻辑判断的结果赋值给一个有意义的布尔变量名，以提高可读性。
说明： 很多 if 语句内的逻辑表达式相当复杂，与、或、取反混合运算，甚至各种方法纵深调用，理解成本非常高。如果赋值一个非常好理解的布尔变量名字，则是件令人爽心悦目的事情。
9、不要在其它表达式（尤其是条件表达式）中，插入赋值语句。
说明： 赋值点类似于人体的穴位，对于代码的理解至关重要，所以赋值语句需要清晰地单独成为一行。

注释规约

强制
1、 类、类属性、类方法的注释必须使用 Javadoc 规范，使用/*内容/格式，不得使用// xxx 方式。
说明： 在 IDE 编辑窗口中，Javadoc 方式会提示相关注释，生成 Javadoc 可以正确输出相应注释；在 IDE中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读效率。
2、所有的抽象方法 （ 包括接口中的方法 ） 必须要用 Javadoc 注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。
说明： 对子类的实现要求，或者调用注意事项，请一并说明。
3、所有的类都必须添加创建者和创建日期。
说明： 在设置模板时，注意 IDEA 的@author 为${USER}，而 eclipse 的@author 为${user}，大小写有区别，而日期的设置统一为 yyyy/MM/dd 的格式 。

//正例：
/**
* @author yangguanbao
* @date 2016/10/31
*/

4、 方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/* */注释，注意与代码对齐。
5、所有的枚举类型字段必须要有注释，说明每个数据项的用途。

前后端规约

1、前后端交互的 API，需要明确协议、域名、路径、请求方法、请求内容、状态码、响应体。
2、前后端数据列表相关的接口返回，如果为空，则返回空数组[]或空集合{}。
说明 ： 此条约定有利于数据层面上的协作更加高效，减少前端很多琐碎的 null 判断。
3、服务端发生错误时，返回给前端的响应信息必须包含 HTTP 状态码，errorCode、errorMessage、用户提示信息四个部分。
说明： 四个部分的涉众对象分别是浏览器、前端开发、错误排查人员、用户。其中输出给用户的提示信息要求：简短清晰、提示友好，引导用户进行下一步操作或解释错误原因，提示信息可以包括错误原因、上下文环境、推荐操作等。 errorCode：参考 附表 3 。errorMessage：简要描述后端出错原因，便于错误排查人员快速定位问题，注意不要包含敏感数据信息。
4、 在前后端交互的 JSON 格式数据中，所有的 key 必须为小写字母开始的
lowerCamelCase 风格，符合英文表达习惯，且表意完整。
5、errorMessage 是前后端错误追踪机制的体现，可以在前端输出到 type="hidden"文字类控件中，或者用户端的日志中，帮助我们快速地定位出问题。
6、对于需要使用超大整数的场景，服务端一律使用 String 字符串类型返回，禁止使用Long 类型。
7、 HTTP 请求通过 URL 传递参数时，不能超过 2048 字节。
说明： 不同浏览器对于 URL 的最大长度限制略有不同，并且对超出最大长度的处理逻辑也有差异，2048字节是取所有浏览器的最小值。
8、HTTP 请求通过 body 传递内容时，必须控制长度，超出最大长度后，后端解析会出错。
说明： nginx 默认限制是 1MB，tomcat 默认限制为 2MB，当确实有业务需要传较大内容时，可以通过调大服务器端的限制。
9、在翻页场景中，用户输入参数的小于 1，则前端返回第一页参数给后端；后端发现用户输入的参数大于总页数，直接返回最后一页。
10、服务器内部重定向必须使用 forward；外部重定向地址必须使用 URL 统一代理模块生成，否则会因线上采用 HTTPS 协议而导致浏览器提示“不安全”，并且还会带来 URL 维护不一致的问题。

异常日志

错误码

异常处理

单元测试

安全规约

MYSQL数据库

建表规约

1、 表达是与否概念的字段，必须使用 is_xxx 的方式命名，数据类型是 unsigned tinyint
（1 表示是，0 表示否）。
说明： 任何字段如果为非负数，必须是 unsigned 。
注意： POJO 类中的任何布尔类型的变量，都不要加 is 前缀，所以，需要在< resultMap >设置从 is_xxx 到Xxx 的映射关系。数据库表示是与否的值，使用 tinyint 类型，坚持 is_xxx 的命名方式是为了明确其取值含义与取值范围。
2、表名、字段名必须使用小写字母或数字 ， 禁止出现数字开头，禁止两个下划线中间只出现数字。数据库字段名的修改代价很大，因为无法进行预发布，所以字段名称需要慎重考虑。
说明： MySQL 在 Windows 下不区分大小写，但在 Linux 下默认是区分大小写。因此，数据库名、表名、字段名，都不允许出现任何大写字母，避免节外生枝。
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, create_time, update_time。
说明： 其中 id 必为主键，类型为 bigint unsigned、单表时自增、步长为 1。create_time,update_time的类型均为 datetime 类型，前者现在时表示主动式创建，后者过去分词表示被动式更新。
10、（推荐）单表行数超过 500 万行或者单表容量超过 2GB，才推荐进行分库分表。
说明： 如果预计三年后的数据量根本达不到这个级别，请不要在创建表时就分库分表。

索引规约

强制
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、SQL 性能优化的目标：至少要达到 range 级别，要求是 ref 级别，如果可以是 consts最好。
说明：
1）consts 单表中最多只有一个匹配行（主键或者唯一索引），在优化阶段即可读取到数据。
2）ref 指的是使用普通的索引（normal index）。
3）range 对索引进行范围检索。

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 问题。
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 更新，即为级联更新。外键与级联更新适用于单机低并发，不适合分布式、高并发集群；级联更新是强阻塞，存在数据库更新风暴的风险；外键影响数据库的插入速度。

ORM映射

1、在表查询中，一律不要使用 * 作为查询的字段列表，需要哪些字段必须明确写明。
说明： 1）增加查询分析器解析成本。2）增减字段容易与 resultMap 配置不一致。3）无用字段增加网络消耗，尤其是 text 类型的字段。
2、POJO 类的布尔属性不能加 is，而数据库字段必须加 is_，要求在 resultMap 中进行字段与属性之间的映射。
说明： 参见定义 POJO 类以及数据库字段定义规定，在 sql.xml 增加映射，是必须的。
3、不要用 resultClass 当返回参数，即使所有类属性名与数据库字段一一对应，也需要定义；反过来，每一个表也必然有一个与之对应。
说明： 配置映射关系，使字段与 DO 类解耦，方便维护。
4、 sql. xml 配置参数使用：#{}，# param # 不要使用${} 此种方式容易出现 SQL 注入。
5、更新数据表记录时，必须同时更新记录对应的 update_time 字段值为当前时间。

工程结构

应用分层

二方库依赖

服务器

设计规约

Java开发手册