plantUML快速入门

plantUML快速入门

本文主要描述了如何使用plantUML语言绘制UML图，如有出入请批评指正！

目录

• plantUML快速入门
  • 什么是plantUML
  • plantUML的主要特点
  • 使用plantUML语法的环境准备
  • PlantUML常用语法
    • 时序图
    • 类图
    • 用例图
    • 状态图
    • 组件图

什么是plantUML

PlantUML 是一种开源工具，用于创建 UML（统一建模语言）图。它使用简单的文本描述语言，用户可以通过编写代码来生成多种类型的图形，包括：

1. 类图：展示类之间的关系。

2. 时序图：显示对象之间的交互和顺序。

3. 用例图：描述系统的功能及其用户。

4. 状态图：表示对象状态的变化。

5. 组件图：显示系统中的组件及其关系。

plantUML的主要特点

• 简单易用：使用简单的文本语法描述图形，便于版本控制和编辑。

• 多种输出格式：可以生成 PNG、SVG、PDF 等多种格式的图像。

• 集成性强：可以与多种开发工具（如 IntelliJ IDEA、Eclipse 等）和 CI/CD 工具集成。

使用plantUML语法的环境准备

使用Visual Studio Code插件绘制
使用之前请安装PlantUML插件，然后就可以愉快的书写UML语言，右侧会生成对应的预览图片(alt+D显示)

PlantUML常用语法

autonumber 表示在绘制的图上添加序列号

时序图

@startuml
autonumber
Alice -> Bob: Hello, Bob!
Bob --> Alice: Hi, Alice! How can I help you?
Alice -> Bob: Can you send me the report?
Bob -> Alice: Sure, here it is.
@enduml

类图

@startuml
class User {
  +String name
  +String email
  +void login()
  +void logout()
}

class Admin extends User {
  +void manageUsers()
  +void viewReports()
}

User --> "1..*" Post : creates >
Post : +String title
Post : +String content
@enduml

用例图

@startuml
actor User
actor Admin
User --> (Login)
User --> (Register)
Admin --> (Manage Users)
Admin --> (Generate Reports)
@enduml

状态图

@startuml
[*] --> Idle
Idle --> Working : start()
Working --> Idle : stop()
Working --> Error : errorOccurred()
Error --> Idle : reset()
@enduml

组件图

@startuml
package "Web Application" {
  [Frontend] --> [Backend]
  [Backend] --> [Database]
}

package "Services" {
  [Authentication Service]
  [Payment Service]
}
[Frontend] --> [Authentication Service]
[Backend] --> [Payment Service]
@enduml