经常看到有的ppt中有非常专业的图,非常整齐、简洁、清晰,于是经过一番查找和交流得知,有一款开源工具 plantuml,能够实现此类效果。特记录之。
个人感觉这个软件的2大优势是:可代码编程,可版本管理(因为是代码实现的)
1、plantuml 的官网:https://plantuml.com
2、通过在VSCode中安装plantuml 插件,可以很容易的通过编程实现。
3、安装方法。
主要参考:https://plantuml.com/zh/starting
a. 本地电脑必须安装java (官网下载安装 https://www.java.com/zh-CN/)
b. 本地电脑必须安装GraphViz (官网下载安装 https://graphviz.org/download/ )
c. 本地电脑下载 plantuml.jar包,jar包路径如下,下载完毕后,将文件名称修改成 plantuml.jar
https://objects.githubusercontent.com/github-production-release-asset-2e65be/1051476/3742718f-3510-4875-8c50-2d3d31a41448?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=releaseassetproduction%2F20250101%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250101T135433Z&X-Amz-Expires=300&X-Amz-Signature=76dc21dece4f7b62f6ac6c230029f15fc63059b7fb803b5c97448412ddbd8a57&X-Amz-SignedHeaders=host&response-content-disposition=attachment%3B%20filename%3Dplantuml-1.2024.8.jar&response-content-type=application%2Foctet-stream
d. VSCode中安装plantuml 插件(选择 jabbs 作者),如下
e. plantuml 的设置关键点是:
(1)plantuml.jar 文件路径,需要手工指定本地下载的plantuml.jar包
(2)选择本地渲染。
{ "security.workspace.trust.untrustedFiles": "open", "workbench.colorTheme": "Visual Studio 2017 Light - C++", "plantuml.render": "Local", "chat.editing.alwaysSaveWithGeneratedChanges": true, "plantuml.jar": "C:\\zhouhaibing\\code\\plantuml\\plantuml.jar", "plantuml.includepaths": [ ] }
上述配置,我在User 和 Workspace中都配置了,如下:
4、实测效果如下
(1) 在VSCode中编辑如下内容,然后右键选择如下,右侧就会显示 plantuml的预览效果图。
plantuml 文件的文件名是 a.puml,内容如下
@startuml !include <office/Servers/virtual_server> nwdiag { network underlay { address = "192.168.74.x/24" vm01 [address = "192.168.74.129", description = "<$virtual_server>\n web01"]; vm02 [address = "192.168.74.130"]; } } @enduml
5、plantuml 支持ER图、时序图、网络图、状态机图、部署图等,基本上覆盖到工作中经常使用的内容,它的参考文档写的非常细,值得看。
英文版:https://plantuml.com/en/guide
中文版:https://plantuml.com/zh/guide