PlantUML 1.2021.2 Справочное руководство по языку

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

摘要

文档是PlantUML语言的参考手册，版本为1.2021.2。PlantUML是一个开源项目，支持通过简单的文本描述快速创建多种UML和非UML图表，包括顺序图、用例图、类图、对象图、活动图、组件图、部署图、状态图、同步图等。此外，还支持JSON、YAML、网络图、线框图、Archimate图、SDL图、Ditaa图、甘特图、思维导图、工作分解结构图、数学表达式（使用AsciiMath或JLaTeXMath）以及实体关系图等。文档还介绍了预处理功能，如断言、自定义库的创建与使用，以及标准库的内容。

AI总结

《PlantUML 1.2021.2 参考指南》是一份关于PlantUML语言的详细说明文档，以下是其核心内容的总结：

### 1. PlantUML 简介
PlantUML 是一个开源工具，支持通过简单的文本语言快速创建多种图表，包括：
- UML 图表：如序列图、用例图、类图、对象图、活动图、组件图、部署图、状态图、同步图等。
- 非 UML 图表：如 JSON 数据图、YAML 数据图、网络图、界面原型图、Archimate 图、SDL 图、Ditaa 图、甘特图、思维导图、工作分解结构图、数学表达式（支持 AsciiMath 和 JLaTeXMath）以及实体关系图。

### 2. 语法与示例
PlantUML 使用简单直观的语法，支持定义节点、关系和分组等功能。例如：
- **节点分组**：通过 `group` 关键字定义节点组，方便组织复杂的网络结构。

  @startuml
  nwdiag {
    network Sample_front {
      address = "192.168.10.0/24";
    }
    group web {
      web01 [address = ".1"];
      web02 [address = ".2"];
    }
    network Sample_back {
      address = "192.168.20.0/24";
      web01 [address = ".1"];
      web02 [address = ".2"];
      db01 [address = ".101"];
      db02 [address = ".102"];
    }
    group db {
      db01;
      db02;
    }
  }
  @enduml

- **断言功能**：可以在图表中添加断言（`!assert`）用于调试目的。

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

### 3. 预处理功能
PlantUML 的预处理功能类似于 C 语言预处理器，但特殊字符 `#` 被替换为 `!`。主要功能包括：
- **函数与变量定义**：支持定义函数（`!function`）和变量（`$` 开头），变量分为整数和字符串两种类型。

  @startuml
  !$ab = "foo1"
  !$cd = "foo2"
  !$ef = $ab + $cd
  Alice -> Bob : $ab
  Alice -> Bob : $cd
  Alice -> Bob : $ef
  @enduml

- **断言与自定义库**：支持断言（`!assert`）和自定义库（`!import` 和 `!include`），可以将文件打包成 `.zip` 或 `.jar` 并导入使用。

### 4. 标准库
PlantUML 提供了丰富的标准库（stdlib），包含多种图表元素和宏，主要包括：
- **AWS 库**：支持 Amazon Web Services 的图标和宏，适合绘制 AWS 架构图。

  @startuml
  !include 
  left to right direction
  Users(sources, "Events", "millions of users") --> APIGateway(votingAPI, "Voting API", "user votes")
  APIGateway --> Cognito(userAuth, "User Authentication", "jwt to submit votes")
  Cognito --> Lambda(generateToken, "User Credentials", "return jwt")
  APIGateway --> Lambda(recordVote, "Record Vote", "enter or update vote per user")
  Lambda(recordVote) --> DynamoDB(voteDb, "Vote Database", "one entry per user")
  @enduml

- **Azure 库**：提供 Microsoft Azure 的图标和宏，支持通过 `!include ` 导入。
- **其他库**：包括 Kubernetes、Cloud Insight、C4 模型等，涵盖了多种技术栈和架构风格。

### 5. 使用 PlantUML
- **语法参考**：官方语法文档可通过 [https://plantuml.com](https://plantuml.com) 访问。
- **命令行支持**：支持通过命令行使用 `java -jar plantuml.jar` 运行，并可通过 `java -jar plantuml.jar -stdlib` 查看标准库列表。

### 总结
PlantUML 是一个功能强大且灵活的工具，支持通过简单的文本语言创建多种图表。其预处理功能、标准库和扩展性使其成为软件开发、系统设计和架构图表的理想选择。