Eclipse 外掛開發：整合 FindBugs 靜態分析工具提升代碼品質

問題背景

代碼完成測試後提交正式環境，隱藏錯誤在運行時才被發現，修復成本極高。FindBugs (開源靜態分析工具) 可掃描「Bug Patterns」——極可能為錯誤的代碼模式，助你提早發現問題，提升代碼健壯度與系統可靠性。

環境準備

• JDK 1.5.0+
• Eclipse 3.1.1+
• FindBugs 0.9.4 (https://findbugs.sourceforge.net/)
• Eclipse Plugin for FindBugs 0.0.17 (https://findbugs.sourceforge.net/downloads.html)

外掛管理最佳實踐：Link 方式隔離外掛

1. Eclipse 安裝目錄設為 %ECLIPSE_HOME% (如 E:\OpenSource\Eclipse\)。
2. 在 %ECLIPSE_HOME% 下建立 PlugInsNew\ 目錄。
3. 每個外掛獨立子目錄 (如 PlugInsNew\XYZ\eclipse\features、plugins)。
4. 在 %ECLIPSE_HOME%\links\ 建立 XYZ.link，內容：path=../PlugInsNew/XYZ (相對路徑利於團隊共享與整體遷移)。
5. 啟用：將 .link 檔放入 links 目錄；停用：移除 .link 檔並刪除外掛目錄，重啟 Eclipse。

驗證安裝

重啟 Eclipse → Help → About Eclipse SDK → Plug-in Details，可見 FindBugs Plug-in 0.0.17 (Provider: FindBugs Project)。

FindBugs 核心概念

• Bug Patterns：極可能為錯誤的代碼模式庫 (如空指針解引用、資源洩漏、同步錯誤等)。
• 掃描目標：Java 位元碼 (.class)，不需原始碼。
• 平台獨立，需 256MB+ 記憶體，大型專案需更多。

Eclipse 整合使用流程

1. 開啟 Bug Details 視圖

Window → Show View → Other... → FindBugs → BugDetails

2. 執行掃描

Package Explorer 或 Navigator 中右鍵專案 → Find Bugs → Find Bugs。進度對話框顯示掃描狀態。

3. 查看結果

• Problems 視圖：新增警告條目，雙擊跳轉對應代碼行。
• 編輯器標記欄：警告圖示標註問題行，滑鼠懸停顯示提示。
• Bug Details 視圖：Problems 條目右鍵 Show Bug Details，或點擊編輯器標記圖示，顯示詳細說明與修正建議。

4. 修正範例

原代碼直接回傳內部陣列引用：

public class Test {
    private String[] name;
    public String[] getName() { return name; }
    public void setName(String[] name) { this.name = name; }
}

FindBugs 警告：EI_EXPOSE_REP (暴露內部可變狀態)。修正為回傳防禦性副本：

public String[] getName() { String[] temp = name; return temp; }
public void setName(String[] name) { String[] temp = name; this.name = temp; }

重新掃描，警告消失。

進階配置

專案右鍵 → Properties → FindBugs：

• Run FindBugs Automatically：勾選後配合 Eclipse 自動建置，儲存檔案即時掃描。
• Minimum priority to report：Low/Medium/High 三級過濾 (類 Log4j 級別)。
• Enable bug categories：依類別啟用/停用 (Correctness、Performance、Internationalization、Multithreaded correctness、Style、Malicious code vulnerability)。
• Select bug patterns：精細控制具體檢查規則 (Bug code、Detector 名稱/描述)。

總結與建議

• FindBugs 功能強大，能顯著提升代碼品質與安全性，建議納入日常開發流程或 Ant/Maven 持續建置腳本。
• 立即對現有專案執行掃描，發現並修復潛在缺陷。
• 定期更新 FindBugs 核心與 Eclipse 外掛，獲取最新 Bug Pattern 庫。