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="http://www.cnblogs.com/findbugs-1.3.8" />

              <path id="findbugs.path">

                  <fileset dir="http://www.cnblogs.com/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文件所在的文件夹）。再点击完成就可以建立一个要分析的项目。

 

 

建立项目后，会自动先自动开始解析项目。

解析后界面：

 

其中左边是缺陷的树结构列表，点击其中一个Bug，可以在右边的界面中，显示Bugs的源文件以及所在的位置。

2.3         Findbugs Eclipse插件

Eclipse的Findbugs插件，可以将Findbugs集成到Eclipse中使用。

2.3.1        Findbugs的Eclipse插件安装方法

        1.      在线安装

安装地址：http://findbugs.cs.umd.edu/eclipse

        2.      离线安装

下载Findbugs插件，将它放入Eclipse下的plusin文件夹，然后重启Eclipse

 

        2.3.2        Findbugs的Eclipse插件使用

         安装了Findbugs插件后。右击点击你要检查的项目选择【Find Bugs】->【Find Bugs】进行检查。

        要查看Findbugs检查出了哪些Bug，可以选择Windows菜单->Show View->Bug Explorer，打开Bug Explorer面板。

         如果想要查看某个Bug详细的信息，则可以选择Windows菜单->Open Perspective，然后选择FindBugs就可以打开FindBugs的Properties面板，在这个面板里面可以看到最详尽的Bugs信息。

 

FindBugs插件的安装与使用

1 什么是FindBugs

FindBugs 是一个静态分析工具，它检查类或者 JAR 文件，将字节码与一组缺陷模式进行对比以发现可能的问题。有了静态分析工具，就可以在不实际运行程序的情况对软件进行分析。不是通过分析类文件的形式或结构来确定程序的意图，而是通常使用 Visitor 模式来鉴别代码是否符合一些固定的规范。

 

2 如何安装FindBugs?

作为Eclipse的一个插件，可以将Findbugs集成到Eclipse中使用。

第一种是在线安装：在Eclipse的插件安装地址中输入 http://findbugs.cs.umd.edu/eclipse并一路“next”就可安装成功。

第二种方式是下载Findbugs插件，将它放入Eclipse下的plusin文件夹，然后重启Eclipse即可。

 

 

 

 

 

3如何使用FindBugs

安装了Findbugs插件后。右击点击你要检查的项目选择【Find Bugs】->【Find Bugs】进行检查。要查看Findbugs检查出了哪些Bug，可以选择Windows菜单->Show View->Bug Explorer，打开Bug Explorer面板。如果想要查看某个Bug详细的信息，则可以选择Windows菜单->Open Perspective，然后选择FindBugs就可以打开FindBugs的Properties面板，在这个面板里面可以看到最详尽的Bugs信息。

4 FindBugs能发现的所有Bug类型
FindBugs 网站 http://findbugs.sourceforge.net/bugDescriptions.html提供了完整的类型清单。

 

 

 

 

To install the FindBugs plugin:

1. In Eclipse, click on Help -> Software Update -> Find and Install...
2. Choose the Search for new features to install option, and click Next.
3. Click New Remote Site.
4. Enter the following:
   • Name: FindBugs update site
   • URL: one of the following (note: no final slash on the url)
     • http://findbugs.cs.umd.edu/eclipse for official releases
     • http://findbugs.cs.umd.edu/eclipse-candidate for candidate releases and official releases
     • http://findbugs.cs.umd.edu/eclipse-daily for all releases, including developmental ones
   and click OK.
5. "FindBugs update site" should appear under Sites to include in search. 
   Click the checkbox next to it to select it, and click Finish.
6. You should see FindBugs Feature under Select features to install. 
   (You may have to click on one or two triangles to make it visible in the tree.)
   Select the checkbox next to it and click next.
7. Select the I accept option to accept the license and click Next.
8. Make sure the location is correct where you're installing it. The default (your workspace) should be fine. Click Finish.
9. The plugin is not digitally signed. Go ahead and install it anyway.
10. Click Yes to make Eclipse restart itself.

 

 

 

 

 

 

它是干嘛的？

