详细设计 on Liangweidong's blog

详细设计实战：数据库 + 接口 + 概要设计的层次化文档

Mon, 15 Sep 2025 00:00:00 +0800

详细设计（Detailed Design）是项目从"概要"走向"可编码"的关键文档——它是程序员写代码的"施工图"。本文基于多年项目实践，给出一套层次化、可落地的详细设计实战模板。

本文写于 2025 年 9 月——敏捷开发的时代，详设不会过时，只是形式更轻量。

一、详细设计 vs 概要设计

维度	概要设计	详细设计
粒度	模块 / 子系统	函数 / 类 / 表
读者	架构师 / PM	程序员
目的	划定边界	指导编码
重点	架构图 / 模块划分	数据结构 / 算法 / 接口
产物	架构图 / 接口契约	类图 / 时序图 / 表结构
更新频率	季度	周 / 迭代

二、详细设计 7 大章节

2.1 章节结构总览

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40


1. 引言
 1.1 编写目的
 1.2 背景
 1.3 参考资料
 1.4 术语定义及说明

2. 设计概述
 2.1 任务和目标
 2.2 需求概述
 2.3 运行环境概述
 2.4 条件与限制
 2.5 详细设计方法和工具

3. 系统详细需求分析
 3.1 详细需求分析
 3.2 详细系统运行环境及限制条件分析
 3.3 接口需求分析

4. 总体方案确认
 4.1 系统总体结构确认
 4.2 系统详细界面划分

5. 系统详细设计
 5.1 系统结构设计及子系统划分
 5.2 系统功能模块详细设计
 （采用 HIPO 图进行功能分解与模块描述）
 5.3 用 IPO 或结构图描述各模块的组成结构、算法、模块间的接口关系，
 以及需求、功能和模块三者之间的交叉参照关系
 5.4 系统界面详细设计

6. 数据库系统设计
 6.1 数据库概念设计（E-R 图）
 6.2 数据库逻辑设计（表结构）
 6.3 数据库物理设计（索引 / 分区）
 6.4 数据字典

7. 接口设计
 7.1 内部接口（模块间）
 7.2 外部接口（系统间）
 7.3 用户接口（UI）

三、章节 1：引言

3.1 编写目的

模板：

本文是某项目的详细设计文档，目的是：

明确系统的功能模块划分和接口关系

为程序员编码提供"施工图"

作为测试用例设计的依据

作为项目验收的标准

预期读者：项目开发工程师、测试工程师、架构师、产品经理

3.2 背景

模板：

项目名称：某业务系统委托单位：某部门开发单位：某研发部主管部门：某信息中心

3.3 参考资料

模板：

序号	文档名称	作者	日期	版本
1	需求规格说明书	张三	2025-09-01	V1.0
2	概要设计文档	李四	2025-09-10	V1.0
3	数据库设计规范	王五	2025-08-15	V2.0

3.4 术语定义

术语	解释
CRM	客户关系管理
ERP	企业资源计划
MES	制造执行系统
…	…

四、章节 2：设计概述

4.1 任务和目标

任务：完成某业务系统的详细设计，确保系统可实现性。

目标：

100% 覆盖需求规格说明书的功能点
性能指标：响应时间 < 2s，并发 1000+
可用性：99.9%
安全性：通过等保三级

4.2 需求概述

简要说明系统要实现的核心功能（不超过 5 页）：

用户管理（登录、权限、角色）
订单管理（创建、查询、修改、删除）
报表管理（日报、月报、季报）
系统管理（参数配置、日志审计）

4.3 运行环境

维度	描述
操作系统	Linux 7+ / Windows Server 2016+
Web 服务器	Nginx 1.20+
应用服务器	Tomcat 9 / Spring Boot 内嵌
数据库	MySQL 8.0+
缓存	Redis 6+
消息队列	RabbitMQ / Kafka
监控	Prometheus + Grafana
日志	ELK（Elasticsearch + Logstash + Kibana）

4.4 条件与限制

