- 引言
- [PlantUML 代码语法快速上手](#PlantUML 代码语法快速上手)
- [1.使用 PlantUML 在线工具(1 分钟)](#1.使用 PlantUML 在线工具(1 分钟))
- [2.使用 IntelliJ IDEA + PlantUML 插件(3 分钟)](#2.使用 IntelliJ IDEA + PlantUML 插件(3 分钟))
- [3. 使用 PlantUML JAR 包(5 分钟)](#3. 使用 PlantUML JAR 包(5 分钟))
- 总结
引言
在项目开发和技术学习过程中,我们经常需要理解类之间的 继承、实现、关联 关系。UML 类图 直观地展示了这些关系,使代码结构更加清晰。
本篇文章将介绍 三种快速绘制 UML 类图的方法,不超过 10 分钟 即可上手:
- 1 分钟掌握 PlantUML 在线工具
- 3 分钟学会 IDEA 内置插件绘图
- 5 分钟使用 PlantUML JAR 包生成 UML
无论你是 新手还是资深开发者,都能通过这些方法 轻松绘制 UML 类图,助力项目开发和技术理解。
PlantUML 代码语法快速上手
使用 PlantUML 绘制 UML 类图的核心语法非常简单,只需遵循以下步骤:
- 代码块 必须以 @startuml 开头,以 @enduml 结尾。
- 定义类和接口。
- 建立类与类之间的关系,包括:
- 继承: A <|-- B(表示 B 继承 A)
- 接口实现: A <|-- B(表示 B 继承 A)
- 组合: A *-- B(表示 A 组合 B)
你可以直接复制下面的代码,快速创建 UML 类图:
java
@startuml
' 定义接口
interface Serializable
interface Lock
' 定义类
class AbstractQueuedSynchronizer
class ConditionObject
class Node
class ReentrantLock
class Sync
class NonfairSync
class FairSync
' 继承关系
Serializable <|.. AbstractQueuedSynchronizer
Serializable <|.. ConditionObject
Serializable <|.. ReentrantLock
Lock <|.. ReentrantLock
' 实现关系
Sync <|-- NonfairSync
Sync <|-- FairSync
' 组合关系
ReentrantLock *-- Sync
ReentrantLock *-- NonfairSync
ReentrantLock *-- FairSync
AbstractQueuedSynchronizer *-- ConditionObject
AbstractQueuedSynchronizer *-- Node
@enduml
1.使用 PlantUML 在线工具(1 分钟)
步骤一: 访问网址:https://www.planttext.com/,进入plantUML在线界面。
步骤二: 编写构建类图的代码。
步骤三: 点击Refresh按钮,即可在代码右侧看到画出来的UML类图。
2.使用 IntelliJ IDEA + PlantUML 插件(3 分钟)
步骤一: 打开File->Setting->Plugins ,找到PlantUML Integration插件,下载安装,然后重启IDEA。
步骤二: 在自定义目录下右键即可创建 .puml 后缀的文件,在该文件中编写构建类图的代码。
步骤三: 即可在右侧展现出来对应的uml类图。
3. 使用 PlantUML JAR 包(5 分钟)
步骤一: 之前还需要下载一个Graphviz,并把它配置到环境变量中,但现在它已经嵌入到plantuml中了,所以直接到https://github.com/plantuml/plantuml/releases的github链接下载plantUML的jar包,注意下载下面后缀的:
步骤二: 编写好画图用的代码,保存为.txt文件(其实什么格式都行,只要内容是对的)。
步骤三: 使用命令行界面,执行该jar包来为运行好的画图代码。
步骤四: 最后即可在运行的目录下得到画好的png图片。
总结
- 如果你想快速上手,推荐使用 PlantUML 在线工具。
- 如果你是 Java 开发者,强烈推荐 IntelliJ IDEA +
PlantUML 插件。 - 如果你喜欢 命令行自动化,可以使用 PlantUML JAR 包。