Findbugs使用简介

Findbugs使用简介Findbugs是一个在java程序中查找bug的程序，它查找bug模式的实例，也就是可能出错的代码实例，注意Findbugs是检查java字节码，也就是*.class文件。

其实准确的说，它是寻找代码缺陷的，很多我们写的不好的地方，可以优化的地方，它都能检查出来。

例如：未关闭的数据库连接，缺少必要的null check，多余的null check，多余的if后置条件，相同的条件分支，重复的代码块，错误的使用了"=="，建议使用StringBuffer代替字符串连加等等。

而且我们还可以自己配置检查规则(做哪些检查,不做哪些检查)，也可以自己来实现独有的校验规则(用户自定义特定的bug模式需要继承它的接口,编写自己的校验类,属于高级技巧)。

Findbugs是一个静态分析工具，它检查类或者JAR 文件，将字节码与一组缺陷模式进行对比以发现可能的问题。

Findbugs自带检测器，其中有60余种Bad practice，80余种Correctness，1种Internationalization，12种Malicious code vulnerability，27种Multithreaded correctness，23种Performance，43种Dodgy。

Bad practice 坏的实践一些不好的实践，下面列举几个：HE：类定义了equals()，却没有hashCode()；或类定义了equals()，却使用Object.hashCode()；或类定义了hashCode()，却没有equals()；或类定义了hashCode()，却使用Object.equals()；类继承了equals()，却使用Object.hashCode()。

SQL：Statement 的execute方法调用了非常量的字符串；或Prepared Statement是由一个非常量的字符串产生。

DE：方法终止或不处理异常，一般情况下，异常应该被处理或报告，或被方法抛出。

Correctness 一般的正确性问题可能导致错误的代码，下面列举几个：NP：空指针被引用；在方法的异常路径里，空指针被引用；方法没有检查参数是否null；null值产生并被引用；null值产生并在方法的异常路径被引用；传给方法一个声明为@NonNull的null参数；方法的返回值声明为@NonNull实际是null。

Nm：类定义了hashcode()方法，但实际上并未覆盖父类Object的hashCode()；类定义了tostring()方法，但实际上并未覆盖父类Object的toString()；很明显的方法和构造器混淆；方法名容易混淆。

SQL：方法尝试访问一个Prepared Statement的0索引；方法尝试访问一个ResultSet的0索引。

UwF：所有的write都把属性置成null，这样所有的读取都是null，这样这个属性是否有必要存在；或属性从没有被write。

Internationalization 国际化当对字符串使用upper或lowercase方法，如果是国际的字符串，可能会不恰当的转换。

Malicious code vulnerability 可能受到的恶意攻击如果代码公开，可能受到恶意攻击的代码，下面列举几个：FI：一个类的finalize()应该是protected，而不是public的。

MS：属性是可变的数组；属性是可变的Hashtable；属性应该是package protected的。

Multithreaded correctness 多线程的正确性多线程编程时，可能导致错误的代码，下面列举几个：ESync：空的同步块，很难被正确使用。

MWN：错误使用notify()，可能导致IllegalMonitorStateException异常；或错误的使用wait()。

No：使用notify()而不是notifyAll()，只是唤醒一个线程而不是所有等待的线程。

SC：构造器调用了Thread.start()，当该类被继承可能会导致错误。

Performance 性能问题可能导致性能不佳的代码，下面列举几个：DM：方法调用了低效的Boolean的构造器，而应该用Boolean.valueOf(…)；用类似Integer.toString(1) 代替new Integer(1).toString()；方法调用了低效的float的构造器，应该用静态的valueOf方法。

SIC：如果一个内部类想在更广泛的地方被引用，它应该声明为static。

SS：如果一个实例属性不被读取，考虑声明为static。

UrF：如果一个属性从没有被read，考虑从类中去掉。

UuF：如果一个属性从没有被使用，考虑从类中去掉。

Dodgy 危险的具有潜在危险的代码，可能运行期产生错误，下面列举几个：CI：类声明为final但声明了protected的属性。

DLS：对一个本地变量赋值，但却没有读取该本地变量；本地变量赋值成null，却没有读取该本地变量。

ICAST：整型数字相乘结果转化为长整型数字，应该将整型先转化为长整型数字再相乘。

INT：没必要的整型数字比较，如X <= Integer.MAX_VALUE。

NP：对readline()的直接引用，而没有判断是否null；对方法调用的直接引用，而方法可能返回null。

REC：直接捕获Exception，而实际上可能是RuntimeException。

ST：从实例方法里直接修改类变量，即static属性。

1、和Ant配合使用从/downloads.html下载最新版本的Findbugs，目前的版本是1.3.0, 于2007年11月8日发布。

把解压后目录复制到项目的lib目录下，然后就可以和Ant配合使用了。

FindBugs工作在j2se1.4.0或以后的版本中，需要至少256MB内存。

在Ant脚本中，首先定义Findbugs的解压目录位置：<path id="findbugs.path" ><fileset dir ="${lib.home}/findbugs-1.3.0"><include name ="**/*.jar"/></fileset></path>接着声明Findbugs任务：<taskdef name="findbugs"classname="edu.umd.cs.findbugs.anttask.FindBugsTask" classpathref ="findbugs.path"/>然后建立Findbugs任务：<property name ="findbugs.home" value="${lib.home}/findbugs-1.3.0"/><!-- 定义findbugs的home，findbugs的task要使用--><target name ="findbugs"><findbugs home ="${findbugs.home}"includeFilter="${findbugs_include_filter}"excludeFilter="${findbugs_exclude_filter}"jvmargs="-Xmx384m" output ="html"outputFile ="d:\test.html"><class location ="${build.home}/WEB-INF/classes/"/><!-- 以上定义findbugs查找的类路径--><auxClasspathpath="${lib.home}/findbugs-1.3.0/lib/findbugs-ant.jar"/><auxClasspath><fileset dir="${build.home}/WEB-INF/lib" includes="**/*.jar" /> </auxClasspath><!-- 以上定义上述类所依赖的类路径--><sourcePath path ="${src.home}"/><!-- 以上定义源代码的路径--></findbugs ></target >最后运行ant findbugs即可。

2、Eclipse插件在Eclipse当中安装Findbugs插件和安装CheckStyle一样，可以参照以下五个步骤进行：a. 在Eclipse当中分别打开一下菜单Help->Software Updates->Find and Installb. 选择Search for new features to install 选项然后点击Nextc. 新建一个New Remote Site...d. 输入名称（比如：Findbugs Plug-in）和下面的URL：/eclipsee. 开始安装安装好Findbugs以后，选择Windows -> Show View -> Other… -> FindBugs -> BugDetails打开Bug Details视图。

然后在Package Explorer或Navigator视图中，选中你的Java项目，点击右键，可以看到“Find Bugs”菜单项，子菜单项里有“Find Bugs”和“Clear Bug Markers”两项内容。

我们点中“Find Bugs”，运行结束后可以在Problems中看到增加了如下的警告信息内容。

（图略）FindBugs运行后的警告信息内容不仅在Problems视图中显示，而且将标记在源代码标记框中，在源代码编辑器中我们可以看到警告标识，当光标指向你的警告信息的代码上面时，就会有相应的错误提示信息，与Eclipse本身的错误或警告信息提示类似。

选中Problems视图里出现的相应问题，就会在代码编辑器里切换到相应的代码上去，方便根据相应的提示信息进行代码的修改。