目录
前言
在软件开发的生命周期中,需要先进行设计,最后才是进行具体的编码和测试。设计时就需要画各种 UML 图,有专业的 UML 画图软件,也有很多在线的 UML 画图网站可以来画图,但是这些一般都是可视化界面,通过鼠标拖拽各种组件来画图,在画图时需要不停在键鼠直接来回切换——鼠标拖拽好组件,再用键盘打字补充说明,实际使用体验个人感觉非常难受。
PlantUML 是一个多功能组件,可快速、直接地创建图表。用户可以使用简单直观的语言起草各种图表。使用 PlantUML 就可以使用简单的文字描述来画 UML 图了。
本文演示用 PlantUML 设计一个模块,使用 PlantUML 来画用例图,类图,活动图,时序图。
具体的语法可以直接参考官方文档
使用简单的文字描述画UML图的开源工具。 (plantuml.com)https://plantuml.com/zh/
需求场景
开发一个 api 调用服务,让用户自定义要调用 api 的各种配置,例如 api 的 url 地址,请求方式,query 参数名,header 参数名,body 参数名(表单或者json),api 返参等等,配置完成后,即可提供给其他系统模块进行调用。
api 提供一个调用的接口,其他系统模块调用时按照 api 配置的输入参数名称,传入对应的输入参数值,返回 api 调用模块配置的返参。
调用接口的整体逻辑可以抽象成以下几个步骤
- 获取 api 配置信息
- 构造请求参数
- 构造请求头
- 构造请求体
- 校验必填字段
- 调用 api
- 校验 api 返回值
- 返回 api 返回值
梳理好需求并将业务逻辑分解后,开始设计 UML。
用例图
PlantUML