数据库开发与设计规范

最新推荐文章于 2024-07-01 23:02:25 发布

LookHowTheyShine4You

最新推荐文章于 2024-07-01 23:02:25 发布

阅读量715

点赞数

文章标签：数据库

本文链接：https://blog.csdn.net/S_yellow/article/details/118101046

版权

本文档详细阐述了数据库设计的原则与规范，包括数据库安全、性能、命名、表设计、字段规范、索引创建等方面，强调了避免自定义函数、存储过程、触发器的使用，提倡使用清晰的命名策略，以及合理规划数据库性能与备份策略，以确保数据库高效稳定运行。

摘要由CSDN通过智能技术生成

1. 引言

1.1 文档目的
本文档明确数据库设计原则和规范，规范数据库对象命名方式，见名知意，强化分工，保证数据库高效稳定运行。

2. 数据库设计原则

充分考虑业务逻辑和数据分离，数据库只作为一个保证ACID特性的关系数据的持久化存储系统，尽量避免使用自定义函数、存储过程、触发器和视图。
充分考虑数据库整体安全设计，数据库管理和使用人员权限分离。
充分考虑具体数据对象的访问频度及性能需求，结合主机、存储等需求，做好数据库性能设计。
充分考虑数据增长模型，决策是否采用“分布式（水平拆分或者垂直拆分）”模式。
充分考虑业务数据安全等级，设计合适的备份和恢复策略。

3. 设计规范

3.1 约定
6. 一般情况下设计遵守数据的设计规范3NF，尽量减少非标准范式或者反模式使用。如果需要使用非标准范式或者反模式，请DBA配合和审核相关工作并进行相关性能测试。
7. 3NF规定：
Ø 表内的每一个值都只能被表达一次。
Ø 表内的每一行都应该被唯一的标识（有唯一键）。
Ø 表内不应该存储依赖于其他键的非键信息。

3.2 表设计规范
8. 应该根据系统架构中的组件划分，针对每个组件所处理的业务进行组件单元的数据库设计；不同组件间所对应的数据库表之间的关联应尽可能减少，确保组件对应的表之间的独立性，为系统或表结构的重构提供可能性。
9. 采用领域模型驱动的方式和自顶向下的思路进行数据库设计，首先分析系统业务，根据职责定义对象。对象要符合封装的特性，确保与职责相关的数据项被定义在一个对象之内，不会出现职责描述缺失或多余。
10. 应针对所有表的主键和外键建立索引，有针对性地建立组合属性的索引。
11. 尽量少采用存储过程。
12. 设计出的表要具有较好的使用性。
13. 设计出的表要尽可能减少数据冗余，确保数据的准确性。

3.3 字段规范
14. 一行记录必须表内唯一，表必须有主键。
15. 如果数据库类型为MYSQL ，应尽量以自增INT类型为主键。如果数据库类型为ORACLE，建议使用UUID为主键。
16. 日期字段，如需要按照时间进行KEY分区或者子分区，则使用VARCHAR2类型存储，存储格式为：YYYYMMDD 。如若不需要以KEY形式作为分区列，则使用DATE或者DATETIME类型存储。不建议使用时间戳存储时间。
17. 字段名称和字段数据类型对应，如DATE命名字段，则存储时间精确到日，如TIME命名字段，则存储时间精确到时分秒，甚至毫秒。

4. 命名规范类

4.1 约定
18. 数据库对象命名清晰，尽量做到建名知意，在进行数据库建模时备注对象，便于他人理解。
19. 如果数据库类型为MYSQL，则使用Pascal Casing命名方式：
每个英语单词首字母大写，例如：BookName。
常用单词缩写三个字母以下字母都大写，例如：SP、PG 。
常用单词缩写三个字母以上第一个字母大写，例如：Xml。
20. 如果数据库类型为ORACLE，则使用驼峰式命名规范。

5. 管理范围
管理数据库中所有对象，包括实例，表，视图，索引，过程，自定义函数，包，序列，触发器等。

