使用 AI + PlantUML 自动生成项目架构图（超详细教程）

使用 AI + PlantUML 自动生成项目架构图（超详细教程）

前言

现在很多程序员其实不是不会画 UML 图，而是：

  • 手动画图太麻烦
  • 项目一复杂就懒得维护
  • 改一次代码还得重新调整布局

而现在完全可以：

1
2
3
4
5
6
7
8
9
项目代码
  ↓
AI 自动分析
  ↓
生成 PlantUML
  ↓
在线网站渲染
  ↓
自动生成架构图

整个流程几分钟就能完成。

这篇文章就带你完整体验：

  • 什么是 PlantUML
  • 如何让 AI 自动分析项目
  • 如何生成 UML 图
  • 如何在线渲染图片
  • 如何写高质量 Prompt

什么是 PlantUML？

PlantUML 是一个基于文本生成 UML 图的工具。

和传统拖拽式 UML 工具不同：

PlantUML 通过代码描述结构，然后自动生成图片。

例如：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
@startuml

class User {
  +id: Long
  +name: String
}

class Order {
  +id: Long
  +price: Double
}

User --> Order : create

@enduml

直接就能生成类图。

PlantUML 能做什么？

PlantUML 支持很多类型的图。

常见的有：

类型 用途
类图 展示类之间关系
时序图 展示接口调用流程
用例图 展示系统功能
ER 图 数据库关系
流程图 业务流程
架构图 微服务结构

对于后端开发来说：

最常用的是：

  • 类图
  • 时序图
  • 系统架构图
  • 数据库 ER 图

为什么 AI + PlantUML 特别强？

因为 AI 很适合：

1
2
3
4
5
阅读代码
↓
理解结构
↓
输出文本

而 PlantUML 正好是：

1
2
3
输入文本
↓
自动生成图片

所以两者天然适配。

现在已经可以做到：

1
2
3
4
5
6
7
8
9
SpringBoot 项目
↓
AI 自动分析
↓
自动生成 PlantUML
↓
网站自动渲染
↓
直接导出图片

很多情况下甚至不需要真正懂 UML。

准备工具

AI 工具

推荐：

  • ChatGPT
  • Claude
  • Gemini

其中：

  • Claude 更适合分析大型项目
  • ChatGPT 更适合生成 UML
  • Gemini 对 Google 技术栈支持不错

PlantUML 在线网站

官方：

1
https://plantuml.com

在线编辑器（推荐）：

1
https://www.planttext.com

PlantText 特别方便：

  • 左边写代码
  • 右边实时出图
  • 不需要安装环境

非常适合新手。

方法一：AI 分析项目结构

例如项目：

1
2
3
4
5
6
src
 ├── controller
 ├── service
 ├── mapper
 ├── entity
 └── config

直接告诉 AI：

1
请根据下面 SpringBoot 项目结构生成 PlantUML 类图

AI 就会自动分析模块关系。

方法二：直接让 AI 分析代码

例如：

1
2
3
4
5
6
7
@RestController
public class UserController {

    @Autowired
    private UserService userService;

}

AI 可以自动识别：

  • Controller
  • Service
  • Repository
  • Entity

并生成依赖关系。

方法三：直接分析 GitHub 项目（最强）

这个是目前最方便的方式。

例如：

1
2
3
4
请分析这个 SpringBoot 项目，
并生成系统架构图的 PlantUML

https://github.com/xxx/project

AI 会自动：

  • 分析目录结构
  • 判断模块关系
  • 理解调用流程
  • 自动生成 UML

实战：生成类图

示例项目结构

1
2
3
4
5
6
7
8
9
10
11
controller
 └── UserController

service
 └── UserService

repository
 └── UserRepository

entity
 └── User

给 AI 的 Prompt

1
2
3
4
5
6
7
8
9
请根据下面 SpringBoot 项目结构，
生成 PlantUML 类图。

要求：

1. 展示 Controller、Service、Repository、Entity
2. 使用 package 分组
3. 展示依赖关系
4. 输出完整 PlantUML

AI 生成结果

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
@startuml

package controller {
  class UserController
}

