【阿里巴巴Java编程规范学习 五】MySQL数据库规约

本文涉及的产品
云数据库 RDS MySQL,集群系列 2核4GB
推荐场景:
搭建个人博客
RDS MySQL Serverless 基础系列,0.5-2RCU 50GB
云数据库 RDS MySQL,高可用系列 2核4GB
简介: 【阿里巴巴Java编程规范学习 五】MySQL数据库规约

作为一个后端开发者,数据库那是必须接触的,数据库的一些操作规范也是重中之重了,因为使用不慎轻则导致慢查,重则导致数据库服务器宕机。分别从建表规约、索引规约、SQL语句以及ORM映射着几个部分来讨论。红色加粗字体为自己可能会犯的错误以及不规范的地方,蓝色结论部分为几条规则的归纳或一条规则的阐述。

建表规约

1 【强制】表达是与否概念的字段,必须使用 is_xxx 的方式命名,数据类型是 unsigned tinyint(1 表示是,0 表示否)。个人容易出现不规范行为

  • 说明:任何字段如果为非负数,必须是 unsigned。
  • 注意:POJO 类中的任何布尔类型的变量,都不要加 is 前缀,所以,需要在<resultMap>设置从 is_xxxXxx 的映射关系。数据库表示是与否的值,使用 tinyint 类型,坚持 is_xxx 的命名方式是为了明确其取值含义与取值范围。
  • 正例:表达逻辑删除的字段名 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【强制】主键索引名为 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。

  • 说明:其中 id 必为主键,类型为 bigint unsigned、单表时自增、步长为 1。create_time, update_time的类型均为 datetime 类型,前者现在时表示主动式创建,后者过去分词表示被动式更新。
  • 这里认为创建人和修改人也必须有:creater,updator

10【推荐】表的命名最好是遵循业务名称_表的作用

  • 正例:alipay_task / force_project / trade_config

11【推荐】库名与应用名称尽量一致

12【推荐】如果修改字段含义或对字段表示的状态追加时,需要及时更新字段注释

13【推荐】字段允许适当冗余,以提高查询性能,但必须考虑数据一致。冗余字段应遵循:

  • 不是频繁修改的字段。
  • 不是唯一索引的字段。
  • 不是 varchar 超长字段,更不能是 text 字段。

正例:各业务线经常冗余存储商品名称,避免查询时需要调用 IC 服务获取

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

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

15【参考】合适的字符存储长度,不但节约数据库表空间、节约索引存储,更重要的是提升检索速度个人容易出现不规范行为

  • 正例:无符号值可以避免误存负数,且扩大了表示范围

索引规约

1【强制】业务上具有唯一特性的字段,即使是组合字段,也必须建成唯一索引个人容易出现不规范行为

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

2【强制】超过三个表禁止 join。需要 join 的字段,数据类型保持绝对一致多表关联查询时,保证被关联的字段需要有索引尽量不用join,关联关系获取在上层代码层面处理

  • 说明:即使双表 join 也要注意表索引、SQL 性能。

3 【强制】在 varchar 字段上建立索引时,必须指定索引长度,没必要对全字段建立索引,根据实际文本区分度决定索引长度

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

4【强制】页面搜索严禁左模糊或者全模糊,如果需要请走搜索引擎来解决例如使用ES解决

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

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

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

6【推荐】利用覆盖索引来进行查询操作,避免回表

  • 说明:如果一本书需要知道第 11 章是什么标题,会翻开第 11 章对应的那一页吗?目录浏览一下就好,这个目录就是起到覆盖索引的作用。
  • 正例:能够建立索引的种类分为主键索引、唯一索引、普通索引三种,而覆盖索引只是一种查询的一种效果,用 explain 的结果,extra 列会出现:using index

7 【推荐】利用延迟关联或者子查询优化超多分页场景

  • 说明:MySQL 并不是跳过 offset 行,而是取 offset+N 行,然后返回放弃前 offset 行,返回 N 行,那当offset 特别大的时候,效率就非常的低下,要么控制返回的总页数,要么对超过特定阈值的页数进行 SQL改写。
  • 正例:先快速定位需要获取的 id 段,然后再关联:
SELECT t1.* FROM 表 1 as t1, (select id from 表 1 where 条件 LIMIT 100000,20 ) as t2 where t1.id=t2.id

8【推荐】SQL 性能优化的目标:至少要达到 range 级别,要求是 ref 级别,如果可以是 consts最好。说明:

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

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

9【推荐】建组合索引的时候,区分度最高的在最左边个人容易出现不规范行为

  • 正例:如果 where a=? and b=?,a 列的几乎接近于唯一值,那么只需要单建 idx_a 索引即可。
  • 说明:存在非等号和等号混合判断条件时,在建索引时,请把等号条件的列前置。如:where c>? and d=? ,那么即使 c 的区分度更高,也必须把 d 放在索引的最前列,即建立组合索引 idx_d_c

10【推荐】防止因字段类型不同造成的隐式转换,导致索引失效。

11【参考】创建索引时避免有如下极端误解:

  • 索引宁滥勿缺。认为一个查询就需要建一个索引。
  • 吝啬索引的创建。认为索引会消耗空间、严重拖慢记录的更新以及行的新增速度。
  • 抵制惟一索引。认为惟一索引一律需要在应用层通过先查后插方式解决。

正确看待索引的使用,我认为是循序渐进的,有些字段在设计表的时候就知道有大量查询会打到这里(或者认为应该定义为唯一限索引),此时就一定要考虑好索引创建,有些则是在业务增长一段时间后才知道,那么到时候再创建不迟,不必一开始就创建。

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 IFNULL(SUM(column), 0) FROM table;

4【强制】使用 ISNULL()来判断是否为 NULL 值。个人容易出现不规范行为

  • 说明:NULL 与任何值的直接比较都为 NULL。
  • NULL<>NULL 的返回结果是 NULL,而不是 false。
  • NULL=NULL 的返回结果是 NULL,而不是 true。
  • NULL<>1 的返回结果是 NULL,而不是 true。
  • 反例:在 SQL 语句中,如果在 null 前换行,影响可读性。select * from table where column1 is null and column3 is not null;ISNULL(column)是一个整体,简洁易懂。从性能数据上分析,ISNULL(column)执行效率更快一些。

5 【强制】代码中写分页查询逻辑时,若 count 为 0 应直接返回,避免执行后面的分页语句

6 【强制】不得使用外键与级联,一切外键概念必须在应用层解决

  • 说明:(概念解释)学生表中的 student_id 是主键,那么成绩表中的 student_id 则为外键。如果更新学生表中的 student_id,同时触发成绩表中的 student_id 更新,即为级联更新。外键与级联更新适用于单机低并发,不适合分布式、高并发集群;级联更新是强阻塞,存在数据库更新风暴的风险;外键影响数据库的插入速度。

7 【强制】禁止使用存储过程,存储过程难以调试和扩展,更没有移植性

8【强制】数据订正(特别是删除或修改记录操作)时,要先 select,避免出现误删除,确认无误才能执行更新语句个人容易出现不规范行为

9【强制】对于数据库中表记录的查询和变更,只要涉及多个表,都需要在列名前加表的别名(或表名)进行限定

  • 说明:对多表进行查询记录、更新记录、删除记录时,如果对操作列没有限定表的别名(或表名),并且操作列在多个表中存在时,就会抛异常。
  • 正例:select t1.name from table_first as t1 , table_second as t2 where t1.id=t2.id;
  • 反例:在某业务中,由于多表关联查询语句没有加表的别名(或表名)的限制,正常运行两年后,最近在某个表中增加一个同名字段,在预发布环境做数据库变更后,线上查询语句出现出 1052 异常:Column 'name' in field list is ambiguous

10【推荐】SQL 语句中表的别名前加 as,并且以 t1、t2、t3、…的顺序依次命名。个人容易出现不规范行为

  • 说明:1)别名可以是表的简称,或者是依照表在 SQL 语句中出现的顺序,以 t1、t2、t3 的方式命名。2)别名前加 as 使别名更容易识别。
  • 正例:select t1.name from table_first as t1, table_second as t2 where t1.id=t2.id;

