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

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

相关推荐
「、皓子~1 天前
后台管理系统的诞生 - 利用AI 1天完成整个后台管理系统的微服务后端+前端
前端·人工智能·微服务·小程序·go·ai编程·ai写作
lgbisha11 天前
华为云Flexus+DeepSeek征文|体验华为云ModelArts快速搭建Dify-LLM应用开发平台并创建自己的AI写作神器
人工智能·ai·语言模型·自然语言处理·华为云·ai写作
超级晒盐人12 天前
《AI大模型落地:重塑生活与行业的未来》
ai编程·ai写作·腾讯云ai代码助手
PengShuaiD519 天前
AI是什么?大模型、语料、训练、推理、机器学习、神经网络等专业名词如何关联
ai写作·ai基础概念·ai是什么·ai应用调用关系
试剂界的爱马仕25 天前
TCA 循环中间体如何改写肝损伤命运【AbMole】
大数据·人工智能·科技·机器学习·ai写作
试剂界的爱马仕1 个月前
软珊瑚成分 CI-A:靶向口腔癌细胞的 “氧化利剑” 与 ERK 密码
网络·人工智能·科技·机器学习·ci/cd·ai写作
阿部多瑞 ABU2 个月前
小说所有设定(v3.0 preview)
ai·ai写作
小白聊AI2 个月前
什么是AI写作
人工智能·学习·ai写作
create172 个月前
使用 AI 如何高效解析视频内容?生成思维导图或分时段概括总结
人工智能·aigc·语音识别·ai写作
怪我冷i2 个月前
k8s笔记——kubebuilder工作流程
云原生·kubernetes·ai编程·ai写作