阿里巴巴 Java 开发手册-建表规约

小鱼儿 2022-05-16 13:43 460阅读 0赞

### 文章目录 ###

*   *   *  一、概述
         *  二、建库
         *  三、建表
         *  四、索引
         *  五、SQL
         *  六、ORM

### 一、概述 ###

参见《阿里巴巴Java开发手册终极版v1.3.0.pdf》

### 二、建库 ###

1.尽量保持和项目名一致。

2.全小写。

3.不存emoji，选用字符编码：**utf-8**，否则选utf8mb4。

4.无国际化需求，排序Collation选择**utf8\_general\_ci**。

*  原因1：
    
        Mysql默认为utf8_general_ci，当新增字段未指定，则会造成字段排序不一致的情况。
 *  原因2：
    
        utf8_unicode_ci和utf8_general_ci对中、英文来说没有实质的差别。
        utf8_general_ci校对速度快，但准确度稍差。
        utf8_unicode_ci准确度高，但校对速度稍慢。
        如果你的应用有德语、法语或者俄语，请一定使用utf8_unicode_ci。
        Note：
        ci是 case insensitive, 即 "大小写不敏感", a 和 A 会在字符判断中会被当做一样的。

4.主键步长1000。

5.生产一定关闭远程访问权限，修改默认端口，授权指定白名单IP。

6.Mysql5.6和5.7存在较大版本差异，不要混用。

### 三、建表 ###

1.  【强制】表达是与否概念的字段，必须使用 is\_xxx 的方式命名，数据类型是 unsigned tinyint
    
    （ 1 表示是，0 表示否）。
    
    说明：任何字段如果为非负数，必须是 unsigned。
    
    正例：表达逻辑删除的字段名 is\_deleted，1 表示删除，0 表示未删除。
2.  【强制】表名、字段名必须使用小写字母或数字，禁止出现数字开头，**禁止两个下划线中间只出现数字**。数据库字段名的修改代价很大，因为无法进行预发布，所以字段名称需要慎重考虑。
    
    说明：MySQL 在 Windows 下不区分大小写，但在 **Linux 下默认是区分大小写**。因此，数据库名、表名、字段名，都不允许出现任何大写字母，避免节外生枝。
    
    正例：aliyun\_admin，rdc\_config，level3\_name
    
    反例：AliyunAdmin，rdcConfig，level\_3\_name
3.  【强制】表名不使用复数名词。
    
    说明：表名应该仅仅表示表里面的实体内容，不应该表示实体数量，对应于 DO 类名也是单数
    
    形式，符合表达习惯。
4.  【强制】禁用保留字，如 desc、range、match、delayed 等，请参考 MySQL 官方保留字。
5.  【强制】小数类型为 decimal，禁止使用 float 和 double。
    
    说明：float 和 double 在存储的时候，存在精度损失的问题，很可能在值的比较时，得到不
    
    正确的结果。如果存储的数据范围超过 decimal 的范围，建议将数据拆成整数和小数分开存储。
6.  【强制】如果存储的字符串长度几乎相等，使用 char 定长字符串类型。
7.  【强制】varchar 是可变长字符串，不预先分配存储空间，长度不要超过 5000，如果存储长
    
    度大于此值，定义字段类型为 text，独立出来一张表，用主键来对应，避免影响其它字段索
    
    引效率。
8.  【强制】表必备三字段：id, gmt\_create, gmt\_modified。
    
    说明：其中 id 必为主键，类型为 unsigned bigint、单表时自增、步长为 1。gmt\_create,
    
    gmt\_modified 的类型均为 date\_time 类型，前者现在时表示主动创建，后者过去分词表示被
    
    动更新。
    
        # 查看昨天insert：
        select * FROM  test_table  WHERE 
        gmt_create < date_format(DATE(now()), '%Y-%m-%e %H-%i-%s') AND 
        gmt_create >= date_format(DATE(date_add(now(), INTERVAL - 1 DAY)),'%Y-%m-%e %H-%i-%s');
        
        # 查看昨天update：
        select * FROM test_table WHERE gmt_create < date_format(DATE(now()), '%Y-%m-%e %H-%i-%s')
        AND gmt_create >= date_format(DATE(date_add(now(), INTERVAL - 1 DAY)),'%Y-%m-%e %H-%i-%s')
        AND date_add(gmt_create, INTERVAL - 1 DAY) != date_add(gmt_modified, INTERVAL - 1 DAY)
