【得物技术】软件工程与 PlantUML 实战

前言

正如任何生物一样，软件也有孕育，诞生，成长，成熟以及衰亡的生命过程，常称为“软件生命周期”。软件生命周期一般分为几个阶段：既制定计划、需求分析、设计、编码、测试、运行和维护。而 UML 则支持从需求分析到设计再到编码的过程。

需求分析和设计占了整个软件生命周期的两个部分，可见其重要性，而很多时候，开发同学常常会跳过这两步，直接进入编码阶段。本文主要使用 PlantUML 开源项目，结合一些实际项目中的需求进行分析和设计。

PlantUML 是一种简单易懂的 UML 图形绘制语言，几行代码就可以绘制出各种 UML 图。在熟练之后，可以比一般的绘图工具高效许多。更重要的一点是便于版本管理，在不断迭代的功能需求中，可以持续维护。

需求分析-前奏

前奏，是一个首歌的基调，一定程度上决定了整首歌的风格变化。需求分析是整个软件设计的基础。

有很多开发同学会有疑问：需求分析是产品经理要干的事情啊？关我们开发什么事情？其实不然，需求分析对于开发来说，首要也是重要的目的，就是准确并且简洁的回答“谁用什么系统做什么事”。我们通常可以使用「用例图」来搞清楚这一问题。

用例图

例如在「晒单有礼」这个项目中，有如下用例图：

• “客户端用户使用晒单有礼系统匹配晒单策略”

• “运营人员使用该系统设置晒单策略”

PlantUML 代码

@startuml

left to right direction

actor 运营人员 as D

actor 客户端用户 as user

rectangle 晒单有礼（精简版） {

 D --> (晒单策略):设置

 user --> (晒单)

 (晒单) --> (晒单策略):匹配

}

@enduml

解析

1、@staruml 和 @enduml plantuml 预发的起始和结束标识。

2、left to right direction //标识图形由左向右绘制。

3、actor 用户（小人图形）。

4、rectangle 矩形框，内部代码图形都在这个框内。

5、 --> 实线箭头。

上图简单的表达了，“客户端用户使用晒单有礼系统匹配晒单策略”和“运营人员使用该系统设置晒单策略”，已经能能大概回答“谁用什么系统做什么事”了。但是还不够精细，我们还可以做如下扩展：

上图将“晒单”和“晒单策略”进行了补充和解释。

• “晒单”入口来源于订单列表

• “晒单策略”分为“设置”和“匹配”两个动作

• “晒单”包括“发动态”和“匹配晒单策略”

• “设置晒单策略”包括“设置激励类型”和“设置画像”。

PlantUML 代码

@startuml

left to right direction

actor 运营人员 as D

actor 客户端用户 as user

rectangle 晒单有礼（扩展版） {

 D --> (设置晒单策略)

 (设置晒单策略) .> (设置画像):《include》

 (设置晒单策略) .> (设置激励类型):《include》

 user --> (查看订单列表)

 (查看订单列表) --> (晒单)

 (晒单) .> (发动态):《include》

 (晒单) .> (匹配晒单策略):《include》

}

@enduml

解析

1、用例图除了常用的关联和泛化还有下面两种：

• include - 一个功能可以拆分较小的部分）

• extend - 一个功能的附加功能

2、(晒单) .> (发动态):《include》

表示“晒单”包含“发动态”这个动作，冒号后面其实可以是随意文本。

实际上，我们还可以将用例图继续细化，但是并没有必要这么做，用例图往往只要做到能够比较清楚的描述两个 W，Who-谁来用这系统；What-用这个系统做什么。

概要设计-主歌

主歌，是一首歌的中心思想，核心主题，它贯穿于整首歌当中。在概要设计中，我们需要梳理并掌握整个项目的脉络。

有了需求分析的铺垫，我们才能更好地进行概要设计。在上文中我们已经提到，需求分析时，需要回答好 Who&What，而概要设计则是需要概要的回答 How-如何解决问题。在概要设计时，我通常会使用 UML 中的活动图，状态图，时序图来描述我的设计。

活动图

