Sublime + PlantUML配置
PlantUML是什么
PlantUML是一个开源项目,支持快速绘制:
- 时序图
- 用例图
- 类图
- 活动图 (旧版语法在此处)
- 组件图
- 状态图
- 对象图
- 部署图
- 定时图
同时还支持以下非UML图:
- Network
- 线框图形界面
- 架构图
- 规范和描述语言 (SDL)
- Ditaa diagram
- 甘特图
- 思维导图
- Work Breakdown Structure diagram
- 以 AsciiMath 或 JLaTeXMath 符号的数学公式
- Entity Relationship diagram
PlantUML示例
官网提供的时序图示例:
要构造出这样一张时序图:
只需要输入代码:
@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
Alice -> Bob: Another authentication Request
Alice <-- Bob: another authentication Response
@enduml
sublime + plantUML环境配置
需求环境
java
graphviz
sublime text 2/3
sublime-plantuml插件
这里我用的是windows,不过差别不大
java 环境配置
这个就网上一大把了,反正只要最后终端输入java -version
有显示成功就是配置完成了。
sublime text 配置
这个也不说了……就是官网http://www.sublimetext.com/下载安装就完事了。
graphviz 和 sublime-plantuml插件 配置
这个为什么放在一起说呢,就是因为我被网上各种年代久远的解决办法坑了啊,后人哀之而不鉴之,亦使后人而复哀后人也。
废话不多说。
黑喂狗。
graphviz 配置
官网http://www.graphviz.org/download/
下载graphviz-2.38.msi
下载完就安装呗这没啥好说的。
然后
划重点!
环境配置这里,官网只让你配置PATH
,本人也只配置了PATH
,并且对于终端可以使用graphviz,但是sublime打死加载不出来百思不得其解。
记得还要配置一个GRAPHVIZ_DOT
参考环境配置:
PATH F:\graphviz-2.38\bin
GRAPHVIZ_DOT F:\graphviz-2.38\bin\dot.exe
重启,靴靴。
sublime-plantUML插件
- 打开sublime,preferences->package control->Add Repository,然后在url中输入 https://github.com/jvantuyl/sublime_diagram_plugin.git,回车,等待加载完。
- preferences->package control->Install Package,等待加载完,输入 sublime_diagram_plugin,安装,重启sublime。
- 快捷键使用,preferences->key bindings,输入
[
{"keys": ["alt+m"], "command": "display_diagrams"}
]
重启sublime 提示 Unable to load diagram plugin, check console for details
- 打开 views->show console
Exception: No working processors found!
说明你graphviz配置不成功,要么重装,要么检查环境变量是否添加了PATH
和GRAPHVIZ_DOT
- 可能还有java not found这些,就对应重新配置对应环境就好了。还有的是charset问题,就preferences->browse packages->sublime_diagram_plugin->Diagram.sublime-settings,修改成
{ // restart sublime to apply the changes "viewer": "WindowsDefaultViewer", // Preview, QuickLook, EyeOfGnome, WindowsDefaultViewer "check_on_startup": true, "new_file": false, // generate new file each time "output_format": "png", // valid values: png, svg, txt, utxt, latex "charset": "UTF-8"// Can be "UTF-8" - to support non-latin text in diagram }
测试
打开sublime,输入
@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
Alice -> Bob: Another authentication Request
Alice <-- Bob: another authentication Response
@enduml
全选文本,按下alt+m,生成时序图
That’ all,thanks for reading!