plantUML 下载(含《plantUML语法指南手册》):http://plantuml.com/download
Visual Studio Code 安装 plantUML 插件,在插件应用商店中搜索:PlantUML,点击安装即可。
快捷键:
Alt + D 即可快速预览,Ctrl + Shift + P 即可快速调出命令面板,选择”导出当前文件图表”即可导出成图片或者svg文件。
安装 graphviz
使用 plantuml 画类图的时候还需要在 VS Code 中安装:Graphviz Preview, 如果还是不画类图,就需要安装graphviz。
下载zip 包,将zip包解压,并移动到固定目录(常用软件安装目录即可),复制graphviz 安装包目录下的 bin 目录下的 dot.exe文件的绝对路径,设置到系统的环境变量中:
在系统环境变量中曾加GRAPHVIZ_DOT的配置,重启 VS Code。
例如:dot运行文件路径是:D:\programs\graphviz\bin\dot.exe,在系统变量列表中创建一个:GRAPHVIZ_DOT:D:\programs\graphviz\bin\dot.exe 的键值对即可。
VS Code 默认是英文系统,可安装”Chinese (Simplified) Language”中文语言插件。
一、简单例子
消息流向使用 -> 表示, 此时绘制出实线箭头; --> 则绘制点线箭头。若要绘制反向消息流向, 可以使用
注意:没有显示申明模块的类型,默认是矩形图形模块,并且随着代码的书写顺序进行从左向右的展示。
1
2
3
4
5
6@startuml
模块1 -> 模块2: Authentication Request
模块2 --> 模块1: Authentication Response
模块1 -> 模块2: Another authentication Request
模块2
@enduml
二、申明例图(种类)
由 participant 声明的参与者的图形是一个矩形,还可以由其它关键字声明一个参与者,不同的关键字声明的参与绘制时使用的图形是不一样的:
participant
actor
boundary
control
entity
database
collections
1
2
3
4
5
6
7
8
9
10
11
12
13@startuml
actor 角色
boundary 分界
control 控制器
entity 数据对象
database 数据库
collections 集合
角色 -> 分