9.  【推荐】表的命名最好是加上“业务名称\_表的作用”。
    
    正例：alipay\_task / force\_project / trade\_config
10. 【推荐】库名与应用名称尽量一致。
11. 【推荐】如果修改字段含义或对字段表示的状态追加时，需要及时更新字段注释。
12. 【推荐】字段允许适当冗余，以提高查询性能，但必须考虑数据一致。冗余字段应遵循：
    
    1）不是频繁修改的字段。
    
    2）不是 varchar 超长字段，更不能是 text 字段。
    
    正例：商品类目名称使用频率高，字段长度短，名称基本一成不变，可在相关联的表中冗余存
    
    储类目名称，避免关联查询。
13. 【推荐】单表行数超过 500 万行或者单表容量超过 2GB，才推荐进行分库分表。
    
    说明：如果预计三年后的数据量根本达不到这个级别，请不要在创建表时就分库分表。
14. 【参考】合适的字符存储长度，不但节约数据库表空间、节约索引存储，更重要的是提升检
    
    索速度。
    
    正例：如下表，其中无符号值可以避免误存负数，且扩大了表示范围。
    
    <table> 
     <thead> 
      <tr> 
       <th>对象</th> 
       <th>年龄区间</th> 
       <th>类型</th> 
       <th>字节</th> 
       <th>表示范围</th> 
      </tr> 
     </thead> 
     <tbody> 
      <tr> 
       <td>人</td> 
       <td>150岁之内</td> 
       <td>unsigned tinyint</td> 
       <td>1</td> 
       <td>无符号值：0到255</td> 
      </tr> 
      <tr> 
       <td>龟</td> 
       <td>数百岁</td> 
       <td>unsigned smallint</td> 
       <td>2</td> 
       <td>无符号值：0到65535</td> 
      </tr> 
      <tr> 
       <td>恐龙化石</td> 
       <td>数千万年</td> 
       <td>unsigned int</td> 
       <td>4</td> 
       <td>无符号值：0到约42.9亿</td> 
      </tr> 
      <tr> 
       <td>太阳</td> 
       <td>约50亿年</td> 
       <td>unsigned bigint</td> 
       <td>8</td> 
       <td>无符号值：0到约10的19次方</td> 
      </tr> 
     </tbody> 
    </table>
15. 【参考】[IP地址][IP]。
    
    方案一：
    
    IPv4 : varchar(15)
    
    ipv4地址32位，有2^32个。255.255.255.255 （十进制表示）只有数字和.符号，最长字符串长度为15。
    
    IPv6 : varchar(39)
    
    ipv6地址128位，有2^128个。IPv6地址通常写成八组，每组四个十六进制数字，每组由冒号（:)分隔。最多39个字符。在POSIX标准的中定义的IPv6地址字符串形式最大长度为46字节，其中包含结尾的null，所以最大长度为45。
    
    方案二：
    
    IPv4：
    
    使用 INET\_ATON() 来把一个字符串IP转成一个整形，并使用 INET\_NTOA() 把一个整形转成一个字符串IP。
    
        int(4)
        # 存储
        SELECT INET_ATON("172.18.163.1");
        # 还原
        SELECT INET_NTOA("2886902529");
    
    IPv6：
    
        # Mysql官方，IPv6最多字符长度为39
        decimal(39,0)

### 四、索引 ###

1.  【强制】主键索引名为 \*\*pk\_\*\*字段名；唯一索引名为 \*\*uk\_\*\*字段名；普通索引名则为 \*\*idx\_\*\*字段名。
    
    说明：pk\_ 即 primary key；uk\_ 即 unique key；idx\_ 即 index 的简称。
