数据字典规范

文档编号: SYS-DB-STD-004
版本: 1.0
日期: 2026-03-08
作者: 数据库架构师
状态: ✅ 已发布
审核状态: ✓ 已审核通过
审核日期: 2026-03-08
审核人: 技术总监

一、概述

1.1 目的

本文档定义System平台数据字典的编制规范，确保数据字典的完整性、准确性和一致性，为开发、测试和运维提供清晰的数据定义参考。

1.2 适用范围

系统数据字典
业务数据字典
枚举值字典
数据字典维护流程

1.3 数据字典价值

统一理解: 确保团队对数据定义的统一理解
开发指导: 为开发提供字段定义参考
测试依据: 为测试提供数据规则依据
运维支持: 为运维提供数据结构参考
知识传承: 沉淀数据资产知识

二、数据字典分类

2.1 系统数据字典

记录系统级表和字段的定义：

用户相关表（sys_user, sys_role, sys_permission等）
配置相关表（sys_config, sys_dict等）
日志相关表（sys_operation_log, sys_login_log等）

2.2 业务数据字典

记录业务级表和字段的定义：

业务核心表
业务关联表
业务历史表

2.3 枚举值字典

记录系统中使用的枚举值定义：

状态枚举（启用/禁用）
类型枚举（角色类型、菜单类型等）
业务枚举（订单状态、支付状态等）

三、数据字典格式规范

3.1 表级字典格式

每个表的数据字典应包含以下信息：

markdown

### 表名: [表名]

| 项目 | 内容 |
|-----|------|
| 表名 | [表名] |
| 中文名 | [中文名称] |
| 说明 | [表的业务说明] |
| 所属模块 | [模块名称] |
| 数据量预估 | [预估数据量] |
| 增长趋势 | [增长趋势说明] |
| 保留周期 | [数据保留周期] |

#### 字段定义

| 序号 | 字段名 | 数据类型 | 必填 | 默认值 | 说明 |
|-----|-------|---------|------|-------|------|
| 1 | id | BIGINT | 是 | 自增 | 主键ID |
| 2 | ... | ... | ... | ... | ... |

#### 索引定义

| 序号 | 索引名 | 类型 | 字段 | 说明 |
|-----|-------|------|------|------|
| 1 | pk_xxx | 主键 | id | 主键索引 |
| 2 | ... | ... | ... | ... |

#### 约束定义

| 序号 | 约束名 | 类型 | 字段 | 说明 |
|-----|-------|------|------|------|
| 1 | pk_xxx | 主键 | id | 主键约束 |
| 2 | ... | ... | ... | ... |

3.2 字段级字典格式

每个字段的详细定义应包含：

属性	说明	示例
字段名	英文字段名	user_name
中文名	中文名称	用户名
数据类型	数据类型和长度	VARCHAR(50)
必填	是否必填	是/否
默认值	默认值	'' / 0 / NULL
取值范围	有效取值范围	1-100
业务含义	字段的业务含义	用户登录账号
业务规则	业务规则说明	全局唯一，不可重复
枚举值	枚举值定义	0-禁用, 1-启用
示例值	示例数据	zhangsan
备注	其他说明	加密存储

3.3 枚举值字典格式

markdown

### 枚举类型: [枚举名称]

| 枚举代码 | 枚举值 | 说明 | 颜色标识 |
|---------|-------|------|---------|
| [code] | [value] | [说明] | [颜色] |
| 0 | 禁用 | 已禁用状态 | 红色 |
| 1 | 启用 | 已启用状态 | 绿色 |

四、字段描述规范

4.1 描述内容要求

字段描述应包含以下要素：

业务含义: 字段代表的业务概念
使用场景: 字段的使用场景
取值规则: 字段的取值规则和限制
关联关系: 与其他字段或表的关系

4.2 描述示例

字段名	描述示例
status	状态：0-禁用，1-启用，默认1。控制用户是否可以登录系统。
user_type	用户类型：1-普通用户，2-管理员，3-超级管理员。决定用户的权限范围。
create_time	创建时间：记录数据创建的时间戳，格式为yyyy-MM-dd HH:mm:ss。

