本文共 3761 字，大约阅读时间需要 12 分钟。

背景

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

plantuml介绍

功能介绍：

支持快速绘制

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

还支持非UML图：

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

以及不常用的的图：

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

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

业务场景

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

用例图

用户角度描述系统功能

语法

系统用例图

内部系统用例

@startumlleft to right directionactor : 其它LX提供给TA的后端系统: as otherLxTaBackendServicenote top of otherLxTaBackendService比如tianansp负责活动和文章的服务比如tiananseason负责西游活动的服务通过dubbo的rpc方法调用end noteusecase 修改用户积分 as changeUserPointusecase 查询用户总积分 as getUserTotalPointusecase 登录校验 as getRestContextByAccessTokenotherLxTaBackendService --> getRestContextByAccessToken:获取用户的登录态[RPC]otherLxTaBackendService --> changeUserPoint:活动增加或者扣减积分[RPC]otherLxTaBackendService --> getUserTotalPoint: 查询用户当前总积分[RPC]@enduml

生成的图：

外部系统用例

@startuml'left to right defaultactor : ta用户: as taUserusecase  用户登录  as  userLoginusecase 查询积分明细 as findUserPointDetailusecase 改变积分 as changeUserPointDetailnote bottom of userLoginTA用户登录LX交互的后端系统LX的saas系统构造登录态end notetaUser -right-> userLogin: 登录进LX交付的功能[REST]taUser --> changeUserPointDetail : 修改积分\n阅读文章\n分享文章\n参加活动[REST]taUser --> findUserPointDetail : 查询积分\n消费获取\n明细[REST]@enduml

时序图（顺序图）

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

语法

登录接口时序图

@startumlautonumber "[00]"title 登录接口时序图actor "TA用户" as User #whiteparticipant "TAAPP" as TAAPP #goldbox "LX交付" #grayparticipant "LX交付SDK" as LXSDK #orangeparticipant "LX交付后端\ntiananuser" as LXServer #redparticipant "LXsaas后端" as LXSaasServer #grayend boxparticipant "TA后端" as TAServer #greenactivate UserUser -> 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保存登录令牌到redisLXServer -> LXSDK   : 构造LX专属登录态(token)==后端对接完成==LXSDK --> TAAPP   : 正常使用LX交互功能TAAPP --> User   : 看到LX交互功能@enduml

改变用户积分

@startumlautonumber "[#]"actor TAapp用户 as taUsercontrol 网关 as nginxbox 接口程序 #greenboundary Web服务器 as tomcatend boxcollections Redis as redisdatabase Mysql as mysqltaUser -> nginx     : 看文章，增加积分nginx ->> tomcat    : 负载均衡策略遭到一台tomcat==接口处理流程开始==tomcat --> tomcat    : 参数判断alt 参数判断不合法    tomcat -[#red]> taUser    : 参数传错误else 参数合法tomcat -> mysql    : 插入积分改变的明细记录return 表记录idtomcat ->redis    : 获取缓存中用户对应的记录idalt 缓存中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 无返回值endtomcat ->redis: 清除掉总积分缓存，分页缓存，总条数缓存return  用户增加积分明细记录idendtomcat -[#green]> taUser    : 改变积分成功@enduml

查询用户积分

小结

原创不易，转载请注明出处，欢迎多沟通交流