Findbugs安裝使用文檔

一、簡介

Findbugs 是一個靜態分析工具，它檢查類或者 JAR 文件，將字節碼與一組缺陷模式進行對比以發現可能的問題。利用這個工具，就可以在不實際運行程序的情況對軟件進行分析。它可以幫助改進代碼的質量。

Findbugs提供了方便操作的可視化界面，同時也可以作為Eclipse的一個插件來使用，而我們使用得最多的還是作為Eclipse的插件來使用。

二、使用方法

Findbugs可以通過三種方法使用，可以通過Ant工具，通過Ant提供的Swing操作界面和作為Eclipse的一個插件來使用。

1. Ant工具

Ant是一個很好的Java自動執行工具。

Findbugs官方提供了Ant的findbugs操作方法，我們可以通過這樣一個build.xml文件來使用findbugs。

<project name="項目名" default="all">

<property name="findbugs.home" value="findbugs解壓路徑" />

<path id="findbugs.path">

<fileset dir="findbugs解壓路徑">

<include name="**/*.jar" />

</fileset>

</path>

<taskdef name="findbugs"

classname="edu.umd.cs.findbugs.anttask.FindBugsTask"

classpathref="findbugs.path" />

<!-- 定義findbugs的home，findbugs的task要使用 -->

<target name="findbugs">

<findbugs home="${findbugs.home}"

output="xml:withMessages" outputFile="生成的文件">

<!-- 以上定義findbugs查找的類路徑 -->

<auxClasspath path="${findbugs.home}/lib/findbugs-ant.jar" />

<auxClasspath>

<fileset dir="lib"

includes="*.jar" />

</auxClasspath>

<sourcePath path="源文件路徑" />

<class location="生成類路徑" />

</findbugs>

</target>

</project>

比如：我這裡有一個我放在博客上的項目的findbugs的ant操作的build文件。

<project name="Calendar" default="all">

<property name="findbugs.home" value="../../findbugs-1.3.8" />

<path id="findbugs.path">

<fileset dir="../../findbugs-1.3.8">

<include name="**/*.jar" />

</fileset>

</path>

<taskdef name="findbugs"

classname="edu.umd.cs.findbugs.anttask.FindBugsTask"

classpathref="findbugs.path" />

<!-- 定義findbugs的home，findbugs的task要使用 -->

<target name="findbugs">

<mkdir dir="target/findbugs"/>

<findbugs home="${findbugs.home}"

output="xml:withMessages" outputFile="target/findbugs/calendar-fb.xml">

<!-- 以上定義findbugs查找的類路徑 -->

<auxClasspath path="${findbugs.home}/lib/findbugs-ant.jar" />

<auxClasspath>

<fileset dir="lib"

includes="*.jar" />

</auxClasspath>

<sourcePath path="src" />

<class location="target/classes" />

</findbugs>

</target>

</project>

設置好Ant的環境後，在命令中使用ant -f build.xml，或者在Eclipse直接運行build.xml文件，運行後生成了一個xml文件，如果你想用Html的格式查看findbugs的結果，可以把output屬性設為：html。這樣就可以通過Html來查看findbugs的結果了。

2. 提供的Swing工具

Ant操作是專家級的操作，一般對於Java不是很熟悉的人，寫build.xml文件。比起Ant來，使用Findbugs提供的Swing工具會使Findbugs的操作更加簡單。運行Findbugs解壓包中的bin文件夾下的findbugs.bat文件。

Findbugs的Swing工具初始主界面如下：

在分析項目之前，我們必須要新建一個項目來分析，選擇文件->新建

顯示新建項目的界面如下圖：

然後添加要分析的類包和目錄（可以選擇編譯好的類所在的文件夾，也可以選擇生成的jar包），再添加輔助類所在的文件夾和源文件所在的文件夾（java文件所在的文件夾）。再點擊完成就可以建立一個要分析的項目。