在 UML 中，活动图会比较宽泛，例如我们常说的流程图，泳道图等都可以算是一种活动图。流程图的主要侧重点在于突出有哪些流程节点，以及节点的走向控制；泳道图则是在流程图的基础上，突出不同角色在整个流程中的位置和作用。通常我们会结合起来绘制。

下面我们看一个自建圈子项目的实例：

就绘制泳道图而言，还是推荐使用其他工具绘制。

对比一下使用其他工具绘制的图（完全一样的流程）：

PlantUML 代码

@startuml

|客户端|

|H5 前端|

|ServerAPI|

|CRM 后台|

|客户端|

start

|ServerAPI|

if(不符合建圈要求) then

|客户端|

 :不展示建圈入口;

 stop

else

|客户端|

 :展示建圈入口;

|H5 前端|

:填写建圈表单;

|ServerAPI|

:提交表单等待审核;

|CRM 后台|

if(审核不通过) then

|ServerAPI|

 :私信通知不通过;

 stop

else

|ServerAPI|

 :私信通知通过;

|客户端|

:展示建圈任务入口;

:点击任务入口;

|H5 前端|

:展示任务列表;

|ServerAPI|

if(未完成任务) then

:私信通知任务失败;

stop

else

:私信通知任务成功;

|客户端|

:保留自建圈子;

stop

@enduml

解析

1、|客户端| 

双竖线表示泳道。

2、start 、stop

开始结束节点，是泳道流程图中必须的元素。

3、if ... then ... else 

条件判断，一般用菱形表示。

4、一般来说泳道中的流程只能一直往下“游”，而不能往回“游”。

状态图

状态图用来描述一个实体的各种状态，以及状态之间的转化关系。例如电商平台最常见的“订单状态”，状态繁杂多样，用状态图来表达，可以让项目更加清晰。

在晒单有礼中，就有涉及到订单列表按钮状态的变换。在下面的例子中，有几个关键点：

• 必须要有起始状态和终止状态

• 状态是相对静止的

• 状态间的转化一定伴随着动作

• 状态是可以包含状态的

PlantUML 代码

@startuml

[*] --> 其他订单状态变换

state 其他订单状态变换 {

[*] --> 等待付款

等待付款 --> [*] : 取消支付

等待付款 --> 等待发货 : 支付

等待发货 --> [*] : 取消订单

}

其他订单状态变换 --> 无礼确认收货 : 未命中有礼策略

其他订单状态变换 --> 有礼确认收货 : 命中有礼策略

有礼确认收货 --> 晒单 : 14 天后点击确认收货

无礼确认收货 --> 晒单 : 点击确认收货

晒单 --> 查看晒单 : 发布动态

有礼确认收货 --> 晒单有礼 : 点击确认收货

晒单有礼 --> 查看晒单 : 发布动态

查看晒单 --> 有礼查看晒单 : 审核通过发送优惠券

有礼查看晒单 --> 查看晒单 : 领完优惠券

查看晒单 --> [*]

@enduml

解析

1、[*] -->   与  -->[*]

分表表示起始状态与终止状态。

2、state ... {}

状态是可以包含子状态的。在本例中，晒单有礼不关心订单的其他状态，可以使用此语法做简单描述。

时序图

时序图是本人最喜欢的 UML 图，在多团队协作时，可以让沟通变得非常高效，所有相关人员都能很快的了解到自己需要负责的地方。

例如下图是品牌列表需求的一个时序图：

PlantUML 代码

@startuml

hide footbox

autonumber

actor "用户" as user

participant "APP" as app

participant "服务端" as tag

participant "数仓" as sc

participant "算法" as alg

==点击品牌入口==

user -> app: 点击品牌入口卡片

activate user

activate app

app -> tag: 调用自选品牌数据接口

activate tag

tag --> app: 返回「无自选品牌数据」

deactivate tag

app -> app: 弹出自选品牌窗口

app -> tag: 访问品牌数据接口

activate tag

tag -> sc: 访问数仓排序数据

activate tag

activate sc #orange

sc --> tag: 返回品牌排序结果

deactivate tag

deactivate sc

