PlantUML安装和使用

最新推荐文章于 2025-03-31 11:08:05 发布

weixin_34234721

最新推荐文章于 2025-03-31 11:08:05 发布

阅读量411

点赞数

文章标签： java git 开发工具

原文链接：https://yq.aliyun.com/articles/25404

版权

本文介绍了PlantUML，一种用于快速创建UML图形的工具，支持多种类型的图表如序列图、用例图等，并提供了如何在Sublime Text中集成使用的详细步骤。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

什么是PlantUML

PlantUML是一个快速创建UML图形的组件，PlantUML支持的图形有：

sequence diagram,
use case diagram,
class diagram,
activity diagram,
component diagram,
state diagram,
object diagram,
wireframe graphical interface

PlantUML通过简单和直观的语言来定义图形，语法参见PlantUML Language Reference Guide，它支持很多工具，可以生成PNG、SVG、LaTeX和二进制图片。例如，下面的例子是通过在线示例工具生成的。

ASCII Art格式：

     ┌───┐          ┌─────┐
     │Bob│          │Alice│
     └─┬─┘          └──┬──┘
       │    hello      │   
       │──────────────>│   
     ┌─┴─┐          ┌──┴──┐
     │Bob│          │Alice│
     └───┘          └─────┘

http://www.planttext.com/planttext也是一个类似的导出工具，甚至你可以自建一个服务器生成图片。使用在线生成工具的好处是不用保存图片，可以直接应用生成的图片地址。

主页

官网地址：http://plantuml.com/。

安装

PlantUML下载地址：http://plantuml.com/download.html。你可以下载jar包和java的开发工具集成使用，更多的安装或者集成方式见http://plantuml.com/running.html。

对于我来说，有用的是在Chrome上集成PlantUML插件和在Sublime Text中集成。

Sublime Text集成PlantUML

PlantUML依赖Graphviz，故先安装：

brew install graphviz

Sublime Text 的集成使用的是sublime_diagram_plugin因为默认的包管理中没有，所以需要自己添加源。

使用 Command-Shift-P 打开 Command Palette
输入 add repository 找到 Package Control:Add Repository 在下方出现的输入框中输入 https://github.com/jvantuyl/sublime_diagram_plugin.git，然后回车
等待添加完成后再次使用Command-Shift-P打开Command Palette
输入install package找到Package Control:Install Package
等待列表加载完毕，输入diagram找到sublime_diagram_plugin 安装
重启Sublime Text

重启后可以在Preferences -> Packages Setting看到Diagram，默认绑定的渲染快捷键是super + m也就是Command + m如果不冲突直接使用即可。

为了简化使用，可以在 Sublime 里配置个快捷键。打开 Preferences -> Key Binding - User，添加一个快捷键：

{ "keys": ["alt+d"], "command": "display_diagrams"}

上面的代码配置成按住 Alt + d 来生成 PlantUML 图片，你可以修改成你自己喜欢的按键。

简单使用

使用的话比较简单，绘图的内容需要包含在@startuml和@enduml中，不然会报错。

在文本中输入以下内容：

@startuml
Bob -> Alice : Hello, how are you
Alice -> Bob : Fine, thank you, and you?
@enduml

按Command + m会在当前工作目录下生成这个图片文件，同时自动弹出窗口显示如下图片。

将其保存为basic.txt之后，可以在命令行运行：

java -jar /path/to/jar/plantuml.jar -tsvg basic.txt

这样会在当前路径生成了名为 basic.svg 的图片。

命令行使用参见：http://plantuml.sourceforge.net/command_line.html 。