Mysql规约

记录阿里巴巴Java开发手册中Mysql数据库规范

1. 建表规约

1. 表达是与否概念的字段，必须使用 is_xxx 的方式命名，数据类型是 tinyint unsigned（1 表示是，0 表示否）

   注意：POJO 类中的任何布尔类型的变量，都不要加 is前缀

   正例：表达逻辑删除的字段名 is_deleted ，1 表示删除，0 表示未删除。

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. varchar 是可变长字符串，不预先分配存储空间，长度不要超过 5000，如果存储长度大于此值，定义字段类型为 text ，独立出来一张表，用主键来对应，避免影响其它字段索引效率。

8. 表必备三字段： id,gmt _ create ,gmt _ modified 。
   说明：其中 id 必为主键，类型为bigint unsigned 、单表时自增、步长为 1。 gmt_create,gmt_modified 的类型均为 datetime 类型，前者现在时表示主动创建，后者过去分词表示被动更新。

9. 单表行数超过 500 万行或者单表容量超过 2 GB ，才推荐进行分库分表。
   说明：如果预计三年后的数据量根本达不到这个级别，请不要在创建表时就分库分表。

10. 合适的字符存储长度，不但节约数据库表空间、节约索引存储，更重要的是提升检索速度。

2. 索引规约

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
6. 建组合索引的时候，区分度最高的在最左边。
   正例：如果 where a =? and b =?，如果 a列的几乎接近于唯一值，那么只需要单建idx _ a索引即可。
   说明：存在非等号和等号混合时，在建索引时，请把等号条件的列前置。如：where c >? and d =?那么即使 c 的区分度更高，也必须把 d放在索引的最前列，即索引
   idx_d_c。

3. SQL语句

1. 不要使用 count( 列名 )或 count( 常量 )来替代count( * )， count( * )是 SQL 92定义的标准统计行数的语法，跟数据库无关，跟 NULL 和非 NULL 无关。
   说明： count( * ) 会统计值为 NULL 的行，而 count( 列名 ) 不会统计此列为 NULL 值的行。
2. count(distinct col)计算该列除 NULL之外的不重复行数，注意 count(distinct col 1, col 2 )如果其中一列全为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. 禁止使用存储过程，存储过程难以调试和扩展，更没有移植性。
7. 数据订正（特别是删除、修改记录操作）时，要先 select，避免出现误删除，确认无误才能执行更新语句。
8. in操作能避免则避免，若实在避免不了，需要仔细评估 in 后边的集合元素数量，控制在 1000 个之内。
9. 如果有国际化需要，所有的字符存储与表示，均以 utf -8编码，注意字符统计函数的区别。
   说明：
   SELECT LENGTH( "轻松工作" )； 返回为 12
   SELECT CHARACTER _ LENGTH( "轻松工作" )； 返回为 4
   如果需要存储表情，那么选择 utf8mb 4来进行存储，注意它与utf -8编码的区别。

4. ORM 映射

1. 在表查询中，一律不要使用 * 作为查询的字段列表，需要哪些字段必须明确写明。

2. POJO 类的布尔属性不能加 is ，而数据库字段必须加is _，要求在 resultMap 中进行字段与属性之间的映射。

3. sql. xml 配置参数使用：#{}，# param # 不要使用${}此种方式容易出现 SQL注入。

4. 不允许直接拿HashMap 与 Hashtable 作为查询结果集的输出。
   说明： resultClass=”Hashtable”，会置入字段名和属性值，但是值的类型不可控。

5. 更新数据表记录时，必须同时更新记录对应的 gmt _ modified字段值为当前时间。

6. 不要写一个大而全的数据更新接口。传入为 POJO类，不管是不是自己的目标更新字段，都进行 update table set c1=value1,c2=value2,c3=value3;这是不对的。执行 SQL时，不要更新无改动的字段，一是易出错 ； 二是效率低 ； 三是增加 binlog存储。

7. < isEqual >中的compareValue是与属性值对比的常量，一般是数字，表示相等时带上此条件 ； < isNotEmpty >表示不为空且不为 null 时执行 ； < isNotNull >表示不为null值时执行。