PlantUML 快速入门指南

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

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

本地安装程序

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

Java:

GraphViz

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

WARNING
 This translation need to be updated. 
WARNING

命令行操作

对于那些熟悉命令行界面或打算将 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,进一步提高您的图表绘制能力。

WARNING
 This translation need to be updated. 
WARNING

使用 Docker

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

说明

1.拉取 PlantUML 的 Docker 镜像

Docker Hub 上有 PlantUML 的官方Docker 镜像

docker pull plantuml/plantuml-server:jetty

该命令使用 Jetty 作为服务器拉取 PlantUML 服务器镜像

2.运行 PlantUML 服务器容器

只要下载了镜像,就可以运行基于此镜像的容器。

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

该命令执行以下操作:

3.访问 PlantUML 服务器

只要容器正在运行中,您就可以通过浏览器访问 PlantUML 服务器,网址是http://localhost:8080/plantuml

您应该看到 PlantUML 服务器的用户界面,它允许您输入 PlantUML 代码,并且可以实时地看到可视化表示。

4.测试您的 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]

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

PlantUML 集成能力

多年来(自 2009 年起!),该工具已与多种平台和工具集成,为用户提供了灵活性和易用性。

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

PlantUML 语言参考指南

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

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