4.3 描述禁用词

描述中应避免使用以下词汇：

模糊的词汇："等"、"等等"、"其他"
无意义的词汇："相关"、"有关"、"对应"
过于简单的词汇："编号"、"名称"（应更具体）

五、枚举值定义规范

5.1 枚举值命名

规范	说明	正确示例	错误示例
数字编码	使用数字表示	0, 1, 2	zero, one, two
含义明确	编码有明确含义	0-禁用, 1-启用	0-状态A, 1-状态B
连续编码	编码尽量连续	0, 1, 2, 3	0, 2, 5, 10
预留空间	预留扩展空间	0, 1, 2（间隔10）	0, 1, 2, 3

5.2 常用枚举值定义

5.2.1 状态枚举

markdown

| 枚举代码 | 枚举值 | 说明 | 颜色 |
|---------|-------|------|------|
| 0 | 禁用 | 已禁用 | 红色 #FF4D4F |
| 1 | 启用 | 已启用 | 绿色 #52C41A |

5.2.2 删除标志枚举

markdown

| 枚举代码 | 枚举值 | 说明 |
|---------|-------|------|
| 0 | 正常 | 数据正常 |
| 1 | 已删除 | 数据已逻辑删除 |

5.2.3 性别枚举

markdown

| 枚举代码 | 枚举值 | 说明 |
|---------|-------|------|
| 0 | 未知 | 性别未知 |
| 1 | 男 | 男性 |
| 2 | 女 | 女性 |

5.2.4 是否枚举

markdown

| 枚举代码 | 枚举值 | 说明 |
|---------|-------|------|
| 0 | 否 | 否/假 |
| 1 | 是 | 是/真 |

5.3 枚举值扩展规则

向后兼容: 新增枚举值不应改变已有枚举值的含义
预留空间: 枚举值之间预留间隔，便于扩展
废弃标记: 废弃的枚举值标记为"已废弃"，不删除
版本记录: 记录枚举值的变更历史

六、数据字典维护规范

6.1 维护职责

角色	职责
数据库架构师	制定数据字典规范，审核数据字典
数据库设计师	编制和维护数据字典
开发工程师	参考数据字典进行开发，反馈问题
测试工程师	参考数据字典设计测试用例

6.2 维护流程

┌─────────────┐    ┌─────────────┐    ┌─────────────┐    ┌─────────────┐
│  设计阶段   │ -> │  编制字典   │ -> │  评审确认   │ -> │  发布使用   │
└─────────────┘    └─────────────┘    └─────────────┘    └─────────────┘
       ^                                                    |
       └──────────────── 变更维护 ──────────────────────────┘

6.3 变更管理

6.3.1 变更类型

变更类型	说明	处理流程
新增	新增表或字段	设计评审 -> 编制字典 -> 发布
修改	修改字段定义	影响分析 -> 变更评审 -> 更新字典
删除	删除表或字段	影响分析 -> 变更评审 -> 标记废弃

6.3.2 变更影响分析

字段变更需分析以下影响：

应用影响: 影响哪些应用程序
接口影响: 影响哪些接口
报表影响: 影响哪些报表
历史数据: 历史数据处理方案

6.4 版本管理

数据字典应进行版本管理：

markdown

## 版本历史

| 版本 | 日期 | 作者 | 变更内容 |
|-----|------|------|---------|
| 1.2 | 2026-03-15 | 张三 | 新增sys_user表的phone字段 |
| 1.1 | 2026-03-10 | 李四 | 修改sys_role表的status字段枚举值 |
| 1.0 | 2026-03-08 | 王五 | 初始版本 |

七、数据字典模板

7.1 系统数据字典模板

markdown

# 系统数据字典

> **文档编号**: SYS-DB-DICT-001  
> **版本**: 1.0  
> **日期**: 2026-03-08  

---

## 一、概述

### 1.1 文档说明
本文档定义System平台系统级表的数据字典。

### 1.2 表清单

