PLANTUML快速上手

背景

开发中需要画一些类图, 时序图, UML图等, 像draw.io这种可视化的绘图软件, 虽然灵活, 却要花费大量时间调整线条与布局.

PlantUML是一个开源项目, 支持快速绘制各种UML图和非UML图, 基本满足了程序员的绘图需求. 它通过简单直观的语言来定义这些图, 让我们聚焦内容, 而非样式.

安装

1. 在vscode上，搜索 PlantUML 安装

1. 设置渲染方式 生成图片有2种渲染方式，一种是通过远程服务生成，一种是在本地生成。 在本地生成，需要安装 java环境和Graphviz绘图工具，相对比较麻烦。 而在远程服务生成，只需要在服务器上，运行一个docker服务即可。操作如下： # 拉取镜像 docker pull plantuml/plantuml-server # 启动镜像，将容器的8080端口, 映射到服务器的8082端口, 外界直接通过访问服务器的8082端口即可 docker run -d -p 8082:8080 plantuml/plantuml-server:jetty 容器启动成功后, 我们在客户机访问, 访问地址http://服务器地址:8082

1. 在vscode的配置文件中, 配置plantuml server的地址 设置 -> 搜索plantuml -> 配置render和server地址

使用

在vscode中，新建后缀为 *.wsd, *.pu, *.puml, *.plantuml, *.iuml 的文件，编写内容，右键菜单 preview current diagram 即可预览

可参考plantuml官方创建一个测试文件, 完整文档: http://plantuml.com/zh/guide

如创建一个简单的名为test的uml图

@startuml test
Bob -> Alice : hello
@enduml

编写完成后, 右键选择"预览光标位置的图表", 即可查看生成的uml图

最后

如果你可以成功看到uml图, 恭喜你, 配置成功了