讓開發(fā)自動化: 用 Eclipse 插件提高代碼質量 在 Eclipse 中使用 5 個有用的插件來自動化代碼質量分析

? 將此頁作為電子郵件發(fā)送 ? ?

級別: 初級

Paul Duvall (paul.duvall@stelligent.com), CTO, Stelligent Incorporated

2007 年 1 月 29 日

如果能在構建代碼前發(fā)現(xiàn)代碼中潛在的問題會怎么樣呢？很有趣的是，Eclipse 插件中就有這樣的工具，比如 JDepend 和 CheckStyle，它們能幫您在軟件問題暴露前發(fā)現(xiàn)這些問題。在 讓開發(fā)自動化的本期文章中，自動化專家 Paul Duvall 將帶來一些關于 Eclipse 插件的例子，您可以安裝、配置和使用這些靜態(tài)分析插件，以便在開發(fā)生命周期的早期預防問題。

關于本系列 作為一名開發(fā)人員，我們的工作就是為終端用戶將過程自動化；然而，我們當中有很多人卻忽視了將我們自己的開發(fā)過程自動化的機會。為此，我編寫了讓開發(fā)自動化 這個系列的文章，專門探索軟件開發(fā)過程自動化的實際應用，并教您何時 以及如何 成功地應用自動化。

開發(fā)軟件時，我的主要目標之一是：要么防止將缺陷引入代碼庫，要么限制缺陷的生存期；換言之，要盡早找到缺陷。很顯然，越是了解如何編寫更好的代碼以及如何有效測試軟件，就越能及早地捕捉到缺陷。我也很想要一張能發(fā)現(xiàn)潛在缺陷的安全之網(wǎng)。

在本系列 八月份 的那期文章中，我得出了這樣的結論：將檢驗工具集成到構建過程（例如，使用 Ant 或 Maven）中，能夠建立起一種尋找潛在缺陷的方法。盡管這種方法使一致性成為可能并超越了 IDE，但它也有一點反作用。必須在本地構建軟件或等待 Continuous Integration 構建的運行。如果使用 Eclipse 插件，就可以在通過 Continuous Integration 構建或集成前 發(fā)現(xiàn)一些這樣的沖突。這就促成了我稱為漸進編程 的編程方式，在這種方式下，允許在編碼過程中進行一定程度的質量檢驗 —— 再也不能比這個更早了！

本文涵蓋了我所認為的 “五大” 代碼分析領域：

• 編碼標準
• 代碼重復
• 代碼覆蓋率
• 依賴項分析
• 復雜度監(jiān)控

可以用接下來的幾個靈活的 Eclipse 插件來揭示這些分析領域：

• CheckStyle：用于編碼標準
• PMD 的 CPD：幫助發(fā)現(xiàn)代碼重復
• Coverlipse：測量代碼覆蓋率
• JDepend：提供依賴項分析
• Eclipse Metric 插件：有效地查出復雜度

Eclipse 不是您的構建系統(tǒng) 使用 Eclipse 插件與您將這些檢驗工具用于構建過程并不矛盾。事實上，您想要確保的是：下列使用 Eclipse 插件的規(guī)則就是應用到構建過程中的規(guī)則。

安裝 Eclipse 插件

安裝 Eclipse 插件再簡單不過了，只需要幾個步驟。在開始之前，最好把該插件下載站點的 URL 準備好。表 1 是本文用到的插件的列表：

表 1. 代碼改進插件和相應的下載站點 URL

工具	目的	Eclipse 插件的 URL
CheckStyle	編碼標準分析	http://eclipse-cs.sourceforge.net/update/
Coverlipse	測試代碼覆蓋率	http://coverlipse.sf.net/update
CPD	復制/粘貼檢驗	http://pmd.sourceforge.net/eclipse/
JDepend	包依賴項分析	http://andrei.gmxhome.de/eclipse/
Metrics	復雜度監(jiān)控	http://metrics.sourceforge.net/update

知道了這些有用插件的下載地址后，安裝插件就是一個極簡單的過程。啟動 Eclipse，然后遵循下列步驟：

1. 選擇 Help | Software Updates | Find and Install，如圖 1 所示：
   
   
   
   圖 1. 尋找并安裝 Eclipse 插件
   
   
   
   
   
