数据库设计规范

44

1. 建表规约

  1. 【强制】表达是与否概念的字段，必须使用fg_xxx的方式命名，数据类型是char(1) （ 1 表示是， 0 表示否）。

    说明：fg代替is，避免出现is_xxx的字段命名，对java的POJO类不友好。

  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. 【推荐】如果修改字段含义或对字段表示的状态追加时，需要及时更新字段注释。

  10. 【推荐】字段允许适当冗余，以提高查询性能，但必须考虑数据一致。冗余字段应遵循： 1 ）不是频繁修改的字段。 2 ）不是唯一索引的字段。 3 ）不是varchar超长字段，更不能是text字段。 正例：门诊或住院登记表冗余患者常用基本信息（姓名，性别等），避免大表间的联表查询导致的性能问题。

  11. 【推荐】非必要不考虑分库分表，优先考虑数据库分区，其次考虑数据归档。

    说明：如果预计三五年后的数据量根本达不到千万级别的，请不要在创建表时就分库分表。

  12. 【参考】合适的字符存储长度，不但节约数据库表空间、节约索引存储，更重要的是提升检索速度。 正例：无符号值可以避免误存负数，且扩大了表示范围。

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

2. 索引规约

  1. 【强制】业务上具有唯一特性的字段，即使是组合字段，也必须建成唯一索引。

    说明：不要以为唯一索引影响了insert速度，这个速度损耗可以忽略，但提高查找速度是明显的；另外，即使在应用层做了非常完善的校验控制，只要没有唯一索引，根据墨菲定律，必然有脏数据产生。

  2. 【推荐】尽量减少三个表以上的join操作(如果确实发生，需重新分析表结构设计的合理性，或者适当冗余数据)。需要join的字段，数据类型保持绝对一致；多表关联查询时，保证被关联的字段需要有索引。

    说明：即使双表join也要注意表索引、SQL性能。

  3. 【推荐】不建议对varchar(32)长度以上的字段上建立索引时，如果确实需要,必须指定索引长度，没必要对全字段建立索引，根据实际文本区分度决定索引长度。

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

  1. 【强制】页面搜索严禁左模糊或者全模糊，如果需要请走搜索引擎来解决(查询不频繁的,或者数据量极少的可以酌情处理)。

    说明：索引文件具有B-Tree的最左前缀匹配特性，如果左边的值未确定，那么无法使用此索引。

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

    正例：where a=? and b=? order by c; 索引：a_b_c 反例：索引如果存在范围查询，那么索引有序性无法利用，如：WHERE a>10 ORDER BY b; 索引a_b无法排序。

  3. 【推荐】利用覆盖索引来进行查询操作，避免回表。

    说明：如果一本书需要知道第 11 章是什么标题，会翻开第 11 章对应的那一页吗？目录浏览一下就好，这个目录就是起到覆盖索引的作用。 正例：能够建立索引的种类分为主键索引、唯一索引、普通索引三种，而覆盖索引只是一种查询的一种效果，用explain的结果，extra列会出现：using index。

  4. 【推荐】利用延迟关联或者子查询优化超多分页场景。

    说明：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

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

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

  6. 【推荐】建组合索引的时候，区分度最高的在最左边。

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

  7. 【推荐】防止因字段类型不同造成的隐式转换，导致索引失效。

  8. 【参考】创建索引时避免有如下极端误解： 1 ） 索引宁滥勿缺。认为一个查询就需要建一个索引。 2 ） 吝啬索引的创建。认为索引会消耗空间、严重拖慢记录的更新以及行的新增速度。 3 ） 抵制惟一索引。认为惟一索引一律需要在应用层通过“先查后插”方式解决。

3. SQL语句