5.1 实例或者schema
21. 如果项目或者模块有约定俗成的简称或专有名称，则用该称呼命名该实例。
22. 如果项目或者模板没有约定俗成的简称或者专有名称，则用完整的名词英语单词命名该实例。如果需要单词词组来进行概括，单词与单词之间使用英文半角输入状态下_链接。
23. 数据库实例命名长度不能超过30个字符。

5.2 表
24. 使用项目名/模块名++表名的格式命名。
25. 表名长度不能超过30个字符。
26. 表名应使用名词性质英文单词。如果需要单词词组来进行概括，单词与单词之间使用英文半角输入状态下_连接。
如果超长，则从前面单词开始截取，保留单词前三位，保留完整的最后一个单词，如果依然超长，则保留前面单词首字母，直接和最后一个单词连接。
27. 临时表需以TMP开头，命名格式为TMP_模块/用途名称_名字拼音首字母。
28. 表中标识唯一性字段必须以标识性简称++ID命名。其余字段根据存储信息，使用名词性质英文单词表示，如需要单词词组来进行概括，单词与单词之间使用英文半角输入状态下_连接。外键引用字段使用外键表_ID的形式命名。
29. 尽量减少或者不使用联合主键。
30. 字段名称长度不能超过30个字符。

5.3 视图
31. 使用VW++项目名/模块名+ +用途的格式命名。
32. 视图名称长度不能超过30个字符。
33. 在视图中过滤条件尽量写在where或者join之后，禁止在select … from直接进行关联表进行二次过滤。

5.4 序列
34. 使用SEQ+_+用途的格式命名。
35. 序列名称长度不能超过30个字符。

5.5 存储过程/函数
36. 使用PRO++过程名称的格式命名。
37. 过程名称长度不能超过30个字符。
38. 过程参数使用P_前缀。使用P+INOUT类型+变量名称格式命名。
39. 过程参数变量名称长度不能超过20个字符。
40. 过程参数命名需使用名词英文单词命名，且不能为无意义名称。
41. 自定义函数要有明确的返回值。

5.6 索引
42. 使用INX++索引类型++字段名的格式命名。
43. 主键索引索引类型为PK,外键索引索引类型为FK ，唯一索引类型为UK，位图索引类型为BM，一般索引不给索引类型。
44. 联合索引命名时按照创建索引时字段顺序列举字段名，字段建议不要超过3个。
45. 索引名称长度不超过30个字符。

5.7 包
46. 按照使用用途区分。
47. 如果是功能模块需要，则包以PKG++模块名格式命名。如果是个人功能或者数据处理，则包以PKG++姓名首字母格式命名。
48. 包名称长度不超过30个字符。
49. 包内过程和函数使用规范参照前面存储过程/函数章节。

其余如OBJECT，触发器等对象规范，根据后续发展，如需使用到时完善这部分规则。

6. 使用规范类
50. 所有除临时表以外的新增，对数据模型的更改都需要通知DBA做好相应的维护。
51. 所有JOB和scheduler的运行需要通知DBA , DBA做好相应的执行时间规划。
52. 一张表上索引建议不能超过5个。索引的创建需求应让DBA 知晓并让DBA 做好规划。
53. 开发人员禁止直接使用DDL语言。
54. 所以库表，索引，过程，函数等对象操作，必须填写相应备注说明。
55. 如果表有分区，那么分区表上索引尽量使用本地索引。

四. MySQL数据库

1. 建表规约

