PlantUML 快速入门指南
对于有兴趣初步探索 PlantUML 的人,我们建议使用直接支持 PlantUML 的在线平台。 在我们的在线服务器上进行探索。
本地安装程序
在试用过在线版本后,如果您考虑更全面的本地环境,建议您在本地安装 PlantUML。安装前,请确保满足以下前提条件:
Java:
- 检查是否已安装 Java * :
`java -version`。 * 所需的最低版本为 Java 8。
- 如果未安装,请从Java 官方网站下载并安装,或通过软件包管理器(如 Ubuntu 的
apt、macOS 的brew等)下载并安装。
WARNING
This translation need to be updated. WARNING
命令行操作
对于那些熟悉命令行界面或打算将 PlantUML 与脚本或文档平台集成的用户,PlantUML 提供了方便的命令行语法。请按照以下步骤操作:
- 撰写文本文件:记录您的 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
该命令执行以下操作:
-d:以分离模式运行容器。-p 8080:8080:将容器的 8080 端口映射到主机上的 8080 端口。
http://localhost:8080/plantuml 。
您应该看到 PlantUML 服务器的用户界面,它允许您输入 PlantUML 代码,并且可以实时地看到可视化表示。
4.测试您的 PlantUML 代码
在 PlantUML 服务器界面中:
- 在提供的文本区域中输入或粘贴您的 PlantUML 代码。
- 当您输入或修改代码时,右侧的图表应该会自动更新。
docker ps
该命令会列出所有正在运行的容器。在列表中查找
plantuml/plantuml-server:jetty 镜像,并记下容器 ID。
现在,你可以停止容器了:
docker stop [CONTAINER_ID]
用运行中的 PlantUML 容器的 ID 替换
[CONTAINER_ID] 。
6.移除容器(可选)
如果要完全移除容器:
docker rm [CONTAINER_ID]
此命令会从机器上删除已停止的容器。
PlantUML 集成能力
多年来(自 2009 年起!),该工具已与多种平台和工具集成,为用户提供了灵活性和易用性。
以下是 PlantUML 集成能力的摘要。
- IDE集成 * :
- IntelliJ IDEA:Plugins like "PlantUML integration" 可让您直接在 IDE 中查看和编辑 PlantUML 图表。
- <ziref link='eclipse'></ziref>Eclipse * :
- </zhref>VS * <zhref link='https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml'>Code:
- 其他 * :
- 版本控制系统集成:
- Documentation and Wiki Tools:
- Confluence: * 使用 "PlantUML for Confluence" 插件,您可以将 UML 图表直接嵌入到您的 Confluence 页面。
- Markdown:
- Continuous Integration/Continuous Deployment (CI/CD):
- 一些 CI/CD 工具和平台允许自动生成和渲染 PlantUML 图表,作为构建或文档流程的一部分 * 。
- 浏览器扩展:
- 有一些浏览器扩展可以直接在网页中渲染 PlantUML 图表,这对于没有原生集成的平台尤其有用。
- 其他工具:
- 云平台:
- 某些 云平台(如GitLab) * 提供了与 PlantUML 的原生集成,可以直接在版本库或维基中渲染图表。