必须兼容 IE 11 浏览器（仅老系统迁移）
数据库必须使用 MySQL（甲方要求）
单台服务器资源：16 核 32G
项目周期：6 个月

4.5 详细设计方法和工具

设计方法：面向对象（OOAD）+ 结构化（SA/SD）
设计模式：MVC、Factory、Strategy、Observer
设计工具：PlantUML、draw.io、Visio
文档工具：Confluence + Markdown

五、章节 3：详细需求分析

5.1 功能需求矩阵

需求 ID	需求名称	优先级	详细说明
FR-001	用户登录	高	支持账密、SSO、扫码登录
FR-002	权限管理	高	RBAC 模型
FR-003	订单创建	高	包含订单明细
…	…	…	…

5.2 非功能需求

类别	指标
性能	响应时间 < 2s，并发 1000+
可用性	99.9%（年宕机 < 8.76 小时）
安全性	等保三级
兼容性	Chrome / Edge / Firefox 最新版
可维护性	模块独立部署

5.3 接口需求

内部接口：模块 A 调用模块 B 的接口
外部接口：与 CRM、ERP、支付的接口
数据接口：数据库、缓存、文件

六、章节 4：总体方案确认

4.1 系统总体结构

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


┌────────────────────────────────────┐
│ 表现层（Web/App） │
├────────────────────────────────────┤
│ API 网关（Gateway） │
├────────────────────────────────────┤
│ 业务服务层（订单 / 用户 / 报表） │
├────────────────────────────────────┤
│ 数据访问层（MyBatis / JPA） │
├────────────────────────────────────┤
│ 数据层（MySQL / Redis / MQ） │
└────────────────────────────────────┘

4.2 模块划分

模块编号	模块名称	职责
M-001	用户中心	登录、权限、SSO
M-002	订单中心	订单生命周期
M-003	报表中心	数据聚合、可视化
M-004	系统中心	字典、参数、日志

七、章节 5：系统详细设计（核心）

7.1 模块 HIPO 图

HIPO（Hierarchy plus Input-Process-Output） 是经典的结构化设计方法。

示例：订单中心 HIPO 图

1
2
3
4
5
6
7
8
9


 订单中心
 │
 ┌─────────────────┼─────────────────┐
 │ │ │
 订单创建 订单查询 订单修改
 │ │ │
 ┌────┴────┐ ┌───┴───┐ ┌────┴────┐
 │ │ │ │ │ │
 输入参数 业务规则 输入条件 返回结果 输入参数 业务规则

7.2 模块详细设计

每个模块都需要包含：

字段	描述
1. 模块编号	M-002
2. 模块名称	订单中心
3. 输入	订单数据 / 用户 ID / 操作类型
4. 处理	业务逻辑描述
5. 算法描述	伪代码 / 流程图
6. 输出	订单结果 / 错误码

7.3 模块 1：订单创建（M-002-001）

1. 模块编号：M-002-001

2. 模块名称：订单创建

3. 输入：

1
2
3
4
5
6
7
8
9


{
 "userId": "12345",
 "items": [
 {"productCode": "P001", "qty": 2, "price": 99.00},
 {"productCode": "P002", "qty": 1, "price": 199.00}
 ],
 "addressId": "A001",
 "remark": "请尽快发货"
}

4. 处理：

校验用户登录态
校验商品库存（每件商品）
校验地址有效性
计算订单总金额（含运费、优惠）
创建订单记录
冻结库存
返回订单号

5. 算法描述（伪代码）：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49


def create_order(user_id, items, address_id, remark):
 # 1. 校验登录
 user = check_login(user_id)
 if not user:
 return error(401, "未登录")

 # 2. 校验库存
 for item in items:
 stock = get_stock(item.product_code)
 if stock < item.qty:
 return error(400, f"商品 {item.product_code} 库存不足")

 # 3. 校验地址
 address = get_address(address_id)
 if not address or address.user_id != user_id:
 return error(400, "地址无效")

 # 4. 计算金额
 total = 0
 for item in items:
 total += item.qty * item.price
 shipping_fee = calc_shipping(address, total)
 discount = calc_discount(user, total)
 final_total = total + shipping_fee - discount

 # 5. 创建订单
 with transaction():
 order_no = generate_order_no()
 order = Order(
 order_no=order_no,
 user_id=user_id,
 status="待付款",
 total=final_total,
 remark=remark
 )
 order.save()

 for item in items:
 order_item = OrderItem(
 order_no=order_no,
 **item
 )
 order_item.save()

 # 6. 冻结库存
 for item in items:
 freeze_stock(item.product_code, item.qty, order_no)

 return success({"order_no": order_no, "total": final_total})

