mysql 规范

说明

ñ本规范包含 平安金融科技 使用 MySQL 数据库时所需要遵循的所有对象设计（数据库，表，字段），所需要遵循的命名，对象设计，SQL 编写等的规范约定。

ñ所有内容都为必须严格执行的项目，执行过程中有任何疑问，请联系 DBA Team 取得帮助。

概述

ñ禁止明文传播数据库帐号和密码。

ñ禁止开发工程师通过应用帐号登录生产数据库。

ñ禁止应用在服务器安装MySQL客户端（可以安装开发包）。

ñ禁止开发人员在SQL中添加 Hint，Hint只能由DBA审核后添加。

ñ禁止使用悲观锁定，即读锁 select … for update。

ñ禁止在开发代码中使用DDL语句，比如truncate，alter table … 等。

ñ禁止DML语句的where条件中包含恒真条件（如：1=1）。

1. 命名规范

总则

ñ数据库对象名仅可包含小写英文字母、数字、下划线（_）三类字符，并以英文字母开头。

ñ数据库对象命名禁止使用MySQL保留字。

ñ多个单词之间用下划线（_）分隔。

ñ对象名称长度若超过限制，则使用简写/缩写命名。

1.1. 数据库命名

ñ数据库以"db_"前缀 +"站点名_"前缀及其所服务的应用名称命名。

1.2. 表命名

ñ所属同一模块的表必须以模块名作为前缀命名。

ñ历史数据表在原表基础上增加"_his"后缀命名。

1.3. 字段命名

ñ布尔意义的字段以"_flag"作为后缀，前接动词。如：表示逻辑删除意义的字段可命名为 delete_flag。

ñ各表间相同意义的字段（如：作为连接关系的引用字段）使用相同的字段名。

1.4. 索引命名

ñ唯一索引以 uk_tablename_columnnames 方式命名

ñ普通索引以 idx_tablename_columnnames 方式命名

ñ组合索引以 idx_tablename_column1_column2... 方式命名

示例

ñ站点名：maymay

ñ模块名：order ；

ñ数据表：item；

ñ字段组成：order_item_id,add_time,raw_update_time,c1,c2,c3,c4,c5

ñ标准数据库名：db_maymay_order；

ñ标准数据表名：order_item；

ñ历史数据表名：order_item_his；

ñ索引需求：c1唯一，c2和c3 组合索引：uk_order_item_c1,idx_order_item_c2_c3

ñ字段实际意义：是否已删除；

ñ标准字段名：delete_flag；

ñ字段 order.order_id被order_item引用；

ñorder_item 表中与之对应的字段命名必须为：order_id

2. 对象设计规范

总则

ñ所有表、字段必须添加能够清楚表示其含义的注释。状态类字段的注释中必须明确列出各状态值的说明。

ñMySQL数据库中仅可以使用下文提及的数据类型。

2.1. 数据类型

2.1.1. 数值类型

ñDECIMAL(M,D)

当表示定点小数的情况下使用该类型，禁止使用浮点类型，会带来不精确。定点数在MySQL内部以字符串形式存储，比浮点数更精确，适合用来表示货币等精度高的数据。

ñINT系列

所有整数类型字段使用INT（TINYINT、SMALLINT、MEDIUMINT、INT、BIGINT）,根据所存放的数据大小选择合适的子类型，且所有INT类型都不使用长度限制。

2.1.2. 字符串类型

ñVARCHAR

所有可变长度的字段均使用VARCHAR类型，对于有限类别的字段（如性别、状态等），均建议使用VARCHAR类型存储能明显表现其意义的字符串。

ñTEXT系列

仅当需存储的字节数可能超过20000时，使用TEXT系列类型（TEXT、MEDIUMTEXT、LONGTEXT）。并和原表进行分拆，与原表主键组成新表存储，且每个表只允许有一个TEXT系列类型字段。

2.1.3. 时间类型

ñDATE

只需要精确到天的字段使用DATE类型。精确到"天"的取当前时期的操作使用CURDATE()函数实现。 -DATETIME

需要精确到时间（时、分、秒）的字段使用DATETIME类型。精确到"秒"的取当前时间的操作使用NOW()函数实现。取值范围：'1000-01-01'到'9999-12-31'

TIMESTAMP

需要使用函数作为默认值时使用TIMESTAMP。取值范围：'1970-01-01 00:00:00'到'2037-01-01 00:00:00'

2.2. 表设计

ñ必含字段

id INT：主键使用MySQL的自增类型

raw_add_time DATETIME：创建日期（大字段拆分表除外），必须使用数据库时间（用now()生成）

raw_update_time TIMESTAMP：修改日期（大字段拆分表除外, 但内容变化必须修改主表的update_time字段），由数据库自动变更，应用不操作此字段

以上3个字段都必须是没有任何商业意义的与业务无关的字段，不允许赋予任何商业意义

