PlantUML 下载教程及实例

小蓝 • 2024-12-12 11:56 • 编程

一、下载PlantUML的步骤

1、访问PlantUML的官方网站（https://plantuml.com/zh/download）, 在界面中找到“下载”菜单。

2、进入下载页面。该页面会显示PlantUML的各个版本，包括jar、exe、zip等多种格式，根据系统环境选择相应版本。比如，如果你是Windows用户，就可以下载exe文件或zip包。

3、选择适合本地环境的PlantUML版本，然后下载。下载后解压缩，将jar文件保存到本地目录。

二、PlantUML的使用

1、新建一个文本文件，使用文本编辑器，比如Notepad，输入PlantUML图的源码，然后将文件保存成.puml格式。

@startuml
Bob -> Alice : Hello
Alice -> Bob : Hi
@enduml

2、在安装Java的前提下，打开命令行，并进入到刚刚保存.puml文件的文件夹。然后输入以下命令：

java -jar plantuml.jar myfile.puml

其中，”myfile.puml” 表示你刚才保存.puml文件的名字。在相同的文件夹中，会生成一个对应的.png图片。如果要生成不同格式的图片，可以在执行上述命令时添加”-tpng”等参数。

3、将生成的图片保存。如果没有指定保存位置，则根据默认设置图片会保存在相同的文件夹内。

三、PlantUML的实际应用

1、绘制类图。PlantUML是一个基于文本的UML工具，因此它非常适合描述类、接口、继承关系及方法等相关信息。比如，下面是一个简单的类图示例。

@startuml
class Customer {
  + int id
  + String name
  + String email
  + void register()
  + void login()
}

class Order {
  + int id
  + Date orderDate
  + double amount
  + void placeOrder()
  + void cancelOrder()
}

Customer --> Order
@enduml

2、绘制顺序图。使用PlantUML，可以很好地描述系统中各个部分之间的消息流通，因此它经常被用于绘制顺序图。比如，下面是一个简单的顺序图示例。

@startuml
actor User
participant Client
participant Server

User -> Client : openApp()
Client -> Server : connect()
Server -> Client : response()
Client -> User : showUI()
@enduml

3、绘制活动图。对于复杂的业务流程，活动图能够提供直观的表示方式。PlantUML支持绘制活动图，并且使用它可以快速构建系统的落地方案。比如，下面是一个简单的活动图示例。

@startuml
|Start|
:customer request;
:system createMemento;
:system prepareOrder;
|Loop|
:system validateOrder;
:system acceptPayment;
if (successful) then (yes)
  :system reserveProduct;
else (no)
  :system cancelPayment;
  break Loop;
endif
end Loop
:system shipProduct;
:customer getNotified;
|End|
@enduml

四、下载PlantUML之后遇到的问题

1、不能识别命令。当以管理员身份运行CMD并输入Java版本及PlantUML命令时出现以下报错信息：
“‘java is not recognized as an internal or external command, operable program or batch file.’”
解决方法：添加Java和PlantUML的环境变量或将它们两个所在的路径添加到系统路径中。

2、无法生成图片。当执行PlantUML命令失败时，程序没有报错信息，也没有任何反应。
解决方法：检查PlantUML和Java的版本是否匹配。同样可以尝试卸载掉旧版本，重新安装最新版本。

3、输出图片质量较低。PlantUML生成的图片有一些缺点，例如输出的图片质量较低。此时，可以通过在文件头部添加”!pragma graphviz_dot_args=-Gdpi=300″或设置其他属性提高图片的质量。

五、总结

本文介绍了PlantUML的下载、使用方法，并提供了一些PlantUML绘图的实例。通过学习本文，读者可以掌握基本的PlantUML绘图语法，更高效地完成各种UML图的绘制。当然，PlantUML还有众多其他特性，有兴趣的读者可以去官网查看详细的文档和示例。

原创文章，作者：小蓝，如若转载，请注明出处：https://www.506064.com/n/235722.html