2. 選擇 Search for new features to install 單選按鈕,單擊 Next。
   
   
3. 單擊 New Remote Site，輸入要安裝的插件名和 URL（參見圖 2），單擊 OK，然后單擊 Finish 來顯示 Eclipse 更新管理器。
   
   
   
   圖 2. 配置新的遠程站點
   
   
   
   
   
4. 在 Eclipse 更新管理器中，有一個查看插件各方面特性的選項。我通常選擇頂級項，如圖 3 所示。選擇您需要的選項并單擊 Finish。Eclipse 現(xiàn)在安裝該插件。您需要重啟 Eclipse 實例。
   
   
   
   圖 3. 安裝 Eclipse 插件
   
   
   

請遵循上述這些步驟來安裝其他的 Eclipse 插件；只需改變插件名和相應的下載位置即可。

回頁首

用 CheckStyle 校正標準

代碼庫的可維護性直接影響著軟件的整個成本。另外，不佳的可維護性還會讓開發(fā)人員十分頭痛（進而導致開發(fā)人員的缺乏）—— 代碼越容易修改，就越容易添加新的產品特性。像 CheckStyle 這樣的工具可以協(xié)助尋找那些可影響到可維護性、與編碼標準相沖突的地方，比方說，過大的類、太長的方法和未使用的變量等等。

有關 PMD 另一個叫做 PMD 的開源工具提供的功能和 CheckStyle 類似。我偏愛 CheckStyle，但 PMD 也有很多執(zhí)著的追隨者，所以我建議您了解一下這個工具，畢竟它也頗受一些人的青睞。

使用 Eclipse 的 CheckStyle 插件的好處是能夠在編碼過程中了解到源代碼上下文的各種編碼沖突，讓開發(fā)人員更可能在簽入該代碼前真正處理好這些沖突。您也幾乎可以把 CheckStyle 插件視作一個連續(xù)的代碼復查工具！

安裝 CheckStyle 插件并做如下配置（參見圖 4）：

1. 選擇 Project，然后選擇 Eclipse 菜單中的 Properties 菜單項。
   
   
2. 選擇 CheckStyle active for this project 復選框，單擊 OK。
   
   
   
   圖 4. 在 Eclipse 中配置 CheckStyle 插件
   
   
   

Eclipse 重新構建工作空間，并在 Eclipse 控制臺中列示已發(fā)現(xiàn)的編碼沖突，如圖 5 所示：

圖 5. Eclipse 中 CheckStyle 的代碼沖突列表

使用 CheckStyle 插件在 Eclipse 內嵌入編碼標準檢驗是一種很棒的方法，用這種方法可以在編碼時 積極地改進代碼，從而在開發(fā)周期的早期發(fā)現(xiàn)源代碼中潛在的缺陷。這么做還有更多的好處，如節(jié)省時間、減少失敗，也因此會減少項目的成本。沒錯，這就是一種積極主動的方式！

回頁首

用 Coverlipse 確認覆蓋率

Coverlipse 是一個用于 Cobertura 的 Eclipse 插件，Cobertura 是一個代碼覆蓋率工具，可以用它來評估具有相應測試的源代碼的比率。Cobertura 也提供一個 Ant 任務和 Maven 插件，但用 Cobertura，您可以在編寫代碼時 評估代碼覆蓋率。您見過這樣的模式嗎？

通過選擇 Eclipse 菜單項 Run 安裝 Coverlipse 插件并將其和 JUnit 關聯(lián)起來，該操作會顯示一系列運行配置選項，例如 JUnit、SWT 應用程序和 Java? 應用程序。右鍵單擊它并選擇 JUnit w/Coverlipse 節(jié)點中的 New。在這里，需要確定 JUnit 測試的位置，如圖 6 所示：

圖 6. 配置 Coverlipse 以獲取代碼覆蓋率

一旦單擊了 Run，Eclipse 會運行 Coverlipse 并在源代碼（如圖 7 所示）中嵌入標記，該標記顯示了具有相關 JUnit 測試的代碼部分：

圖 7. Coverlipse 生成的具有嵌入類標記的報告

正如您所見，使用 Coverlipse Eclipse 插件可以更快地確定代碼覆蓋率。例如，這種實時數(shù)據(jù)功能有助于在將代碼簽入 CM 系統(tǒng)前 更好地進行測試。這對漸進編程來說意味著什么呢？

