详细设计规范及评审要点.md

1. 数据架构设计

1.1 数据库 ER 模型图

PowerDesigner ER 建模

前期工作：做好需求分析(用例图、每个用例的泳道图)，概要设计(时序图、逻辑架构图)

PS: 将所有 ER 模型再一张图中体现出来

1.2 数据库逻辑设计

PowerDesigner 将 ER 模型转为逻辑模型

1.3 数据库物理设计

PowerDesigner 将逻辑模型转为物理模型

数据库设计评审要点：

重点关注索引设计，确保现在已有和未来可能有的各种功能，都可以用到索引，避免全表扫描的情况
索引设计要好好结合业务，去考虑如何建联合索引

2. 接口设计

2.1 XX 模块

• 接口类
• 接口名称
• 接口描述
• 输入
• 输出

接口设计评审要点：

接口调用方需要确保接口设计能否满足自己的需求

3. 开发架构设计

3.1 实现类图设计

需要哪些类，类与类之间的关系，有哪些成员变量，有哪些方法

思考点： 一个业务需求，要拆分为哪些类，哪些对象，哪些接口，每个类具体负责哪些职责，类与类之间如何交互

类图设计要点：

- 把每个类画出来
- 类与类之间的继承/实现/依赖/组合/聚合关系画出来
- 类与类之间的关联关系,1对1，1对多，多对多

3.2 包设计

有哪些包，包下有哪些类

开发架构设计的评审要点：

面向对象的类图设计，是否逻辑清晰，拆分合理，未来的可扩展性是否足够好
设计模式就体现在这里了，看看有没有用合理的、良好的设计模式的设计来保障代码的扩展性

4. 运行流程设计(活动图)

4.1 XXX 模块

4.1.1 XX 功能1

类与类、类与表之间的交互关系及交互顺序与逻辑

5. 测试用例设计

5.1 单元测试用例设计

5.1.1 XX 模块

5.1.1.1 测试用例1

每个类设计对应的单元测试类，每个方法都要有单元测试的方法

1) 数据准备
2) 输入
3) 输出
4) 断言
5) 资源清理

5.2 冒烟测试用例设计

5.2.1 XX 模块

5.2.1.1 测试用例1

同 5.1.1.1

6. 日志设计

6.1 XX 模块

6.1.1 XX 功能

1) 日志埋点1
2) 日志埋点2

日志设计的评审要点：

异常日志及案发现场日志的记录、重现