一、建表规约

强制要求

1. 表达是/否概念的字段，必须使用is_xxx的方式命名，数据类型是unsigned tinyint（1表示是，0表示否）或bit。
   
   • 说明： 任何字段如果为非负数，必须是unsigned。
   • 正例： 表达逻辑删除的字段名is_deleted，1表示删除，0表示未删除。
2. 表名、字段名必须使用小写字母或数字，禁止出现数字开头，禁止两个下划线中间只出现数字。
   
   • 说明： MySQL 在 Windows 下不区分大小写，但在 Linux 下默认是区分大小写。因此，数据库名、表名、字段名，都不允许出现任何大写字母，避免节外生枝。
   • 正例：sens_user，sens_log
   • 反例：SensUser，SensLog数据库字段名的修改代价很大，因为无法进行预发布，所以字段名称需要慎重考虑。`
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. 表必备字段：id，create_time，update_time，create_by，update_by。也可以叫做Who字段，就是每个表里必须具备的字段。这些字段起到似metadata的作用。这些字段的作用很大，例如，数据分析的时候，可以使用update_time作为数据抽取的时间戳字段等。
   
   • id必为主键，类型为unsigned bigint时：单表时自增、步长为 1，类型为varchar时使用SnowFlake雪花ID算法生成。
   • create_time是此条数据的创建时间，数据类型为datetime类型。
   • update_date是此条数据的最后更新时间，数据类型为datetime类型。
   • create_by是此条数据的创建人，建议存user_id，但我们也可以避免联表查询默认存的为username，数据类型为varchar类型。
   • update_by是此条数据的最后更新人，建议存user_id，但我们也可以避免联表查询默认存的为username，数据类型为varchar类型。
10. 表的命名最好是加上业务名称_表的作用。

*   正例：`user_task`、`plan_project`、`website_config`

推荐规约

1. 数据库名称或者编码与应用名称或者编码尽量一致。
2. 如果修改字段含义或对字段表示的状态追加时，需要及时更新字段注释。
3. 字段允许适当冗余（所谓冗余是指在不同的表里面存储相同的字段），以提高查询性能，但必须考虑数据一致。冗余字段应遵循：
   
   • 不是频繁修改的字段。
   • 不是varchar超长字段，更不能是 text 字段。
   • 正例： 商品类目名称使用频率高， 字段长度短，名称基本一成不变， 可在相关联的表中冗余存储类目名称，避免关联查询。
4. 单表行数超过 500 万行或者单表容量超过 2GB，才推荐进行分库分表。
   
   • 说明： 如果预计三年后的数据量根本达不到这个级别，请不要在创建表时就分库分表。

规约参考

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

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

二、索引规约

强制要求

1. 业务上具有唯一特性的字段，即使是多个字段的组合，也必须创建唯一索引。
   
   • 说明：不要以为唯一索引影响了insert速度，这个速度损耗可以忽略，但提高查找速度是明显的；另外，即使在应用层做了非常完善的校验控制，只要没有唯一索引，根据墨菲定律，必然有脏数据产生。
2. 超过三个表禁止join。需要join的字段，数据类型必须绝对一致；多表关联查询时，保证被关联的字段需要有索引。
   
   • 说明：即使双表join也要注意表索引和SQL性能。
3. 在varchar字段上建立索引时，必须指定索引长度，没必要对全字段建立索引，根据实际文本区分度决定索引长度即可。
   
   • 说明：索引的长度与区分度是一对矛盾体，一般对字符串类型数据，长度为 20 的索引，区分度会高达90%以上，可以使用count(distinct left(列名，索引长度))和count(*)的区分度来确定。
4. 页面搜索严禁左模糊或者全模糊，如果需要请走搜索引擎来解决。
   
   • 说明：索引文件具有B-Tree的最左前缀匹配特性，如果左边的值未确定，那么无法使用此索引。

推荐规约

1. 如果有order by的场景，请注意利用索引的有序性。order by最后的字段是组合索引的一部分，并且放在索引组合顺序的最后，避免出现file_sort的情况，影响查询性能。
   
   • 正例：where a=? and b=? order by c索引为：a_b_c
   • 反例： 索引中有范围查找，那么索引有序性无法利用，如：WHERE a>10 ORDER BY b， 索引a_b无法排序。
2. 利用覆盖索引来进行查询操作， 避免回表。
   
   • 说明：如果一本书需要知道第 11 章是什么标题，会翻开第 11 章对应的那一页吗？目录浏览一下就好，这个目录就是起到覆盖索引的作用。
   • 正例：能够建立索引的种类分为主键索引、唯一索引、普通索引三种，而覆盖索引只是一种查询的一种效果，用explain的结果，extra列会出现using index。
3. 利用延迟关联或者子查询优化超多分页场景。
   
   • 说明：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
4. SQL 性能优化的目标：至少要达到range级别，要求是ref级别，如果可以是consts最好。
   
   • 说明：
     
     • consts单表中最多只有一个匹配行（主键或者唯一索引），在优化阶段即可读取到数据。
     • ref指的是使用普通的索引（normal index）。
     • range对索引进行范围检索。
   • 反例：explain表的结果，type=index，索引物理文件全扫描，速度非常慢，这个index级别比较range还低，与全表扫描是小巫见大巫。
5. 建组合索引的时候，区分度最高的在最左边。
   
   • 正例： 如果where a=? and b=?，a列的几乎接近于唯一值，那么只需要单建idx_a索引即可。
   • 说明： 存在非等号和等号混合判断条件时，在建索引时，请把等号条件的列前置。如：where a>? and b=?那么即使a的区分度更高，也必须把b放在索引的最前列。
6. 防止因字段类型不同造成的隐式转换，导致索引失效。

规约参考

创建索引时避免有如下极端误解：

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

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 IF(ISNULL(SUM(g)),0,SUM(g)) FROM table;
4. 使用ISNULL()来判断是否为NULL值。
   
   • 说明：NULL与任何值的直接比较都为NULL。
     
     • NULL<>NULL的返回结果是NULL， 而不是false。
     • NULL=NULL的返回结果是NULL， 而不是true。
     • NULL<>1的返回结果是NULL，而不是true。 在代码中写分页查询逻辑时，若count为0应直接返回，避免执行后面的分页语句。
5. 不得使用外键与级联，一切外键概念必须在应用层解决。
   
   • 说明：以学生和成绩的关系为例，学生表中的student_id是主键，那么成绩表中的student_id则为外键。如果更新学生表中的student_id，同时触发成绩表中的student_id更新， 即为级联更新。外键与级联更新适用于单机低并发，不适合分布式、高并发集群；级联更新是强阻塞，存在数据库更新风暴的风险:外键影响数据库的插入速度。
6. 禁止使用存储过程，存储过程难以调试和扩展，更没有移植性。
7. 数据订正（特别是删除、 修改记录操作） 时，要先select，避免出现误删除，确认无误才能执行更新语句。

推荐规约

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

规约参考

1. 如果有全球化需要，所有的字符存储与表示，均以utf-8编码，注意字符统计函数的区别。
   
   • 说明：SELECT LENGTH("轻松工作")；返回为 12SELECT CHARACTER_LENGTH("轻松工作")；返回为 4
   • 如果需要存储表情，那么选择utf8mb4来进行存储，注意它与utf-8编码的区别。
2. 不建议在开发代码中使用此语句TRUNCATE TABLE
   
   • TRUNCATE TABLE比DELETE速度快，且使用的系统和事务日志资源少，但TRUNCATE无事务且不触发trigger，有可能造成事故，故不建议在开发代码中使用此语句。
   • 说明：TRUNCATE TABLE在功能上与不带WHERE 子句的DELETE语句相同。

ORM 映射

强制要求

1. 在表查询中，一律不要使用*作为查询的字段列表，需要哪些字段必须明确写明。
   
   • 说明：
     
     • 增加查询分析器解析成本；
     • 增减字段容易与resultMap配置不一致。
2. POJO类的布尔属性不能加is，而数据库字段必须加is_，要求在resultMap中进行字段与属性之间的映射。
3. 不要用resultClass当返回参数，即使所有类属性名与数据库字段一一对应，也需要定义；反过来，每一个表也必然有一个与之对应。
   
   • 说明： 配置映射关系，使字段与DO类解耦，方便维护。
4. sql.xml配置参数使用#{}，#param#不要使用${}此种方式容易出现 SQL 注入。
5. iBATIS自带的queryForList(String statementName,int start,int size)不推荐使用。
   
   • 说明：其实现方式是在数据库取到statementName对应的SQL语句的所有记录，再通过subList取start,size的子集合。
   • 正例：Map<String, Object> map = new HashMap<String, Object>(); map.put("start", start); map.put("size", size);
6. 不允许直接拿HashMap与Hashtable作为查询结果集的输出。 说明：resultClass=”Hashtable”， 会置入字段名和属性值，但是值的类型不可控。
7. 更新数据表记录时，必须同时更新记录对应的gmt_modified字段值为当前时间。

推荐规约

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

规约参考

@Transactional事务不要滥用。事务会影响数据库的QPS，另外使用事务的地方需要考虑各方面的回滚方案，包括缓存回滚、搜索引擎回滚、消息补偿、统计修正等。<isEqual>中的compareValue是与属性值对比的常量，一般是数字，表示相等时带上此条件；<isNotEmpty>表示不为空且不为null时执行；<isNotNull>表示不为null值时执行。
摘自《阿里巴巴代码规范》