Java代码缺陷自动分析工具介绍

4.3 FindBugs 作为 Ant 任务

如何在 Ant 编译脚本中使用 FindBugs？首先将 FindBugs Ant 任务拷贝到 Ant 的 lib 目录中，这样 Ant 就知道新的任务。将 FIND_BUGS_HOME\lib\FindBugs-ant.jar 拷贝到 ANT_HOME\lib。

现在看看在编译脚本中要加入什么才能使用 FindBugs 任务。因为 FindBugs 是一个自定义任务，将需要使用 taskdef 任务以使 Ant 知道装载哪一个类。通过在编译文件中加入以下一行：

<taskdef name="FindBugs" classname="edu.umd.cs.FindBugs.anttask.FindBugsTask"/> 在定义了 taskdef 后，可以用它的名字 FindBugs 引用它。下一步要在编译中加入使用新任务的目标，示例如下：

1 <target name="FindBugs" depends="compile">

2 <FindBugs

home="${FindBugs.home}" output="xml" outputFile="jedit-output.xml">

3 <class location="c:\apps\JEdit4.1\jedit.jar" />

4 <auxClasspath path="${basedir}/lib/Regex.jar" />

5 <sourcePath path="c:\tempcbg\jedit" />

6 </FindBugs>

7 </target>

第 1 行： 注意 target 取决于编译。一定要记住处理的是类文件而 不 是源文件，这样使 target 对应于编译目标保证了 FindBugs 可在最新的类文件运行。FindBugs 可以灵活地接受多种输入，包括一组类文件、JAR 文件、或者一组目录。

第 2 行：必须指定包含 FindBugs 的目录，我是用 Ant 的一个属性完成的，像这样： <property name="FindBugs.home" value="C:\apps\FindBugs-0.7.3" />

可选属性 output 指定 FindBugs 的结果使用的输出格式。可能的值有 xml 、 text 或者 emacs 。如果没有指定 outputFile ，那么 FindBugs 会使用标准输出。如前所述，XML 格式有可以在 UI 中观看的额外好处。

第 3 行： class 元素用于指定要 FindBugs 分析哪些 JAR、类文件或者目录。分析多个 JAR 或者类文件时，要为每一个文件指定一个单独的 class 元素。除非加入了 projectFile 元素，否则需要 class 元素。

第 4 行： 用嵌套元素 auxClasspath 列出应用程序的依赖性。这些是应用程序需要但是不希望 FindBugs 分析的类。如果没有列出应用程序的依赖关系，那么 FindBugs 仍然会尽可能地分析类。与 class 元素一样，可以在 FindBugs 元素中指定多个 auxClasspath 元素。 auxClasspath 元素是可选的。

第 5 行： 如果指定了 sourcePath 元素，那么 path 属性应当表明一个包含应用程序源代码的目录。指定目录使 FindBugs 可以在 GUI 中查看 XML 结果时突出显示出错的源代码。这个元素是可选的。