什么是 PlantUML
PlantUML 是一个画图脚本语言,用它可以快速地画出:
时序图
流程图
用例图
状态图
组件图
简单地讲,我们使用 visio 画图时需要一个一个图去画,但使用 PlantUML 只需要用文字表达出图的内容,然后就可以直接生成图片。看一个最简单的例子:
Bob -> Alice : Hello, how are you
Alice -> Bob : Fine, thank you, and you?
demo
软件安装
这些软件全部是开源或共享软件,不存在版权问题,可以放心使用。
安装 Eclipse
Sublime 是个强大的可扩展的文本编辑器。进入官网下载对应操作系统下的版本安装即可。
下载安装成功后,重启 Eclipse。会在 Windows->Show View->Other 看到 PlantUML 的图标。
点击PlantUML View 图标,打开PlantUML图片显示
效果检验
最后检验一下工作安装是否正确。新建一个空白文件, 输入:
@startuml
Bob -> Alice : Hello, how are you
Alice -> Bob : Fine, thank you, and you?
@enduml
在PlantUML中会自动显示demo图片
PlantULM 快速入门
时序图
@startuml
title 时序图
== 鉴权阶段 ==
Alice -> Bob: 请求
Bob -> Alice: 应答
== 数据上传 ==
Alice -> Bob: 上传数据
note left: 这是显示在左边的备注
Bob --> Canny: 转交数据
... 不超过 5 秒钟 ...
Canny --> Bob: 状态返回
note right: 这是显示在右边的备注
Bob -> Alice: 状态返回
== 状态显示 ==