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

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

摘要

PlantUML은 UML을 비롯한 다양한 차트를 생성하기 위해 사용되는 오픈소스 도구입니다. 간단하고 직관적인 언어를 사용해 시퀀스 다이어그램, 유즈케이스 다이어그램, 클래스 다이어그램, 컴포넌트 다이어그램等多种 유형의 차트를 손쉽게 그릴 수 있습니다. PlantUML은 텍스트 기반의 언어로, 텍스트와 그래픽의 상관성 덕분에 빠르고 정확하게 차트를 생성할 수 있습니다. 또한, 사용자 정의 라이브러리와 표준 라이브러리 등을 통해 다양한 기능을 확장할 수 있습니다.

AI总结

### PlantUML 使用指南（版本 1.2023.11）

#### 1. PlantUML 简介
- **PlantUML** 是一个用于快速生成图表的开源工具，支持多种类型的 UML 图表（如序列图、类图、对象图、活动图等）以及非 UML 图表（如 JSON 数据图、网络图、甘特图等）。
- 使用简单直观的文本语言定义图表，文本与图形高度相关，生成速度快，易于编辑和修订。

#### 2. 核心功能
- **直观语法**：语法设计简洁易记，适合新手快速上手。
- **文本到图形的高效转换**：文本描述与图形输出高度一致，减少意外结果。
- **可视化与编辑**：在 drafting 阶段即可预览最终结果，编辑时只需修改文本，避免复杂图形工具的繁琐操作。

#### 3. 图表类型
- **支持的 UML 图表**：
- 序列图（Sequence Diagram）
- 类图（Class Diagram）
- 对象图（Object Diagram）
- 活动图（Activity Diagram）
- 组件图（Component Diagram）
- 状态图（State Diagram）
- 时序图（Timing Diagram）
- 用例图（Use Case Diagram）
- 跨界图（Deployment Diagram）
- 网络图（Network Diagram）
- JSON 数据图
- YAML 数据图
- Archimate 图
- SDL 图
- Gantt 图
- MindMap 图
- Work Breakdown Structure 图
- 数学公式图（支持 AsciiMath 或 JLaTeXMath）
- 实体关系图（Entity Relationship Diagram）

#### 4. 自定义库与搜索路径
- **自定义库**：可通过 `!import` 和 `!include` 指令将多个文件打包为 `.zip` 或 `.jar`，然后导入到图表中。
- 示例：

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

- **搜索路径**：通过 `-Dplantuml.include.path` 参数指定自定义库的搜索路径。
- 示例：

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

#### 5. 参数拼接
- 使用 `##` 语法追加文本到宏参数中。
- 示例：

    @startuml
    !unquoted procedure COMP_TEXTGENCOMP(name)
    [name] << Comp >> interface Ifc << IfcType >> AS name##Ifc
    name##Ifc - [name]
    !endprocedure
    COMP_TEXTGENCOMP(dummy)
    @enduml

#### 6. 图表创建示例
- **序列图**：

  @startuml
  Alice -> Bob: Authentication Request
  Bob -> Alice: Authentication Response
  Alice -> Bob: Another authentication Request
  Alice <- Bob: another authentication Response
  @enduml

- **组件图**：

  @startuml
  [First component]
  [Another component] as Comp2
  component Comp3
  [Last\ncomponent] as Comp4
  @enduml

- **用例图**：

  @startuml
  (First usecase)
  (Another usecase) as UC2
  usecase UC3
  (Last\nusecase) as UC4
  @enduml

#### 7. YAML 数据可视化
- 使用 `@startyaml` 和 `@endyaml` 包裹 YAML 数据。
- 示例：

    @startyaml
    fruit: Apple
    size: Large
    color: - Red - Green
    @endyaml

#### 8. 标准库
- **标准库概述**：PlantUML 的标准库包含丰富的文件和资源，支持多种图表类型。
- **列出标准库**：

  @startuml
  stdlib
  @enduml

#### 9. 总结
PlantUML 提供了简单、直观且强大的工具，用于快速创建多种类型的图表。其文本驱动的语法和高度一致的图形输出使其成为开发人员、架构师和设计师的理想选择。通过自定义库和标准库的扩展，用户可以进一步提升图表创作的效率和灵活性。