findbugs是一个开源的eclipse 代码检查工具；它可以简单高效全面地帮助我们发现程序代码中存在的bug，bad smell，以及潜在隐患。针对各种问题，它并且提供了简单的修改意见供我们重构时进行参考； 通过使用它，可以一定程度上降低我们code review的工作量，并且会提高review效率。 通过findbugs找到bug，再由我们自己重构代码，可以培养我们的编码意识及水平，形成好的习惯提高开发编码能力。

哪里下载？

下载地址：

http://downloads.sourceforge.net/project/findbugs/findbugs%20eclipse%20plugin/1.3.9/edu.umd.cs.findbugs.plugin.eclipse_1.3.9.20090821.zip?use_mirror=ncu

如何安装？

1， 把下载的压缩包解压后，把 

copy到eclipse的plugin目录中去；

2， 重新启动eclipse

3， 打开eclipse->window->Preferences，搜索关键字findbugs,如果能找到配置项，那么表示安装成功，如图：

怎么用？

findbugs 简单易用，按照下图操作即可；

 

1， 在eclipse package Explorer 右键选择目标工程-> build project

 

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

 

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

 

3，添加findbugs explorer 
（eclipse 左下角）

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

找出的bug有3中颜色， 黑色的臭虫标志是分类， 红色的臭虫表示严重bug发现后必须修改代码，橘黄色的臭虫表示潜在警告性bug 尽量修改。（附录是各种bug的解释及修改方案，请大家按附表参考修改）

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

 

 

参考资料

suorceforge 地址： http://findbugs.sourceforge.net/

官方的文档 ： http://findbugs.sourceforge.net/manual

http://hi.baidu.com/seejava/blog/item/bbbd02382c7ea5f5b311c742.html

转载自： http://tidus2005.iteye.com/blog/462212

 

 

有的时候MyEclipse8.5不可以在线更新插件，也就是说明明你添加插件后，却不可以应用更改（不知道为什么，谁知道可以告诉我)。那就只有采用离线安装方式，下载插件包，然后安装。

而MyEclipse在7.0版之后的目录结构发生了变化，而且是很大的变化，你再也找不到eclipse这个文件夹了，而以前安装插件的时候是都要在这个文件夹里做手脚的。在网上找了好多文章，有各种说法，这样那样的，都不管用，后来终于找到了几个有用的，知道了两种离线插件的安装方法。

在一般情况下，下载回来的插件解压后只有这两种目录结构

eclipse目录，下面有两个文件夹：features、plugins。

插件名目录（如edu.umd.cs.findbugs.plugin.eclipse_1.3.9.20090821），下面有这样的结构

第一种结构的插件应该是老版本的Eclipse离线安装目录结构，后者应该是比较新的结构，当然这些都是我猜测的。

下面说如何安装，那就是在MyEclipse8.5里有一个插件配置的文件，这个是很必要的，位置在：MyEclipse安装根目录/configuration/org.eclipse.equinox.simpleconfigurator/bundles.info
所有插件都必须配置在这个文件里才可以使用，这个文件的格式是

包名，版本号，文件路经，4，false

要安装插件最必要的步骤就是照猫画虎的把插件信息添加到这里就OK了。

安装步骤：

一、Copy文件

如果是第一种目录结构，就要把features、plugins里面的内容 分别copy到 MyEclipse安装根目录/Common/features与 MyEclipse安装根目录/Common/plugins目录下。

如果是第二种目录结构，就要把解压出来的那一整个目录copy到 MyEclipse安装根目录/Common/plugins目录下。

二、配置bundles.info文件

如果是第一种目录结构，在bundles.info末尾追加类似如下信息：

jp.gr.java_conf.ussiy.app.propedit,5.3.3,file:/D:/MyEclipse 8.5/Common/plugins/jp.gr.java_conf.ussiy.app.propedit_5.3.3.jar/,4,false

如果是第二种目录结构，在bundles.info末尾追加类似如下信息：

edu.umd.cs.findbugs.plugin.eclipse,1.3.9.20090821,file:/D:/MyEclipse 8.5/Common/plugins/edu.umd.cs.findbugs.plugin.eclipse_1.3.9.20090821/,4,false

所不同的就是第一种目录结构的要指定到具体的jar文件，而第二种目录结构只需要指定到目录就可以了。

三、重启MyEclipse。