本文参考《阿里巴巴Java开发手册》
1 建表规约
(1)【强制】表达是与否概念的字段,必须使用 is_xxx 的方式命名,数据类型是 unsigned tinyint(1 表示 是,0 表示 否)。
(2)【强制】表名、字段名必须使用小写字母或数字,禁止出现数字开头,禁止两个下划线中间只出现数字。数据库字段名的修改代价很大,因为无法进行预发布,所以字段名称需要慎重考虑。
(3)【强制】表名不使用复数名词。
(4)【强制】禁用保留字,如 desc、range、match、delayed 等,请参考 MySQL 官方保留字。
(5)【强制】主键索引名为 pk_字段名,唯一索引名为 uk_字段名;普通索引名为 idx_字段名。
(6)【强制】小数类型为 decimal,禁止使用 float 和 double。
(7)【强制】如果存储的字符串长度几乎相等,使用 char 定长字符串类型。
(8)【强制】varchar 是可变长字符串,不预先分配存储空间,长度不要超过 5000,如果存储长度大于此值,定义字段类型为 text,独立出来一张表,用主键来对应,避免影响其它字段索引效率。
(9)【强制】表必备三字段:id,gmt_create,gmt_modified。
(10)【推荐】表的命名最好是加上 "业务名称_表的作用"。
(11)【推荐】库名与应用名称尽量一致。
(12)【推荐】如果修改字段含义或对字段表示状态追加时,需要及时更新字段注释。
(13)【推荐】字段允许适当冗余,以提高查询性能,但必须考虑数据一致。冗余字段应遵循:
1)不是频繁修改的字段。
2)不是 varchar 超长字段,更不能是 text 字段。
(14)【推荐】单表行数超过 500 万行或者单表容量超过 2 GB,才推荐进行分库分表。
(15)【参考】合适的字符存储长度,不但节约数据库表空间、节约索引存储,更重要的是提升检索速度。
2 索引规约
(1)【强制】业务上具有唯一特性的字段,即使是多个字段的组合,也必须建成唯一索引。
(2)【强制】超过三个表禁止 join。需要 join 的字段,数据类型必须绝对一致;多表关联查询时,保证被关联的字段需要有索引。
(3)【强制】在 varchar 字段上建立索引时,必须指定索引长度,没必要对全字段建立索引,根据实际文本区分度决定索引长度即可。
(4)【强制】页面搜索严禁左模糊或者全模糊,如果需要请走搜索引擎来解决。
(5)【强制】如果有 order by 的场景,请注意利用索引的有序性。order by 最后的字段是组合索引的一部分,并且放在索引组合顺序的最后避免出现 file_sort 的情况,影响查询性能。
(6)【推荐】利用覆盖索引来进行查询操作,避免回表。
(7)【推荐】利用延迟关联或者子查询优化超多分页场景。
(8)【推荐】SQL 性能优化的目标:至少要达到 range 级别,要求是 ref 级别,如果可以是 consts 最好。
(9)【推荐】建组合索引的时候,区分度最高的最左边。
(10)【推荐】防止因字段类型不同造成的隐式转换,导致索引失效。
(11)【参考】创建索引时避免有如下极端误解:
1)宁滥毋缺。
2)宁缺毋滥。
3)抵制唯一性索引。
3 SQL语句
(1)【强制】不要使用 count(列名) 或 count(常量) 来替代 count(*),count(*) 是 SQL92 定义的标准统计行数的语法,跟数据库无关,跟 NULL 和 非NULL 无关。
(2)【强制】count(distinct col) 计算该列除 NULL 之外不重复行数,注意 count(distinct col1, col2) 如果其中一列全为 NULL,那么即使另一列有不同的值,也返回 0。
(3)【强制】当某一列的值全是 NULL 时,count(col) 的返回结果为 0,但 sum(col) 的返回结果为 NULL,因此使用 sum() 时需注意 NPE 问题。
(4)【强制】使用 ISNULL() 来判断是否为 NULL 值。
(5)【强制】在代码中写分页查询逻辑时,若 count 为 0 应直接返回,避免执行后面的分页语句。
(6)【强制】不得使用外键与级联,一切外键概念必须应在应用层解决。
(7)【强制】禁止使用存储过程,存储过程难以调试和扩展,更没有移至性。
(8)【强制】数据修订(特别是删除、修改记录操作)时,要先 select,避免出现误删除,确认无误才能执行更新语句操作。
(9)【推荐】in 操作能避免则避免,若实在避免不了,需要仔细评估 in 后边的集合元素数量,控制在 1000 个之内。
(10)【参考】如果有国际化需要,所有的字符存储与表示,均以 utf-8 编码,注意字符统计函数的区别。
(11)【参考】TRUNCATE TABLE 比 DELETE 速度快,且使用的系统和事务日志资源少,但 TRUNCATE 无事务且不触发 trigger,有可能造成事故,故不建议在开发代码中使用此语句。
4 ORM 映射
(1)【强制】在表查询中,一律不要使用 * 作为查询的字段列表,需要哪些字段必须明确写明。
(2)【强制】POJO 类的布尔属性不能加 is,而数据库字段必须加 is_,要求在 resultMap 中进行字段与属性之间的映射。
(3)【强制】不要用 resultClass 当返回参数,即使所有类属性名与数据库字段一一对应,也需要定义;反过来,每一个表也必然有一个 POJO 类与之对应。
(4)【强制】sql.xml 配置参数使用:#{},#param# 不要使用 ${},此种方式容易出现 SQL 注入。
(5)【强制】iBATIS 自带的 queryForList(String statementName, int start, int size) 不推荐使用。
(6)【强制】不允许直接拿 HashMap 与 Hashtable 作为查询结果集的输出。
(7)【强制】更新数据表记录时,必须同时更新记录对应的 gmt_modified 字段值为当前时间。
(8)【推荐】不要写一个大而全的数据更新接口。传入为 POJO 类,不管是不是自己的目标更新字段,都进行 update table set c1 = v1,c2 = v2;这是不对的。执行 SQL 时,不要更新无改动的字段,一是容易出错;二是效率低;三是增加 binlog 存储。
(9)【参考】@Transactional 事务不要滥用。事务会影响数据库的 QPS,另外使用事务的地方需要考虑各方面的回滚方案,包括缓存回滚、搜索引擎回滚、消息补偿、统计修正等。
(10)【参考】<isEqual> 中的 compareValue 是与属性值对比的常量,一般是数字,表示相等时带上此条件;<isNotEmpty> 表示不为空且不为 null 时执行;<isNotNull> 表示不为 null 值时执行。
网友评论