回頁首

用 CPD 捕捉代碼重復

Eclipse 的 PMD 插件提供了一項叫做 CPD（或復制粘貼探測器）的功能，用于尋找重復的代碼。為在 Eclipse 中使用這項便利的工具，需要安裝具有 PMD 的 Eclipse 插件，該插件具有 CPD 功能。

為尋找重復的代碼，請用右鍵單擊一個 Eclipse 項目并選擇 PMD | Find Suspect Cut and Paste，如圖 8 所示：

圖 8. 使用 CPD 插件運行復制粘貼檢驗

一旦運行了 CPD，您的 Eclipse 根目錄下就會創(chuàng)建出一個 report 文件夾，其中包含一個叫做 cpd.txt 的文件，文件中列示了所有重復的代碼。圖 9 中是一個 cpd.txt 文件的例子：

圖 9. Eclipse 插件生成的 CPD 文本文件

靠人工來尋找重復的代碼是一項挑戰(zhàn)，但使用像 CPD 這樣的插件卻能在編碼時輕松地發(fā)現(xiàn)重復的代碼。

回頁首

使用 JDepend 進行依賴項檢查

JDepend 是個可免費獲取的開源工具，它為包依賴項提供面向對象的度量值，以此指明代碼庫的彈性。換句話說，JDepend 可有效測量一個架構的健壯性（反之，脆弱性）。

除了 Eclipse 插件，JDepend 還提供一個 Ant 任務、Maven 插件和一個 Java 應用程序，用以獲取這些度量值。對于相同的信息，它們有著不同的傳遞機制；但 Eclipse 插件的特別之處和相應優(yōu)點是：它能以更接近源代碼（即，編碼時）的方式傳遞這條信息。

圖 10 演示了使用 Eclipse JDepend 插件的方法：通過右鍵單擊源文件夾并選擇 Run JDepend Analysis。一定要選擇一個含源代碼的源文件夾；否則看不到此菜單項。

圖 10. 使用 JDepend Analysis 分析代碼

圖 11 顯示了運行 JDepend Analysis 時生成的報告。左邊顯示包，右邊顯示針對每個包的依賴項度量值。

圖 11. Eclipse 項目中的包依賴項

正如您所見，JDepend 插件提供了有助于不斷觀察架構可維護性變化的大量信息 —— 這其中最大的好處是您可以在編碼時看到這些數(shù)據(jù)。

回頁首

用 Metrics 測量復雜度

“五大”代碼分析最后的一項是測量復雜度。Eclipse 提供一種叫做 Metrics 的插件，使用該插件可以進行許多有用的代碼度量，包括圈復雜度度量，它用于測量方法中惟一路徑的數(shù)目。

安裝 Metrics 插件并重啟 Eclipse；然后遵循下列步驟：

1. 右鍵單擊您的項目并選擇 Properties 菜單。在結果窗口中，選擇 Enable Metrics plugin 復選框并單擊 OK，如圖 12 所示：
   
   
   
   圖 12. 為項目配置 Metrics
   
   
   
   
   
2. 從 Eclipse 中選擇 Window 菜單打開 Metrics 視圖，然后選擇 Show View | Other...。
   
   
3. 選擇 Metrics | Metrics View 打開如圖 13 中顯示的窗口。您需要使用 Java 透視圖并重新構建項目，從而顯示這些度量值。
   
   
   
   圖 13. 打開 Eclipse 中的 Metrics View
   
   
   
   
   
4. 單擊 OK 來顯示如圖 14 中的窗口。
   
   在此例中，我正在查看一個單獨方法的圈復雜度。真正妙的是您可以雙擊 Metrics 列表中的方法，該插件會在 Eclipse 編輯器中為此方法打開源代碼。這就讓修正變得超級簡單（如果需要的話）！
   
   
   
   圖 14. 查看方法的圈復雜度
   
   
   

正如我之前提到過的，Eclipse Metrics 插件還提供了許多功能強大的度量值，有助于您在開發(fā)軟件的過程中改進代碼 —— 可見，它是一個漸進編程意義上的插件!

回頁首

合適的才是最好的

