软件建模与设计文档指南

lzz的编码时刻

于 2024-10-18 09:28:28 发布

阅读量1k

点赞数 10

分类专栏：软件架构文章标签：软件工程 uml 系统架构流程图

本文链接：https://blog.youkuaiyun.com/weixin_45970964/article/details/143033810

版权

软件架构专栏收录该内容

3 篇文章

订阅专栏

1. 引言

软件建模和设计文档是软件开发过程中的关键环节。本指南旨在帮助您理解软件建模的概念,掌握常用的建模工具,以及学习如何组织一份有价值的软件设计文档。

2. 软件建模概述

2.1 什么是软件建模?

软件建模是为要开发的软件创建抽象模型的过程。这些模型帮助我们:

抽象软件系统的主要特征和组成部分
梳理关键组成部分之间的关系
为开发过程提供清晰的蓝图和约束

2.2 软件建模的重要性

使系统整体结构可控
帮助相关人员清晰了解软件蓝图和进展
明确不同开发工程师之间的工作关系与依赖

2.3 软件建模的两个关键方面

领域问题建模:抽象功能、对象关系和业务流程
软件系统建模:设计类、组件、依赖关系和部署方案

3. 统一建模语言(UML)

UML是最常用的软件建模工具,包含10种图形,其中7种最为常用:

类图
序列图
组件图
部署图
用例图
状态图
活动图

3.1 类图

描述类的特性和类之间的静态关系
包含:类名、属性列表、方法列表
表示6种静态关系:关联、依赖、组合、聚合、继承、泛化

3.2 序列图

描述参与者之间的动态调用关系
展示对象之间的交互顺序

3.3 组件图

描述比类更大粒度的设计元素
通常用于描述物理组件(如JAR、DLL)之间的依赖关系

3.4 部署图

描述软件系统的最终部署情况
显示服务器数量和关键组件的部署位置

3.5 用例图

描述系统的功能需求
展示用户和软件系统的交互

3.6 状态图

展示单个对象生命周期的状态变迁
适用于描述复杂状态变化的领域对象(如账号、订单等)

3.7 活动图

描述过程逻辑和业务流程
可用泳道概念划分不同领域、系统或角色的活动

4. UML图例说明

为了帮助您更好地理解和使用UML图，以下是各种UML图中常见元素的图例说明：

4.1 类图图例

+------------------------+
|       ClassName        |
+------------------------+
| - privateAttribute     |
| # protectedAttribute   |
| + publicAttribute      |
+------------------------+
| + publicMethod()       |
| # protectedMethod()    |
| - privateMethod()      |
+------------------------+

类名位于顶部
属性列在中间部分，方法列在底部
+ 表示public，# 表示protected，- 表示private

关系线：

实线箭头 -----> 表示关联
虚线箭头 -----> 表示依赖
实线菱形 ◆——— 表示组合
空心菱形 ◇——— 表示聚合
实线三角 ▲——— 表示继承/泛化

4.2 序列图图例

对象1        对象2
       |            |
       |--消息1---->|
       |            |
       |<--消息2----|
       |            |

垂直虚线表示对象的生命线
水平箭头表示消息传递
箭头上方标注消息名称

4.3 组件图图例

+-------------+
 |  <<组件>>   |
 |   组件名    |
 +-------------+
        ^
        |
  +-----+-----+
  |  接口名   |
  +-----------+

矩形表示组件
球形符号表示提供的接口
插座符号表示所需的接口

4.4 部署图图例

+-------------------+
 |     <<设备>>      |
 |    设备名称       |
 |  +-------------+  |
 |  |  <<组件>>   |  |
 |  |   组件名    |  |
 |  +-------------+  |
 +-------------------+

立方体表示物理节点（如服务器）
节点内可以包含组件

4.5 用例图图例

+-----+
     |     |
     | 角色 |
     |     |
     +-----+
        |
        |
    (用例名称)

小人图形表示角色（可以是用户或外部系统）
椭圆形表示用例
线条连接角色和用例，表示关联

4.6 状态图图例

+---------+
 -->| 状态名称 |-->
    +---------+

圆角矩形表示状态
箭头表示状态转换
实心圆表示初始状态
圆环表示结束状态

4.7 活动图图例

+----------+
    | 活动名称 |
    +----------+
         |
         v
    [条件判断]
      /     \
     /       \
  [是]       [否]
   |           |
   v           v