简洁的 PlantUML 入门教程

评论中太多朋友在问，我的文章中图例如何完成的。

我一直用plantUML,也推荐大家用，下面给出一个简洁的PlantUML教程。

🌱 什么是 PlantUML？

PlantUML 是一个用纯文本语言画图的工具，支持流程图、时序图、用例图、类图、组件图、状态图等。它适合开发人员用来快速写文档或可视化设计。

✍️ 基本语法结构

每个图都从 @startuml 开始，以 @enduml 结束：

@startuml
// 你的图内容
@enduml

🔹 示例 1：时序图（Sequence Diagram）

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

🔹 效果：显示 Alice 向 Bob 发消息，Bob 回复 Alice。

🔹 示例 2：用例图（Use Case）

@startuml
actor User
User --> (Login)
User --> (Upload File)
@enduml

🔹 效果：用户能执行登录和上传文件的用例。

🔹 示例 3：类图（Class Diagram）

@startuml
class Car {
  +start()
  +stop()
  -engine
}

class Engine

Car --> Engine : uses
@enduml

🔹 效果：Car 类使用 Engine 类，有公开方法和私有成员。

🔹 示例 4：流程图（Activity Diagram）

@startuml
start
:Login;
if (Valid?) then (yes)
  :Show Dashboard;
else (no)
  :Show Error;
endif
stop
@enduml

🔹 效果：登录流程图，成功进入主界面，失败显示错误。

⚙️ 如何运行？

你可以用以下方式使用 PlantUML：

1. 在线编辑器：

   • PlantUML Web Server

   • 只需粘贴代码即可看到图像。

2. 本地使用：

   • 安装 Java 和 PlantUML JAR 文件

   • 用命令运行：java -jar plantuml.jar yourfile.puml

3. IDE 插件：

   • VSCode：安装 PlantUML 插件

   • IntelliJ：安装 PlantUML Integration 插件

   • VSCode：使用markdown, 在markdown预览插件中，配置还是需要提前安装plantuml.jar，这是我比较喜欢的方式。

🎯 常用图类型

欢迎在评论区交流使用心得！