【推荐】表达是与否概念的字段，必须使用 is_xxx 的方式命名，数据类型是 unsigned tinyint
（1 表示是，0 表示否）。
说明：任何字段如果为非负数，必须是 unsigned。
注意：POJO 类中的任何布尔类型的变量，都不要加 is 前缀，所以，需要在设置从 is_xxx 到 Xxx 的映射关系。数据库表示是与否的值，使用 tinyint 类型，坚持 is_xxx 的命名方式是为了明确其取值含义与取值范围。
正例：表达逻辑删除的字段名 is_deleted，1 表示删除，0 表示未删除。
【强制】表名、字段名必须使用小写字母或数字，禁止出现数字开头，禁止两个下划线中间只出现数字。数据库字段名的修改代价很大，因为无法进行预发布，所以字段名称需要慎重考虑。
说明：MySQL 在 Windows 下不区分大小写，但在 Linux 下默认是区分大小写。因此，数据库名、表名、字段名，都不允许出现任何大写字母，避免节外生枝。
正例：aliyun_admin，rdc_config，level3_name
反例：AliyunAdmin，rdcConfig，level_3_name
【强制】表名不使用复数名词。
说明：表名应该仅仅表示表里面的实体内容，不应该表示实体数量，对应于 DO 类名也是单数形式，符合表达习惯。
【强制】禁用保留字，如 desc、range、match、delayed 等，请参考 MySQL 官方保留字。
【强制】主键索引名为 pk_字段名；唯一索引名为 uk_字段名；普通索引名则为 idx_字段名。
说明：pk_ 即 primary key；uk_ 即 unique key；idx_ 即 index 的简称。
【强制】小数类型为 decimal，禁止使用 float 和 double。
说明：float 和 double 在存储的时候，存在精度损失的问题，很可能在值的比较时，得到不正确的结果。如果存储的数据范围超过 decimal 的范围，建议将数据拆成整数和小数分开存储。
【强制】如果存储的字符串长度几乎相等，使用 char 定长字符串类型。
【推荐】表必备三字段：id, gmt_create, gmt_modified。

说明：其中 id 必为主键，类型为 bigint unsigned、单表时自增、步长为 1。gmt_create,gmt_modified 的类型均为 datetime 类型，前者现在时表示主动创建，后者过去分词表示被动更新。

【推荐】表的命名最好是加上“业务名称_表的作用”。
正例：alipay_task / force_project / trade_config
【推荐】库名与应用名称尽量一致。
【推荐】如果修改字段含义或对字段表示的状态追加时，需要及时更新字段注释。
【推荐】字段允许适当冗余，以提高查询性能，但必须考虑数据一致。冗余字段应遵循：
1）不是频繁修改的字段。
2）不是 varchar 超长字段，更不能是 text 字段。
正例：商品类目名称使用频率高，字段长度短，名称基本一成不变，可在相关联的表中冗余存储类目名称，避免关联查询。
【推荐】单表行数超过 500 万行或者单表容量超过 2GB，才推荐进行分库分表。
说明：如果预计三年后的数据量根本达不到这个级别，请不要在创建表时就分库分表。
【参考】合适的字符存储长度，不但节约数据库表空间、节约索引存储，更重要的是提升检索速度。
正例：如下表，其中无符号值可以避免误存负数，且扩大了表示范围。
对象年龄区间类型字节表示范围
人 150 岁之内 tinyint unsigned 1 无符号值：0 到 255
龟数百岁 smallint unsigned 2 无符号值：0 到 65535
恐龙化石数千万年 int unsigned 4 无符号值：0 到约 42.9 亿
太阳约 50 亿年 bigint unsigned 8 无符号值：0 到约 10 的 19 次方

2. 索引规约

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

3. SQL语句