11【推荐】in 操作能避免则避免,若实在避免不了,需要仔细评估 in 后边的集合元素数量,控制在 1000 个之内个人容易出现不规范行为

12【参考】因国际化需要,所有的字符存储与表示,均采用 utf8 字符集,那么字符计数方法需要注意。说明:

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

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

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

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

ORM映射

1【强制】在表查询中,一律不要使用 * 作为查询的字段列表,需要哪些字段必须明确写明。个人容易出现不规范行为

  • 说明:1)增加查询分析器解析成本。2)增减字段容易与 resultMap 配置不一致。3)无用字段增加网络消耗,尤其是 text 类型的字段。

2【强制】POJO 类的布尔属性不能加 is,而数据库字段必须加 is_,要求在 resultMap 中进行字段与属性之间的映射。

  • 说明:参见定义 POJO 类以及数据库字段定义规定,在 sql.xml 增加映射,是必须的。

3 【强制】不要用 resultClass 当返回参数,即使所有类属性名与数据库字段一一对应,也需要定义<resultMap>;反过来,每一个表也必然有一个<resultMap>与之对应。个人容易出现不规范行为

  • 说明:配置映射关系,使字段与 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<>(16);
map.put("start", start);
map.put("size", size);

6 【强制】不允许直接拿 HashMap 与 Hashtable 作为查询结果集的输出。

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

7 【强制】更新数据表记录时,必须同时更新记录对应的 update_time 字段值为当前时间个人容易出现不规范行为

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

9 【参考】@Transactional 事务不要滥用。事务会影响数据库的 QPS,另外使用事务的地方需要考虑各方面的回滚方案,包括缓存回滚、搜索引擎回滚、消息补偿、统计修正等。

10【参考】<isEqual>中的 compareValue 是与属性值对比的常量,一般是数字,表示相等时带上此条件;表示不为空且不为 null 时执行;<isNotNull>表示不为 null 值时执行

总结一下

数据库的相关规约应该是最重要的,因为它难以修改,一旦设计好,后期的业务代码一堆积,基本就动不了结构了,所以设计数据库表才如此重要,同时创建索引、写SQL、ORM映射等操作动作也应该认真思考。通篇而言我认为操作数据库表时应突出笨这个字,笨指的是尽量用笨办法,不要整花活,例如多嵌套join语句,ORM对象整体映射,select 全部,count 全部,字段都直接设计varchar,唯一索引懒得设计,查询之间上in等,虽然看起来很方便,不用动脑子,但是后期都是可能出问题的地方,所以设计和使用的的时候一定要精细化的用笨办法去看,每个设计功能尽量单一,在上层代码应用的时候再进行逻辑的组合。否则一旦更新迭代久了,没人记得当初为什么要这么写,也因为代码太底层影响范围太大而放弃修改,只能继续堆,所以越底层的东西功能和结构越要单一,越要短平快,复杂逻辑交给上层去整合和处理,以换取更大的系统扩展性。

