检查代码质量的插件Findbugs使用说明

一、简介
Findbugs是一个静态分析工具，它检查类或者jar文件，将字节码与一组缺陷模式进行对比以发现可能的问题。利用这个工具可以在不实际运行程序的情况下对软件进行分析。可以帮助改进代码质量。Findbugs提供了方便操作的可视化界面，同时也可以作为eclipse的一个插件来使用，而我们是用的最多的还是作为eclipse插件来使用。

二、使用方法
1、Findbugs的常用操作：
Findbugs找出的bug有三种颜色

黑色的臭虫标志是分类；
红色的臭虫标志表示严重bug，发现后必须修改代码；
橘黄色的臭虫标志表示潜在警告性bug，应尽量修改；

2、Findbugs的使用方法
Findbugs可以通过三种方法是用：Ant，swing操作界面，eclipse。
2.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.2 swing工具
Ant操作是专家级的操作，一般对于Java不是很熟悉的人，写build.xml文件。比起Ant来，使用Findbugs提供的Swing工具会使Findbugs的操作更加简单。运行Findbugs解压包中的bin文件夹下的findbugs.bat文件，即可开始进行后续的分析工作。

2.3 eclipse
使用eclipse的findbugs插件将findbugs集成到eclipse中，这也是我们平时工作中最常用的一种方法。

下载findbugs插件，解压之后copy到eclipse的plugin目录中去，然后重启eclipse。打开eclipse->window->Preferences，搜索关键字findbugs,如果能找到配置项，那么表示安装成功，如图：

简单使用：
（1） 在eclipse package Explorer 右键选择目标工程-> build project

（2） 选择指定的包或者类进行findbug

此时 遍历指定的包或者类进行分析，找出代码bug，然后集中显示在findbugs的bugs explorer中。下面，我们添加bugs explorer。
（3） 添加findbugs explorer （eclipse 左下角）

（4） bugs explorer 添加完毕后，我们就可以查看刚刚找到的bugs了，如图：

 

双击bug项目就可以在右边编辑窗口自动打开相关代码文件并连接到代码片段。 点击行号旁边的小臭虫图标后再eclipse下方输出区将提供详细的bug描述，以及修改建议等信息。我们可以根据此信息进行修改。

tips1：每次使用Findbugs，文件夹上右键→Findbugs→Findbugs，命令时，如果改动了代码，需要先BuildProject；
tips2：修改完bug之后，在文件上右键→Findbugs→Clear Bug Marker清除Findbugs的标志。

3、配置Findbugs
你可以对Findbugs的规则进行详细设置：
3.1 Run Automatically开关
  当此项选中后，FindBugs将会在你修改Java类时自动运行，如你设置了Eclipse自动编译开关后，当你修改完Java文件保存，FindBugs就会运行，并将相应的信息显示出来。
当此项没有选中，你只能每次在需要的时候自己去运行FindBugs来检查你的代码。
3.2 Detector Configuration选择项
在这里你可以选择所要进行检查的相关的Bug Pattern条目,你可以根据需要选择或去掉相应的 检查条件。
3.3 Minimum priority to report选择项
这个选择项是让你选择哪个级别的信息进行显示，有Low、Medium、High三个选择项可以选择，很类似于Log4J的级别设置啦。 比如：
你选择了High选择项，那么只有是High级别的提示信息才会被显示。
你选择了Medium选择项，那么只有是Medium和High级别的提示信息才会被显示。
你选择了Low选择项，那么所有级别的提示信息都会被显示。
3.4 Report bug categories选择项
在这里是一些显示Bug分类的选择：
Malicious code vulnerability关于恶意破坏代码相关方面的
Correctness关于代码正确性相关方面的
Internationalization关于代码国际化相关方面的
Performance关于代码性能相关方面的
Multithreaded correctness关于代码多线程正确性相关方面的
另外FindBugs有UI页面，可以单独运行。也可以通过Ant以及命令行方式运行。