findbugs 1.3.9 使用

FindBugs 1.3.9

 

本文介绍如何利用Eclipse插件FindBugs在Eclipse中的使用。

 

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

FindBugs 是由马里兰大学提供的一款开源 Java 静态代码分析工具，它检查类或者 JAR 文件，将字节码与一组缺陷模式进行对比以发现可能的问题(先对编译后的class进行扫描，然后进行对比)，寻找出真正的缺陷和潜在的性能问题。在开发阶段和维护阶段都可使用。

 

现今检测的类型如下：

 正确性：如强制类型转换
 标准：如某个类实现了equals方法但未实现hashCode方法
 多线程：主要在同步和多线程问题
 性能：潜在的性能委托
 安全：相关
 高危：导致Bug的可能性最高
 更多的Bug描述：http://findbugs.sourceforge.net/bugDescriptions.html

 

说明：

JDK：1.6.0 从http://java.sun.com上去下载安装

Eclipse：Indigo 从http://www.eclipse.org 上去下载解压

FindBugs：1.3.9 从http://findbugs.sourceforge.net/

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

Eclipse plugin for FindBugs ：http://findbugs.sourceforge.net/downloads.html下载

插件安装：

网上有好多方法介绍安装，我安装成功的方法是直接把解压后的文件夹考到Eclipse plugin目录下，然后重启Eclipse，可以按以下步骤看到安装是否成功：

 

为了以后观察方便先建立添加findbugs explorer

 

Eclipse里面使用findbug：创建简单测试例子

首先，创建练习工程：FindBugsTestà再创建测试类FindBugsTest，代码如下：

package com.topsoft.findbugs;

 

public class FindBugsTest {

    private String[] name;

 

    public String[] getName() {

       return name;

    }

 

    public void setName(String[] name) {

       this.name = name;

    }

}

 

这个类里面有错误，以便测试用。在编辑区里面点击右键选择Find BugsàFind Bugs

 

打开Bugs Explore

 

可以看到黄色虫子。找出的bug虫子颜色有三种：黑色的臭虫标志是分类， 红色的臭虫表示严重bug发现后必须修改代码，橘黄色的臭虫表示潜在警告性bug 尽量修。

Bugs Explore右侧Problems是问题信息，打开Problems面板

 

选中相应的问题条目，右键，在弹出的菜单中，可以看到“Show Bug Details”，选中也可以查看问题详细信息。

根据这里详细的信息，你可以得到FindBugs为什么会对你的代码报警告信息，及相应的处理办法，根据它的提示，你可以快速方便地进行代码修改。

 

如果双击问题，系统会自动跳转到相对应的问题行出。

 

 

FindBugs Configuration by different project

 

配置FindBugs:

在Bugs Explorer视图中，选择项目à右键àProperties àFindBugs

Detector Configuration

在这里你可以选择所要进行检查的相关的Bug Pattern条目

可以从Bug codes、Detector name、Detector description中看到相应的是要检查哪些方面的内容，你可以根据需要选择或去掉相应的检查条件。

 

Run FindBugs Automatically

当此项选中后，FindBugs将会在你修改Java类时自动运行，如你设置了Eclipse自动编译开关后，当你修改完Java文件保存，FindBugs就会运行，并将相应的信息显示出来。

当此项没有选中，你只能每次在需要的时候自己去运行FindBugs来检查你的代码。

 

Reporter ConfigurationàMinimum priority to report

这个选择项是让你选择哪个级别的信息进行显示，有Low、Medium、High三个选择项可以选择，很类似于Log4J的级别设置啦。

比如：

你选择了High选择项，那么只有是High级别的提示信息才会被显示。

你选择了Medium选择项，那么只有是Medium和High级别的提示信息才会被显示。

你选择了Low选择项，那么所有级别的提示信息都会被显示。

 

Enable bug categories

Correctness关于代码正确性相关方面的

Performance关于代码性能相关方面的

Internationalization关于代码国际化相关方面的

Multithreaded correctness关于代码多线程正确性相关方面的

Style关于代码样式相关方面的

Malicious code vulnerability关于恶意破坏代码相关方面的

比如：如果你把Style的检查框去掉不选择中它，那么与Style分类相关的警告信息就不会显示了。其它的类似。