相关实践学习
如何快速连接云数据库RDS MySQL
本场景介绍如何通过阿里云数据管理服务DMS快速连接云数据库RDS MySQL,然后进行数据表的CRUD操作。
全面了解阿里云能为你做什么
阿里云在全球各地部署高效节能的绿色数据中心,利用清洁计算为万物互联的新世界提供源源不断的能源动力,目前开服的区域包括中国(华北、华东、华南、香港)、新加坡、美国(美东、美西)、欧洲、中东、澳大利亚、日本。目前阿里云的产品涵盖弹性计算、数据库、存储与CDN、分析与搜索、云通信、网络、管理与监控、应用服务、互联网中间件、移动服务、视频服务等。通过本课程,来了解阿里云能够为你的业务带来哪些帮助 &nbsp; &nbsp; 相关的阿里云产品:云服务器ECS 云服务器 ECS(Elastic Compute Service)是一种弹性可伸缩的计算服务,助您降低 IT 成本,提升运维效率,使您更专注于核心业务创新。产品详情: https://www.aliyun.com/product/ecs
相关文章
|
2月前
|
Java 调度 开发者
Java线程池ExecutorService学习和使用
通过学习和使用Java中的 `ExecutorService`,可以显著提升并发编程的效率和代码的可维护性。合理配置线程池参数,结合实际应用场景,可以实现高效、可靠的并发处理。希望本文提供的示例和思路能够帮助开发者深入理解并应用 `ExecutorService`,实现更高效的并发程序。
43 10
|
2月前
|
Java 数据库连接 数据库
【潜意识Java】深度分析黑马项目《苍穹外卖》在Java学习中的重要性
《苍穹外卖》项目对Java学习至关重要。它涵盖了用户管理、商品查询、订单处理等模块,涉及Spring Boot、MyBatis、Redis等技术栈。
174 4
|
2月前
|
前端开发 Java 数据库连接
【潜意识Java】深度解读JavaWeb开发在Java学习中的重要性
深度解读JavaWeb开发在Java学习中的重要性
42 4
|
2月前
|
存储 移动开发 算法
【潜意识Java】Java基础教程:从零开始的学习之旅
本文介绍了 Java 编程语言的基础知识,涵盖从简介、程序结构到面向对象编程的核心概念。首先,Java 是一种高级、跨平台的面向对象语言,支持“一次编写,到处运行”。接着,文章详细讲解了 Java 程序的基本结构,包括包声明、导入语句、类声明和 main 方法。随后,深入探讨了基础语法,如数据类型、变量、控制结构、方法和数组。此外,还介绍了面向对象编程的关键概念,例如类与对象、继承和多态。最后,针对常见的编程错误提供了调试技巧,并总结了学习 Java 的重要性和方法。适合初学者逐步掌握 Java 编程。
58 1
|
3月前
|
存储 JSON NoSQL
学习 MongoDB:打开强大的数据库技术大门
MongoDB 是一个基于分布式文件存储的文档数据库,由 C++ 编写,旨在为 Web 应用提供可扩展的高性能数据存储解决方案。它与 MySQL 类似,但使用文档结构而非表结构。核心概念包括:数据库(Database)、集合(Collection)、文档(Document)和字段(Field)。MongoDB 使用 BSON 格式存储数据,支持多种数据类型,如字符串、整数、数组等,并通过二进制编码实现高效存储和传输。BSON 文档结构类似 JSON,但更紧凑,适合网络传输。
97 15
|
4月前
|
Java 大数据 API
14天Java基础学习——第1天:Java入门和环境搭建
本文介绍了Java的基础知识,包括Java的简介、历史和应用领域。详细讲解了如何安装JDK并配置环境变量,以及如何使用IntelliJ IDEA创建和运行Java项目。通过示例代码“HelloWorld.java”,展示了从编写到运行的全过程。适合初学者快速入门Java编程。
|
2月前
|
关系型数据库 MySQL 数据库连接
数据库连接工具连接mysql提示:“Host ‘172.23.0.1‘ is not allowed to connect to this MySQL server“
docker-compose部署mysql8服务后,连接时提示不允许连接问题解决
|
1月前
|
关系型数据库 MySQL 数据库
Docker Compose V2 安装常用数据库MySQL+Mongo
以上内容涵盖了使用 Docker Compose 安装和管理 MySQL 和 MongoDB 的详细步骤,希望对您有所帮助。
175 42
|
4天前
|
SQL 关系型数据库 MySQL
MySQL生产环境迁移至YashanDB数据库深度体验
这篇文章是作者将 MySQL 生产环境迁移至 YashanDB 数据库的深度体验。介绍了 YashanDB 迁移平台 YMP 的产品相关信息、安装步骤、迁移中遇到的各种兼容问题及解决方案,最后总结了迁移体验,包括工具部署和操作特点,也指出功能有优化空间及暂不支持的部分,期待其不断优化。
|
1月前
|
关系型数据库 MySQL 网络安全
如何排查和解决PHP连接数据库MYSQL失败写锁的问题
通过本文的介绍,您可以系统地了解如何排查和解决PHP连接MySQL数据库失败及写锁问题。通过检查配置、确保服务启动、调整防火墙设置和用户权限,以及识别和解决长时间运行的事务和死锁问题,可以有效地保障应用的稳定运行。
132 25