Java - 《阿里Java开发手册》代码规范学习笔记2（数据库规约）

2020-09-19 发布：hangge 阅读：705

二、数据库规约

1，表名不使用复数名词

表名应该仅仅表示表里面的实体内容，不应该表示实体数量，对应于 DO 类名也是单数形式，符合表达习惯。

2，索引命名规范

说明：pk_ 即 primary key；uk_ 即 unique key；idx_ 即 index 的简称。

主键索引名为 pk_字段名;
唯一索引名为 uk_ 字段名;
普通索引名则为 idx_ 字段名。

3，小数类型使用 decimal

小数类型为 decimal，禁止使用 float 和 double。因为在存储的时候，float 和 double 都存在精度损失的问题，很可能在比较值的时候，得到不正确的结果。

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

4，char 与 varchar 使用规范

（1）如果存储的字符串长度几乎相等，使用 char 定长字符串类型。

提示：数据库中的表越小，在它上面执行的查询也就会越快。因此为了获得更好的性能，在创建表的时候，可以将表中字段的宽度设得尽可能小。比如定义邮政编码这个字段时，可以使用 CHAR(6) 而不是 VARCHAR。

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

5，表必备三字段

一张表必备三字段：id、create_time、update_time。

id 为主键，类型为 bigint unsigned、单表时自增、步长为 1。
create_time，update_time 的类型均为 datetime 类型，前者现在时表述主动式创建，后者过去分词表示被动式更新。

6，表的命名规则

表的命名最好是遵循“业务名称_表的作用”

比如：alipay_task / force_project / trade_config

7，分库分表原则

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

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

8，根据数据范围选择合适的字符存储长度

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

提示：无符号值可以避免误存负数，且扩大了表示范围。

类型	字节	范围
tinyint	1	无符号值: 0～255；有符号值： -128~127
smallint	2	无符号值: 0～65536；有符号值： -32768~32767
mediumint	3	无符号值: 0～16777215；有符号值： -8388608~8388607
int	4	无符号值: 0~4294967295（42.9亿）；有符号值： -2147483648~2147483647
bigint	8	无符号值: 0~((2³²×²)-1)；有符号值： -(2³²×²)/2 ~ (2³²×²)/2-1

9，业务上具有唯一特性的字段（即使是组合字段）必须建成唯一索引

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

墨菲定律：如果有两种或两种以上的方式去做某件事情，而其中一种选择方式将导致灾难，则必定有人会做出这种选择。根本内容是：如果事情有变坏的可能，不管这种可能性有多小，它总会发生

10，join 规范

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

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

11，varchar 字段的索引须指定索引长度

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

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

12，尽量避免在 where 子句中使用 or 来连接条件

（1）比如下面查询将导致引擎放弃使用索引而进行全表扫描，即使 num 和 name 这两个字段都有索引：

select id from t where num=10 or name = 'admin'

我们可以使用 UNION ALL 函数进行优化，比如上面查询可以改成如下形式：

select id from t where num = 10
union all
select id from t where name = 'admin'

（2）不过 MySQL 如果使用 or 链接的是同一列带索引字段（比如下面查询），那么它还是会使用到索引的，不需要改造成 union all：

select id from t where num = 10 or num = 12

13，尽量不使用IN、NOT IN、<>、!= 操作

（1）IN、NOT IN、<>、!= 操作都不会使用索引将进行全表扫描。

select id from t where num in(1,2,3)
select num from a where num in(select num from b)
select id from t where id != 3

（2）IN 可以使用 EXISTS 代替（对于连续的数值，也可以使用 BETWEEN 代替 IN），NOT IN 可以 NOT EXISTS 代替，id<>3（id!=3）则可使用 id>3 or id<3 来代替。

select id from t where num between 1 and 3
select num from a where exists(select 1 from b where num=a.num)
select id from t where id>3 or id<3

14，有索引的字段上尽量不要使用函数进行操作

（1）比如下面查询在一个 DATE 类型的字段上使用 YEAE() 函数时，将在每个行上进行运算，这将导致索引失效而进行全表扫描：

select * from users where YEAR(adddate)<2020

（2）因此我们可以改成如下语句，性能比上面提高很多：

select * from users where adddate<'2020-01-01'

15，页面搜索严禁左模糊或者全模糊

页面搜索严禁左模糊或者全模糊，如果需要请走搜索引擎来解决。

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

16，order by 时注意索引的有序性

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

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

17，利用覆盖索引来进行查询操作，避免回表

如果一本书需要知道第 11 章是什么标题，会翻开第 11 章对应的那一页吗?目录浏览一下就好，这个目录就是起到覆盖索引的作用。

