软件文档写作-plantuml画用例图和时序图

2024-04-02 18:08

本文主要是介绍软件文档写作-plantuml画用例图和时序图,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

背景

当下的软件开发人员,不可避免的需要输出一些软件设计文档,作为一个软件工程专业毕业的工程师,最常用的设计工具就是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 changeUserPoint
usecase 查询用户总积分 as getUserTotalPoint
usecase 登录校验 as getRestContextByAccessTokenotherLxTaBackendService --> getRestContextByAccessToken:获取用户的登录态[RPC]
otherLxTaBackendService --> changeUserPoint:活动增加或者扣减积分[RPC]
otherLxTaBackendService --> getUserTotalPoint: 查询用户当前总积分[RPC]@enduml

生成的图:

file

外部系统用例

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

file

时序图(顺序图)

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

语法

对象语法说明
箭头和线-> <-实线箭头 <-- -->虚线箭头标识参与者之间的消息传递
参与者actor 角色 boundary 带边界 control控制 entity 实体 database 数据库 collections 集合 participant 参与者标识参与者
重命名participant 参与者详细名称 as 简称重命名参与者
定义顺序participant 参与者详细名称 order 排序号序号越小越靠前
参与者含有特殊字符“参与者”双引号包围
箭头样式丢失的消息 ->x 实心箭头 -> 虚箭头 ->> 半实心箭头 - 半虚箭头 -\ 箭头末尾加0 ->o
各种箭头
箭头颜色参与者1-[颜色定义]->参与者改变箭头颜色
消息自动编号autonumber放在开始的位置
设置title,header,footerheader footer title在开始的地方定义
组合消息条件分支alt/else end
条件分支
组合消息循环分支分支loop end循环
组合消息 groupgroup end
分组
单行注释note 位置 :注释内容给消息增加备注
多行注释note 位置(right,left,over) 换行 注释内容 换行 end note给消息增加备注
改变注释的形状hnote 六边形 rnote 四边形注释的形状
分隔符==分割备注内容==横向划分模块
引用ref over 参与者1 参与者2 : 引用内容引用
延迟···标识延迟 ···消息固定延迟
空间3根竖线间隔
激活生命线activate 参与者激活生命线
取消激活生命线deactivate 参与者激活生命线
返回return 参与者返回
创建参与者create 参与者标识创建对象
快捷键 激活参与者 --取消激活参与者 ** 创建参与者 !!销毁参与者见语法说明
创建盒子box "box的命名" #背景色 换行 参与者1 参与者2 end box纵向划分模块

登录接口时序图

@startumlautonumber "<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 #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

file

改变用户积分