6. 输出：

1
2
3
4
5
6
7
8


{
 "code": 200,
 "data": {
 "orderNo": "SO20250915001",
 "total": 397.00,
 "payUrl": "https://pay.example.com/..."
 }
}

7.4 模块 2：订单查询（M-002-002）

输入：

1
2
3
4
5
6


{
 "userId": "12345",
 "page": 1,
 "size": 20,
 "status": "待发货"
}

处理：

分页查询订单主表
关联查询订单明细
返回结果

输出：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14


{
 "code": 200,
 "data": {
 "total": 50,
 "list": [
 {
 "orderNo": "SO20250915001",
 "status": "待发货",
 "total": 397.00,
 "items": [...]
 }
 ]
 }
}

八、章节 6：数据库系统设计

8.1 E-R 图

1
2
3


用户 ──< 订单 >── 订单明细 >── 商品
 │
 └──< 支付

8.2 核心表设计

订单主表（t_order）：

字段	类型	必填	说明
order_no	VARCHAR(32)	Y	主键
user_id	BIGINT	Y	用户 ID
status	VARCHAR(20)	Y	订单状态
total_amount	DECIMAL(18,2)	Y	总金额
shipping_fee	DECIMAL(18,2)	Y	运费
discount	DECIMAL(18,2)	Y	优惠
final_amount	DECIMAL(18,2)	Y	实付金额
address_id	BIGINT	Y	收货地址 ID
remark	VARCHAR(500)		备注
created_at	DATETIME	Y	创建时间
updated_at	DATETIME	Y	更新时间
version	INT	Y	乐观锁版本

订单明细表（t_order_item）：

字段	类型	必填	说明
id	BIGINT	Y	主键
order_no	VARCHAR(32)	Y	订单号
product_code	VARCHAR(50)	Y	商品编码
product_name	VARCHAR(200)	Y	商品名称（冗余）
qty	INT	Y	数量
price	DECIMAL(18,2)	Y	单价
amount	DECIMAL(18,2)	Y	金额

支付表（t_payment）：

字段	类型	必填	说明
id	BIGINT	Y	主键
order_no	VARCHAR(32)	Y	订单号
pay_type	VARCHAR(20)	Y	支付方式
pay_amount	DECIMAL(18,2)	Y	支付金额
pay_status	VARCHAR(20)	Y	支付状态
pay_time	DATETIME		支付时间

8.3 索引设计

表	索引	字段	类型
t_order	PK	order_no	主键索引
t_order	IDX_user_status	user_id, status	联合索引
t_order	IDX_created	created_at	普通索引
t_order_item	PK	id	主键索引
t_order_item	IDX_order	order_no	普通索引
t_order_item	IDX_product	product_code	普通索引
t_payment	PK	id	主键索引
t_payment	IDX_order	order_no	唯一索引

8.4 数据字典

订单状态字典：

状态码	状态名称	描述
10	待付款	订单创建未支付
20	已付款	已支付待发货
30	已发货	已发货待收货
40	已完成	已确认收货
50	已取消	用户主动取消
60	已退款	退款完成

九、章节 7：接口设计

7.1 RESTful API 规范

统一格式：

1
2
3
4
5
6
7


{
 "code": 200,
 "message": "success",
 "data": { ... },
 "timestamp": "2025-09-15T10:00:00Z",
 "traceId": "abc123"
}

错误码：

错误码	含义
200	成功
400	参数错误
401	未登录
403	无权限
404	资源不存在
500	系统错误

