通过代码创建
专业UML图

PlantUML让创建UML图变得简单高效。只需编写简单的文本描述,即可生成各种高质量的UML图。

PlantUML 示例

源代码

@startuml
class User {
    -id: int
    -name: string
    -email: string
    +register()
    +login()
}

class Order {
    -orderId: int
    -items: Item[]
    +createOrder()
    +cancelOrder()
}

User "1" -- "*" Order : places
@enduml

生成的UML图

PlantUML生成的类图示例

什么是PlantUML?

PlantUML是一款开源工具,支持通过简单的文本描述语言来创建各种UML图。它的主要目标是帮助软件开发团队更高效地创建和维护系统文档,通过代码化的方式管理UML图,使图表与代码保持同步。

PlantUML的工作原理是将文本描述转换为标准的UML图形。用户只需编写简单的文本代码,PlantUML就能自动生成对应的UML图,包括类图、时序图、用例图、活动图、组件图、状态图、对象图等多种类型。

作为一种文本驱动的建模工具,PlantUML具有许多优势。它可以轻松集成到各种开发工具和工作流中,支持版本控制,便于团队协作。此外,由于图表是从文本生成的,因此可以很容易地进行修改、更新和维护。

PlantUML基于Graphviz技术,它负责处理图形的布局和渲染。这使得生成的图表具有专业的外观和清晰的结构。无论是在软件开发过程中进行设计、文档编写,还是在团队沟通中进行可视化表达,PlantUML都是一个强大而灵活的工具。

除了标准的UML图,PlantUML还支持其他类型的图表,如思维导图、架构图、JSON数据可视化等,进一步扩展了其应用场景。

PlantUML的特点

文本驱动

通过简单的文本描述创建UML图,无需使用图形界面。这使得图表可以像代码一样进行版本控制和管理。

多种图表类型

支持类图、时序图、用例图、活动图、组件图、状态图等多种UML图类型,满足不同的建模需求。

广泛的工具集成

可以集成到各种开发工具中,如Eclipse、IntelliJ IDEA、VS Code、Vim等,方便在开发过程中使用。

团队协作友好

由于图表以文本形式存在,可以轻松地进行版本控制和团队协作,避免了传统图形工具的冲突问题。

自定义样式

可以通过简单的配置来自定义图表的样式,包括颜色、字体、线条样式等,使图表符合项目的视觉风格。

跨平台支持

在Windows、macOS、Linux等多种操作系统上都能使用,并且支持多种输出格式,如PNG、SVG、LaTeX等。

安装指南

Windows

  1. 1

    安装Java

    从Oracle官网或OpenJDK下载并安装Java SE Development Kit (JDK) 8或更高版本。

  2. 2

    下载PlantUML

    从官方网站下载最新版本的PlantUML JAR文件。

  3. 3

    安装Graphviz (可选)

    从Graphviz官网下载并安装,以支持更复杂的图表布局。

  4. 4

    设置环境变量

    将Java和Graphviz (如果安装了) 添加到系统PATH环境变量中。

  5. 5

    测试安装

    打开命令提示符,运行java -jar plantuml.jar -version检查是否安装成功。

macOS

  1. 1

    安装Java

    通过Homebrew安装Java:brew install openjdk

  2. 2

    下载PlantUML

    从官方网站下载最新版本的PlantUML JAR文件。

  3. 3

    安装Graphviz (可选)

    使用Homebrew安装:brew install graphviz

  4. 4

    创建别名

    在~/.zshrc或~/.bashrc中添加别名:alias plantuml='java -jar /path/to/plantuml.jar'

  5. 5

    测试安装

    打开终端,运行plantuml -version检查是否安装成功。

Linux

  1. 1

    安装Java

    使用包管理器安装OpenJDK:sudo apt-get install openjdk-11-jdk (Ubuntu/Debian) 或 sudo dnf install java-11-openjdk-devel (Fedora)

  2. 2

    下载PlantUML

    从官方网站下载最新版本的PlantUML JAR文件。

  3. 3

    安装Graphviz (可选)

    使用包管理器安装:sudo apt-get install graphviz (Ubuntu/Debian) 或 sudo dnf install graphviz (Fedora)

  4. 4

    创建可执行脚本

    创建一个脚本文件,例如~/bin/plantuml,内容为java -jar /path/to/plantuml.jar,并赋予执行权限。

  5. 5

    测试安装

    打开终端,运行plantuml -version检查是否安装成功。

兼容性

工具/环境 支持情况 说明
IDE集成
完全支持 支持主流IDE如Eclipse、IntelliJ IDEA、VS Code、NetBeans等,可通过插件集成
Markdown编辑器
完全支持 支持在Markdown中嵌入PlantUML代码,如VS Code的Markdown Preview Enhanced、Typora等
Wiki系统
完全支持 支持Confluence、MediaWiki等Wiki系统,可通过插件实现PlantUML渲染
版本控制系统
完全支持 完美支持Git、SVN等,UML图以文本形式存储,便于版本控制
文档工具
完全支持 支持Docx、LaTeX、PDF等文档格式生成,可通过各种工具集成
移动应用
部分支持 有适用于iOS和Android的移动应用,支持查看和编辑PlantUML图表

免费与开源

PlantUML是一款完全免费的开源软件,采用MIT许可证发布。这意味着你可以自由地使用、修改和分发它,无需支付任何费用。

作为开源项目,PlantUML拥有活跃的社区支持,不断更新和改进。你可以在GitHub上找到其源代码,并参与贡献。

最新新闻

PlantUML 1.2025.0版本发布
2025年6月10日

PlantUML 1.2025.0版本发布

PlantUML团队很高兴地宣布1.2025.0版本发布。这个新版本带来了对Mermaid图表的初步支持,改进了时序图的布局算法,并修复了多个长期存在的问题。

阅读更多
PlantUML官方VS Code扩展更新
2025年5月22日

PlantUML官方VS Code扩展更新

PlantUML官方VS Code扩展已更新至3.0.0版本,新增实时预览、自动补全和语法高亮等功能,大大提升了在VS Code中使用PlantUML的体验。

阅读更多
PlantUML加入开源软件联盟
2025年4月15日

PlantUML加入开源软件联盟

PlantUML项目已正式加入开源软件联盟,这将有助于项目的长期发展,并促进与其他开源项目的合作与交流。

阅读更多

准备开始使用PlantUML了吗?

下载PlantUML并开始通过代码创建专业的UML图。提高你的软件开发效率,让图表与代码保持同步。