2.  【强制】业务上具有唯一特性的字段，即使是多个字段的组合，也必须建成唯一索引。
    
    说明：不要以为唯一索引影响了 insert 速度，这个速度损耗可以忽略，但提高查找速度是明
    
    显的；另外，即使在应用层做了非常完善的校验控制，只要没有唯一索引，根据墨菲定律，必
    
    然有脏数据产生。
3.  【强制】超过三个表禁止 join。需要 join 的字段，数据类型必须绝对一致；多表关联查询时，
    
    保证被关联的字段需要有索引。
    
    说明：即使双表 join 也要注意表索引、SQL 性能。
4.  【强制】在 varchar 字段上建立索引时，**必须指定索引长度，没必要对全字段建立索引**，根据
    
    实际文本区分度决定索引长度即可。
    
    说明：索引的长度与区分度是一对矛盾体，一般对字符串类型数据，长度为 20 的索引，区分
    
    度会高达 90%以上，可以使用 count(distinct left(列名, 索引长度))/count(\*)的区分度
    
    来确定。
5.  【强制】页面搜索严禁左模糊或者全模糊，如果需要请走搜索引擎来解决。
    
    说明：索引文件具有 B-Tree 的最左前缀匹配特性，如果左边的值未确定，那么无法使用此索
    
    引。
6.  【推荐】如果有 order by 的场景，请注意利用索引的有序性。order by 最后的字段是组合
    
    索引的一部分，并且放在索引组合顺序的最后，避免出现 file\_sort 的情况，影响查询性能。
    
    正例：where a=? and b=? order by c; 索引：a\_b\_c
    
    反例：索引中有范围查找，那么索引有序性无法利用，如：WHERE a>10 ORDER BY b; 索引
    
    a\_b 无法排序。
7.  【推荐】利用覆盖索引来进行查询操作，避免回表。
    
    说明：如果一本书需要知道第 11 章是什么标题，会翻开第 11 章对应的那一页吗？目录浏览
    
    一下就好，这个目录就是起到覆盖索引的作用。
    
    正例：能够建立索引的种类：主键索引、唯一索引、普通索引，而覆盖索引是一种查询的一种
    
    效果，用 explain 的结果，extra 列会出现：using index。
8.  【推荐】利用延迟关联或者子查询优化超多分页场景。
    
    说明：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
9.  【推荐】SQL 性能优化的目标：至少要达到 range 级别，要求是 ref 级别，如果可以是 consts
    
    最好。
    
    说明：
    
    1）consts 单表中最多只有一个匹配行（主键或者唯一索引），在优化阶段即可读取到数据。
    
    2）ref 指的是使用普通的索引（normal index）。
    
    3）range 对索引进行范围检索。
    
    反例：explain 表的结果，type=index，索引物理文件全扫描，速度非常慢，这个 index 级
    
    别比较 range 还低，与全表扫描是小巫见大巫。
10. 【推荐】建组合索引的时候，区分度最高的在最左边。
    
    正例：如果 where a=? and b=? ，a 列的几乎接近于唯一值，那么只需要单建 idx\_a 索引即
    
    可。
    
    说明：存在非等号和等号混合判断条件时，在建索引时，请把等号条件的列前置。如：where a>?
    
    and b=? 那么即使 a 的区分度更高，也必须把 b 放在索引的最前列。
11. 【推荐】防止因字段类型不同造成的隐式转换，导致索引失效。
12. 【参考】创建索引时避免有如下极端误解：
    
    1）宁滥勿缺。认为一个查询就需要建一个索引。
    
    2）宁缺勿滥。认为索引会消耗空间、严重拖慢更新和新增速度。
    
    3）抵制惟一索引。认为业务的惟一性一律需要在应用层通过“先查后插”方式解决。

