PlantUML
PlantUML 是用文本描述生成 UML 与非 UML 图表的工具,可在命令行、编辑器、构建流程或服务器中输出 PNG、SVG、PDF、LaTeX 和文本图,并支持多种布局引擎与集成方式。
适合做什么
PlantUML 适合把序列图、类图、组件图、部署图、状态图、甘特图、思维导图等内容写成可审查和版本化的文本,再自动生成文档图片。它不替代架构评审,也不应让公开渲染服务无约束读取本地文件或内网资源。
当前版本与构建
1.2026.6 于 2026-06-08 发布,提供标准与多许可证 JAR、Java 8 包、Linux/Windows/macOS 原生构建和 JavaScript 构建。Java JAR 推荐 Java 11+;部分图表仍依赖 Graphviz,具体取决于图表类型和布局引擎。
服务器、元数据与许可边界
默认安全模式允许本地文件和 URL 访问,不适合直接处理公网输入;应根据场景使用 INTERNET、ALLOWLIST 或 SANDBOX。输出图可能嵌入完整源码元数据。项目提供多许可证构建,发布工具包时应保存所选文件和许可,生成图本身不自动继承工具许可。
维护记录
本页于 2026-08-06 根据 PlantUML 1.2026.6 发布资产、Java/Graphviz 要求、命令行输出、源码元数据、安全配置和多许可证 FAQ 复核。
选择下载方式
下载前请核对资源版本和授权范围。本站不提供破解软件及未经授权的资料。
PlantUML 1.2026.6 本地渲染与安全配置教程
下面使用 JAR 或原生构建生成一张序列图和一张需要布局引擎的测试图,输出 PNG/SVG,检查源码元数据,并为不可信输入设置受限安全模式。
安装前准备
- 标准 JAR 准备 Java 11+,若项目只能使用 Java 8 应选择对应兼容包;原生构建需按系统与 CPU 架构匹配。
- 建立独立输入和输出目录,不让首次批量命令扫描代码仓库根目录或覆盖文档中的唯一图片。
- 服务端、CI 或协作者提交的图表属于不可信输入,先确定允许读取的本地路径、远程资源和输出格式。
安装步骤
- 01
选择 1.2026.6 构建与许可证
通用场景可选标准 JAR,特定平台可用原生 ZIP,浏览器集成可用 JavaScript 构建;分发时核对文件名中的 GPL、LGPL、ASL、EPL、BSD 或 MIT 许可变体。
- 02
验证 Java 与基本渲染
检查 Java 版本后生成最小序列图,确认命令退出码和 PNG 输出;在 CI 中使用语法检查与失败即停参数,避免错误图被当成成功产物。
- 03
检查 Graphviz 与输出目录
再渲染类图或组件图,必要时测试 dot 路径;显式指定输出目录并用样例文件确认不会覆盖源文件或写入仓库外目录。
快速上手
- 01
编写最小图表源码
用 start/end 标记创建参与者和一条消息,保持图表文本进入版本控制,生成文件作为可重建产物而非唯一来源。
- 02
输出 PNG 与 SVG 并比较
PNG 适合直接展示,SVG 适合缩放和文档集成;对含链接或用户文本的 SVG 做目标环境安全检查,不把矢量格式等同于纯图片。
- 03
设置安全配置和元数据策略
不可信输入使用受限安全模式与 allowlist;若图表源码含内网结构或密钥名称,生成公开图片时关闭源码元数据并检查导出内容。
使用建议
- PlantUML 默认会把预处理后的图表源码编码进 PNG/SVG 元数据,便于恢复编辑,但公开图可能因此泄露隐藏信息。
- include、远程素材和本地路径能改善复用,也会扩大服务器文件读取和网络访问面,应配合安全配置使用。
- 在线服务器、编辑器插件和本地 JAR 的数据路径不同,敏感架构图优先在受控本地或内部服务生成。
故障排查与卸载方法
序列图能生成但类图失败怎么办?
检查 Graphviz 是否安装、dot 是否可执行及路径配置,使用测试命令查看实际位置;不要为了渲染给整个构建进程管理员权限。
CI 中有语法错误但仍生成部分图片怎么办?
启用语法检查和 fail-fast 策略,使用明确退出码阻断发布;先在临时输出目录渲染,全部成功后再替换站点资产。
- 保留源码、配置和许可记录归档图表源码、主题、允许列表、构建版本和所选许可证,确认不再需要从公开图片元数据恢复敏感源码。
- 移除 JAR、原生包与服务配置删除工具包、缓存、容器或编辑器集成,撤销服务器端口、文件路径与 URL 允许列表,并清理临时渲染目录。
常见问题
PlantUML 必须安装 Java 和 Graphviz 吗?
标准 JAR 建议使用 Java 11 或更高版本,另有 Java 8 特殊包和部分原生构建。Graphviz 只用于部分图表,Windows 近期版本内含精简 dot;Linux/macOS 需要时应单独配置。
生成的图片会受 PlantUML 软件许可限制吗?
不会因为生成工具自动受 GPL、LGPL、Apache、EPL 或 MIT 约束,图像权利通常跟随你编写的图表源码及其中素材。不同 JAR 有不同许可证,分发工具本身时要选对构建。
为什么不应把默认安全模式直接用于公网服务?
LEGACY 默认模式允许访问本地文件和 URL。处理不可信图表时应选择 INTERNET、ALLOWLIST 或 SANDBOX,并限制本地路径和远程资源,防止 include 等语法读取不应暴露的数据。
下载时需要提取码吗?
夸克网盘无需提取码;百度网盘所需的四位提取码会直接显示在下载入口旁。
