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

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

相关推荐
java_logo2 天前
LobeHub Docker 容器化部署指南
运维·人工智能·docker·ai·容器·ai编程·ai写作
极速learner8 天前
【Prompt分享】自学英语教程的AI 提示语:流程、范例及可视化实现
人工智能·prompt·ai写作
doubao3617 天前
如何有效降低AIGC生成内容被识别的概率?
人工智能·深度学习·自然语言处理·aigc·ai写作
一尘之中23 天前
【架构人生】一种“低耦合、高内聚”的处世哲学
架构·ai写作
一尘之中1 个月前
量子计算机操作系统的破晓:中国“本源司南“与全球开源生态全景解析
开源·ai写作·量子计算
寒秋丶1 个月前
AutoGen多智能体协作、人机交互与终止条件
人工智能·python·microsoft·ai·人机交互·ai编程·ai写作
战神数科1 个月前
AI IN ALL峰会|百度阿里揭秘智能营销与出海的AI实战
ai·ai作画·aigc·ai编程·ai写作
熙客1 个月前
Cursor:开发常用工具网站
ai·ai作画·ai编程·ai写作
没有梦想的咸鱼185-1037-16631 个月前
AI语言大模型支持下的:SCI论文从设计到发表的全流技巧(选题、文献调研、实验设计、数据分析、论文结构及语言规范)
chatgpt·数据分析·ai写作
一尘之中1 个月前
从比特币的24小时交易到去中心化股市:一场金融交易的范式革命
网络·架构·ai写作