PlantUML简介

UML: Unified Modeling Language 统一建模语言,是非专利的第三代建模和规约语言。
UML是一种开放的方法，用于说明、可视化、构建和编写一个正在开发的、面向对象的、软件密集系统的制品的开放方法。（来自wikipedia）

PlantUML 使用简单的可读文本描述语句来绘制图表。需要注意的是，它并不会阻止你绘制相互矛盾的图表（比如，有两个相互继承的类），所以与其说它是一个建模工具，不如说它是一个绘图工具。（来自PlantUML官网What’s the goal of PlantUML ?）

一.所需环境

• JDK(Java SE Development Kit)
• graphviz
• Visual Studio Code(或者sublime, Chrome, eclipse, AndroidStudio, Intellij…更多)

二.配置

1.安装JDK

• 检测是否已安装JDK 终端输入

java -version

没有安装的话会弹窗

点击更多信息，进入JDK下载页

点击DOWNLOAD

进入下载页面

点击接受条款，再点击。dmg的链接下载

由于某些缘故Oracle下载JDK奇慢，你可以使用华为JDK镜像源，找到最新的版本下载即可
关于JDK环境变量配置可以参照 macOS下JDK11安装及环境变量配置总结

安装配置完成后，终端跑一下

java -version

会是下图的样子

2.安装graphviz

graphviz 是一个开源的额图片渲染库，可以将PlantUML脚本转换成图片。

终端中输入

brew install graphviz

有好几个依赖包会下，所以需要一些时间，耐心等待

3.VSCode安装plantUML插件

• 打开VSCode
• ⌘(command) + shift + X打开扩展，搜索PlantUML
• 选择星最多的，一般就第一个

• install

4.使用

• 新建一个文件
• 输入样例

@startuml

title 时序图

== 鉴权阶段 ==

Alice -> Bob: 请求
Bob -> Alice: 应答

== 数据上传 ==

Alice -> Bob: 上传数据
note left: 这是显示在左边的备注

Bob --> Canny: 转交数据
... 不超过 5 秒钟 ...
Canny --> Bob: 状态返回
note right: 这是显示在右边的备注

Bob -> Alice: 状态返回

== 状态显示 ==

Alice -> Alice: 给自己发消息

@enduml

保存文件为test.wsd

• alt + D右侧即可渲染出UML图

三.其他开发工具使用PlantUML配置

• 在AndroidStudio中使用PlantUML(for Mac)

• Mac使用Sublime + PlantUML高效地画图

• Mac环境下，Intellij IDEA中安装使用PlantUML画时序图

• PlantUML Viewer Chrome 插件 画时序图

• Information about the PlantUML Eclipse Plugin

• 用Atom在Mac OS X 下编辑PlantUML

END