PlantUML 在 IDEA 中文版中的安装与使用指南

摘要

[一、安装 PlantUML 插件](#一、安装 PlantUML 插件)

[二、配置 PlantUML 运行环境](#二、配置 PlantUML 运行环境)

[三、创建 PlantUML 文件](#三、创建 PlantUML 文件)

[四、编写 PlantUML 代码](#四、编写 PlantUML 代码)

五、生成并查看图表

六、自动生成类图（重点新增）

[6.1 从 Java 类生成类图](#6.1 从 Java 类生成类图)

[6.2 类图语法详解](#6.2 类图语法详解)

[6.3 类图高级技巧](#6.3 类图高级技巧)

七、常见问题及解决方案

八、进阶技巧

总结

摘要

本文详细介绍了如何在 IntelliJ IDEA 中文版环境中安装和使用 PlantUML 插件，通过图文结合的方式，帮助零基础用户快速掌握 UML 图表的创建方法。内容涵盖插件安装、环境配置、文件创建、代码编写、图表生成等核心步骤，并针对常见问题提供解决方案。特别新增了 "自动生成类图" 的详细教程，帮助用户通过 Java 代码快速生成 UML 类图。

一、安装 PlantUML 插件

打开插件市场
点击菜单栏「文件」→「设置」（Windows/Linux）或「IntelliJ IDEA」→「偏好设置」（Mac），进入「插件」页面。
搜索并安装
在搜索框输入「PlantUML integration」，点击「安装」按钮，安装完成后重启 IDEA。

二、配置 PlantUML 运行环境

进入配置页面
重启后，再次打开「设置」→「工具」→「PlantUML」。
选择运行方式
- 本地方式：若已下载 PlantUML.jar 文件，点击「...」按钮选择文件路径。
- 在线方式：勾选「Use online server」，通过网络生成图表（需确保网络畅通）。

三、创建 PlantUML 文件

新建项目或打开已有项目
可选择「空项目」或「Java 项目」，本文以空项目为例。
创建 PUML 文件
在项目目录右键→「新建」→「文件」，命名为demo.puml（后缀必须为.puml或.plantuml）。

四、编写 PlantUML 代码

在demo.puml文件中输入以下示例代码（以序列图为例）：

plantuml

复制代码

@startuml
actor 用户
participant 系统
用户 -> 系统: 发送请求
系统 --> 用户: 返回响应
@enduml

语法说明：

@startuml和@enduml：标识图表开始和结束
actor：定义参与者（如用户、系统）
->和-->：表示消息流向（实线为请求，虚线为响应）

五、生成并查看图表

触发图表生成
在代码编辑区右键→「Diagrams」→「Show Diagram」（快捷键：Ctrl+Shift+U）。
查看与操作图表
在弹出的窗口中可查看生成的 UML 图，支持缩放、拖动、导出为图片等操作。

六、自动生成类图（重点新增）

6.1 从 Java 类生成类图

准备 Java 类文件
在项目中创建或打开一个 Java 类，例如：

java

复制代码

package com.example;

public class User {
    private String name;
    private int age;
    
    public User(String name, int age) {
        this.name = name;
        this.age = age;
    }
    
    public String getName() {
        return name;
    }
    
    public void setName(String name) {
        this.name = name;
    }
}

生成 PlantUML 代码
在 Java 类编辑区右键→「Diagrams」→「Show PlantUML Diagram」。

查看生成的代码
IDEA 会自动创建一个.puml文件并填充类图代码：

plantuml

复制代码

@startuml
class User {
  - String name
  - int age
  + User(String name, int age)
  + String getName()
  + void setName(String name)
}
@enduml

6.2 类图语法详解

类定义 ：class 类名 { ... }
访问修饰符 ：-（private）、#（protected）、+（public）
属性和方法 ：类型名称 或 返回类型方法名(参数)

关系表示 ：

plantuml

复制代码

@startuml
class User {
  + String name
}

class Order {
  + int orderId
}

// 关联关系
User "1" -- "*" Order : 拥有

// 继承关系
class VIPUser extends User {
  + String vipLevel
}

// 实现接口
interface Payable {
  + void pay()
}

Order implements Payable
@enduml

6.3 类图高级技巧

隐藏属性和方法 ：

plantuml

复制代码

@startuml
class User <<hide all>> {
  + String name
  + void showInfo()
}
@enduml

自定义样式 ：

plantuml

复制代码

@startuml
skinparam class {
  BackgroundColor LightBlue
  BorderColor Blue
  ArrowColor Red
}

class User {
  + String name
}
@enduml

七、常见问题及解决方案

插件未显示
- 检查插件是否正确安装并启用
- 尝试重启 IDEA 或清除缓存（「文件」→「Invalidate Caches」）
图表不显示
- 检查代码语法是否正确（如括号是否配对、箭头方向是否正确）
- 尝试简化代码，逐步添加元素排查问题
- 确认 PlantUML 运行环境配置无误
类图生成失败
- 确保 Java 类没有编译错误
- 在「设置」→「工具」→「PlantUML」中启用「Generate diagram automatically」

八、进阶技巧

实时预览
安装「PlantUML Preview」插件，实现代码编辑时的实时图表预览。
导出图表
在图表窗口右键→「Export Diagram」，支持 PNG、SVG、PDF 等格式。

总结

通过以上步骤，您可以在 IDEA 中高效使用 PlantUML 创建各种 UML 图表。建议从简单的序列图、类图开始练习，逐步掌握更多语法和技巧。遇到问题时，可查阅PlantUML 官方文档获取更多帮助。