主页 新鲜 入门指南 Online Server 使用 常见问题 下载 论坛 Theme 预处理 标准库 Hitchhiker's Guide 用户指南(PDF)
PlantUML News and information PlantUML for the impatient

Edit in DokuwikiEdit in AsciidocEdit in Markdown
PlantUML 快速入门指南

对于有兴趣初步探索 PlantUML 的人，我们建议使用直接支持 PlantUML 的在线平台。

在我们的在线服务器上进行探索。

Edit in DokuwikiEdit in AsciidocEdit in Markdown
本地安装程序

在试用过在线版本后，如果您考虑更全面的本地环境，建议您在本地安装 PlantUML。安装前，请确保满足以下前提条件：

Java：

  • 检查是否已安装 Java * ：`java -version`。 * 所需的最低版本为 Java 8。

  • 如果未安装，请从Java 官方网站下载并安装，或通过软件包管理器（如 Ubuntu 的apt 、macOS 的brew 等）下载并安装。

GraphViz：

  • Linux：您可以在这里找到有关 GraphViz 安装的模式信息
  • Windows：已编译的 GraphViz 版本已嵌入 PlantUML，无需单独安装。不过，如果需要，您可以在此处获取独立版本

准备就绪后，下载 plantuml.jar 文件并执行，即可访问 PlantUML 的图形用户界面。无需进一步解压缩或安装。

Edit in DokuwikiEdit in AsciidocEdit in Markdown
命令行操作

对于那些熟悉命令行界面或打算将 PlantUML 与脚本或文档平台集成的用户，PlantUML 提供了方便的命令行语法。请按照以下步骤操作：

  1. 撰写文本文件：记录您的 PlantUML 命令。下面是一个示例sequenceDiagram.txt ：

@startuml
Alice -> Bob: test
@enduml

2.执行文件：处理上述文本文件： 

java -jar plantuml.jar sequenceDiagram.txt

3.另一种方法：启动图形用户界面，选择包含文本文件的目录： 

java -jar plantuml.jar -gui

执行后，将生成包含序列图的sequenceDiagram.png 。

探索 PlantUML，进一步提高您的图表绘制能力。

Edit in DokuwikiEdit in AsciidocEdit in Markdown
使用 Docker

使用Docker测试 PlantUML 提供了一个隔离的环境，不需要在机器上直接安装 PlantUML 或其依赖项。

说明

  1. 提取 PlantUML 的 Docker 镜像

Docker Hub 上有 PlantUML 的官方Docker 镜像。 

docker pull plantuml/plantuml-server:jetty

2.运行 PlantUML 服务器容器

一旦下载了镜像，就可以运行基于此镜像的容器。 

docker run -d -p 8080:8080 plantuml/plantuml-server:jetty

该命令执行以下操作：

  • -d ： * 以分离模式运行容器。
  • -p 8080:8080 ： * 将容器的 8080 端口映射到主机上的 8080 端口。

3.访问 PlantUML 服务器

一旦容器运行，您就可以通过浏览器访问 PlantUML 服务器，网址是http://localhost:8080/plantuml 。

您应该看到 PlantUML 服务器的用户界面，它允许您键入 PlantUML 代码，并在运行中看到可视化表示。

4.测试您的 PlantUML 代码

在 PlantUML 服务器界面中：

  • 在 * 提供的文本区域中键入或粘贴您的 PlantUML 代码。
  • 当您键入或修改代码时，右侧的图表会自动更新。

5.停止容器（完成后）

当您测试完 PlantUML 图表后，您可能想停止正在运行的 Docker 容器。首先，确定容器 ID： 

docker ps

该命令会列出所有正在运行的容器。在列表中查找plantuml/plantuml-server:jetty 镜像，并记下容器 ID。

现在，你可以停止容器了： 

docker stop [CONTAINER_ID]

用运行中的 PlantUML 容器的 ID 替换[CONTAINER_ID] 。

6.移除容器（可选）

如果要完全移除容器： 

docker rm [CONTAINER_ID]

此命令会从机器上删除已停止的容器。

Edit in DokuwikiEdit in AsciidocEdit in Markdown
PlantUML 集成能力

多年来（自 2009 年起！），该工具已与多种平台和工具集成，为用户提供了灵活性和易用性。

以下是 PlantUML 集成能力的摘要。

  • 版本控制系统集成：
    • Git * ：
    • <zhref link='https://docs.gitlab.com/ee/administration/integration/plantuml.html'></zhref>GitLab * 有 * PlantUML * 集成， * 可以 * 直接在标记符文件中 * 查看 * UML * 图表。
    • Github * 有 * 一个动作，可以 * 生成 UML 图表并推送到您的版本 * 库中。

  • Documentation and Wiki Tools:
    • Confluence： * 使用 "PlantUML for Confluence" 插件，您可以将 UML 图表直接嵌入到您的 Confluence 页面。
    • Markdown：

  • Continuous Integration/Continuous Deployment (CI/CD)：
    • 一些 CI/CD 工具和平台允许自动生成和渲染 PlantUML 图表，作为构建或文档流程的一部分 * 。

  • 浏览器扩展：
    • 有一些浏览器扩展可以直接在网页中渲染 PlantUML 图表，这对于没有原生集成的平台尤其有用。

  • 其他工具：
    • Doxygen：
    • <zhref link='https://pypi.org/project/sphinxcontrib-plantuml/'></zhref>Sphinx * : Python * 文档生成器有集成PlantUML 图的 * 插件。
    • AsciiDoc * : * 通过asciidoctor-diagram 扩展，您可以在 AsciiDoc * 文档 * 中嵌入 * PlantUML 图。

  • 云平台：
    • 某些 云平台（如GitLab） * 提供了与 PlantUML 的原生集成，可以直接在版本库或维基中渲染图表。

  • Docker ：
    • Docker Image forPlantUML * ：有一个用于 PlantUML 的 Docker镜像，可以轻松地在容器化环境中运行 PlantUML，用于各种用途。

Edit in DokuwikiEdit in AsciidocEdit in Markdown
PlantUML 语言参考指南

如需深入了解 PlantUML，请参阅《PlantUML语言参考指南》。

该指南提供了对该语言从基本语法到高级技术的全面见解。它是所有用户的宝贵资源。请购买并扩展您的图表知识。

Privacy Policy      Advertise