首頁(yè) > 開(kāi)發(fā) > 綜合 > 正文

讓開(kāi)發(fā)自動(dòng)化 用 Eclipse 插件提高代碼質(zhì)量

2020-10-08 16:17:19
字體:
來(lái)源:轉載
供稿:網(wǎng)友
在 讓開(kāi)發(fā)自動(dòng)化 的本期文章中,自動(dòng)化專(zhuān)家 Paul Duvall 將帶來(lái)一些關(guān)于 Eclipse 插件的例子,您可以安裝、配置和使用這些靜態(tài)分析插件,以便在開(kāi)發(fā)生命周期的早期預防問(wèn)題。

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

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

本文涵蓋了我所認為的 “五大” 代碼分析領(lǐng)域:

  • 編碼標準
  • 代碼重復
  • 代碼覆蓋率
  • 依賴(lài)項分析
  • 復雜度監控

可以用接下來(lái)的幾個(gè)靈活的 Eclipse 插件來(lái)揭示這些分析領(lǐng)域:

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

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

安裝 Eclipse 插件

安裝 Eclipse 插件再簡(jiǎn)單不過(guò)了,只需要幾個(gè)步驟。在開(kāi)始之前,最好把該插件下載站點(diǎn)的 URL 準備好。表 1 是本文用到的插件的列表:


表 1. 代碼改進(jìn)插件和相應的下載站點(diǎn) URL

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

知道了這些有用插件的下載地址后,安裝插件就是一個(gè)極簡(jiǎn)單的過(guò)程。啟動(dòng) Eclipse,然后遵循下列步驟:

  1. 選擇 Help | Software Updates | Find and Install,如圖 1 所示:



    圖 1. 尋找并安裝 Eclipse 插件
    尋找并安裝 Eclipse 插件


  2. 選擇 Search for new features to install 單選按鈕,單擊 Next。
  3. 單擊 New Remote Site,輸入要安裝的插件名和 URL(參見(jiàn)圖 2),單擊 OK,然后單擊 Finish 來(lái)顯示 Eclipse 更新管理器。



    圖 2. 配置新的遠程站點(diǎn)
    配置新的遠程站點(diǎn)


  4. 在 Eclipse 更新管理器中,有一個(gè)查看插件各方面特性的選項。我通常選擇頂級項,如圖 3 所示。選擇您需要的選項并單擊 Finish。Eclipse 現在安裝該插件。您需要重啟 Eclipse 實(shí)例。



    圖 3. 安裝 Eclipse 插件
    安裝 Eclipse 插件

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





回頁(yè)首

用 CheckStyle 校正標準

代碼庫的可維護性直接影響著(zhù)軟件的整個(gè)成本。另外,不佳的可維護性還會(huì )讓開(kāi)發(fā)人員十分頭痛(進(jìn)而導致開(kāi)發(fā)人員的缺乏)―― 代碼越容易修改,就越容易添加新的產(chǎn)品特性。像 CheckStyle 這樣的工具可以協(xié)助尋找那些可影響到可維護性、與編碼標準相沖突的地方,比方說(shuō),過(guò)大的類(lèi)、太長(cháng)的方法和未使用的變量等等。

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

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

安裝 CheckStyle 插件并做如下配置(參見(jiàn)圖 4):

  1. 選擇 Project,然后選擇 Eclipse 菜單中的 Properties 菜單項。
  2. 選擇 CheckStyle active for this project 復選框,單擊 OK。



    圖 4. 在 Eclipse 中配置 CheckStyle 插件
    在 Eclipse 中配置 CheckStyle 插件

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


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

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





回頁(yè)首

用 Coverlipse 確認覆蓋率

Coverlipse 是一個(gè)用于 Cobertura 的 Eclipse 插件,Cobertura 是一個(gè)代碼覆蓋率工具,可以用它來(lái)評估具有相應測試的源代碼的比率。Cobertura 也提供一個(gè) Ant 任務(wù)和 Maven 插件,但用 Cobertura,您可以在編寫(xiě)代碼時(shí) 評估代碼覆蓋率。您見(jiàn)過(guò)這樣的模式嗎?

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


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

一旦單擊了 Run,Eclipse 會(huì )運行 Coverlipse 并在源代碼(如圖 7 所示)中嵌入標記,該標記顯示了具有相關(guān) JUnit 測試的代碼部分:


圖 7. Coverlipse 生成的具有嵌入類(lèi)標記的報告
Coverlipse 生成的具有嵌入類(lèi)標記的報告

正如您所見(jiàn),使用 Coverlipse Eclipse 插件可以更快地確定代碼覆蓋率。例如,這種實(shí)時(shí)數據功能有助于在將代碼簽入 CM 系統前 更好地進(jìn)行測試。這對漸進(jìn)編程來(lái)說(shuō)意味著(zhù)什么呢?





回頁(yè)首

用 CPD 捕捉代碼重復

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

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


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

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


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

靠人工來(lái)尋找重復的代碼是一項挑戰,但使用像 CPD 這樣的插件卻能在編碼時(shí)輕松地發(fā)現重復的代碼。





回頁(yè)首

使用 JDepend 進(jìn)行依賴(lài)項檢查

JDepend 是個(gè)可免費獲取的開(kāi)源工具,它為包依賴(lài)項提供面向對象的度量值,以此指明代碼庫的彈性。換句話(huà)說(shuō),JDepend 可有效測量一個(gè)架構的健壯性(反之,脆弱性)。

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

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


圖 10. 使用 JDepend Analysis 分析代碼
使用 JDepend Analysis 分析代碼

圖 11 顯示了運行 JDepend Analysis 時(shí)生成的報告。左邊顯示包,右邊顯示針對每個(gè)包的依賴(lài)項度量值。


圖 11. Eclipse 項目中的包依賴(lài)項
Eclipse 項目中的包依賴(lài)項

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





回頁(yè)首

用 Metrics 測量復雜度

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

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

  1. 右鍵單擊您的項目并選擇 Properties 菜單。在結果窗口中,選擇 Enable Metrics plugin 復選框并單擊 OK,如圖 12 所示:



    圖 12. 為項目配置 Metrics
    為項目配置 Metrics


  2. 從 Eclipse 中選擇 Window 菜單打開(kāi) Metrics 視圖,然后選擇 Show View | Other...。
  3. 選擇 Metrics | Metrics View 打開(kāi)如圖 13 中顯示的窗口。您需要使用 Java 透視圖并重新構建項目,從而顯示這些度量值。



    圖 13. 打開(kāi) Eclipse 中的 Metrics View
    打開(kāi) Eclipse 中的 Metrics View


  4. 單擊 OK 來(lái)顯示如圖 14 中的窗口。

    在此例中,我正在查看一個(gè)單獨方法的圈復雜度。真正妙的是您可以雙擊 Metrics 列表中的方法,該插件會(huì )在 Eclipse 編輯器中為此方法打開(kāi)源代碼。這就讓修正變得超級簡(jiǎn)單(如果需要的話(huà))!



    圖 14. 查看方法的圈復雜度
    查看方法的圈復雜度

正如我之前提到過(guò)的,Eclipse Metrics 插件還提供了許多功能強大的度量值,有助于您在開(kāi)發(fā)軟件的過(guò)程中改進(jìn)代碼 ―― 可見(jiàn),它是一個(gè)漸進(jìn)編程意義上的插件!





回頁(yè)首

合適的才是最好的

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

發(fā)表評論 共有條評論
用戶(hù)名: 密碼:
驗證碼: 匿名發(fā)表