1. 前言PlantUML 是一个开源工具允许使用简单的文本描述语言来快速绘制 UML 图。它支持 UML 标准中的多种图表类型包括用例图、类图、对象图、序列图、组件图、部署图、状态图、活动图、定时图和需求图。PlantUML 的官网是 https://plantuml.com提供丰富的文档和社区支持。PlantUML 的核心特点包括纯文本定义UML 图通过简洁的文本代码描述易于版本管理和协作。多输出格式支持生成 PNG、SVG、PDF、PlantStory 等多种格式。丰富的图表类型覆盖 UML 标准中的核心图表类型。与开发工具深度集成支持在 Visual Studio Code、IntelliJ IDEA、Eclipse 等 IDE 中直接使用也可通过 LaTeXWith LaTeX、Confluence、GitHub 等集成。在 AI 编程时代文本方式设计 UML 的优势更加凸显AI 友好大语言模型擅长理解和生成文本用自然语言描述即可自动生成 UML 图无需手动拖拽。高效迭代修改文本代码即可更新图表比图形化工具更快。版本控制友好纯文本格式易于 Git 管理差分清晰。模板化与复用可以创建模板和宏快速生成常用模式。与 Mermaid 对比优势PlantUML 支持的 UML 类型更多如部署图、状态图的精细控制语法表达能力更强图表定制更灵活社区中有很多现成的宏库如 Arc4UT、JMRTD。劣势Mermaid 在 GitHub 和 GitLab 中原生支持无需额外插件即可渲染Mermaid 的学习曲线更平缓语法更接近自然语言PlantUML 依赖于 Java 运行时和插件支持。2. 用例图用例图用于描述系统的外部参与者与系统功能之间的关系帮助理解系统的功能边界和用户需求。startuml left to right direction actor Guest as g package Professional { actor Chef as c actor Food Critic as fc } package Restaurant { usecase Eat Food as UC1 usecase Pay for Food as UC2 usecase Drink as UC3 usecase Review as UC4 } fc -- UC4 g -- UC1 g -- UC2 g -- UC3 enduml用例图展示了餐厅系统中的参与者顾客、厨师、美食评论家与系统功能用餐、付款、饮酒、评价之间的关系。参与者通过箭头指向其交互的用例清晰表达了不同角色的功能需求。3. 组件图组件图描述系统的物理组件及其相互关系展示系统的模块化和依赖结构。startuml interface Data Access as DA DA - [ncuc-ncgw-service] [ncuc-ncgw-service] .. HTTP : use note left of HTTP : Web Service only note right of [ncuc-ncgw-service] A note can also be on several lines end note enduml组件图展示了Data Access接口与ncuc-ncgw-service组件之间的实现关系以及该组件对 HTTP 协议的依赖。注释说明 Web Service 的用途和组件的说明。组件图有助于理解系统的模块划分和依赖方向。4. 部署图部署图用于描述系统运行时硬件和软件的物理部署结构展示计算节点、设备和它们之间的连接关系。startuml skinparam packageStyle rectangle node Client as client { [Web Browser] as browser [Mobile App] as mobile } node Load Balancer as lb { [Nginx] } node App Server as server { package Service A as svcA { [Microservice A] } package Service B as svcB { [Microservice B] } } node DB Server as db { [PostgreSQL] as pg [Redis] as redis } client -- lb : HTTPS lb -- svcA : gRPC lb -- svcB : gRPC svcA -- pg : TCP svcB -- redis : TCP enduml部署图展示了一个典型的三层架构客户端层Web 浏览器和移动应用、应用服务器层微服务 A/B和数据存储层PostgreSQL 和 Redis通过负载均衡器Nginx分发请求。5. 时序图时序图又称序列图描述对象之间消息传递的时间顺序展现交互过程中的生命周期。startuml participant User as U participant Login Page as LP participant Auth Service as AS database User DB as DB U - LP : 输入用户名/密码 LP - AS : 提交登录请求 AS - DB : 查询用户信息 DB -- AS : 返回用户数据 alt 验证成功 AS -- LP : 返回 Token LP -- U : 跳转首页 note right of AS : 生成 JWT Token else 验证失败 AS -- LP : 返回错误信息 LP -- U : 显示错误提示 end U - LP : 请求资源 LP - AS : 验证 Token alt Token 有效 AS -- LP : 返回授权 LP -- U : 返回数据 else Token 过期 AS -- LP : 返回 401 LP -- U : 提示重新登录 end enduml时序图展示了一个完整的用户登录流程用户输入凭据后系统验证身份并返回 Token后续请求基于 Token 进行授权。通过alt片段处理成功和失败两种分支清晰表达了交互的时间顺序和条件逻辑。6. 活动图活动图描述业务流程或算法的工作流程类似于流程图支持并行分支和合并。startuml skinparam activityBackgroundColor #F0F0F0 skinparam activityBorderColor #333333 start :用户访问商品详情页; if (商品有库存?) then (是) :用户选择数量并下单; :系统创建订单; :系统扣减库存; fork :发送邮件确认; fork again :更新推荐系统; end fork :用户支付; if (支付成功?) then (是) :发货; :更新订单状态为已发货; else (否) :通知用户支付失败; :恢复库存; stop endif else (否) :显示缺货提示; :建议替代品; stop endif :用户确认收货; stop enduml活动图展示了电商下单流程从库存检查到创建订单再到并行执行的通知和推荐任务最后处理支付和发货逻辑。通过if/else和fork结构清晰地表达了条件判断和并行处理。7. 状态图状态图描述单个对象在其生命周期内经历的状态和状态之间的转换。startuml skinparam state { BackgroundColor White BorderColor Black ArrowColor #333333 } [*] -- 待审核 state 待审核 { [*] -- 提交中 提交中 -- 待审核 : 提交完成 } 待审核 -- 已通过 : 审核通过 待审核 -- 已拒绝 : 审核不通过 待审核 -- 待修改 : 要求修改 已通过 -- 执行中 : 开始执行 执行中 -- 已完成 : 执行成功 执行中 -- 执行失败 : 执行异常 执行失败 -- 待审核 : 重试 已拒绝 -- 待修改 : 补充材料 state 终止 as Terminated final 待修改 -- 待审核 : 重新提交 待修改 -- Terminated : 取消 enduml状态图描述了一个审核流程的状态流转从初始的待审核状态开始经过已通过、“已拒绝”、待修改等状态最终到达终止状态。其中包含了循环逻辑执行失败可重试和多个终止路径。8. 类图类图描述系统中类的静态结构包括类的属性、方法以及类之间的关系继承、实现、关联、聚合、组合、依赖。startuml abstract class Animal { String name int age {abstract} makeSound() : void {abstract} move() : void } class Dog { String breed Dog(name: String, breed: String) bark() : void fetch(item: String) : void } class Cat { Boolean indoor Cat(name: String, indoor: Boolean) meow() : void climb() : void } interface Swimmable { swim() : void } class Duck { String color Duck(name: String, color: String) quack() : void swim() : void } class Owner { String name ListAnimal pets Owner(name: String) addPet(pet: Animal) : void removePet(pet: Animal) : void } Animal |-- Dog Animal |-- Cat Animal |-- Duck Duck .. Swimmable : implements Owner 1 -- 0..* Animal : owns enduml类图展示了一个宠物管理系统的核心类结构Animal作为抽象基类定义了通用属性和方法Dog、Cat、Duck分别继承动物类并实现各自特有的行为Swimmable接口被Duck实现Owner类通过聚合关系管理多个宠物。这展示了继承、实现和聚合等多种 UML 关系。9. 包图包图描述软件系统的模块划分和包之间的依赖关系帮助组织大型代码库的结构。startuml package 核心层 as core { package 基础设施 { [Logger] [Config] } package 领域模型 { [User] [Order] [Product] } } package 服务层 as service { [UserService] [OrderService] [ProductService] } package 接口层 as api { package REST API { [UserController] [OrderController] [ProductController] } package 消息队列 { [EventPublisher] } } package 外部依赖 as external { [PostgreSQL] [Redis] [RabbitMQ] } core .. service : used by service .. api : exposed by api .. external : integrates note bottom of core : 领域逻辑和\n基础设施 note bottom of service : 业务规则编排 note bottom of api : 对外暴露的\n接口层 enduml包图展示了一个典型分层架构的模块组织核心层包含领域模型和基础设施服务层负责业务规则编排接口层暴露 REST API 和消息队列接口外部依赖包括数据库、缓存和消息中间件。包之间的依赖箭头清晰表达了分层架构的单向依赖原则。10. 结束语PlantUML 作为一个成熟的文本 UML 工具凭借其简洁的语法和强大的图表生成能力在软件开发中发挥着重要作用。尤其在 AI 编程日益普及的今天文本形式的 UML 设计能够与 AI 工具无缝协作——开发者只需用自然语言描述需求即可自动生成准确的 UML 图大幅提升了设计效率和沟通效果。无论是小型团队快速原型设计还是大型企业进行系统架构文档化PlantUML 都是一个值得尝试的工具。