Eclipse 配置findbugs進行代碼審查

1、FindBugs介紹

FindBugs是一款Java靜態代碼分析工具,與其他靜態分析工具(如CheckstylePMD)不同,FindBugs 不注重樣式或者格式,它專注於尋找真正的缺陷或者潛在的性能問題,它可以幫助java工程師提高代碼質量以及排除隱含的缺陷。有了靜態分析工具,就可以在不實際運行程序的情況對軟件進行分析。

最新版本是1.3.9.20090821,下載地址http://findbugs.sourceforge.net/downloads.html

FindBugs運用Apache BCEL 庫分析類文件(class文件)而不是源代碼,將字節碼與一組缺陷模式進行對比以發現可能的問題。FindBugs的檢測器已增至300多條,被分爲不同的類型,常見的類型如下:

· 正確性(Correctness):這種歸類下的問題在某種情況下會導致bug,比如錯誤的強制類型轉換等。

· 最佳實踐反例(Bad practice):這種類別下的代碼違反了公認的最佳實踐標準,比如某個類實現了equals方法但未實現hashCode方法等。

· 多線程正確性(Multithreaded correctness):關注於同步和多線程問題。

· 性能(Performance):潛在的性能問題。

· 安全(Security):安全相關。

· 高危(Dodgy):FindBugs團隊認爲該類型下的問題代碼導致bug的可能性很高。

 

2、Eclipse中安裝FindBugs插件

   下載Eclipse plugin 的版本,解壓zip文件。

   將解壓後的文件放到EclipsePlugin中。

   重新啓動Eclipse 

 

    我使用的是MyEclipse8.5可能路徑和大家的不太一樣,我是放到了路徑Genuitec/MyEclipse 8.5/dropins下面

 

 

3、Eclipse中使用FindBugs

重新啓動eclipse

打開FindBugs視圖

 

 

執行Find Bug 任務

右鍵單擊你要檢測的工程、包或文件,-->Find Bugs-->Find Bugs

check完成後將在Bug Explorer視圖中看到問題列表,該列表以問題類型組織。

 

 

 

展開列表,雙擊列表中具體的問題就可以定位的具體的代碼行。

 

 

 

4、配置FindBugs
這裏可以對FindBugs規則等進行詳細設置。 
  選擇你的項目,右鍵 => Properties => FindBugs =>

 

Run Automatically開關

當此項選中後,FindBugs將會在你修改Java類時自動運行,如你設置了Eclipse自動編譯開關後,當你修改完Java文件保存,FindBugs就會運行,並將相應的信息顯示出來。
當此項沒有選中,你只能每次在需要的時候自己去運行FindBugs來檢查你的代碼。

Detector Configuration選擇項

在這裏你可以選擇所要進行檢查的相關的Bug Pattern條目,你可以根據需要選擇或去掉相應的 檢查條件。

 

Minimum priority to report選擇項
這個選擇項是讓你選擇哪個級別的信息進行顯示,有LowMediumHigh三個選擇項可以選擇,很類似於Log4J的級別設置啦。 比如:


你選擇了High選擇項,那麼只有是High級別的提示信息纔會被顯示。
你選擇了Medium選擇項,那麼只有是MediumHigh級別的提示信息纔會被顯示。
你選擇了Low選擇項,那麼所有級別的提示信息都會被顯示。

Report bug categories選擇項
在這裏是一些顯示Bug分類的選擇:
Malicious code vulnerability關於惡意破壞代碼相關方面的
Correctness關於代碼正確性相關方面的
Internationalization關於代碼國際化相關方面的
Performance關於代碼性能相關方面的
Multithreaded correctness關於代碼多線程正確性相關方面的

另外FindBugsUI頁面,可以單獨運行。也可以通過Ant以及命令行方式運行。

 

 

5、其它分析工具

除FingBugs靜態分析工具外,還有PMDCheckstyleFingBugsPMDCheckstyle三個工具各有不同的特點,聯合使用有助於減少誤報錯誤,提高報告的準確率。

 

這三個工具檢查的側重點各有不同: 

工具

目的

主要檢查內容

FindBugs

基於Bug Patterns概念,查找java bytecode中的潛在bug。在目前版本中,它不檢查java源文件。

主要檢查bytecode中的bug patterns,也允許用戶自定義特定的bug patterns

PMD

檢查java源文件中的潛在問題。

主要包括:

  -  try/catch/finally/switch語句塊

 -       未使用的局部變量、參數和private方法

 -       if/while語句

 -       過於複雜的表達式,如不必要的if語句等

 -       複雜類

CheckStyle

檢查java源文件是否與代碼規範相符

主要包括

 -       Javadoc註釋

 -       命名規範

 -       Headers

 -       Imports

 -       Size衝突和度量,如過長的方法

 -       Whitespace

 -       Modifiers

 -       Blocks

 -       Coding Problems

 -       Class Design

 -       重複代碼

 -       Miscellaneous Checks

 -       Optional Checks

 

 

Findbug官網地址:http://findbugs.sourceforge.net/

FindBugs的詳細bug描述清單見:http://findbugs.sourceforge.net/bugDescriptions.html


轉自:http://blog.csdn.net/strawbingo/article/details/5924005

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章