简洁的 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. 在线编辑器

  2. 本地使用

    • 安装 Java 和 PlantUML JAR 文件

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

  3. IDE 插件

    • VSCode:安装 PlantUML 插件

    • IntelliJ:安装 PlantUML Integration 插件

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


🎯 常用图类型

图类型 关键词
时序图 sequence
用例图 usecase
类图 class
活动图/流程图 activity
状态图 state
组件图 component
时态图 deployment

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

相关推荐
GISer_Jing6 天前
基于 OpenClaw 构建 博客自动撰写 Agent
前端·aigc·ai写作
2501_926978336 天前
概率分形:智能涌现的统一机理
人工智能·经验分享·机器学习·ai写作·agi
2501_926978337 天前
嵌套分形意识融合理论3.0:概率分形通用理论与存在意义论的统一整合框架
人工智能·经验分享·机器学习·ai写作·agi
一尘之中7 天前
状态的演化:量子世界的时间箭头 | 量子门与酉变换
ai写作·量子计算
一尘之中8 天前
两能级系统:量子计算的基石
ai写作·量子计算
阿部多瑞 ABU8 天前
论“酸葡萄”之辩
ai写作
一尘之中8 天前
气候的例外:如何打破地理决定论的边界
ai写作
一尘之中9 天前
量子力学数学基础入门:从态矢到内积外积(附Python演示)
python·ai写作·量子计算
sanshanjianke9 天前
AI辅助网文创作理论研究笔记(二):一些新的思路和想法
语言模型·ai写作
sanshanjianke9 天前
AI辅助网文创作理论研究笔记(一):叙事模型的构建
人工智能·语言模型·ai写作