MySQL开发规约

一、基础规约

使用INNODB存储引擎
表字符集使用UTF8
所有表和字段都需要添加注释
单表数据量建议控制在5000W以内，存储大小60G以内
不在数据库中存储图片、文件等大数据
禁止在线上做数据库压力测试
禁止从测试、开发环境直连数据库

二、建表规约

• 1.【强制】表中必须有主键，并且类型为int/bigint、单表自增、步长为1，如果是分片表，采用了全局id生成器，确保生成的值是整型、自增有序。
  说明：
  • 1）MySQL使用binlog进行主从复制，当binlog为row模式时，数据是一条一条在从库执行的，当没有主键和其它唯一非空约束字段时会全表扫描（delete和update）。
  • 2）innodb引擎是以主键为索引来组织数据的，主键不仅是B+树主索引的键，它还会包含在其它索引项中，所以小巧为好。
  • 3）B+树索引是有序的，自增有序的主键在插入数据时可大量减少页分裂带来的数据移动，并减少数据碎片。
• 2.【强制】表名、字段名必须使用小写字母或数字，禁止出现数字开头，禁止两个下划线中间只出现数字。数据库字段名的修改代价很大，因为无法进行预发布，所以字段名称需要慎重考虑。
  正例：getter_admin，task_config，level3_name
  反例：GetterAdmin，taskConfig，level_3_name
• 3.【强制】禁用保留字，如desc、range、match、delayed、virtual等，请参考MySQL官方保留字。
• 4.【强制】主键索引名为pk_字段名；唯一索引名为uk_字段名；普通索引名则为idx_字段名。
  说明：pk_ 即primary key；uk_ 即 unique key；idx_ 即index的简称。
• 5.【强制】小数类型为decimal，禁止使用float和double。
  说明：float和double在存储的时候，存在精度损失的问题，很可能在值的比较时，得到不正确的结果。如果存储的数据范围超过decimal的范围，建议将数据拆成整数和小数分开存储。
• 6.【强制】如果存储的字符串长度几乎相等，使用char定长字符串类型。
• 7.【强制】varchar是可变长字符串，不预先分配存储空间，长度不要超过5000，如果存储长度大于此值，定义字段类型为text，独立出来一张表，用主键来对应，避免影响其它字段索引效率。
• 8.【推荐】表的命名最好是加上“业务名称_表的作用”。
  正例：tiger_task / tiger_reader / mpp_config
• 9.【推荐】库名与应用名称尽量一致。
• 10.【推荐】如果修改字段含义或对字段表示的状态追加时，需要及时更新字段注释。
• 11.【推荐】字段允许适当冗余，以提高性能，但是必须考虑数据同步的情况。冗余字段应遵循：
  • 1）不是频繁修改的字段。
  • 2）不是varchar超长字段，更不能是text字段。
    正例：商品类目名称使用频率高，字段长度短，名称基本一成不变，可在相关联的表中冗余存储类目名称，避免关联查询。
• 13.【参考】合适的字符存储长度，不但节约数据库表空间、节约索引存储，更重要的是提升检索速度。
  正例：如下表，其中无符号值可以避免误存负数，且扩大了表示范围。

---

对象	年龄区间	类型	表示范围
人	150岁之内	unsigned tinyint	无符号值：0到255
龟	数百岁	unsigned tinyint	无符号值：0到65535
恐龙化石	数千万年	unsigned int	无符号值：0到约42.9亿
太阳	约50亿年	unsigned bigint	无符号值：0到约10的19次方

• 14.【参考】表设计不要超过50个字段，字段太多考虑拆分成多个表。这个可以减少SQL复杂度，减少IO消耗。

三、索引规约

• 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
  反例：索引中有范围查找，那么索引有序性无法利用，如：WHERE a>10 ORDER BY b; 索引a_b无法排序。

• 6.【推荐】利用覆盖索引来进行查询操作，避免回表。
  说明：如果一本书需要知道第11章是什么标题，会翻开第11章对应的那一页吗？目录浏览一下就好，这个目录就是起到覆盖索引的作用。
  正例：能够建立索引的种类：主键索引、唯一索引、普通索引，而覆盖索引是一种查询的一种效果，用explain的结果，extra列会出现：using index。

• 7.【推荐】利用延迟关联或者子查询优化超多分页场景。
  说明：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

• 8.【推荐】 SQL性能优化的目标：至少要达到 range 级别，要求是ref级别，如果可以是consts最好。
  说明：

  • 1）consts 单表中最多只有一个匹配行（主键或者唯一索引），在优化阶段即可读取到数据。
  • 2）ref 指的是使用普通的索引（normal index）。
  • 3）range 对索引进行范围检索。
    反例：explain表的结果，type=index，索引物理文件全扫描，速度非常慢，这个index级别比较range还低，与全表扫描是小巫见大巫。