ñ作为表间连接关系的字段，数据类型必须保持严格一致，避免索引无法正常使用。

ñ附属表拆分后，附属表关联字段使用主表主键字段，且附属表须有独立主键（大字段拆分的表不需要单独的主键）

ñ存在过期概念的表，在其设计之初就必须有过期机制，且有明确的过期时间。过期数据必须迁移至历史表中。

ñ不再使用的表，必须通知DBA予以更名归档。

ñ线上表中若有不再使用的字段，为保证数据完整，禁止删除，而是进行更名归档，名称统一增加"droped_"前缀

2.3. 约束使用

2.3.1. 主键

ñ主键不能包含业务含义。

ñ主键在任何情况下不允许被更新。

2.3.2. 唯一约束

ñ除主键外，需存在唯一性约束的，可通过创建以"uk_"为前缀的唯一索引实现。

2.3.3. 外键

ñ任何情况不在数据库创建外键约束，外键规则由应用控制。

2.3.4. 非空列

ñ所有非空列须在建表之初明确标识"NOT NULL",上线之后，不允许再变更。

2.3.5. 存储过程、触发器、视图、计划任务

ñ禁止任何业务逻辑通过封装在数据库中的procedure/function/trigger实现。

ñ禁止应用程序使用view。

ñ禁止业务逻辑使用数据库的计划任务。

3. SQL编写规范

3.1. 绑定变量与替代变量

原则

所有 Query 的 Where 条件中的变量，都需要使用绑定变量来实现，此要求并不完全是基于性能的考虑，更多是基于安全方面的考虑。

3.2. 数据类型转换

原则

避免因数据类型转换导致执行计划有误。

说明

ñwhere条件中的过滤字段如需转换类型，只可转换过滤值，不可转换被过滤字段。

ñ表连接操作中，作为连接条件的字段的数据类型严格一致。

ñ如果表连接字段数据类型不一致，在SQL中用显示用类型转换，具体情况咨询DBA。

示例

正确用法1：select col1, col2from tbl1, tbl2

where tbl1.col3 = tbl2.col4;

其中"tbl1.col3"与"tbl2.col4"数据类型严格一致。

正确用法2：select col1，col2 from tbl

where gmt_create = str_to_date('20100526 00:00:00','%Y%m%d%H:%i:%s');

"count(…)"使用

除非是明确目的是统计某个字段上值不为空的记录的数目，否者只允许之用 count(*),而不允许使用count(column_name) 或者 count(1)。

3.3. "select * from …"使用

原则

为避免查询中无用字段参与排序操作而导致的性能降低及潜在的安全隐患。禁止使用"select* from …"。

说明

任何情况都要明确列出查询需要返回的字段，禁止使用select * 返回所有字段。

3.4. "insert into tablename values()"使用

原则

为避免增加或删除字段带来的SQL报错。禁止使用省略字段名的insert into语句。

说明

任何情况都要明确列出需要写入的字段名称。

3.5. 表连接

原则

规范连接语法以方便SQL脚本的阅读及提升连接操作性能。

说明

ñ非外连接查询中，连接表在"from"子句中列出，并以逗号分隔；连接条件在"where"子句中列出，而不允许使用join … on 方式实现join。

ñ外连接查询中，可使用"left join … on"语法；外连接一律使用"left join"表示。

ñ可以改写为连接的子查询禁止使用子查询方式，而应改写为连接方式。

示例

ñ规范

select col1, col2 from tbl1,tbl2 where tbl1.col4 = tbl2.col3;

select col1, col2 from tbl1 leftouter join tbl2 on tbl1.col4 = tbl2.col3;

select col1, col2 from tbl1 leftouter join tbl2 on tbl1.col4 = tbl2.col3;

select col1 from tbl1,tbl2 wheretbl1.col2 = tbl2.col3;

select col1 from tbl1 left jointbl2 on tbl1.col2 = tbl2.col3 where tbl2.col3 is null;

ñ非规范：

select col1, col2 from tbl1 jointbl2 on tbl1.col4 = tbl2.col3;

select col1 from tbl1 where col2in (select col3 from tbl2);

select col1 from tbl1 where col2not in (select col3 from tbl2);

3.6. 分页查询

说明

ñ分页查询必须带有唯一的排序条件，除非业务逻辑明确要求随机展现数据。对于多表连接的分页语句，如果过滤条件在单个表上，则先分页，后连接。

ñ通过limit进行分页操作的时候，limit参数为start（起始记录数），page_offset(每页记录数)。

示例

ñ规范化用法：

select a.col1, a.col2，b.col1, b.col2

from (select t.col1, t.col2

from tbl1 t where t.col3 = exp

order by t.col4 limit start,page_offerset) a,tbl2 b

where a.col3 = b.col3;  

4.数据库级别规范

4.1连接池的使用

应用程序连接数据库必须使用连接池。

4.2存储引擎的选择

尽量不要使用memory引擎的表，除非能把握好对内存表的控制。