说明：能够建立索引的种类分为主键索引、唯一索引、普通索引三种，而覆盖索引只是一种查询的一种效果，用 explain 的结果，extra 列会出现：using index。

18，利用延迟关联或者子查询优化超多分页场景

（1）MySQL 并不是跳过 offset 行，而是取 offset+N 行，然后返回放弃前 offset 行，返回 N 行，那当 offset 特别大的时候，效率就非常的低下，要么控制返回的总页数，要么对超过特定阈值的页数进行 SQL 改写。
（2）比如下面样例，我们先快速定位需要获取的 id 段，然后再关联：

SELECT t1.* FROM 表 1 as t1, (select id from 表 1 where 条件 LIMIT 100000,20 ) as t2 where t1.id=t2.id

19，SQL 性能优化的目标

至少要达到 range 级别，要求是 ref 级别，如果可以是 consts 最好。

说明：

consts 单表中最多只有一个匹配行（主键或者唯一索引），在优化阶段即可读取到数据。
ref 指的是使用普通的索引（normal index）。
range 对索引进行范围检索。

反例：

explain 表的结果，type=index，索引物理文件全扫描，速度非常慢，这个 index 级别比较 range 还低，与全表扫描是小巫见大巫。

20，组合索引顺序

（1）建组合索引的时候，区分度最高的在最左边。

如果 where a=? and b=?，a 列的几乎接近于唯一值，那么只需要单建 idx_a 索引即可。

（2）存在非等号和等号混合判断条件时，在建索引时，请把等号条件的列前置。

比如：where c>? and d=? 那么即使 c 的区分度更高，也必须把 d 放在索引的最前列，即建立组合索引 idx_d_c。

21，count 使用规范

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

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

（2）count(distinct col) 计算该列除 NULL 之外的不重复行数。

注意：count(distinct col1, col2) 如果其中一列全为 NULL，那么即使另一列有不同的值，也返回为 0。

22，使用 sum() 时需注意 NPE 问题

（1）当某一列的值全是 NULL 时，count(col) 的返回结果为 0，但 sum(col) 的返回结果为 NULL，因此使用 sum() 时需注意 NPE 问题。
（2）可以使用如下方式来避免 sum 的 NPE 问题：

SELECT IFNULL(SUM(column), 0) FROM table;

23，不得使用外键与级联

不得使用外键与级联，一切外键概念必须在应用层解决。外键与级联更新适用于单机低并发，不适合分布式、高并发集群；级联更新是强阻塞，存在数据库更新风暴的风险；外键影响数据库的插入速度。

说明：学生表中的 student_id 是主键，那么成绩表中的 student_id 则为外键。如果更新学生表中的 student_id，同时触发成绩表中的 student_id 更新，即为级联更新。

24，禁止使用存储过程

存储过程难以调试和扩展，更没有移植性。

25，尽量避免使用 in 操作

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

26，采用 utf8 字符集

（1）因国际化需要，所有的字符存储与表示，均采用 utf8 字符集，那么字符计数方法需要注意：

SELECT LENGTH("轻松工作") 返回为 12
SELECT CHARACTER_LENGTH("轻松工作") 返回为 4

（2）如果需要存储表情，那么选择 utf8mb4 来进行存储，注意它与 utf8 编码的区别。

27，不建议在开发中使用 TRUNCATE TABLE

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

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

28，查询字段必须明确，不要使用 *

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

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

29，不要用 resultClass 当返回参数

即使所有类属性名与数据库字段一一对应，也需要定义 <resultMap>。反过来，每一个表也必然有一个 <resultMap> 与之对应。配置映射关系的好处是，使字段与 DO 类解耦，方便维护。

30，sql.xml 配置参数不要使用${}

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

31，不推荐使用iBATIS 自带的 queryForList(String statementName,int start,int size)

（1）因为其实现方式是在数据库取到 statementName 对应的 SQL 语句的所有记录，再通过 subList 取 start，size 的子集合。

（2）建议想下面这样将分页条件传入 sql 语句进行查询：

Map<String, Object> map = new HashMap<>(16); 
map.put("start", start);
map.put("size", size);

32，不允许直接拿 HashMap 与 Hashtable 作为查询结果集的输出

resultClass="Hashtable"，虽然会置入字段名和属性值，但是值的类型不可控。

比如：某同学为避免写一个 <resultMap>xxx</resultMap>，直接使用 HashTable 来接收数据库返回结果，结果出现日常是把 bigint 转成 Long 值，而线上由于数据库版本不一样，解析成 BigInteger，导致线上问题。