背景

当下的软件开发人员，不可避免的需要输出一些软件设计文档，作为一个软件工程专业毕业的工程师，最常用的设计工具就是UML，使用UML工具绘制一些软件相关的图，是必备技能，也是输出的技术文档中的重要组成部分。不关注逆向工程，这里只关注快速的绘制对应的图，plantuml是一款比较不错的工具。本节先初步熟悉用例图和时序图。

plantuml介绍

官网主页

功能介绍：

支持快速绘制

• 时序图
• 用例图
• 活动图
• 类图
• 组件图
• 状态图
• 对象图
• 部署图
• 定时图

还支持非UML图：

• 架构图
• 甘特图
• 思维导图
• ER图

以及不常用的的图：

• SDL（规范描述语言）
• 线框图形界面
• Ditaa
• 数学公式

画完图之后，可以生成PNG,SVG,Latex格式的图片;

业务场景

x项目的用户后端服务,包括用户登录，用户积分模块；

用例图

用户角度描述系统功能

语法

系统用例图

内部系统用例

@startuml

left to right direction

actor : 其它LX提供给TA的后端系统: as otherLxTaBackendService

note top of otherLxTaBackendService
比如tianansp
负责活动和文章的服务
比如tiananseason
负责西游活动的服务
通过dubbo的rpc方法调用
end note

usecase 修改用户积分 as changeUserPoint
usecase 查询用户总积分 as getUserTotalPoint
usecase 登录校验 as getRestContextByAccessToken


otherLxTaBackendService --> getRestContextByAccessToken:获取用户的登录态[RPC]
otherLxTaBackendService --> changeUserPoint:活动增加或者扣减积分[RPC]
otherLxTaBackendService --> getUserTotalPoint: 查询用户当前总积分[RPC]


@enduml

生成的图：

外部系统用例

@startuml

'left to right default

actor : ta用户: as taUser

usecase  用户登录  as  userLogin
usecase 查询积分明细 as findUserPointDetail
usecase 改变积分 as changeUserPointDetail


note bottom of userLogin
TA用户登录
LX交互的后端系统
LX的saas系统
构造登录态
end note

taUser -right-> userLogin: 登录进LX交付的功能[REST]
taUser --> changeUserPointDetail : 修改积分\n阅读文章\n分享文章\n参加活动[REST]
taUser --> findUserPointDetail : 查询积分\n消费获取\n明细[REST]

@enduml

时序图（顺序图）

展示对象跟对象之间的协作关系

语法

登录接口时序图

@startuml

autonumber "<b>[00]"

title 登录接口时序图

actor "TA用户" as User #white
participant "TAAPP" as TAAPP #gold
box "LX交付" #gray
participant "LX交付SDK" as LXSDK #orange
participant "LX交付后端\ntiananuser" as LXServer #red
participant "LXsaas后端" as LXSaasServer #gray
end box
participant "TA后端" as TAServer #green

activate User

User -> TAAPP ++:  登录TAAPP\n打开健康TAP页面
==sdk对接==
TAAPP -> LXSDK ++:  userId\n或者加密信息

==后端对接==

LXSDK -> LXServer ++: 登录转换为LX登录态接口
==TA后端对接==
LXServer <-> TAServer ++: 用户信息校验\n
==对接saas==
LXServer <-> LXSaasServer ++: 注册并登录\n到LXSaas
==构造LX专属登录态==
LXServer -> LXServer ++: 登记用户信息\n保存登录令牌到redis

LXServer -> LXSDK ++: 构造LX专属登录态(token)
==后端对接完成==

LXSDK --> TAAPP ++: 正常使用LX交互功能

TAAPP --> User ++: 看到LX交互功能


@enduml

改变用户积分

@startuml

autonumber "<b>[#]"

actor TAapp用户 as taUser

control 网关 as nginx
box 接口程序 #green
boundary Web服务器 as tomcat
end box
collections Redis as redis
database Mysql as mysql

taUser -> nginx  ++ : 看文章，增加积分

nginx ->> tomcat ++ : 负载均衡策略遭到一台tomcat

==接口处理流程开始==
tomcat --> tomcat ++ : 参数判断
alt 参数判断不合法
    tomcat -[#red]> taUser ++ : 参数传错误
else 参数合法

tomcat -> mysql ++ : 插入积分改变的明细记录
return 表记录id

tomcat ->redis ++ : 获取缓存中用户对应的记录id

alt 缓存中userId对应的积分id存在
    tomcat -> mysql ++ : 更新用户的总积分
else 缓存中userId对应的积分id不存在
    tomcat -> mysql ++ : 查询得到用户对应的id
    alt 用户的总积分记录在数据库中存在
        tomcat -> mysql ++ :更新用户的总积分
    else userId对应的积分记录id不存在
        tomcat -> mysql ++ :插入用户的总积分记录
    end
    return 用户积分记录对应的记录id
    tomcat -> redis ++: 用户积分记录对应的记录id保存到redis
    return 无返回值
end
tomcat ->redis: 清除掉总积分缓存，分页缓存，总条数缓存

return  用户增加积分明细记录id

end

tomcat -[#green]> taUser ++ : 改变积分成功
@enduml

查询用户积分

@startuml

title 查询用户积分明细接口时序图

autonumber

actor TA用户 as taUser
boundary Web服务 as tomcat
collections Redis as redis
database Mysql as mysql


taUser -> tomcat ++ : 请求查询总积分和明细
|||

tomcat -> tomcat ++: 参数校验

opt 参数校验不通过
tomcat -> taUser --:   参数校验不通过
end
... ...
tomcat <-> redis ++: 明细总数

opt 明细总数不存在
 tomcat <-> mysql ++: 查询明细总数
 tomcat <-> redis ++: 保存明细总数
end 


opt 明细总条数为 0 
    tomcat -> taUser ++: 查询成功，记录为空
end

tomcat <-> redis ++: 查询明细记录
opt 明细记录为空
tomcat <-> mysql ++: 查询明细记录
tomcat <-> redis ++: 保存明细记录
end

tomcat -> tomcat ++: 明细记录组装到返回对象中

tomcat -> redis ++: 查询用户的总积分
opt 用户的总积分
tomcat <-> mysql ++: 查询用户的总积分
tomcat <-> redis ++: 保存用户的总积分

tomcat -> tomcat ++: 用户的总积分组装到返回对象中


tomcat -> taUser ++: 返回积分明细

end


@enduml

小结

1. plantuml可以绘制很多软件设计文档中的图，包括架构图，ER图，UML图；
2. 用例图宏观的描述了系统的功能；
3. 时序图比较细致的描述了单个接口的内部处理流程；
4. 接受老项目的时候，按照UML图去一个一个画出来，可以尽快的hold老系统

本文由博客一文多发平台 OpenWrite 发布！