| 序号 | 表名 | 中文名 | 说明 |
|-----|------|-------|------|
| 1 | sys_user | 用户表 | 存储系统用户信息 |
| 2 | sys_role | 角色表 | 存储系统角色信息 |
| ... | ... | ... | ... |

---

## 二、表定义

### 2.1 sys_user（用户表）

#### 基本信息

| 项目 | 内容 |
|-----|------|
| 表名 | sys_user |
| 中文名 | 用户表 |
| 说明 | 存储系统用户的基本信息，包括用户名、密码、联系方式等 |
| 所属模块 | 用户管理 |
| 数据量预估 | 10万条 |
| 增长趋势 | 每月增长约1000条 |
| 保留周期 | 永久保留 |

#### 字段定义

| 序号 | 字段名 | 数据类型 | 必填 | 默认值 | 说明 |
|-----|-------|---------|------|-------|------|
| 1 | id | BIGINT | 是 | 自增 | 用户ID，主键 |
| 2 | username | VARCHAR(50) | 是 | - | 用户名，登录账号，全局唯一 |
| 3 | password | VARCHAR(100) | 是 | - | 密码，BCrypt加密存储 |
| 4 | email | VARCHAR(100) | 否 | NULL | 邮箱地址，全局唯一 |
| 5 | phone | VARCHAR(20) | 否 | NULL | 手机号，全局唯一 |
| 6 | status | TINYINT | 是 | 1 | 状态：0-禁用，1-启用 |
| 7 | create_time | DATETIME | 是 | CURRENT_TIMESTAMP | 创建时间 |
| 8 | update_time | DATETIME | 否 | NULL | 更新时间 |
| 9 | deleted | TINYINT | 是 | 0 | 删除标志：0-正常，1-删除 |

#### 索引定义

| 序号 | 索引名 | 类型 | 字段 | 说明 |
|-----|-------|------|------|------|
| 1 | pk_user | 主键 | id | 主键索引 |
| 2 | uk_user_username | 唯一 | username | 用户名唯一索引 |
| 3 | uk_user_email | 唯一 | email | 邮箱唯一索引 |
| 4 | idx_user_phone | 普通 | phone | 手机号索引 |

#### 约束定义

| 序号 | 约束名 | 类型 | 字段 | 说明 |
|-----|-------|------|------|------|
| 1 | pk_user | 主键 | id | 主键约束 |
| 2 | uk_user_username | 唯一 | username | 用户名唯一约束 |
| 3 | uk_user_email | 唯一 | email | 邮箱唯一约束 |

---

## 三、枚举值定义

### 3.1 状态枚举（status）

| 枚举代码 | 枚举值 | 说明 | 颜色 |
|---------|-------|------|------|
| 0 | 禁用 | 已禁用，不可登录 | 红色 |
| 1 | 启用 | 已启用，可以登录 | 绿色 |

### 3.2 删除标志枚举（deleted）

| 枚举代码 | 枚举值 | 说明 |
|---------|-------|------|
| 0 | 正常 | 数据正常可用 |
| 1 | 已删除 | 数据已逻辑删除 |

---

## 四、版本历史

| 版本 | 日期 | 作者 | 变更内容 |
|-----|------|------|---------|
| 1.0 | 2026-03-08 | 张三 | 初始版本 |

7.2 业务数据字典模板

markdown

# 业务数据字典

> **文档编号**: SYS-DB-DICT-002  
> **版本**: 1.0  
> **日期**: 2026-03-08  

---

## 一、概述

### 1.1 文档说明
本文档定义System平台业务级表的数据字典。

### 1.2 表清单

| 序号 | 表名 | 中文名 | 所属业务域 |
|-----|------|-------|-----------|
| 1 | biz_order | 订单表 | 订单管理 |
| 2 | biz_product | 产品表 | 产品管理 |
| ... | ... | ... | ... |

---

## 二、表定义

[表定义内容...]

---

## 三、业务规则

### 3.1 订单状态流转

待支付 -> 已支付 -> 已发货 -> 已完成 | | v v 已取消已退款


### 3.2 数据一致性规则

