如何做好技术方案设计

目录

一、为什么要做好技术方案设计？

二、好的技术方案应该包含哪些部分？

2.1 概要设计

2.1.1 系统架构图

2.1.2 数据模型图

2.1.3 核心业务流程图

2.1.4 关键上下游交互设计

2.2 详细设计

2.2.1 包图

2.2.2 类图

2.2.3 表设计

2.2.4 接口设计

2.2.5 系统监控设计

---

一、为什么要做好技术方案设计？

作为一名软件开发工程师，技术方案设计的重要性不言而喻。技术方案是我们从全局到局部去理解项目需求、技术挑战和解决方案的关键步骤。它确保了项目的每个环节都能有序衔接，每个细节都能得到充分考虑，从而提高开发效率和产品质量。

技术方案也是企业的数字资产，不仅记录了项目的设计思路和实现细节，还沉淀了设计过程中遇到的问题和权衡决策。这些宝贵的信息对于后来者来说，是理解和维护系统的重要参考，也是传承知识、避免重复错误的关键。

二、好的技术方案应该包含哪些部分？

一个好的技术方案应该包括：概要设计、详细设计两部分；

• 概要设计：包括系统架构图、数据模型图、核心业务流程图、关键上下游交互
• 详细设计：具体落地过程中的包图、类图、基于业务用例的业务流程设计、接口设计、系统监控设计

分别总结一下每一部分设计过程中的关键要素：

2.1 概要设计

2.1.1 系统架构图

• 组件划分：为了简化系统的复杂性，提高模块化，应该将系统分解成若干个高内聚、低耦合的模块或组件。
• 技术选型：应该从成本、稳定性等多个因素来考虑关键系统选型，例如：存储方案、消息中间件方案等。
• 数据流向：描述了数据在系统中的流动路径，包括数据如何在不同的组件、服务或系统之间传输和处理。

2.1.2 数据模型图

• 实体识别：是现实世界中可以区分的事物，可以是人、地点、物品或概念。
• 属性定义：是指为每个实体确定和定义其属性的过程，属性是实体的特定特征或属性。在属性定义过程中的关键是确定数据类型、考虑非空约束、定义默认值
• 关系建立：明确实体之间的关系，如一对一、一对多或多对多。
• 范式优化：范式优化是指通过应用数据库范式原则来优化数据模型，过程中需要在减少数据冗余和提高系统性能方面取的平衡。

2.1.3 核心业务流程图

• 流程步骤：需要针对核心业务用例（可以忽略分支流程），列出业务流程中的每个步骤。
• 用户交互：如果涉及用户操作，明确用户在流程中的角色和交互。

2.1.4 关键上下游交互设计

• 推拉模式：需要考虑两个系统交互时，应该使用推模式还是拉模式。
• 系统边界：定义在两个系统交互过程中各自系统的定位，并明确职责范围。
• 安全性考虑：考虑数据传输的安全性，如加密和认证机制。
• 性能优化：评估和优化数据交换的性能，确保系统的响应速度。

2.2 详细设计

2.2.1 包图

• 包的划分：将系统中概念或语义相近的要素，分组到不同的包中。
• 依赖关系：描述了包之间的相互关系，特别是它们之间的访问和使用关系。
• 复用和封装：
  • 复用等价原则：对于同类可重用的模型元素尽量放到一个包中，不要把可重用模型元素和不可重用的模型元素混到一个包中。
  • 共同重用原则：把同一个应用要重用的多个模型元素放到同一个包中，以减少包间的依赖，提高包的独立性。
  • 共同封闭原则：把可能同时修改，同时维护的模型元素放到一个包中，以便于今后维护和升级。
  • 非循环依赖原则：包之间的依赖关系不要形成循环，即不要出现A依赖B，B又依赖于A的现象。

2.2.2 类图

• 类的定义：确定系统中需要哪些类，并定义它们的属性、方法、构造器等
• 继承和接口实现：继承和接口实现描述了类之间的层次结构和契约关系，包括继承、接口实现、多重继承等。
• 关联和依赖：标识类之间的关联、聚合和组合等关系。
• 设计模式应用：设计模式是解决特定问题的成熟模板，它们在类图中体现为特定的类结构和关系。

2.2.3 表设计

• 字段定义：为每个表定义具体的字段、数据类型、非空约束、默认值等。
• 索引设计：索引设计用于提高查询性能，减少数据检索所需的时间，常见的包括：主键索引、唯一索引、辅助索引、符合索引。

2.2.4 接口设计

• 接口规范：主要定义接口通信协议、接口同步还是异步、接口的安全性要求。
• 参数和返回值：明确接口的输入参数、返回结构体。
• 异常处理：需要定义好异常码、异常处理机制。
• 版本管理：考虑接口的版本管理，以支持向后兼容。

2.2.5 系统监控设计

• 业务监控：常见的业务监控包括数据正确性监控、数据一致性监控、业务流程正确性监控、业务变化趋势监控等。
• 系统监控：常见的系统监控不仅包括CPU、磁盘、IO、网络等系统监控，也需要考虑慢查询、消息积压等中间件的关键监控。