PlantUML 是一个开源项目,支持快速绘制(通过简单直观的语言来定义这些示意图):
- 时序图
- 用例图
- 类图
- 活动图
- 组件图
- 状态图
- 对象图
- 部署图
- 定时图
同时还支持以下非 UML 图:
- 线框图形界面
- 架构图
- 规范和描述语言 (SDL)
- Ditaa diagram
- 甘特图
- 以 AsciiMath 或 JLaTeXMath 符号的数学公式
PlantUML 本体是一个 plantuml.jar文件, 依赖于 graphviz,graphviz 是一个开源的图片渲染库, 安装了这个库才能在 Windows 下把脚本转换为图片(sequence diagram 和 activity beta diagrams 可以不需要)。
下载 graphviz之后, 设置GRAPHVIZ_DOT环境变量为 path/to/graphviz/release/dot.exe
, 使 PlantUML能够找到 dot.exe, 然后使用 java -jar ./plantuml.jar -testdot
测试配置是否成功.
配置完成之后, 新建文件, 在其中写入简单的 Demo:
1 | @startuml |
然后执行命令 java -jar plantuml.jar demo.txt
即可生成图片. 也可以直接双击 plantuml.jar
文件打开GUI窗口来操作.
PlantUML 几乎可以集成到任何编辑器/IDE/文档工具中, 比如 Sublime Text 中有 PlantUML for Sublime 、Intellij IDEA 、Eclipse、Chrome 中都有相应的插件.在这里查看如何在你当前的使用的软件中集成 PlantUML。