1. 订单金额 = 商品金额 + 运费 - 优惠金额
2. 订单创建时必须关联有效用户
3. 订单取消后库存自动回滚

---

## 四、版本历史

| 版本 | 日期 | 作者 | 变更内容 |
|-----|------|------|---------|
| 1.0 | 2026-03-08 | 张三 | 初始版本 |

八、数据字典质量检查清单

8.1 完整性检查

[ ] 所有表都有数据字典定义
[ ] 所有字段都有数据字典定义
[ ] 所有枚举值都有定义
[ ] 所有索引都有说明
[ ] 所有约束都有说明

8.2 准确性检查

[ ] 字段类型与实际一致
[ ] 字段长度与实际一致
[ ] 必填属性与实际一致
[ ] 默认值与实际一致
[ ] 枚举值与实际一致

8.3 规范性检查

[ ] 字段描述符合规范
[ ] 枚举值定义符合规范
[ ] 格式符合模板要求
[ ] 版本历史完整

8.4 可读性检查

[ ] 描述清晰易懂
[ ] 示例值具有代表性
[ ] 业务规则说明完整
[ ] 关联关系清晰

九、审核签字

角色	签字	日期
编制人	数据库架构师	2026-03-08
审核人	技术总监	2026-03-08
批准人	技术总监	2026-03-08

审核意见: 数据字典规范格式清晰，维护流程完善，能够有效支撑项目数据管理，同意发布实施。

十、修订记录

版本	日期	作者	变更内容
1.0	2026-03-08	数据库架构师	初始版本，建立数据字典规范

数据字典规范 ​

一、概述 ​

1.1 目的 ​

1.2 适用范围 ​

1.3 数据字典价值 ​

二、数据字典分类 ​

2.1 系统数据字典 ​

2.2 业务数据字典 ​

2.3 枚举值字典 ​

三、数据字典格式规范 ​

3.1 表级字典格式 ​

3.2 字段级字典格式 ​

3.3 枚举值字典格式 ​

四、字段描述规范 ​

4.1 描述内容要求 ​

4.2 描述示例 ​

4.3 描述禁用词 ​

五、枚举值定义规范 ​

5.1 枚举值命名 ​

5.2 常用枚举值定义 ​

5.2.1 状态枚举 ​

5.2.2 删除标志枚举 ​

5.2.3 性别枚举 ​

5.2.4 是否枚举 ​

5.3 枚举值扩展规则 ​

六、数据字典维护规范 ​

6.1 维护职责 ​

6.2 维护流程 ​

6.3 变更管理 ​

6.3.1 变更类型 ​

6.3.2 变更影响分析 ​

6.4 版本管理 ​

七、数据字典模板 ​

7.1 系统数据字典模板 ​

7.2 业务数据字典模板 ​

八、数据字典质量检查清单 ​

8.1 完整性检查 ​

8.2 准确性检查 ​

8.3 规范性检查 ​

8.4 可读性检查 ​

九、审核签字 ​

十、修订记录 ​

数据字典规范

一、概述

1.1 目的

1.2 适用范围

1.3 数据字典价值

二、数据字典分类

2.1 系统数据字典

2.2 业务数据字典

2.3 枚举值字典

三、数据字典格式规范

3.1 表级字典格式

3.2 字段级字典格式

3.3 枚举值字典格式

四、字段描述规范

4.1 描述内容要求

4.2 描述示例

4.3 描述禁用词

五、枚举值定义规范

5.1 枚举值命名

5.2 常用枚举值定义

5.2.1 状态枚举

5.2.2 删除标志枚举

5.2.3 性别枚举

5.2.4 是否枚举

5.3 枚举值扩展规则

六、数据字典维护规范

6.1 维护职责

6.2 维护流程

6.3 变更管理

6.3.1 变更类型

6.3.2 变更影响分析

6.4 版本管理

七、数据字典模板

7.1 系统数据字典模板

7.2 业务数据字典模板

八、数据字典质量检查清单

8.1 完整性检查

8.2 准确性检查

8.3 规范性检查

8.4 可读性检查

九、审核签字

十、修订记录