tag -> alg: 查询用户社区偏好品牌

activate tag

activate alg

alg --> tag

deactivate tag

deactivate alg

tag --> app: 品牌数据(包括默认选项 2 个)

deactivate tag

app --> user

deactivate app

deactivate user

@enduml

解析

1、autonumber

指定显示序号，方便沟通交流，推荐使用。

2、actor，participant 

表示用户和对象。

3、activate user，deactivate user

激活一个对象，终止一个对象。

4、activate sc #orange

这里是个小技巧，可以给一个对象的激活态标注不同颜色，用于强调。

5、左侧小图中，序号 6，7 步骤，是在一个激活态上再次激活了一次。这里可以强调是开启线程，进行并发调用。

详细设计-副歌

副歌，所谓重要的部分再多细唱两遍，是一首歌的高潮部分，可以升华中心思想。在详细设计中，我们从概要设计中选取一些细节和核心部分做进一步的设计。

详细设计就像一首歌的副歌部分（也常常被我们称为高潮部分），虽然在主歌里有涉及，但是需要重点强调。一般而言，详细设计也是用来回答 How-如何解决问题，但是需要抓到整个系统的难点进行重点设计。在 UML 中我通常会使用时序图、类图和组件图来描述。

时序图

看到这个小标题，有同学会问了，“诶，怎么又是时序图？”。其实，时序图可以上到系统级别的调用过程，也可以下到方法级别的调用过程，甚至可以非常接近代码逻辑。在详细设计中也常常使用，来个示例，大家感受一下：

PlantUML 代码

...//省略

loop 循环订单 ids

server -> extend:查询 trend_extend 是否存在订单

activate server

activate extend

extend -> server: 返回是否已经绑定订单

deactivate extend

...//省略

alt 命中晒单有礼

server->cserver:查询优惠券信息

activate cserver

cserver -> server: 返回优惠券信息

deactivate cserver

server->result:「晒单有礼(最高 XX 元)」

else 未命中晒单有礼

server->result:「晒单」

end

end

...//省略

代码解析

左侧代码只保留了核心逻辑，如下：

1、loop ... end 表示循环，类似各开发语言中的 while 语句。

2、alt ... else ... end 表示逻辑判断，类似各开发语言中的 if else。

类图

类图是常用的 UML 图，显示出类、接口以及它们之间的静态结构和关系；它用于描述系统的结构化设计。

PlantUML 代码

@startuml

interface DuDataFlow {

   InfoPosts()

   InfoAd()

}

class duDataFlow {

  grpc.ClientConn

  phpservice.Service

  context.Context

  InfoPosts()

  InfoAd()

}

class grpc.ClientConn{}

class phpservice.Service{}

class context.Context{}

DuDataFlow <|-down- duDataFlow

duDataFlow .> grpc.ClientConn

duDataFlow .> phpservice.Service

duDataFlow .> context.Context

@enduml

代码解析

左侧代码已经非常接近开发语言的类定义和接口定义了。

1、 <|-down-  继承关系

2、.> 依赖关系

其他部分

详细设计不仅仅只有时序图、类图，还可以包括 DDL、接口文档、任务分工等模块，这里就不再展开细说了。

至此设计文档至此离编写代码仅剩一步之遥了！！

结语

如果将编写软件设计文档比作写一首歌。那么需求分析就是一首歌的前奏，前奏是一首歌的基调，一定程度上决定了整首歌的风格；概要设计则是主歌，是一首歌的中心思想，核心主题；详细设计则是一首歌的高潮部分，好听的，重要的部分，当然就得再多唱两遍，加深一下记忆点。

最后，再用几句话概况一下几个 UML 图的特点：

• 用例图-回答“谁用这个系统做什么事情”

• 活动图-突出流程中的事务扭转，以及每个泳道的位置与作用

• 状态图-描述一个实体的各种状态，以及状态之间的转化关系

• 时序图-在多团队协作时，让沟通非常高效，也可以是代码逻辑的详细结构

• 类图-代码如何组织，各个类之间的关系

文｜BeeOML

关注得物技术，携手走向技术的云端