@startumlautonumber "<b>[#]"actor TAapp用户 as taUsercontrol 网关 as nginx
box 接口程序 #green
boundary Web服务器 as tomcat
end box
collections Redis as redis
database 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    : 查询得到用户对应的idalt 用户的总积分记录在数据库中存在tomcat -> mysql    :更新用户的总积分else userId对应的积分记录id不存在tomcat -> mysql    :插入用户的总积分记录endreturn 用户积分记录对应的记录idtomcat -> redis   : 用户积分记录对应的记录id保存到redisreturn 无返回值
end
tomcat ->redis: 清除掉总积分缓存,分页缓存,总条数缓存return  用户增加积分明细记录idendtomcat -[#green]> taUser    : 改变积分成功
@enduml

查询用户积分

小结

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

这篇关于软件文档写作-plantuml画用例图和时序图的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/870692

相关文章

活用c4d官方开发文档查询代码

当你问AI助手比如豆包,如何用python禁止掉xpresso标签时候,它会提示到 这时候要用到两个东西。https://developers.maxon.net/论坛搜索和开发文档 比如这里我就在官方找到正确的id描述 然后我就把参数标签换过来

软件设计师备考——计算机系统

学习内容源自「软件设计师」 上午题 #1 计算机系统_哔哩哔哩_bilibili 目录 1.1.1 计算机系统硬件基本组成 1.1.2 中央处理单元 1.CPU 的功能 1)运算器 2)控制器 RISC && CISC 流水线控制 存储器  Cache 中断 输入输出IO控制方式 程序查询方式 中断驱动方式 直接存储器方式(DMA)  ​编辑 总线 ​编辑

计算机毕业设计 大学志愿填报系统 Java+SpringBoot+Vue 前后端分离 文档报告 代码讲解 安装调试

🍊作者:计算机编程-吉哥 🍊简介:专业从事JavaWeb程序开发,微信小程序开发,定制化项目、 源码、代码讲解、文档撰写、ppt制作。做自己喜欢的事,生活就是快乐的。 🍊心愿:点赞 👍 收藏 ⭐评论 📝 🍅 文末获取源码联系 👇🏻 精彩专栏推荐订阅 👇🏻 不然下次找不到哟~Java毕业设计项目~热门选题推荐《1000套》 目录 1.技术选型 2.开发工具 3.功能

【STM32】SPI通信-软件与硬件读写SPI

SPI通信-软件与硬件读写SPI 软件SPI一、SPI通信协议1、SPI通信2、硬件电路3、移位示意图4、SPI时序基本单元(1)开始通信和结束通信(2)模式0---用的最多(3)模式1(4)模式2(5)模式3 5、SPI时序(1)写使能(2)指定地址写(3)指定地址读 二、W25Q64模块介绍1、W25Q64简介2、硬件电路3、W25Q64框图4、Flash操作注意事项软件SPI读写W2

免费也能高质量!2024年免费录屏软件深度对比评测

我公司因为客户覆盖面广的原因经常会开远程会议,有时候说的内容比较广需要引用多份的数据,我记录起来有一定难度,所以一般都用录屏工具来记录会议内容。这次我们来一起探索有什么免费录屏工具可以提高我们的工作效率吧。 1.福晰录屏大师 链接直达:https://www.foxitsoftware.cn/REC/  录屏软件录屏功能就是本职,这款录屏工具在录屏模式上提供了多种选项,可以选择屏幕录制、窗口

HomeBank:开源免费的个人财务管理软件

在个人财务管理领域,找到一个既免费又开源的解决方案并非易事。HomeBank&nbsp;正是这样一个项目,它不仅提供了强大的功能,还拥有一个活跃的社区,不断推动其发展和完善。 开源免费:HomeBank 是一个完全开源的项目,用户可以自由地使用、修改和分发。用户友好的界面:提供直观的图形用户界面,使得非技术用户也能轻松上手。数据导入支持:支持从 Quicken、Microsoft Money

PDF 软件如何帮助您编辑、转换和保护文件。

如何找到最好的 PDF 编辑器。 无论您是在为您的企业寻找更高效的 PDF 解决方案,还是尝试组织和编辑主文档,PDF 编辑器都可以在一个地方提供您需要的所有工具。市面上有很多 PDF 编辑器 — 在决定哪个最适合您时,请考虑这些因素。 1. 确定您的 PDF 文档软件需求。 不同的 PDF 文档软件程序可以具有不同的功能,因此在决定哪个是最适合您的 PDF 软件之前,请花点时间评估您的

10个好用的AI写作工具【亲测免费】

1. 光速写作 传送入口:http://u3v.cn/6hXWYa AI打工神器,一键生成文章&ppt 2. 讯飞写作 传送入口:http://m6z.cn/5ODiSw 3. 讯飞绘文 传送入口:https://turbodesk.xfyun.cn/?channelid=gj3 4. AI排版助手 传送入口:http://m6z.cn/6ppnPn 5. Kim

梳理2024年,螺丝钉们爱用的3款剪辑软件

这年头,视频到处都是,就跟天上的星星一样数不清。不管你是公司里的新面孔,还是职场上的老狐狸,学会怎么剪视频,就好比找到了赢的秘诀。不管是给上司汇报工作,展示你的产品,还是自己搞点小视频记录生活,只要是剪辑得漂亮,肯定能一下子吸引大家的目光,让人记得你。咱们今天就来侃侃现在超火的三款视频剪辑工具,尤其是PR剪辑,你肯定听说过,这货在剪辑界可是大名鼎鼎,用它剪视频,既专业又麻利。 NO1. 福昕轻松

秒变高手:玩转CentOS 7软件更换的方法大全

在 CentOS 7 中更换软件源可以通过以下步骤完成。更换源可以加快软件包的下载速度,特别是当默认源速度较慢时。以下是详细步骤: 前言 为了帮助您解决在使用CentOS 7安装不了软件速度慢的问题,我们推出了这份由浪浪云赞助的教程——“CentOS7如何更换软件源加快下载速度”。 浪浪云,以他们卓越的弹性计算、云存储和网络服务受到广泛好评,他们的支持和帮助使得我们可以将最前沿的技术知识分