简洁的 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

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

相关推荐
that's boy3 天前
解锁Midjourney创作潜能:超详细提示词(Prompts)分类指南
人工智能·chatgpt·midjourney·ai绘画·ai写作·gpt-4o·deepseek
that's boy5 天前
Google 发布 Sec-Gemini v1:用 AI 重塑网络安全防御格局?
人工智能·安全·web安全·chatgpt·midjourney·ai编程·ai写作
奥顺互联_老张19 天前
ZBlog泛目录插件+AI写作:自动化内容生产的完美解决方案
运维·自动化·ai写作
白雪讲堂20 天前
2025年3月AI搜索发展动态与趋势分析:从技术革新到生态重构
人工智能·gpt·重构·文心一言·ai写作
Blossom.11823 天前
AI赋能:科技写作的革新之路
人工智能·人机交互·学习方法·ai写作·集成学习·ai赋能·ai智能写作
试剂界的爱马仕1 个月前
早餐 3.20
人工智能·科技·机器学习·ai写作
试剂界的爱马仕1 个月前
投资早报 3.14
人工智能·深度学习·算法·机器学习·区块链·ai写作
AI赛奇1 个月前
【清华出品】deepseek进阶版教程
人工智能·ai写作
猫头虎1 个月前
阿里云操作系统控制台评测:国产AI+运维 一站式运维管理平台
运维·服务器·人工智能·阿里云·aigc·ai编程·ai写作