目錄

摘要

一、安裝 PlantUML 插件

二、配置 PlantUML 運行環境

三、創建 PlantUML 文件

四、編寫 PlantUML 代碼

五、生成并查看圖表

六、自動生成類圖（重點新增）

6.1 從 Java 類生成類圖

6.2 類圖語法詳解

6.3 類圖高級技巧

七、常見問題及解決方案

八、進階技巧

總結

---

摘要

本文詳細介紹了如何在 IntelliJ IDEA 中文版環境中安裝和使用 PlantUML 插件，通過圖文結合的方式，幫助零基礎用戶快速掌握 UML 圖表的創建方法。內容涵蓋插件安裝、環境配置、文件創建、代碼編寫、圖表生成等核心步驟，并針對常見問題提供解決方案。特別新增了 "自動生成類圖" 的詳細教程，幫助用戶通過 Java 代碼快速生成 UML 類圖。

一、安裝 PlantUML 插件

1. 打開插件市場
   點擊菜單欄「文件」→「設置」（Windows/Linux）或「IntelliJ IDEA」→「偏好設置」（Mac），進入「插件」頁面。
2. 搜索并安裝
   在搜索框輸入「PlantUML integration」，點擊「安裝」按鈕，安裝完成后重啟 IDEA。

二、配置 PlantUML 運行環境

1. 進入配置頁面
   重啟后，再次打開「設置」→「工具」→「PlantUML」。
2. 選擇運行方式
   • 本地方式：若已下載 PlantUML.jar 文件，點擊「...」按鈕選擇文件路徑。
   • 在線方式：勾選「Use online server」，通過網絡生成圖表（需確保網絡暢通）。

三、創建 PlantUML 文件

1. 新建項目或打開已有項目
   可選擇「空項目」或「Java 項目」，本文以空項目為例。
2. 創建 PUML 文件
   在項目目錄右鍵→「新建」→「文件」，命名為demo.puml（后綴必須為.puml或.plantuml）。

四、編寫 PlantUML 代碼

在demo.puml文件中輸入以下示例代碼（以序列圖為例）：

plantuml

@startuml
actor 用戶
participant 系統
用戶 -> 系統: 發送請求
系統 --> 用戶: 返回響應
@enduml

語法說明：

• @startuml和@enduml：標識圖表開始和結束
• actor：定義參與者（如用戶、系統）
• ->和-->：表示消息流向（實線為請求，虛線為響應）

五、生成并查看圖表

1. 觸發圖表生成
   在代碼編輯區右鍵→「Diagrams」→「Show Diagram」（快捷鍵：Ctrl+Shift+U）。
2. 查看與操作圖表
   在彈出的窗口中可查看生成的 UML 圖，支持縮放、拖動、導出為圖片等操作。

六、自動生成類圖（重點新增）

6.1 從 Java 類生成類圖

1. 準備 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;}
   }
   

2. 生成 PlantUML 代碼
   在 Java 類編輯區右鍵→「Diagrams」→「Show PlantUML Diagram」。
3. 查看生成的代碼
   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 LightBlueBorderColor BlueArrowColor Red
  }class User {+ String name
  }
  @enduml
  

七、常見問題及解決方案

1. 插件未顯示
   • 檢查插件是否正確安裝并啟用
   • 嘗試重啟 IDEA 或清除緩存（「文件」→「Invalidate Caches」）
2. 圖表不顯示
   • 檢查代碼語法是否正確（如括號是否配對、箭頭方向是否正確）
   • 嘗試簡化代碼，逐步添加元素排查問題
   • 確認 PlantUML 運行環境配置無誤
3. 類圖生成失敗
   • 確保 Java 類沒有編譯錯誤
   • 在「設置」→「工具」→「PlantUML」中啟用「Generate diagram automatically」

八、進階技巧

1. 實時預覽
   安裝「PlantUML Preview」插件，實現代碼編輯時的實時圖表預覽。
2. 導出圖表
   在圖表窗口右鍵→「Export Diagram」，支持 PNG、SVG、PDF 等格式。

總結

通過以上步驟，您可以在 IDEA 中高效使用 PlantUML 創建各種 UML 圖表。建議從簡單的序列圖、類圖開始練習，逐步掌握更多語法和技巧。遇到問題時，可查閱PlantUML 官方文檔獲取更多幫助。