7.2 订单 API 列表

方法	路径	描述
POST	`/api/orders`	创建订单
GET	`/api/orders/{orderNo}`	查询订单详情
GET	`/api/orders`	分页查询
PUT	`/api/orders/{orderNo}`	修改订单
DELETE	`/api/orders/{orderNo}`	删除订单（仅草稿）
POST	`/api/orders/{orderNo}/pay`	发起支付
POST	`/api/orders/{orderNo}/cancel`	取消订单

7.3 API 详细设计

POST /api/orders 创建订单

请求：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


POST /api/orders HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGc...

{
 "items": [
 {"productCode": "P001", "qty": 2, "price": 99.00}
 ],
 "addressId": "A001",
 "remark": "请尽快发货"
}

响应：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


HTTP/1.1 200 OK
Content-Type: application/json

{
 "code": 200,
 "message": "success",
 "data": {
 "orderNo": "SO20250915001",
 "total": 198.00,
 "payUrl": "https://pay.example.com/..."
 }
}

错误码：

code	message	触发条件
400	INVALID_PARAMS	参数校验失败
401	UNAUTHORIZED	未登录
403	NO_PERMISSION	无下单权限
409	STOCK_NOT_ENOUGH	库存不足
500	SYSTEM_ERROR	系统异常

十、详细设计的常见问题

10.1 写得太"概要"

症状：详细设计文档和概要设计文档内容重复，没有具体到函数 / 表 / 接口。

解决：每个模块都必须有"输入 / 处理 / 输出 / 算法描述"4 个要素。

10.2 写得太"详细"

症状：详细设计文档变成代码注释，文档太长没人看。

解决：只描述"做什么"和"用什么算法"，不写具体代码。伪代码为主，复杂逻辑用流程图。

10.3 不更新

症状：代码已经改了好几版，详细设计文档还是 v1.0。

解决：

每个迭代更新一次
引入变更管理（设计变更需评审）
详细设计与代码不一致时，以代码为准 + 标注 TODO 更新文档

10.4 不评审

症状：详细设计文档直接进入开发，没有同行评审。

解决：

必须经过至少 2 人评审
评审 checklist：覆盖率、正确性、一致性、可读性

十一、写在最后

详细设计的本质是"将概要变成可施工的图纸"——既不能太抽象（程序员看不懂），也不能太具体（变成代码注释）。

个人建议：

新项目起步：用本模板的 7 大章节结构

敏捷项目：用轻量版（只保留 3 / 5 / 6 / 7 章节）

核心模块：必须写（订单、支付、库存）

辅助模块：可以只写接口设计

评审流程：至少 2 人同行评审 + 1 人架构师 review

参考资料

架构设计基础：概要设计与详细设计的区别与实践

Fri, 30 Oct 2015 00:00:00 +0800

这是一份关于"概要设计 vs 详细设计"的对比梳理，源于 2015 年前后的架构师培训资料。为什么把它单独提一篇？因为在多数团队里，“概要设计"和"详细设计"的边界是模糊的——有人写到伪代码、有人只画个框图，评审会上吵成一团。

一、为什么这篇值得读

很多团队把"设计文档"当成一个文档：写完直接进开发。结果：

评审会上没人能看完 50 页的"设计文档”
设计粒度不统一，有人写到 SQL，有人只画模块图
模块之间的接口没定清楚，联调时互相甩锅

正确做法是先概要、后详细——概要设计解决"分模块、定接口、估工作量"，详细设计解决"模块内算法、流程、状态"。两个文档职责分离、粒度分离、受众分离。

When to use：当一个系统超过 3 个人、超过 3 个月、超过 3 个子系统时，概要设计文档就是必需的。否则项目进入开发就是"集体蒙眼摸象"。

二、概要设计 vs 详细设计：分界

