无需登录 数据私有 本地保存

PlantUML轻量呈现 - UML图文本预览

12
0
0
0
PlantUML 轻量预览 UML图文本预览
快速示例: 时序图 类图 用例图 活动图 组件图 状态图 甘特图 思维导图
预览
100% |
输入 PlantUML 代码后自动预览
加载中...
常见问题与知识点
PlantUML 是一个开源工具,允许用户使用纯文本描述来生成 UML(统一建模语言)图表。它的核心优势包括:
文本驱动:使用简单直观的文本语法,无需拖拽操作,便于版本控制(如Git管理)。
多类型支持:支持时序图、类图、用例图、活动图、组件图、状态图、甘特图、思维导图等20+种图表类型。
自动化集成:可与CI/CD流水线、文档生成工具、IDE插件无缝集成。
轻量高效:纯文本描述,文件极小,渲染快速,适合团队协作和文档自动化。
使用非常简单:
1. 在左侧编辑器中输入或粘贴 PlantUML 文本代码。
2. 开启自动刷新后,预览图将在停止输入0.8秒后自动更新;也可点击刷新按钮手动触发。
3. 右侧预览区会实时显示生成的UML图表,支持缩放查看细节。
4. 可一键下载SVG矢量图,或复制代码生成分享链接
PlantUML 支持的图表类型非常丰富,覆盖了UML和非UML图表:
UML类图(类、接口、关系)|时序图(消息交互)|用例图(用户场景)|活动图(流程/业务逻辑)|组件图(系统组件)|状态图(状态机)|部署图(物理架构)|对象图定时图
非UML图:甘特图、思维导图、WBS工作分解结构、JSON/YAML可视化、网络图(nwdiag)、架构图等。
每个 PlantUML 图表以 @startuml 开头,以 @enduml 结尾。中间为图表描述文本。
示例(时序图):
@startuml
Alice -> Bob: Hello
Bob --> Alice: Hi there
@enduml
可以在 @startuml 后添加图表类型关键词,如 @startmindmap 表示思维导图,@startgantt 表示甘特图。
常见原因及解决方法:
1. 语法错误:检查是否遗漏 @startuml / @enduml,或箭头、关系符号是否正确。
2. 网络问题:本工具依赖在线渲染服务(Kroki),请确保网络连接正常。
3. 特殊字符:某些特殊字符可能需要转义,建议使用英文标点。
4. 渲染超时:极复杂的图表可能导致渲染超时,可尝试简化图表结构。
如持续出错,可复制代码到 PlantUML官方在线服务 进行对比排查。
PlantUML 提供了丰富的集成方式:
IDE插件:VS Code、IntelliJ IDEA、Eclipse等均有PlantUML插件,支持实时预览。
命令行:通过 plantuml.jar 可将 .puml 文件批量导出为PNG/SVG。
CI/CD:在GitHub Actions、GitLab CI中自动生成图表并嵌入文档。
文档工具:AsciiDoc、Markdown(部分渲染器)支持直接嵌入PlantUML代码块。
API服务:可自建Kroki服务或使用PlantUML Server,通过HTTP API渲染图表。
本工具使用 Kroki.io 开源渲染服务进行图表生成。您的PlantUML代码会通过HTTPS加密传输到Kroki服务器进行渲染,返回SVG图片。
Kroki服务不会永久存储您的代码,仅用于即时渲染。如需处理敏感架构信息,建议:
1. 自建Kroki服务(Docker一键部署)。
2. 使用本地PlantUML工具(如VS Code插件 + PlantUML本地jar)。
3. 对敏感名称进行脱敏处理后再使用在线预览。
时序图核心语法

-> 实线箭头,--> 虚线箭头,actor 定义角色,participant 定义参与者,note 添加注释。

类图关系符号

<|-- 继承,*-- 组合,o-- 聚合,--> 关联,..> 依赖。

样式与配色

使用 skinparam 全局调色,或 <style> 块精细控制,支持手写体、阴影、圆角等。

导出与分享

支持导出SVG矢量图(无损缩放),可嵌入网页、文档或PPT。生成分享链接便于团队协作。