【强制】不要使用 count(列名)或 count(常量)来替代 count()，count()是 SQL92 定义的标准统计行数的语法，跟数据库无关，跟 NULL 和非 NULL 无关。
说明：count(*)会统计值为 NULL 的行，而 count(列名)不会统计此列为 NULL 值的行。
【强制】count(distinct col) 计算该列除 NULL 之外的不重复行数，注意 count(distinct col1, col2) 如果其中一列全为 NULL，那么即使另一列有不同的值，也返回为 0。
【强制】当某一列的值全是 NULL 时，count(col)的返回结果为 0，但 sum(col)的返回结果为NULL，因此使用 sum()时需注意 NPE 问题。
正例：可以使用如下方式来避免 sum 的 NPE 问题：SELECT IF(ISNULL(SUM(g)),0,SUM(g))
FROM table;
【强制】使用 ISNULL()来判断是否为 NULL 值。
说明：NULL 与任何值的直接比较都为 NULL。
1） NULL<>NULL 的返回结果是 NULL，而不是 false。
2） NULL=NULL 的返回结果是 NULL，而不是 true。
3） NULL<>1 的返回结果是 NULL，而不是 true。
【强制】在代码中写分页查询逻辑时，若 count 为 0 应直接返回，避免执行后面的分页语句。
【强制】不得使用外键与级联，一切外键概念必须在应用层解决。
说明：以学生和成绩的关系为例，学生表中的 student_id是主键，那么成绩表中的 student_id则为外键。如果更新学生表中的 student_id，同时触发成绩表中的 student_id 更新，即为级联更新。外键与级联更新适用于单机低并发，不适合分布式、高并发集群；级联更新是强阻塞，存在数据库更新风暴的风险；外键影响数据库的插入速度。
【推荐】禁止使用存储过程，存储过程难以调试和扩展，更没有移植性。
【强制】数据订正（特别是删除、修改记录操作）时，要先 select，避免出现误删除，确认无误才能执行更新语句。
【推荐】in 操作能避免则避免，若实在避免不了，需要仔细评估 in 后边的集合元素数量，控制在 1000 个之内。
【参考】如果有国际化需要，所有的字符存储与表示，均以 utf-8 编码，注意字符统计函数的区别。
说明：SELECT LENGTH(“轻松工作”)；返回为 12
SELECT CHARACTER_LENGTH(“轻松工作”)；返回为 4
如果需要存储表情，那么选择 utf8mb4 来进行存储，注意它与 utf-8 编码的区别。
【参考】TRUNCATE TABLE 比 DELETE 速度快，且使用的系统和事务日志资源少，但 TRUNCATE无事务且不触发 trigger，有可能造成事故，故不建议在开发代码中使用此语句。
说明：TRUNCATE TABLE 在功能上与不带 WHERE 子句的 DELETE 语句相同。

4. ORM映射

【强制】在表查询中，一律不要使用 * 作为查询的字段列表，需要哪些字段必须明确写明。
说明：1）增加查询分析器解析成本。2）增减字段容易与 resultMap 配置不一致。3）无用字段增加网络消耗，尤其是 text 类型的字段。
【强制】POJO 类的布尔属性不能加 is，而数据库字段必须加 is_，要求在 resultMap 中进行字段与属性之间的映射。
说明：参见定义 POJO 类以及数据库字段定义规定，在中增加映射，是必须的。
在 MyBatis Generator 生成的代码中，需要进行对应的修改。
【强制】不要用 resultClass 当返回参数，即使所有类属性名与数据库字段一一对应，也需要定义；反过来，每一个表也必然有一个 POJO 类与之对应。
说明：配置映射关系，使字段与 DO 类解耦，方便维护。
【推荐】sql.xml 配置参数使用：#{}，#param# 不要使用${} 此种方式容易出现 SQL 注入。
【推荐】iBATIS 自带的 queryForList(String statementName,int start,int size)不推荐使用。
说明：其实现方式是在数据库取到statementName对应的SQL语句的所有记录，再通过subList取 start,size 的子集合。
正例：Map<String, Object> map = new HashMap<>();
map.put(“start”, start);
map.put(“size”, size);
【强制】不允许直接拿 HashMap 与 Hashtable 作为查询结果集的输出。
说明：resultClass=”Hashtable”，会置入字段名和属性值，但是值的类型不可控。
【强制】更新数据表记录时，必须同时更新记录对应的 gmt_modified 字段值为当前时间。
【推荐】不要写一个大而全的数据更新接口。传入为 POJO 类，不管是不是自己的目标更新字段，都进行 update table set c1=value1,c2=value2,c3=value3; 这是不对的。执行 SQL时，不要更新无改动的字段，一是易出错；二是效率低；三是增加 binlog 存储。
【参考】@Transactional 事务不要滥用。事务会影响数据库的 QPS，另外使用事务的地方需要考虑各方面的回滚方案，包括缓存回滚、搜索引擎回滚、消息补偿、统计修正等。
【参考】中的 compareValue 是与属性值对比的常量，一般是数字，表示相等时带上此条件；表示不为空且不为 null 时执行；表示不为 null 值时执行。