使用 SpotBugs 图形界面

本章介绍如何使用 SpotBugs 图形用户界面（GUI）。

创建项目

使用 spotbugs 命令启动 SpotBugs 后，选择 File → New Project 菜单项。
你将看到如下所示的对话框：

使用"Classpath to analyze"旁边的"Add"按钮选择一个 Java 归档文件（zip、jar、ear 或 war 文件）或包含待分析 Java 类的目录。你可以添加多个归档文件/目录。

你也可以添加包含所分析 Java 归档文件源代码的源代码目录。这将使 SpotBugs 能够高亮显示包含潜在错误的源代码。你添加的源代码目录应当是 Java 包层级结构的根目录。例如，如果你的应用程序位于 org.foobar.myapp 包中，你应当将 org 目录的父目录添加到项目的源代码目录列表中。

另一个可选步骤是将额外的 Jar 文件或目录作为"辅助类路径位置（Auxiliary classpath locations）"条目添加。如果你所分析的归档文件和目录引用了其他类，而这些类既未包含在被分析的归档文件/目录中，也不在标准运行时类路径中，那么你应该执行此操作。FindBugs 中的一些缺陷模式检测器会利用类层次结构信息，因此如果 FindBugs 执行分析时能够获取完整的类层次结构，你将获得更准确的结果。

运行分析

在添加完所有归档文件、目录和源代码目录之后，点击"Analyze"按钮来分析 Jar 文件中包含的类。请注意，对于非常大型的程序在较旧的计算机上运行，这可能需要相当长的时间（几十分钟）。拥有充足内存的新计算机通常只需几分钟即可完成对大型程序的分析。

浏览结果

分析完成后，你将看到如下所示的界面：

窗口左上方的窗格显示缺陷树，它是已分析 Jar 文件中检测到的所有潜在缺陷的层次化表示。

在顶部窗格中选中某个特定的缺陷实例后，你可以在底部窗格的「Details（详细信息）」标签页中查看该缺陷的描述。此外，如果源代码可用，右上方的源代码窗格会显示出现该潜在缺陷的程序源代码。在上面的示例中，该缺陷是一个未被关闭的流对象。源代码窗口会高亮显示创建该流对象的行。

你可以为缺陷实例添加文字批注。为此，在层次视图正下方的文本框中输入内容即可。你可以输入任何希望记录的信息。加载和保存缺陷结果文件时，这些批注会被保留。

保存与打开

你可以使用 File → Save as... 菜单项来保存工作成果。若要保存你的工作，包括你指定的 jar 文件列表以及全部缺陷结果，请在「Save as...（另存为）」对话框的下拉列表中选择「FindBugs analysis results (.xml)」。此外还有仅保存 jar 文件列表（「FindBugs project file (.fbp)」）或仅保存结果（「FindBugs analysis file (.fba)」）的选项。已保存的文件可以通过 File → Open... 菜单项载入。