• 9.【推荐】建组合索引的时候，区分度最高的在最左边。
  正例：如果where a=? and b=? ，a列的几乎接近于唯一值，那么只需要单建idx_a索引即可。
  说明：存在非等号和等号混合判断条件时，在建索引时，请把等号条件的列前置。如：where a>? and b=? 那么即使a的区分度更高，也必须把b放在索引的最前列。

• 10.【参考】创建索引时避免有如下极端误解：

  • 1）宁滥勿缺。误认为一个查询就需要建一个索引。
  • 2）宁缺勿滥。误认为索引会消耗空间、严重拖慢更新和新增速度。
  • 3）抵制惟一索引。误认为业务的惟一性一律需要在应用层通过“先查后插”方式解决。

四、SQL规约

• 1.【强制】不使用select *，也不要select出所有字段，只查询出需要的字段
  说明：
  消耗CPU和IO、消耗网络带宽
  无法使用覆盖索引
  减少表结构变更带来的影响
  因为大，select/join可能生成临时表
• 2.【强制】避免数据类型隐式转换、避免在where后面的关键列使用函数。会导致索引失效
• 3.【强制】不要使用count(列名)或count(常量)来替代count()，count()是SQL92定义的标准统计行数的语法，跟数据库无关，跟NULL和非NULL无关。
  说明：count(*)会统计值为NULL的行，而count(列名)不会统计此列为NULL值的行。
• 4.【强制】count(distinct col) 计算该列除NULL之外的不重复行数，注意 count(distinct col1, col2) 如果其中一列全为NULL，那么即使另一列有不同的值，也返回为0。
• 5.【强制】当某一列的值全是NULL时，count(col)的返回结果为0，但sum(col)的返回结果为NULL，因此使用sum()时需注意NPE问题。
  正例：可以使用如下方式来避免sum的NPE问题：SELECT IF(ISNULL(SUM(g)),0,SUM(g)) FROM table;
• 6.【强制】使用ISNULL()来判断是否为NULL值。注意：NULL与任何值的直接比较都为NULL。
  说明：
  • 1） NULL<>NULL的返回结果是NULL，而不是false。
  • 2） NULL=NULL的返回结果是NULL，而不是true。
  • 3） NULL<>1的返回结果是NULL，而不是true。
• 7.【强制】 在代码中写分页查询逻辑时，若count为0应直接返回，避免执行后面的分页语句。
• 8.【强制】不得使用外键与级联，一切外键概念必须在应用层解决。
  说明：（概念解释）学生表中的student_id是主键，那么成绩表中的student_id则为外键。如果更新学生表中的student_id，同时触发成绩表中的student_id更新，则为级联更新。外键与级联更新适用于单机低并发，不适合分布式、高并发集群；级联更新是强阻塞，存在数据库更新风暴的风险；外键影响数据库的插入速度。
• 9.【强制】禁止使用存储过程，存储过程难以调试和扩展，更没有移植性。
• 10.【强制】数据订正时，删除和修改记录时，要先select，避免出现误删除，确认无误才能执行更新语句。
• 11.【推荐】减少数据库的交互次数
  INSERT … ON DUPLICATE KEY UPDATE
  REPLACE INTO、INSERT IGNORE、INSERT INTO VALUES(),(),()
  UPDATE …WHERE ID IN(10,20,50, …)
• 12.【推荐】使用in代替or，in的值控制在1000个之内。
• 13.【参考】如果有全球化需要，所有的字符存储与表示，均以utf-8编码，那么字符计数方法
  注意：
  说明：
  SELECT LENGTH(“轻松工作”)； 返回为12
  SELECT CHARACTER_LENGTH(“轻松工作”)； 返回为4
  如果要使用表情，那么使用utfmb4来进行存储，注意它与utf-8编码的区别。
• 14.【参考】 TRUNCATE TABLE 比 DELETE 速度快，且使用的系统和事务日志资源少，但TRUNCATE无事务且不触发trigger，有可能造成事故，故不建议在开发代码中使用此语句。
  说明：TRUNCATE TABLE 在功能上与不带 WHERE 子句的 DELETE 语句相同。

五、行为规约

批量导入、导出数据必须提前通知DBA协助观察
禁止有super权限的应用程序账号存在
产品出现非数据库导致的故障时及时通知DBA协助排查
推广活动或上线新功能必须提前通知DBA进行流量评估
数据库数据丢失，及时联系DBA进行恢复
对单表的多次alter操作必须合并为一次操作
不在MySQL数据库中存放业务逻辑
重大项目的数据库方案选型和设计必须提前通知DBA参与
对特别重要的库表，提前与DBA沟通确定维护和备份优先级
不在业务高峰期批量更新、查询数据库
提交线上建表改表需求，必须详细注明所有相关SQL语句