维度	概要设计	详细设计
回答的问题	系统怎么分？模块怎么交互？	模块内部怎么实现？
粒度	模块、子系统、接口	类、函数、算法
产物	分层数据流图、结构图、数据字典	流程图、状态图、伪代码、局部变量说明
受众	架构师、技术总监、项目经理	模块开发者本人
评审重点	模块划分是否合理、接口是否清晰	算法是否正确、边界条件是否覆盖
改动代价	改了概要 → 重新评估工作量	改了详细 → 一般不影响工期
数量级	通常 10-50 页	一个模块 5-20 页（视复杂度）

Tip：概要设计是多人协作的契约——3 个开发者按概要分工，每人拿到的接口定义清晰到**“传什么、返回什么、什么时候调”。详细设计是单人实现的笔记**——算法怎么写、变量怎么命名、异常怎么抛，是开发者自己的事。

三、概要设计的 4 个原则

源文档里写得很清楚：

评价总体设计的可行性——概要设计是判断"这个项目能不能做、按什么方案做"的依据
检查模块是否完整——保证每个功能都有对应模块实现，不能有"无主功能"
评估开发工作量、指导开发计划——尤其在不写详细设计的情况下，模块数 × 经验系数 = 工期
避免两个误区：
- ❌ 过于重视业务流程（应该在需求里画，不该在概要里写）
- ❌ 过于重视细节实现（应该在详细里写，不该在概要里写）

四、概要设计的内容清单

4.1 总述

需求或目标（讲一下事情的起源）、环境、局限

这是给评审者**30 秒内理解"为什么做这个系统"**的入口。

4.2 总体设计

从全局角度说：

组织结构
功能
处理流程
有哪些模块
模块间的关系
运行环境

输出图：

系统结构图
系统流程图
数据流程图

4.3 外部接口

总体说明：

外部用户
软、硬件接口（可用资源）
第三方系统
网络协议
数据格式

4.4 模块设计（核心）

每个模块"做什么"、简要说明"怎么做"（输入、输出、处理逻辑、与其它模块或系统的接口），处在什么逻辑位置、物理位置。

模块描述——说明哪些模块实现了哪些功能
模块层次结构——可使用某个视角的软件框架图表达
模块间的关系——模块间依赖关系描述、通信机制描述
模块的核心接口——说明模块传递的信息、信息的结构（重点！必须写到"参数名+类型+含义"）
处理方式设计——说一些满足功能和性能的算法（只写算法思想，不写实现）

4.5 数据结构

逻辑结构
物理结构

4.6 容灾设计

出错信息
出错处理
降级方案
数据备份与恢复

4.7 监控设计

运行模块组合
控制
时间
告警阈值
日志规范

4.8 用户界面设计

界面布局
交互流程
UI 规范引用

4.9 安全设计

认证
授权
加密
审计

4.10 其它设计

国际化
性能
兼容性
可扩展性

4.11 制定规范

设计原则
代码规范
接口规约
命名规则

五、概要设计的关键产出物

产出物	作用	形式
分层数据流图	描述系统从输入到输出的加工过程	图
结构图	描述模块的层次和调用关系	图
数据字典	描述系统中所有数据项的含义、类型、长度、取值范围	表
模块清单	列出所有模块及功能	表
接口清单	列出所有模块间接口	表
关键流程说明	文字描述关键业务如何流转	文字 + 流程图

六、详细设计：模块内的实现

详细设计阶段，每个模块可以分给不同人并行设计。设计者工作对象是一个模块：

根据概要设计赋予的局部任务和对外接口
设计并表达出模块的算法、流程、状态转换

6.1 详细设计的关键产出

流程图——模块内主要处理流程
状态图——模块涉及的状态机
局部变量——模块内使用的临时变量
关键函数签名——参数、返回值、异常

6.2 详细设计 vs 概要设计的回退规则

如果发现有结构调整（如分解出子模块等）的必要，必须返回到概要设计阶段，将调整反应到概要设计文档中，而不能就地解决、不打招呼。

Why：详细设计改了不影响别人，但概要设计改了影响所有模块的接口。默默改概要设计 = 让所有下游模块的接口定义失效。

七、概要设计的 5 个常见坑