### 五、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。
    
    1） NULL<>NULL 的返回结果是 NULL，而不是 false。
    
    2） NULL=NULL 的返回结果是 NULL，而不是 true。
    
    3） NULL<>1 的返回结果是 NULL，而不是 true。
5.  【强制】在代码中写分页查询逻辑时，若 count 为 0 应直接返回，避免执行后面的分页语句。
6.  【强制】不得使用外键与级联，一切外键概念必须在应用层解决。
    
    说明：以学生和成绩的关系为例，学生表中的 student\_id是主键，那么成绩表中的 student\_id
    
    则为外键。如果更新学生表中的 student\_id，同时触发成绩表中的 student\_id 更新，即为
    
    级联更新。外键与级联更新适用于单机低并发，不适合分布式、高并发集群；级联更新是强阻
    
    塞，存在数据库更新风暴的风险；外键影响数据库的插入速度。
7.  【强制】禁止使用存储过程，存储过程难以调试和扩展，更没有移植性。
8.  【强制】数据订正时，删除和修改记录时，要先 select，避免出现误删除，确认无误才能执
    
    行更新语句。
9.  【推荐】in 操作能避免则避免，若实在避免不了，需要仔细评估 in 后边的集合元素数量，控
    
    制在 1000 个之内。
10. 【参考】如果有全球化需要，所有的字符存储与表示，均以 utf-8 编码，注意字符统计函数
    
    的区别。
    
    说明：
    
    SELECT LENGTH(“轻松工作”)； 返回为 12
    
    SELECT CHARACTER\_LENGTH(“轻松工作”)； 返回为 4
    
    如果需要存储表情，那么选择 utfmb4 来进行存储，注意它与 utf-8 编码的区别。
11. 【参考】TRUNCATE TABLE 比 DELETE 速度快，且使用的系统和事务日志资源少，但 TRUNCATE
    
    无事务且不触发 trigger，有可能造成事故，故不建议在开发**代码**中使用此语句。
    
    说明：TRUNCATE TABLE 在功能上与不带 WHERE 子句的 DELETE 语句相同。

非手册：

12.【参考】当只要一行数据时使用 LIMIT 1：当你查询表的有些时候，你已经知道结果只会有一条结果，但因为你可能需要去fetch游标，或是你也许会去检查返回的记录数。

13.【参考】在Join表的时候使用相当类型的例，并将其索引：如果应用程序有很多 JOIN 查询，应该确认两个表中Join的字段是被建过索引的。这样，MySQL内部会启动优化Join的SQL语句的机制。 而且，这些被用来Join的字段，应该是相同的类型的。

### 六、ORM ###

1.  【强制】在表查询中，一律不要使用 \* 作为查询的字段列表，需要哪些字段必须明确写明。
    
    说明：1）增加查询分析器解析成本。2）增减字段容易与 resultMap 配置不一致。
2.  【强制】POJO 类的布尔属性不能加 is，而数据库字段必须加 is\_，要求在 resultMap 中进行
    
    字段与属性之间的映射。
    
    说明：参见定义 POJO 类以及数据库字段定义规定，在中增加映射，是必须的。
    
    在 MyBatis Generator 生成的代码中，需要进行对应的修改。
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 字段值为当前时间。
8.  【推荐】不要写一个大而全的数据更新接口。传入为 POJO 类，不管是不是自己的目标更新字
    
    段，都进行 update table set c1=value1,c2=value2,c3=value3; 这是不对的。执行 SQL
    
    时，不要更新无改动的字段，一是易出错；二是效率低；三是增加 binlog 存储。
9.  【参考】@Transactional 事务不要滥用。事务会影响数据库的 QPS，另外使用事务的地方需
    
    要考虑各方面的回滚方案，包括缓存回滚、搜索引擎回滚、消息补偿、统计修正等。
10. 【参考】中的 compareValue 是与属性值对比的常量，一般是数字，表示相等时带
    
    上此条件；表示不为空且不为 null 时执行；表示不为 null 值时
    
    执行。

[IP]: https://dev.mysql.com/doc/refman/5.6/en/miscellaneous-functions.html