绝对禁止将对外提供的接口服务入参中的值直接拼接到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问题。 正例：可以使用如下方式来避免sum的NPE问题：SELECT IFNULL(SUM(column), 0) FROM table;

  4. 【强制】使用ISNULL()来判断是否为NULL值。

    说明：NULL与任何值的直接比较都为NULL。 1 ） NULL<>NULL的返回结果是NULL，而不是false。 2 ） NULL=NULL的返回结果是NULL，而不是true。 3 ） NULL<>1的返回结果是NULL，而不是true。 反例：在SQL语句中，如果在null前换行，影响可读性。select * from table where column1 is null and column3 is not null; 而ISNULL(column)是一个整体，简洁易懂。从性能数据上分析，ISNULL(column)执行效率更快一些。

  5. 【强制】代码中写分页查询逻辑时，若count为 0 应直接返回，避免执行后面的分页语句。

  6. 【强制】不得使用外键与级联，一切外键概念必须在应用层解决。

    说明：（概念解释）学生表中的student_id是主键，那么成绩表中的student_id则为外键。如果更新学生表中的student_id，同时触发成绩表中的student_id更新，即为级联更新。外键与级联更新适用于单机低并发，不适合分布式、高并发集群；级联更新是强阻塞，存在数据库更新风暴的风险；外键影响数据库的插入速度。

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

  8. 【强制】对于数据库中表记录的查询和变更，只要涉及多个表，都需要在列名前加表的别名（或表名）进行限定。

    说明：对多表进行查询记录、更新记录、删除记录时，如果对操作列没有限定表的别名（或表名），并且操作列在多个表中存在时，就会抛异常。 正例：select t1.name from table_first as t1 , table_second as t2 where t1.id=t2.id; 反例：在某业务中，由于多表关联查询语句没有加表的别名（或表名）的限制，正常运行两年后，最近在某个表中增加一个同名字段，在预发布环境做数据库变更后，线上查询语句出现出 1052 异常：Column 'name' in field list is ambiguous。

  9. 【推荐】SQL语句中表的别名前加as，并且以t1、t2、t3、...的顺序依次命名。

    说明： 1 ）别名可以是表的简称，或者是根据表出现的顺序，以t1、t2、t3的方式命名。 2 ）别名前加as使别名更容易识别。 正例：select t1.name from table_first as t1, table_second as t2 where t1.id=t2.id;

  10. 【推荐】in操作能避免则避免，若实在避免不了(常见的如前端勾选列表的批量操作)，需要仔细评估in后边的集合元素数量，单次控制在 1000 个之内。

  11. 【参考】因国际化需要，所有的字符存储与表示，均采用utf 8 字符集，那么字符计数方法需要注意。 说明： SELECT LENGTH("轻松工作")； 返回为 12 SELECT CHARACTER_LENGTH("轻松工作")； 返回为 4 如果需要存储表情，那么选择utf8mb4来进行存储，注意它与utf8 编码的区别。

  12. 【参考】TRUNCATE TABLE 比 DELETE 速度快，且使用的系统和事务日志资源少，但TRUNCATE 无事务且不触发trigger，有可能造成事故，故不建议在开发代码中使用此语句。 说明：TRUNCATE TABLE 在功能上与不带 WHERE 子句的 DELETE 语句相同。

4. ORM映射

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

    说明： 1 ）增加查询分析器解析成本。 2 ）增减字段容易与resultMap配置不一致。 3 ）无用字段增加网络消耗，尤其是text类型的字段。

  2. 【强制】POJO类的布尔属性不能加is，而数据库字段必须加is_，要求在@Column中进行字段与属性之间的映射。

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

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

  4. 【强制】更新数据表记录时，必须同时更新记录对应的modified字段值为当前时间。

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

5. 参考内容

  1. 【强制】避开Mysql 关键字
  2. 【强制】使用纯英文或英文缩写
  3. 【强制】参照对照表
  4. 【强制】使用统一的缩写 字段关键字含义
简写含义备注
id_表示主键建议每张表都以id_表名缩写作为主键
sd_表示字典
des_表示描述
fg_表示标志flag 缩写
dt_表示时间时间缩写
phone_表示电话
email_表示邮箱
user_表示用户
_text表示明文后缀
sn表示业务排序
cd表示业务线编码例如 330106
na表示cd的文字描述例如 西湖区
py表示拼音码例如 hz
wb表示五笔码例如 sy
zj表示助记码
instr表示检索信息通常为 na+py+wb+zj
id_par表示父节点例如 3301 （浙江）
path表示全路径例如330106 （西湖区）