package service {
  class UserService
}

package repository {
  class UserRepository
}

package entity {
  class User
}

UserController --> UserService
UserService --> UserRepository
UserRepository --> User

@enduml

如何生成图片？

打开：

1
https://www.planttext.com

然后：

  1. 删除默认代码
  2. 粘贴 AI 生成的 PlantUML
  3. 右侧自动生成图片

完成。

实战：生成时序图

例如：

1
2
3
4
5
6
7
8
9
10
11
用户下单流程：

用户
↓
Controller
↓
Service
↓
库存服务
↓
支付服务

让 AI 生成：

1
2
3
4
5
6
7
8
9
10
@startuml

actor User

User -> OrderController : createOrder()
OrderController -> OrderService : create()
OrderService -> StockService : lockStock()
OrderService -> PaymentService : pay()

@enduml

这种特别适合：

  • 技术文档
  • 面试项目
  • 系统设计

实战：生成数据库 ER 图

直接把 SQL 给 AI：

1
2
3
4
CREATE TABLE user (
  id BIGINT,
  name VARCHAR(50)
);

AI 就能自动生成 ER 图。

实战：生成微服务架构图

例如：

1
2
3
4
5
gateway
auth-service
user-service
order-service
mq-service

AI 可以生成：

  • 网关结构
  • 服务调用关系
  • MQ 流程
  • Redis 结构
  • MySQL 结构

特别适合：

  • SpringCloud
  • Kubernetes
  • 微服务项目

推荐 Prompt（非常重要）

很多人 AI 效果差。

其实是 Prompt 不够明确。

类图 Prompt

1
2
3
4
5
6
7
8
9
10
请分析下面 Java 项目代码，
生成 PlantUML 类图。

要求：

1. 使用 package 分类
2. 展示继承关系
3. 展示依赖关系
4. 忽略 getter/setter
5. 输出完整 PlantUML

时序图 Prompt

1
2
3
4
5
6
7
8
9
请根据下面接口调用流程，
生成 PlantUML 时序图。

要求：

1. 使用 actor
2. 展示调用顺序
3. 使用 activate/deactivate
4. 输出完整 PlantUML

系统架构图 Prompt

1
2
3
4
5
6
7
8
9
10
11
请分析下面 SpringCloud 项目，
生成系统架构图。

要求：

1. 展示网关
2. 展示微服务
3. 展示 Redis
4. 展示 MySQL
5. 展示 MQ
6. 使用 PlantUML

为什么越来越多人用 PlantUML？

传统 UML：

1
2
3
4
拖组件
调位置
拉线
改布局

非常浪费时间。

而 PlantUML：

1
2
修改代码
重新生成

效率高太多了。

尤其配合 AI 后：

很多时候已经不需要自己手动画图。

适合哪些人？

特别适合：

  • Java 后端开发
  • SpringBoot 开发
  • 微服务开发
  • 学生毕设
  • 技术博主
  • 架构师
  • 开源项目作者

尤其毕业设计特别好用。

因为：

  • AI 帮你分析
  • AI 帮你生成 UML
  • AI 帮你出图

文档质量会直接提升一个档次。

总结

现在最舒服的工作流其实就是：

1
2
3
4
5
6
7
8
9
项目代码
↓
AI 自动分析
↓
生成 PlantUML
↓
在线网站渲染
↓
导出图片

整个过程：

  • 不需要手动画图
  • 不需要复杂 UML 软件
  • 不需要调整布局

只需要：

1
2
3
复制
粘贴
生成

这也是为什么越来越多程序员开始：

  • 用 AI 写文档
  • 用 AI 生成架构图
  • 用 PlantUML 管理系统设计

因为效率真的高太多了。

相关推荐

PlantUML 官方

1
https://plantuml.com

PlantText 在线编辑器

1
https://www.planttext.com

Mermaid

1
https://mermaid.js.org

Draw.io

1
https://app.diagrams.net

结尾

以前很多人觉得：

1
UML 太复杂

但现在其实已经变成：

1
AI 帮你写 UML

PlantUML + AI 基本已经属于：

1
程序员文档效率神器