MySQL开发规范

目录

一、建表规约

二、索引规约

三、SQL语句

四、 ORM映射

---

一、建表规约

强制：

1、表达是与否概念的字段，必须使用is_xxx的方式命名（PoJo中不加is前缀），数据类型是unsigned tinyint（1表示是，0表示否）​。

说明：任何字段如果为非负数，则必须是unsigned。

tinyint和char的使用建议：

• 优先选择 tinyint：若需存储数值且范围在 0-255，更节省空间。

• 慎用 char：仅当字段长度固定且已知时使用（如 MD5 哈希值），否则用 varchar 更灵活。

2、表名、字段名必须使用小写字母或数字（在Linux系统中默认区分大小写），禁止出现数字开头，禁止两个下画线中间只出现数字。数据库字段名的修改代价很大，因为无法进行预发布，所以字段名称需要慎重考虑。

3、表名不使用复数名词。

4、禁用保留字，如desc、range、match、delayed等，请参考MySQL官方保留字。

5、主键索引名为pk_字段名（primary key），唯一索引名为uk_字段名（unique key），普通索引名则为idx_字段名（index）。

6、小数类型为decimal，禁止使用float和double类型。

如果存储的数据范围超过decimal的范围，那么建议将数据拆成整数和小数并分开存储。

7、如果存储的字符串长度几乎相等，则使用char定长字符串类型。

8、varchar是可变长字符串，不预先分配存储空间，长度不要超过5000个字符，如果存储长度大于此值，则应定义字段类型为text，独立出来一张表，用主键来对应，避免影响其他字段的索引效率。

9、表必备三字段：id、create_time、update_time

说明：其中id必为主键，类型为bigint unsigned、单表时自增、步长为1。create_time和update_time的类型均为date_time。

推荐：

1、表的命名最好遵循“业务名称_表的作用”原则。

2、库名与应用名称尽量一致。

3、当修改字段含义或追加字段表示的状态时，需要及时更新字段注释。

4、字段允许适当冗余，以提高查询性能，但必须考虑数据一致性。冗余字段应遵循以下原则。

1）不是频繁修改的字段。

2）不是唯一索引的字段。

3）不是varchar超长字段，更不能是text字段。

5、当单表行数超过500万或者单表容量超过2GB时，才推荐分库分表。

说明：如果预计三年后的数据量无法达到这个级别，请不要在创建表时就分库分表。

参考：

1、设置合适的字符存储长度，不但可以节约数据库表空间和索引存储，更重要的是能够提升检索速度。

二、索引规约

强制：

1、业务上具有唯一特性的字段，即使是多个字段的组合，也必须建成唯一索引。

2、超过三个表禁止join。需要join的字段，数据类型必须绝对一致；当多表关联查询时，保证被关联的字段需要有索引。

3、在varchar字段上建立索引时，必须指定索引长度，没必要对全字段建立索引，根据实际文本区分度决定索引长度即可。

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

4、页面搜索严禁左模糊或者全模糊，如果需要，那么请通过搜索引擎来解决。

推荐：

1、如果有order by的场景，请注意利用索引的有序性。order by最后的字段是组合索引的一部分，并且放在索引组合顺序的最后，避免出现file_sort的情况，影响查询性能。

2、利用覆盖索引进行查询操作，避免回表。

3、利用延迟关联或者子查询优化超多分页场景。

4、SQL性能优化的目标：至少达到range级别，要求是ref级别，最好是consts级别。

说明：

1）consts级别是指单表中最多只有一个匹配行（主键或者唯一索引）​，在优化阶段即可读取到数据。

2）ref级别是指使用普通的索引（normal index）​。

3）range级别是指对索引进行范围检索。

5、当建组合索引时，区分度最高的在最左边。

说明：如果存在非等号和等号混合判断条件，那么在建组合索引时，请把等号条件的列前置。如：where c>? and d=? ，即使c的区分度更高，也必须把d放在索引的最前列，即建立组合索引idx_d_c。

6、防止因字段类型不同造成隐式转换，导致索引失效。

参考：

1、当创建索引时，避免如下极端误解。

1）宁滥勿缺。认为一个查询就需要建一个索引。

2）宁缺毋滥。认为索引会消耗空间、严重拖慢记录的更新及行的新增速度。

