阿里巴巴java开发手册 MYSQL 规约

MYSQL 规约

(一) 建表规约

1. 【强制】表达是与否概念的字段，必须使用 is_xxx 的方式命名，数据类型是 unsigned tinyint
   （ 1 表示是，0 表示否），此规则同样适用于 odps 建表。
   说明：任何字段如果为非负数，必须是 unsigned。
2. 【强制】表名、字段名必须使用小写字母或数字；禁止出现数字开头，禁止两个下划线中间只
   出现数字。数据库字段名的修改代价很大，因为无法进行预发布，所以字段名称需要慎重考虑。
   正例：getter_admin，task_config，level3_name
   反例：GetterAdmin，taskConfig，level_3_name
3. 【强制】表名不使用复数名词。
   说明：表名应该仅仅表示表里面的实体内容，不应该表示实体数量，对应于 DO 类名也是单数
   形式，符合表达习惯。
4. 【强制】禁用保留字，如 desc、range、match、delayed 等，参考官方保留字。
5. 【强制】唯一索引名为 uk_字段名；普通索引名则为 idx_字段名。
   说明：uk_ 即 unique key；idx_ 即 index 的简称。
6. 【强制】小数类型为 decimal，禁止使用 float 和 double。
   说明：float 和 double 在存储的时候，存在精度损失的问题，很可能在值的比较时，得到不
   正确的结果。如果存储的数据范围超过 decimal 的范围，建议将数据拆成整数和小数分开存储。
   decimal:数字型，128bit，不存在精度损失，常用于银行帐目计算。（28个有效位）
7. 【强制】如果存储的字符串长度几乎相等，使用 CHAR 定长字符串类型。
8. 【强制】varchar 是可变长字符串，不预先分配存储空间，长度不要超过 5000，如果存储长度
   大于此值，定义字段类型为 TEXT，独立出来一张表，用主键来对应，避免影响其它字段索引
   效率。
9. 【强制】表必备三字段：id, gmt_create, gmt_modified。
   说明：其中 id 必为主键，类型为 unsigned bigint、单表时自增、步长为 1；分表时改为从
   TDDL Sequence 取值，确保分表之间的全局唯一。gmt_create, gmt_modified 的类型均为
   date_time 类型。
10. 【推荐】表的命名最好是加上“业务名称_表的作用”，避免上云梯后，再与其它业务表关联
    时有混淆。
    正例：tiger_task / tiger_reader / mpp_config
11. 【推荐】库名与应用名称尽量一致。
12. 【推荐】如果修改字段含义或对字段表示的状态追加时，需要及时更新字段注释。
13. 【推荐】字段允许适当冗余，以提高性能，但是必须考虑数据同步的情况。冗余字段应遵循：
    1）不是频繁修改的字段。
    2）不是 varchar 超长字段，更不能是 text 字段。
    正例：各业务线经常冗余存储商品名称，避免查询时需要调用 IC 服务获取。