接口定义不细——只写"调用模块 A"，不写"传什么、返回什么、什么时机调"。联调时两套理解
数据字典缺失——文档里所有"用户 ID"都是一个意思吗？长度？类型？枚举值？没有数据字典就各写各的
过度细化——把详细设计的内容写到概要设计，评审会变成代码 review，没人能看完
不画部署图——只有逻辑架构，没有物理部署。运维拿不到"这台机器跑什么"的答案
不写非功能——性能、可用性、安全、合规等都不写，验收时客户发现没满足

八、核心 5 点提炼

概要设计是"分模块、定接口、估工期"的契约——它的粒度停在模块和接口，不写到类和方法
详细设计是"单模块的实现笔记"——粒度到函数和算法，单模块可并行设计
数据结构 > 算法——概要设计阶段数据字典比算法重要，因为数据结构是模块间共享的
改了概要必须通知所有相关人——默默改概要 = 默默改契约 = 撕毁合作基础
不写详细设计时，概要要写得更细——反之则要保留详细设计的预算

九、When to use

场景	必备设计
1 人、1 个月、1 模块	不需要正式设计文档
2-3 人、2-3 个月、单一系统	概要设计
3+ 人、3+ 月、多子系统	概要设计 + 详细设计
多团队、外部审计、合规项目	概要设计 + 详细设计 + 评审记录 + 变更记录

参考资料

2024+ 视角

2015 年的"概要 vs 详细"分界到 2024-2026 年依然成立，但形式与协作方式发生了几个关键变化：

C4 模型取代大段文字：Simon Brown 的 C4 模型（Context → Container → Component → Code）成为软件架构图的事实标准。一张 C4 上下文图顶 50 页"总体设计说明"。Structurizr DSL + Structurizr Lite 是写 C4 的工具首选。
ADR（Architecture Decision Records）正式成为评审产物：每个重要决策一个 ADR（Markdown 文件 + git 管理），模板：
- 状态：提议 / 已接受 / 已废弃 / 已取代
- 上下文：要解决什么问题
- 决策：选了哪个方案
- 后果：trade-off、风险、未来影响
架构评估从 ATAM → ADR + Fitness Functions：
- 2015 年前用 ATAM（架构权衡分析法） 做架构评审
- 2024 年用 ADR 累积 + 持续验证：每个架构属性（性能 / 可用性 / 安全）有对应的 Fitness Function（自动测试），CI 中持续验证
云原生架构让"物理部署"和"逻辑架构"分离：
- 概要设计要写"逻辑架构" + “物理部署（K8s/Serverless）” 两层
- Infrastructure as Code（Terraform / Pulumi / Crossplane）让部署图也是 git 的一部分
微服务架构的概要设计新要素：
- 服务边界（按业务能力 / DDD 子域）
- 通信模式（同步 REST/gRPC vs 异步事件）
- 数据一致性（Saga / Outbox / CDC）
- 可观测性（OTel / RED/USE 指标）
架构师角色升级：从"画图 + 评审"到"决策 + 治理 + 演进"——C4 + ADR + Fitness Function + ADR 看板 + 架构腐化检测（SonarQube / ArchUnit）。
“概要 vs 详细"边界依然不变：
- 概要：模块 / 接口 / 部署 / 数据流（C4 Level 1-3）
- 详细：类 / 函数 / 算法 / 状态机（C4 Level 4 + 序列图）
- 永远不要在概要设计里写伪代码——让代码本身就是详细设计

2015 视角 vs 2024 视角对照：

维度	2015	2024
图表	Visio / Rational Rose	C4 + Structurizr + Mermaid
决策记录	邮件 / Word 评审	ADR（git 管理）
物理部署	表格 + Visio	Terraform / Helm / Crossplane
架构评估	ATAM 评审会	ADR + Fitness Function + 持续验证
架构腐化	人工 review	ArchUnit + SonarQube

结论：2015 年这篇"先概要、后详细"的方法论至今仍是行业最佳实践，但工具从 Visio 转向 C4 + ADR + IaC，治理从一次性评审转向持续验证。