PlantUML 을사용해서 UML 그리기 - PlantUML 언어참조가이드(Version 1.2019.9)

• 语言: 韩语
• 格式: .pdf
• 来源: pdf.plantuml.net

摘要

文档介绍了PlantUML工具的使用，包括支持的多种UML图表类型（如类图、时序图、组件图等）以及如何通过skinparam自定义图表样式。文档还详细讲解了如何在类图中使用stereotypes和高级类图功能，如分组和可见性。此外，文档提到了如何利用标准库中的宏来增强图表的可读性和美观度，并讨论了PlantUML的语法和预处理功能，如变量定义和宏的使用。

AI总结

### 文档总结：PlantUML 使用指南（版本 1.2019.9）

#### 1. **PlantUML 简介**
- **PlantUML** 是一个用于快速生成图表的开源项目。
- 支持多种 UML 图表类型，包括：
- **类图（Class Diagram）**
- **时序图（Timing Diagram）**
- **活动图（Activity Diagram）**
- **组件图（Component Diagram）**
- **状态图（State Diagram）**
- **部署图（Deployment Diagram）**
- **用例图（Use Case Diagram）**
- 以及其他图表类型（如 Wireframe、Ditaa、甘特图等）。
- 语法简洁直观，支持通过简单命令定义复杂的图表。

#### 2. **核心功能**
- **语法示例**：

  @startuml
  Course " enrols " 1..* Enrollment
  Enrollment {
     drop()
     cancel()
  }
  @enduml

- **皮肤参数（Skinparam）**：
- 可通过 `skinparam` 命令自定义图表的颜色、字体等样式。
- 示例：

    skinparam class {
       BackgroundColor PaleGreen
       ArrowColor SeaGreen
       BorderColor SpringGreen
    }

- **类图高级功能**：
- 支持定义类关系、方法、可见性（如 `+public`, `#protected`, `-private`）。
- 支持抽象类和接口，以及类体的分组和标题。

#### 3. **时序图（Timing Diagram）**
- **参与者（Participant）**：
- 可通过 `robust` 或 `concise` 关键字定义参与者。
- 示例：

    @startuml
    robust "Web Browser" as WB
    concise "Web User" as WU
    @0 WU is Idle
    WB is Idle
    @100 WU -> WB : URL
    WB is Processing
    @300 WB is Waiting
    @enduml

- **消息（Message）**：
- 支持定义消息顺序和参与者状态变化。
- 示例：

    @startuml
    Alice -> Bob : Hello
    @enduml

#### 4. **预处理功能（Preprocessing）**
- **变量定义**：
- 支持全局变量和函数内变量。
- 示例：

    !$ab = "foo1"
    !$cd = "foo2"
    !global $ef = $ab + $cd
    Alice -> Bob : $ab
    Alice -> Bob : $ef

- **宏定义**：
- 支持通过 `!function` 定义宏。
- 示例：

    !function COMP_TEXTGENCOMP(name) [name] << Comp >> interface Ifc << IfcType >> AS name##Ifc
    name##Ifc - [name]

#### 5. **自定义库（Custom Library）**
- **库导入**：
- 可通过 `!import` 导入 `.zip` 或 `.jar` 格式的自定义库。
- 示例：

    !import /path/to/customLibrary.zip
    !include myFolder/myFile.iuml

- **标准库**：
- 提供 AWS 和 Azure 等第三方库，支持通过宏和图标扩展功能。
- 示例：

    !include 
    !include 
    AMAZONS3(s3_internal)

#### 6. **高级功能**
- **断言（Assertion）**：
- 支持通过 `!assert` 进行条件验证。
- 示例：

    Alice -> Bob : Hello
    !assert %strpos("abcdef", "cd") == 3 : "This always fail"

- **搜索路径（Search Path）**：
- 可通过 `plantuml.include.path` 属性指定搜索路径。
- 示例：

    java -Dplantuml.include.path="c:/mydir" -jar plantuml.jar test1.txt

#### 7. **总结**
- PlantUML 是一个功能强大且灵活的图表生成工具，支持多种图表类型和高级功能。
- 通过简洁的语法和自定义样式（如 `skinparam`），用户可以快速生成高质量的图表。
- 支持预处理功能和自定义库，进一步扩展了其使用场景。
- 适用于软件开发、系统设计、教学等领域，是一个高效的工具。