简洁的 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 天前
语音自动生成PPT、思维导图、会议纪要、笔记、大纲、导读等
ai写作
AI产品观察5 天前
有了WriteRightly 这个AI神器,大学里的混子导师可以失业了
ai写作·ai内容检测·ai论文神器
春风LiuK11 天前
三雄争霸,AI写诗大赛!李白魂穿chatgpt?
人工智能·chatgpt·生活·娱乐·ai写作
众链网络21 天前
你的Prompt还有很大提升
人工智能·prompt·ai写作·ai工具·ai智能体
我爱一条柴ya22 天前
【AI大模型】深入理解 Transformer 架构:自然语言处理的革命引擎
人工智能·ai·ai作画·ai编程·ai写作
「、皓子~24 天前
后台管理系统的诞生 - 利用AI 1天完成整个后台管理系统的微服务后端+前端
前端·人工智能·微服务·小程序·go·ai编程·ai写作
lgbisha1 个月前
华为云Flexus+DeepSeek征文|体验华为云ModelArts快速搭建Dify-LLM应用开发平台并创建自己的AI写作神器
人工智能·ai·语言模型·自然语言处理·华为云·ai写作
超级晒盐人1 个月前
《AI大模型落地:重塑生活与行业的未来》
ai编程·ai写作·腾讯云ai代码助手
PengShuaiD51 个月前
AI是什么?大模型、语料、训练、推理、机器学习、神经网络等专业名词如何关联
ai写作·ai基础概念·ai是什么·ai应用调用关系
试剂界的爱马仕2 个月前
TCA 循环中间体如何改写肝损伤命运【AbMole】
大数据·人工智能·科技·机器学习·ai写作