使用PlantUML绘制UML图的教程

1,306 阅读2分钟

使用PlantUML绘制UML图的教程

什么是PlantUML

PlantUML是一个开源项目,其主要功能是用于快速绘制UML图。它支持绘制时序图、用例图、类图、流程图、状态图、组件图等UML图,同时也支持一些非UML图形,如线框图形界面、架构图等。PlantUML使用简单、直观,通过一种简洁的语言来定义这些示意图。

PlantUML解决了什么问题

使用PlantUML可以快速绘制UML图,这对于软件开发人员来说是非常方便的,因为UML图是软件开发中不可或缺的一部分。相比于手动绘制UML图,使用PlantUML可以大大提高效率,并且生成的图形具有一致的风格和布局。

如何使用PlantUML

安装Java和graphviz-dot

在使用PlantUML之前,需要先安装Java和graphviz-dot。Java是运行PlantUML的必需条件,而graphviz-dot是可选的。如果想绘制除时序图和活动图以外的图,就需要安装graphviz-dot软件。

从命令行运行PlantUML

运行PlantUML的方式有多种,其中一种是从命令行运行。首先,创建一个文本文件,例如sequenceDiagram.txt,然后在文件中输入以下代码:

@startuml
Alice -> Bob: test
@enduml

接下来,在命令行中输入以下命令:

java -jar plantuml.jar sequenceDiagram.txt

这将会生成一个名为sequenceDiagram.png的图片文件,其中包含了刚才输入的UML图。

在IDE中使用PlantUML

在IDE中使用PlantUML可以更方便地绘制UML图。以IntelliJ IDEA为例,在项目中选中一个文件夹,右键选择new -> PlantUML File,然后随意写入一串英文名称,选择Class,按Enter键。这样就会生成一个名为test.puml的文件,可以在其中编写UML图的代码。在编写完成后,可以使用PlantUML插件来预览和导出UML图。

使用VS Code+PlantUML高效画图

使用VS Code+PlantUML可以更高效地绘制UML图。首先需要安装PlantUML插件,然后在VS Code中打开一个新文件,输入以下代码:

@startuml
Alice -> Bob: test
@enduml

接下来,按下Ctrl+Shift+P,在搜索框中输入PlantUML,选择Preview Current Diagram,就可以预览生成的UML图了。如果需要导出UML图,可以选择Export Current Diagram。

使用PlantUML绘制不同类型的UML图

PlantUML支持绘制多种类型的UML图,包括时序图、用例图、类图、活动图、组件图、状态图、对象图、部署图等。下面以用例图为例,展示如何使用PlantUML绘制不同类型的UML图。

官网地址

plantuml.com/zh/starting