正如您從本文中看到的那樣，將“五大”測量方法，即編碼標準、代碼重復、代碼覆蓋率、依賴項分析和復雜度監(jiān)控，用于改進代碼質量十分重要。但適合您的才是好的。請記住還有其他許多可用的 Eclipse 插件（比如 PMD 和 FindBugs）能夠幫助您在開發(fā)周期的早期改進代碼質量。不管您想要的工具或偏愛的方法是什么，重要的是：行動起來去積極改進代碼質量并讓手工代碼檢驗的過程變得更加有效。我估計您使用這些插件一段時間后，就再也離不開它們了。

參考資料

學習

• 您可以參閱本文在 developerWorks 全球站點上的 英文原文 。
  
  
• 讓開發(fā)自動化 （Paul Duvall，developerWorks）：閱讀完整的系列。
  
  
• “Improving Code Quality with PMD and Eclipse” （Levent Gurses，Jacoozi，2005 年 1 月）：這篇文章將 PMD 視為 Eclipse 插件，介紹了使用 PMD 改進代碼質量并縮短代碼檢驗過程的方法。
  
  
• “用 Cobertura 測量測試覆蓋率” （Elliotte Rusty Harold，developerWorks，2005 年 5 月）：Elliotte Rusty Harold 分享了他的經驗，即如何使用代碼覆蓋率的最佳實踐來利用 Cobertura。
  
  
• “不要被覆蓋報告所迷惑” （Andrew Glover，developerWorks，2006 年 1 月）：這篇文章進一步揭示了覆蓋率報告中的數(shù)字所代表的真正含義，也給出了這些數(shù)字所不能代表的含義。
  
  
• “Managing Your Dependencies with JDepend” （Glen Wilcox，OnJava，2004 年 1 月）：在這篇文章中，Glen Wilcox 介紹了 JDepend，這是一個可以免費獲取的工具，它能洞悉軟件架構中的許多質量問題。
  
  
• “軟件架構的代碼質量” （Andrew Glover，developerWorks，2006 年 4 月）：Andrew Glover 介紹了如何持續(xù)監(jiān)控以及如何改正能夠影響軟件架構長期存續(xù)性的代碼質量問題。
  
  
• “讓開發(fā)自動化: 持續(xù)檢查” （Paul Duvall，developerWorks，2006 年 8 月）：Paul Duvall 介紹了自動化的檢查工具（如 CheckStyle、JavaNCSS 和 CPD ）是如何增強開發(fā)過程的以及何時應該使用這些工具。
  
  
• “Detecting Duplicate Code with PMD's CPD” （Tom Copeland，OnJava，2003 年 3 月）：Tom Copeland 介紹了一種叫做 CPD（復制/粘貼檢測器）的開源工具，該工具用于尋找重復的 Java 代碼。
  
  
• “Maintain organizational standards with code audits” （testearly.com）：編碼標準有利于廣大開發(fā)人員對代碼庫達成共識。
  
  
• developerWorks Java 技術專區(qū) ：數(shù)百篇關于 Java 編程各方面的文章。
  
  

獲得產品和技術

• Eclipse plugin for PMD ：使用 PMD 插件在代碼中尋找復制粘貼問題。
  
  
• Eclipse plugin for JDepend ：此插件有助于分析代碼庫中的包依賴項。
  
  
• Eclipse plugin for Cobertura ：Coverlipse 是 用于 Cobertura 的 Eclipse 插件，它提供代碼覆蓋率信息。
  
  
• Eclipse Metrics ：此插件提供度量值，如圈復雜度，非常有助于尋找復雜代碼。
  
  
• Eclipse plugin for CheckStyle ：檢驗項目編碼標準的遵循情況。
  
  

討論

• 提高代碼質量論壇 ：developerWorks 的積極貢獻者 Andrew Glover 是一名專注于改進代碼質量的顧問，他為這個由他主持的論壇帶來了很多相當專業(yè)的知識。

關于作者

?		Paul Duvall 是 Stelligent Incorporated 的 CTO，該公司利用有效的開發(fā)人員測試策略，以及能夠讓團隊盡早盡多地監(jiān)視和提高代碼質量的持續(xù)集成技術，幫助其他企業(yè)解決軟件的質量問題。他還是 UML? 2 Toolkit 一書的作者之一，目前正在與他人合作撰寫 Continuous Integration: Improving Software Quality and Reducing Risk (Addison