PlantUML 简介
PlantUML是一个画图脚本语言,官方介绍如下:
Generate UML diagram from textual description
用它可以快速地画出:
- Sequence diagram
- Use case diagram
- Class diagram
- Activity diagram
- Component diagram
- State diagram
- Object diagram
- Deployment diagram
- Timing diagram
对于工程师们来说,用代码的方式来画图,简直是为其量身定做的。PlantUML语法也非常简单,参见PlantUML Language Reference Guide,它支持很多工具,可以生成PNG、SVG、LaTeX和二进制图片。
工具
有非常多的工具来协助工程师们使用PlantUML的语法来进行画图,比如ATOM有language-plantuml、plantuml-viewer、markdown-preview-enhanced等各种Packages。当然其他的编辑器也有同样的类似的插件。
另外,我也写了一个plantuml-tour的项目,其中有哦PlantUML的一些例子,执行脚本,以及安装说明等。大家有兴趣,也可以去看看这个项目。
例子
下面的例子是通过在线示例工具生成的。
比如这样简单的三行文本,就能生成一个基本的时序图。
@startuml |
http://www.planttext.com/planttext也是一个类似的导出工具,并且可以在这个网站上直接查看和测试Plantuml
不同图形的语法。
除了之前说过的可以生成的图形,还能生成其他图形,比如生成🌍图形。
下面是生成上面地图的plantuml描述
@startuml |
PlantUML和Hexo整合
无意中,发现一个Hexo的插件,就是hexo-tag-plantuml,这个插件能够让Hexo生成的网站可以方便的集成PlantUML来生成相关的图。
使用起来也非常简单,只需要将原来的plantuml文件中的@startuml
、@enduml
分别改成,既可以将原来一个个的plantuml文件中的图形,展示在网站上。
安装hexo-tag-plantuml
npm install hexo-tag-plantuml --save |
比如我们通过hexo-tag-plantuml插件,在网站上展示相对复杂的类图
最后,再安利一句,plantuml和hexo-tag-plantuml,你值得拥有。