代码分析工具findbug简介和使用

转帖记录一下代码分析工具，

http://www.51testing.com/?uid-106134-action-viewspace-itemid-92568

 

 

FindBugs（http://findbugs.sourceforge.net/ ） 版本1.1.1

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

自带检测器的介绍: findbugs 自带60 余种Bad practice ，80 余种Correntness ，1 种 Internationalization ，
   12 种Malicious code vulnerability ，27 种Multithreaded correntness ，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 危险的

    具有潜在危险的代码，可能运行期产生错误，下面列举几个：

    BC ： 对抽象集合如List 、Set 的造型；对具体集合如ArrayList 、HashSet 的造型；

未检查或无法保证的造型；

CI ： 类声明为final 但声明了protected 的属性。

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

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

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

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

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

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

 

自定义检测器: findbugs 提供了强大的自定义检测器的功能，首先我们应该清楚需要

检查的案例，findbugs 的官 方文档里并没有详细的介绍如何自定义，那我们只能直接阅读它的源码了，着重阅读BytecodeScanningDetector 和ByteCodePatternDetector 的子类型，它们可以检测一般类型的问题。Findbugs 利用了Byte Code Engineering Library （即BCEL ，Apache 上 的一个开源项目），以实现其检测器，所有的字节码扫描都是基于visitor 模式。我们可以参照findbugs 自带的检测器的类的源码，去编写一个自定义的检测器代码，编写完后编译成类文件，同时我们还 需要提供两个XML 文件，Findbugs.xml 和message.xml ，在Findbugs.xml 里 指定检测器和实现类，检测器的缩写、类型如快速或慢速，而message 文件里则包括了该检测器的 描述信息，可能是html 的，然后将源文件、类文件和上面两个XML 文件打包成jar 文件，放在findbugs home 的plugin 文件夹下，这 样我们就可以使用自定义检查器了。

 

参考文档：

FindBugs 官方文档（http://findbugs.sourceforge.net/ ）

FindBugs ，第1 部分: 提高代码质量

http://www-128.ibm.com/developerworks/cn/java/j-findbug1/

FindBugs ，第2 部分: 编写自定义检测器

http://www-128.ibm.com/developerworks/cn/java/j-findbug2/

代码静态分析（http://blog.donews.com/foxgem/archive/2005/04/23/347444.aspx ）

 

Findbugs使用说明<br>目的<br> Findbugs是一个代码质量工具；我们用它来检查源代码中出现的伪问题，以期尽可能在项目的初始阶段将代码问题解决。本文主要介绍Findbugs的 eclipse插件的应用。 对应的版本是：Findbugs （0.0.16）;eclipse (3.1)<br><br>概要<br> FindBugs 是一个静态分析工具，它检查类或者 JAR 文件，将字节码与一组缺陷模式进行对比以发现可能的问题。我们利用它在eclipse中的插件来对它所过滤的工程的源代码进行检查。希望在程序员编写代码 的过程中，将代码中的缺陷指出来，让编码人员在开发中将它们纠正。达到尽可能在项目编码中将问题解决得目的。而不是在编码结束的时候才用该软件对代码检 查，修改。<br>

Eclipse插件开发之FindBugs插件：http://soft.yesky.com/480/2291980_1.shtml