软件产品研发过程 - 三、详细设计

软件产品研发过程 - 三、详细设计

在软件开发过程中，详细设计阶段是将概要设计中的功能点转化为具体代码实现的关键环节。本文将详细介绍详细设计的主要内容，包括接口设计、数据库设计、类图和时序图等，帮助开发者更好地理解和掌握这一重要阶段。

详细设计概述

详细设计是在软件开发过程中，基于概要设计（将功能按子功能进行拆分，画面跳转关系、UI原型、画面上所有功能点及每个功能点对应的业务流程），以程序开发的角度来设计概要设计中每个功能点的代码实现；

详细设计的内容包含：

1. 接口设计 - 定义每个功能点前后端交互的接口;
2. 数据库设计 - 相关数据表结构定义；
3. 类图 - 定义代码的结构；
4. 时序图 - 每个功能在类、方法的调用过程

一、接口设计

1. 接口概述

用文字的形式将接口实现的功能描述清楚，需要对接口调用的必备条件需要进行特别重点罗列。

2. 请求方式

3. 请求地址

定义接口请求的URL地址，格式为：Http://IP:端口/一级模块/二级模块/接口方法

• 例如：系统管理模块 -> 用户管理 -> 查询接口为Http://IP:端口/system/user/list

4. 参数说明

5. 返回值说明

5.1 成功返回结果

{
   "code": 200,
   "msg": "操作成功",
   "data": {
       "key-1": "值",
       "key-2": "值"
    }
}

5.2 失败返回结果

{
   "code": 500,
   "msg": "操作失败，原因：xxx"
}

二、DB表结构设计

1. 数据表定义

2. 数据表结构定义

说明：

1. PK：主键，如果某字段为主键，则DEFAULT就不用设置了；
2. FK：引用外键
3. NOT NULL：非空
4. DEFAULT：当字段为short、int、long、日期类型时，要设置一个默认值，否则字段为空时程序中容易出错

三、类图

采用UML设计工具，将当前模块的功能从代码实现角度来设计类与类的关系，例如下图所示：

四、时序图

每个功能点一个时序图，基于类图设计，该功能在上面类设计基础上的对象之间的方法调用关系，也需要体现出代码中的分支、循环程序处理逻辑。

本文原文来自CSDN