3）抵制唯一索引。认为唯一索引一律需要在应用层通过“先查后插”的方式解决。

三、SQL语句

强制：

1、不要使用count(列名)或count(常量)来替代count(*)，count(*)是SQL92定义的标准统计行数的语法，与数据库无关，与NULL和非NULL无关。

说明：count(*)会统计值为NULL的行，而count(列名)不会统计此列值为NULL的行。

2、count(distinct column) 计算该列除NULL外的不重复行数。注意，count(distinct column1, column2)，如果其中一列全为NULL，那么即使另一列有不同的值，也返回为0。

3、当某一列的值全为NULL时，count(column)的返回结果为0，但sum(column)的返回结果为NULL，因此使用sum()时需注意避免NPE问题。

正例：可以使用如下方式避免sum的NPE问题：SELECT IFNULL(SUM (column), 0) FROM table;

4、使用ISNULL()判断是否为NULL值。

说明：NULL与任何值的直接比较都为NULL。

反例：在SQL语句中，如果在null前换行，则会降低可读性。select * from table where column1 is null and column3 is not null; 而ISNULL(column)是一个整体，简捷易懂。从性能数据上分析，ISNULL(column)的执行效率更高一些。

5、在代码中写分页查询逻辑时，若count为0，则直接返回，避免执行后面的分页语句。

6、不得使用外键与级联，一切外键概念必须在应用层解决。

外键与级联更新适用于单机低并发，不适合分布式、高并发集群；级联更新是强阻塞，存在数据库更新风暴的风险；外键影响数据库的插入速度。

7、禁止使用存储过程，存储过程难以调试和扩展，更没有移植性。

8、当订正数据（特别是删除或修改记录操作）时，要先select，避免出现误删除，确认无误才能执行更新语句。

9、对于数据库中表记录的查询和变更，只要涉及多个表，就需要在列名前加表的别名（或表名）进行限定。

推荐：

1、SQL语句中表的别名前加as，并且以t1、t2、t3……的顺序依次命名。

2、in操作能避免则避免，若实在避免不了，则需要仔细评估in后面的集合元素数量，控制在1000之内。

参考：

1、如果有国际化需要，那么所有的字符存储与表示，均以UTF-8编码，注意字符统计函数的区别。

说明：

        SELECT LENGTH("轻松工作")；返回为12。

        SELECT CHARACTER_LENGTH("轻松工作")；返回为4。

如果需要存储表情，那么选择utf8mb4进行存储，注意它与UTF-8编码的区别。

2、TRUNCATE TABLE比DELETE速度快，且使用的系统和事务日志资源少，但TRUNCATE无事务且不触发trigger，有可能造成事故，故不建议在开发代码中使用此语句。

说明：TRUNCATE TABLE在功能上与不带WHERE子句的DELETE语句相同。

四、 ORM映射

强制：

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

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

说明：参见POJO类及数据库字段定义规定，在sql.xml中必须增加映射。

3、不要用resultClass作为返回参数，即使所有类属性名与数据库字段一一对应，也需要定义<resultMap>；反过来，每个表也必然有一个<resultMap>与之对应。

说明：配置映射关系，使字段与DO类解耦，方便维护。

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

5、iBATIS自带的queryForList(Stringstatement Name,int start,int size)不推荐使用。

说明：其实现方式是在数据库取到statementName对应的SQL语句的所有记录，再通过subList取start、size的子集合。

6、不允许直接将HashMap与Hashtable作为查询结果集的输出。

反例：某工程师为避免写一个<resultMap>xxx </result Map>，直接使用HashTable接收数据库返回结果，结果由于数据库版本不一样，出现日常把bigint转成Long值，而线上把bigint解析成BigInteger的现象，导致线上出现问题。

7、更新数据表记录时，必须同时更新记录对应的修改时间，即update_time字段值为当前时间。

推荐：

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

参考：

1、@Transactional事务不要滥用。事务会影响数据库的QPS，另外，使用事务的地方需要考虑各方面的回滚方案，包括缓存回滚、搜索引擎回滚、消息补偿和统计修正等。

2、<isEqual>中的compareValue是与属性值对比的常量，一般是数字，表示相等时执行相应的SQL语句；<isNotEmpty>表示不为空且不为null时执行；<isNotNull>表示不为null时执行。

                                                                                             ---信息来源《阿里巴巴Java开发手册》