导读
- PlantUml 是什么?
- 为什么选择PlantUml
- 如何开始?
PlantUml 是什么
PlantUml是一个支持快速绘制的开源项目.它定义了一套完整的语言用于实现UML关系图的描述,并使用强大的graphviz(https://github.com/plantuml/plantuml)图形渲染库进行UML图的生成,绘制的UML图可以直接导出为图片。
在线体验
为什么选择PlantUml
声明式的设计:用户只需要根据startuml
规范去写uml逻辑就可以生成比较好看且整洁的uml图。
比如:
@startuml
title 逼格运维说
Ops -> biaoge: DevOps
@enduml

支持多平台:插件化设计可以支持多个平台,chrome浏览器,eclipse,sublime等等。用户只需要一个编辑器或浏览器就能快速绘制简约大方的uml图

支持多种UML图:时序图、用例图、类图、组件图、活动图
如何开始?
接下来将演示如何在mac上使用sublime进行配置plantuml
的使用。
基础环境
-
java
-
graphviz
-
sublime 以及插件
Java
1.检验系统偏好设置中是否有java图标
2.在终端进行验证
➜ ~ java -version
java version "1.8.0_144"
Java(TM) SE Runtime Environment (build 1.8.0_144-b01)
Java HotSpot(TM) 64-Bit Server VM (build 25.144-b01, mixed mode)
注意:如果检测到没有java环境,需要去官网下载jdk后者jre包并配置java相关的环境变量
3.java检测正常,打开相关应用仍然提示安装java
因为应用程序需要由苹果公司提供的遗留Java 6 ,需要安装[javaforosx ](wget http://download.info.apple.com/Mac_OS_X/031-29055.20150831-0f779fb2-4bf4-11e5-a8d8-/javaforosx.dmg))
正常安装完之后应该就可以了
Graphviz
Graphviz 是一个开源的额图片渲染库,可以将PlantUML脚本转换成图片。
两种安装方式:
(1). 终端执行brew install graphviz
(2). 官网下载graphviz
Sublime 以及插件
Sublime 是一款超强的文本编辑器,多种插件的支持,可以很方便的帮助我们进行文本编辑以及程序开发。
(1). 若没有请官网自行下载
(2). 安装Diagram插件
注意:推荐使用Package Control进行安装(请自行学习如何配置PC)
- 打开
command-shift-p
- 打开
- 找到
Package Control:Add Repository
- 找到
- 打开
command-shift-p
- 打开
- 找到 Package Control:Install Package
- 搜索并安装diagram
注意:
安装完插件后需要重启sublime ,如果Preferences -> Packages Setting 看到 Diagram则安装成功。
Diagram
默认绑定的渲染快捷键是Command+m
,如果快捷键不冲突,就可以直接使用。
(3). 使用startuml
+Sublime
绘制流程图
新建文本并输入如下内容:
@startuml
title 时序图
== 鉴权阶段 ==
Alice -> Bob: 请求
Bob -> Alice: 应答
== 数据上传 ==
Alice -> Bob: 上传数据
note left: 这是显示在左边的备注
Bob --> Canny: 转交数据
... 不超过 5 秒钟 ...
Canny --> Bob: 状态返回
note right: 这是显示在右边的备注
Bob -> Alice: 状态返回
== 状态显示 ==
Alice -> Alice: 给自己发消息
@enduml

至此,你就可以开心的使用sublime进行UML图的制作了。
更多例子请查看官网 示例
网友评论