建表规约
- 【强制】表达是与否概念的字段，必须使用 is_xxx 的方式命名，数据类型是 unsigned tinyint (1 表示是，0 表示否)。
说明：任何字段如果为非负数，数据类型则必须是 unsigned，类型声明：tinyint unsigned
注意：POJO 类中的任何布尔类型的变量，都不要加 is 前缀。
所以，需要在<resultMap> 设置 is_xxx 到 Xxx 的映射关系。数据库表示是与否的值，使用 tinyint 类型，
坚持 is_xxx 的命名方式是为了明确其取值含义与取值范围。
（设置映射之后，0 对应转化为了 false，1 -> true）
正例：表达逻辑删除的字段名 is_deleted，1 表示 删除，0 表示 未删除。 - 【强制】表名、字段名必须使用小写字母或数字。禁止出现数字开头，禁止两个下划线中间出现数字。
说明：MySQL 在 Windows 下不区分大小写，但在 Linux 下 默认区分大小写。因此，数据库名、表名、字段名都不允许出现任何大写字母，避免节外生枝。 - 【强制】表名不使用复数名词。
- 【强制】禁用保留字，如：desc、range、match、delayed等，请参考 MySQL 官方保留字。
- 【强制】主键索引名为 pk_字段名，唯一索引名为 uk_字段名，普通索引名则为 idx_字段名。
说明：pk_ 即 primary key；uk_ 即 unique key；idx_ 即 index 的简称。 - 【强制】小数类型为 decimal，禁止使用 float 和 double。
说明：在存储的时候，float 和 double 存在精度损失的问题，很可能在比较值的时候，得到不正确的结果。如果存储的数据范围超过 decimal 的范围，建议将数据拆成整数和小数并分开存储。 - 【强制】如果存储的字符串长度几乎相等，则应使用 char 定长字符串类型。
- 【强制】varchar 是可变长字符串，不预先分配存储空间，长度不要超过 5000个字符。如果存储长度大于此值，则应定义字段类型为 text，独立出来一张表，用于主键来对应，避免影响其他字段的索引效率。
- 【强制】表必备的三字段：id、create_time、update_time。
说明：其中 id 必为主键，类型为 unsigned bigint，单表时自增，步长为1。create_time 和 update_time 的类型均为 date_time 类型。 - 【推荐】库名与应用名称尽量一致。
- 【推荐】修改字段含义或对字段表示的状态追加时，需要及时更新字段注释。
- 【推荐】字段允许适当冗余，以提高查询性能，但必须考虑数据一致。冗余字段应遵循
1）不是频繁修改的字段。
2）不是 varchar 超长字段，更不能是 text 字段。
3）不是唯一索引的字段。
正例：商品类目名称的使用频率高，字段长度短，名称基本一成不变，可在相关联的表中冗余存储类目的名称，避免关联查询。 - 【推荐】当单表行数超过 500 万行或者单表容量超过 2GB时，才推荐进行分库分表。
说明：如果预计三年后的数据量无法到达这个级别，请不要在创建表时就分库分表。 - 【参考】设置合适的字符存储长度，不但可以节约数据库表空间和索引存储，更重要的是能够提升检索速度。
正例：见表 5-1，其中无符号值可以避免误存负数，且扩大了数据的表示范围。对象 年龄区间 类型 字节 表示范围 人 150岁之内 unsigned tinyint 1 无符号：0-255 龟 数百岁 unsigned smallint 2 无符号：0-65535 恐龙化石 数千万年 unsigned int 4 无符号：0-约42.9亿 太阳 约50亿年 unsigned bigint 8 无符号：0-10^19
索引规约
- 【强制】业务上具有唯一特性的字段，即使是多个字段的组合，也必须建成唯一索引。
说明：不要以为唯一索引影响了 insert 的速度，这个速度损耗可以忽略，但会明显提高查找速度；另外即使应用层做了非常完善的校验控制，只要没有唯一索引，根据墨菲定律，必然会有脏数据产生。 - 【强制】超过三张表禁止 join。需要 join 的字段，数据类型必须绝对一致；当多表关联查询时，保证被关联的字段需要有索引。
说明：即使双表 join 也要注意表索引、SQL 性能。（Oracle 无此限制） - 【强制】在 varchar 字段上建立索引时，必须指定索引长度，没必要对全字段建立索引，根据实际文本区分度决定索引长度即可。
说明：索引的长度与区分度是一对矛盾体，一般对字符串类型数据，长度为 20 的索引，区分度会高达 90% 以上，可以使用 count（distinct left（列名，索引长度））/ count(*) 的区分度来确定。语法 CREATE INDEX index_name ON table_name (column_name(length), clolumn_name(length)…)； 确认当前字段设置一个合适的长度 select count(distinct left(column_name, length))/count(*) from table_name - 【强制】页面搜索严禁左模糊或者全模糊，如果需要请通过搜索引擎来解决。
说明：索引文件具有 B-Tree 的最左前缀匹配特性，如果左边的值未确定，那么无法使用此索引。 - 【推荐】如果有 order by 的场景，请注意利用索引的有序性。order by 最后的字段是组合索引的一部分，并且放在索引组合顺序的最后，避免出现 file_sort 的情况，影响查询性能。
说明：如果 order by 的列上有索引，那么就可以利用索引的有序性进行排序；
如果没有索引，那么就是 file_sort，可以理解为外部排序，
就是把 select 的数据，按照 order by 的列 ，在内存中进行一次排序，然后返回结果。索引的有序性：简单理解为，索引本身就是对某列建立的一个可以按照一定顺序规格访问的目录。通过 order by 列上的索引来访问，那么默认获取到的值就是按照这列排好的顺序。就是利用到了索引的有序性。
正例：where a=? and b= ? order by c；索引：a_b_c
反例：索引中有范围查找，那么索引有序性无法利用，如 where a>10 order by b；索引 a_b 无法排序。 -
【推荐】利用覆盖索引进行查询操作，避免回表。
说明：如果想知道一本书的第 11 章的标题，我们没有必要翻开第 11 章对应的那一页，只浏览一下目录即可，这个目录就祈祷覆盖索引的作用。
正例：能够建立索引的 种类分为 主键索引、唯一索引、普通索引3种，而覆盖索引只是查询的一种效果，用 explain 的结果，extra 列会出现：using index。 -
【推荐】利用延迟关联或者子查询优化超多分页场景。
说明：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性能优化的目标：至少要达到 range 级别，要求 ref 级别，最好是 consts。
说明：1）consts 单表中最多只有一个匹配行（主键或者唯一索引），在优化阶段即可读取到数据。
2）ref 指的是使用普通索引（normal index）。
3）range 对索引进行范围的检索。
反例：explain 表的结果，type=index，索引物理文件全扫描，速度非常慢，这个 index 级别比 range 还低，与全表扫描相比是小巫见大巫。 -
【推荐】建组合索引的时候，区分度最高的在左边。
正例：如果 where a=? and b=?，a 列几乎接近于唯一值，那么只需要单建 idx_a 索引即可。
说明：如存在非等号和等号混合判断条件，在建索引时，请把等号条件的列前置。如 where c>? and d=？，那么即使 c 的区分度更高，也必须把 d 放在索引的最前列。 -
【参考】创建索引时，避免有如下极端误解：
1）宁滥勿缺。认为一个查询就需要建一个索引。
2）宁缺毋滥。认为索引会消耗空间、严重拖慢记录的更新以及行的新增速度。
3）抵制唯一索引。认为业务的唯一性一律需要在应用层通过“先查后插”的方式解决。
SQL 语句
- 【强制】不要使用 count (列名)或 count(常量)来替代 count(*)，count(*) 是 SQL92 定义的标准统计行数的语法，跟数据库无关，跟 NULL 和 非NULL 无关。
说明：count(*) 会统计值为 NULL 的行，而 count(列名) 不会统计此列为 NULL 值的行。 - 【强制】count(distinct column) 计算该列除 NULL 外的不重复行数。注意，count(distinct column1，column2)，如果其中一列全为 NULL，那么即使另一列有不同的值，也返回 0。
- 【强制】当某一列的值全为 NULL时，count(column) 的返回结果为 0，但 sum(column) 的返回结果为 NULL，因此使用 sum() 时需要注意 NPE 问题。
正例：可以使用如下方式来避免 sum 的NPE 问题：select IFNULL(sum(column),0) from table; - 【强制】使用 ISNULL() 来判断是否为 NULL 值。
说明：NULL 与任何值的直接比较都为 NULL。# 返回值都是 NULL select NULL=NULL, NULL<>NULL,NULL<>1,NULL=1; # 1,0,0 select ISNULL(NULL),ISNULL(1),ISNULL(0); - 【强制】在代码中写分页查询逻辑时，若 count 为 0，应直接返回，避免执行后面的分页语句。
- 【强制】不得使用外键与级联，一切外键概念必须在应用层解决。
说明：以学生和成绩的关系为例，学生表中的 student_id 是主键，那么成绩表中的 student_id 则为外键。如果更新学生表中的 student_id ，同时触发成绩表中的 student_id 更新，即为级联更新。外键与级联更新适用于单机低并发，不适合分布式、高并发集群；级联更新是强阻塞，存在数据库更新风暴的风险；外键影响数据库插入速度。 - 【强制】禁止使用存储过程，存储过程难以调试和扩展，更没有移植性。
- 【强制】数据订正（特别是删除、修改记录操作）时，要先 select，避免出现误删除，确认无误才能执行更新语句。
- 【推荐】in 操作能避免则避免，若实在避免不了，需要仔细评估 in 后面的集合元素数量，控制在 1000 个之内。
- 【参考】如果有国际化需要，所有的字符存储与表示，均以 UTF-8 编码，注意字符统计函数的区别。
说明：如果需要存储表情，那么选择 utf8mb4 进行存储，注意它与 UTF-8 的区别。#12,4 select LENGTH('轻松工作'),CHARACTER_LENGTH('轻松工作'); - 【参考】 TRUNCATE TABLE 比 DELETE 速度快，且使用的系统和事物日志资源少，但 TRUNCATE 无事物且不触发 trigger，有可能造成事故，故不建议在开发代码中使用此语句。
说明：TRUNCATE TABLE 在功能上与不带 WHERE 子句的 DELETE 语句相同。TRUNCATE table; delete from table; delete from table where column=?;
ORM 映射
- 【强制】在表查询中，一律不使用 * 作为查询的字段列表，需要哪些字段必须明确写明。
说明：1）增加查询分析器解析成本。
2）增减字段容易与 resultMap 配置不一致。
3）多余字段增加网络开销。 - 【强制】POJO 类的布尔属性不能加 is，而数据库字段必须加 is_，要求在 resultMap 中进行字段与属性之间的映射
说明：参见定义 POJO 类以及数据库字段定义规定，在 <resultMap> 中必须增加映射。在 Mybatis Generator 生成的代码中，需要进行对应的修改。<!--生成对应表及类名--> <table tableName="user" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"> <columnOverride column="is_deleted" javaType="boolean" property="deleted"/> <!-- 特殊字段映射指定 --> </table> - 【强制】不要用 resultClass 作为返回参数，即使所有类属性名与数据库字段一一对应，也需要定义；反过来，每一个表也必然有一个属性与之对应。
说明：配置映射关系，使字段与 DO 类解耦，方便维护。 - sql.xml 配置参数使用：#{}，#param#，不要使用 ${}，此种方式容易出现 SQL 注入。
- 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); - 【强制】不允许直接拿 HashMap 与 Hashtable 作为查询结果集的输出。
说明：resultClass=“Hashtable”，会置入字段名和属性值，但是值的类型不可控。 - 【强制】更新数据表记录时，必须同时更新记录对应的修改时间 update_time。
- 【推荐】不要写一个大而全的数据更新接口。只更新目标字段，不要更新无改动字段，一是容易出错，二是效率低，三是会增加 binlog 存储。
- 【参考】@Transactional 事物不要滥用。事务会影响数据库的 QPS。另外，使用事务的地方需要考虑各方面的回滚方案，包括缓存回滚、搜索引擎回滚、消息补偿、统计修正等。
- 【参考】<isEqual> 中的 compareValue 是与属性值对比的常量，一般是数字，表示相等的时候执行相应的SQL语句 ;
<isNotEmpty> 表示不为空且不为 null 时执行；
<isNotNull> 表示不为 null 时 执行。
说明：mybatis 3 不支持，使用 <if test="属性值 != null"> 这样的 if 标签 加条件表达式。
1075
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
