靜態代碼檢查工具 FindBugs
使用 FindBugs的原因和方法 靜態分析工具承諾無需開發人員費勁就能找出代碼中已有的缺陷。當然,如果有多年的編寫經驗,就會知道這些承諾並不是一定能兌現。儘管如此,好的靜態分析工具仍然是工具箱中的無價之寶。在這個由兩部分組成的系列文章的第一部分中,進階軟體工程師 Chris Grindstaff 分析了 FindBugs 如何協助提高代碼品質以及排除隱含的缺陷。 代碼品質工具的一個問題是它們容易為開發人員提供大量但並非真正問題的問題 —— 即 偽問題(false positives) 。出現偽問題時,開發人員要學會忽略工具的輸出或者放棄它。 FindBugs 的設計者 David Hovemeyer 和 William Pugh 注意到了這個問題,並努力減少他們所報告的偽問題數量。與其他靜態分析工具不同, FindBugs 不注重樣式或者格式,它試圖只尋找真正的缺陷或者潛在的效能問題。
FindBugs 是什麼。 FindBugs 是一個靜態分析工具,它檢查類或者 JAR 檔案(注意它分析是不是JAVA源檔案而是編繹後CLASS類),將位元組碼與一組缺陷模式進行對比以發現可能的問題。有了靜態分析工具,就可以在不實際運行程式的情況對軟體進行分析。不是通過分析類檔案的形式或結構來確定程式的意圖,而是通常使用 Visitor 模式(請參閱 參考資料 )。圖 1 顯示了分析一個匿名項目的結果(為防止可怕的犯罪,這裡不給出它的名字):
圖 1. FindBugs UI
2.安裝Eclipse的FindBugs外掛程式
可以在下面的地址
http://findbugs.sourceforge.net/downloads.html
開啟頁面內容如下:
下載FindBugs軟體以及eclipse和blueJ的外掛程式。 FindBugs tool (standard version with command line, ant, and Swing interfaces) findbugs-1.3.9.tar.gz findbugs-1.3.9.zip ----WINDOWS下載FindBugs軟體,可獨立運行.並可在Ant中使用FindBugs findbugs-1.3.9-source.zip Eclipse plugin for FindBugs version 1.3.9.20090821 (requires Eclipse 3.3 or later) edu.umd.cs.findbugs.plugin.eclipse_1.3.9.20090821.zip --------eclipse 的FindBugs外掛程式,不能獨立運行,只能整合到eclipse外掛程式運行 eclipsePlugin-1.3.9.20090821-source.zip
The Eclipse plugin may also be obtained from one of the FindBugs Eclipse plugin update sites: --FindBugs外掛程式的更新地址有很多,根據類型的不同,包括以下幾個: http://findbugs.cs.umd.edu/eclipse update site for official releases ---只提供FindBugs的官方釋放版本。 http://findbugs.cs.umd.edu/eclipse-candidate update site for candidate releases and official releases --提供FindBugs的官方釋放版本和可選釋放版本。 http://findbugs.cs.umd.edu/eclipse-daily update site for all releases, including developmental ones --提供最新的FindBugs的外掛程式。除了編譯通過外並沒有進行測試的版本。
單擊上面連結即可下載(另存).
也可以在下面的地址:
http://prdownloads.sourceforge.net/findbugs
下載外掛程式的zip檔案,將其解壓縮到eclipse的plugin目錄(<eclipse_install_dir>/plugins)。
安裝完外掛程式後,可以使用Help-->About Eclipse Platform-->Plug-in Details來查看FindBugs外掛程式的使用方法。
3. 在Eclipse中使用FindBugs外掛程式
運行FindBugs外掛程式的方法很簡單,選中一個Java工程後,點擊右鍵,選擇Find Bugs,這時就會啟動FindBugs,並且會在有問題的原始碼中顯示標記。
可以自訂FindBugs的運行方式:查看Java工程的屬性對話方塊,選擇FindBugs的屬性頁面,可以看到如下的選項:
→ 啟用/禁用”自動運行FindBugs”複選框---是否在每次修改時進行FindBugs的檢查
→ 選擇最小的警告優先順序,並啟用bug的分類---這些選項用於決定顯示哪些問題,例如,如果選擇Medium警告優先順序的話,只有Medium和Hign優先順序的警告才會被顯示,類似的,如果不選中Style複選框的話,那麼有關Style類別的警告也不會被顯示。
→ 選擇檢查引擎:對指定的工程啟用那些detectors。
具體的設定畫面如下:
(設定detectors和是否自動運行FindBugs)
(設定啟用的分類)
常見的類型如下:
· 正確性(Correctness):這種歸類下的問題在某種情況下會導致bug,比如錯誤的強制類型轉換等。
· 最佳實務反例(Bad practice):這種類別下的代碼違反了公認的最佳實務標準,比如某個類實現了equals方法但未實現hashCode方法等。
· 多線程正確性(Multithreaded correctness):關注於同步和多線程問題。
· 效能(Performance):潛在的效能問題。
· 安全(Security):安全相關。
· 高危(Dodgy):FindBugs團隊認為該類型下的問題代碼導致bug的可能性很高。
在Eclipse中安裝FindBugs外掛程式
下載Eclipse plugin 的版本,解壓zip檔案。
將解壓後的檔案放到Eclipse的Plugin中。
重新啟動Eclipse 。
我使用的是MyEclipse8.5可能路徑和大家的不太一樣,我是放到了路徑Genuitec/MyEclipse 8.5/dropins下面
在Eclipse中使用FindBugs
重新啟動eclipse
開啟FindBugs視圖
執行Find Bug 任務
按右鍵你要檢測的工程、包或檔案,-->Find Bugs-->Find Bugs。
check完成後將在Bug Explorer視圖中看到問題列表,該列表以問題類型組織。
展開列表,雙擊列表中具體的問題就可以定位的具體的程式碼。
配置FindBugs
在這裡可以對FindBugs規則等進行詳細設定。
選擇你的項目,右鍵 => Properties => FindBugs =>
1 Run Automatically開關
設定Eclipse自動編譯開關-----即主視窗菜單Project---Build Automatically這個選項勾上就行了.
當此項選中後,FindBugs將會在你修改Java類時自動運行,如你設定了Eclipse自動編譯開關後,當你修改完Java檔案儲存,FindBugs就會運行,並將相應的資訊顯示出來。
當此項沒有選中,你只能每次在需要的時候自己去運行FindBugs來檢查你的代碼。
2 Detector Configuration選擇項
在這裡你可以選擇所要進行檢查的相關的Bug Pattern條目,你可以根據需要選擇或去掉相應的 檢查條件。
3 Minimum priority to report選擇項
這個選擇項是讓你選擇哪個層級的資訊進行顯示,有Low、Medium、High三個選擇項可以選擇,很類似於Log4J的層級設定啦。 比如:
你選擇了High選擇項,那麼只有是High層級的提示資訊才會被顯示。
你選擇了Medium選擇項,那麼只有是Medium和High層級的提示資訊才會被顯示。
你選擇了Low選擇項,那麼所有層級的提示資訊都會被顯示。
4 Report bug categories選擇項
在這裡是一些顯示Bug分類的選擇:
Malicious code vulnerability關於惡意破壞代碼相關方面的
Correctness關於代碼正確性相關方面的
Internationalization關於代碼國際化相關方面的
Performance關於代碼效能相關方面的
Multithreaded correctness關於代碼多線程正確性相關方面的
另外FindBugs有UI頁面,可以單獨運行。也可以通過Ant以及命令列方式運行。
4. 在Ant中使用FindBugs
Ant作為一個優秀的自動化構建軟體,大量的應用在Java軟體開發中(雖然有被Maven取代的危險)。FindBugs提供了整合在Ant中使用的Ant Task,可以在自動構建與部署的時候運行FindBugs。
將$FINDBUGS_HOME/lib/findbugs-ant.jar拷貝到$ANT_HOME/lib目錄下以後,就完成了FindBugs的Ant Task的安裝。(強烈建議使用FindBugs附帶的jar檔案)
為了將FindBugs任務整合到Ant指令碼中,需要首先進行一個task的定義,如下面的片段所示:---下面ANT的XML內容介紹
<taskdef name=”findbugs” classname=”edu.umd.cs.findbugs.anttask.FindBugsTask” />
在定義了findbugs task之後,就可以使用了。下面是一個例子:
<property name="findbugs.home" value="/export/home/daveho/work/findbugs" />
<target name="findbugs" depends="jar">
<findbugs home="${findbugs.home}"
output="xml"
outputFile="bcel-fb.xml" >
<auxClasspath path="${basedir}/lib/Regex.jar" />
<sourcePath path="${basedir}/src/java" />
<class location="${basedir}/bin/bcel.jar" />
</findbugs>
</target>
findbugs元素必須有home屬性,用於指定FindBugs的安裝路徑。
這是就會在bcel.jar上執行FindBugs。FindBugs的運行結果會被以xml的格式儲存在bcel-fb.xml檔案中。一個輔助的jar檔案被添加到auxClasspath元素中,因為BCEL庫引用了它。
另外一個例子:
從http://findbugs.sourceforge.net/downloads.html下載最新版本的Findbugs,目前的版本是1.3.0, 於2007年11月8日發布。把解壓後目錄複寫到項目的lib目錄下,然後就可以和Ant配合使用了。FindBugs工作在j2se1.4.0或以後的版本中,需要至少256MB記憶體。
在Ant指令碼中,首先定義Findbugs的解壓目錄位置:
<path id="findbugs.path" >
<fileset dir ="${lib.home}/findbugs-1.3.0">
<include name ="**/*.jar"/>
</fileset>
</path>
接著聲明Findbugs任務:
<taskdef name="findbugs"
classname="edu.umd.cs.findbugs.anttask.FindBugsTask"
classpathref ="findbugs.path"/>
然後建立Findbugs任務:
<property name ="findbugs.home" value ="${lib.home}/findbugs-1.3.0"/>
<!-- 定義findbugs的home,findbugs的task要使用 -->
<target name ="findbugs">
<findbugs home ="${findbugs.home}" includeFilter="${findbugs_include_filter}"
excludeFilter="${findbugs_exclude_filter}"
jvmargs="-Xmx384m" output ="html"
outputFile ="d:/test.html">
<class location ="${build.home}/WEB-INF/classes/"/>
<!-- 以上定義findbugs尋找的類路徑 -->
<auxClasspath path="${lib.home}/findbugs-1.3.0/lib/findbugs-ant.jar"/>
<auxClasspath>
<fileset dir="${build.home}/WEB-INF/lib" includes="**/*.jar" />
</auxClasspath>
<!-- 以上定義上述類所依賴的類路徑 -->
<sourcePath path ="${src.home}"/>
<!-- 以上定義原始碼的路徑 -->
</findbugs >
</target >
最後運行ant findbugs即可。
使用過濾器
使用過濾器我們就可以定義使用哪些bug檢測器和針對哪些類進行檢查,因為一旦項目比較龐大,那查看冗長的bug報告也是十分痛苦的事情。使用過濾器,過濾器用來包含或排除特殊的bug報告。這樣做有助於在特定的時間段內,聚焦我們的關注點。過濾器實際是在一個xml檔案定義的,xml設定檔的內容如下:
<FindBugsFilter>
<!-- 所有類使用bugcode為HE的檢測器 -->
<Match>
<BugCode name ="HE"/>
</Match>
<!-- 該類使用所有的bug檢測器 -->
<Match class ="com.foobar.AClass"/>
<!-- 該類使用bugcode為HE的檢測器 -->
<Match class ="com.foobar.BClass">
<BugCode name ="HE"/>
</Match>
<!-- 該類的AMethod和BMethod方法使用bugcode為HE的檢測器 -->
<Match class =