繁星满空

静态分析工具及使用总结（三）

这里主要介绍三种开源的工具，PMD、CheckStyle和FindBugs，着重是在Ant里的调用，据说商业软件JTest也是著名的代码分析工具，哈哈，要花钱的没有用过。

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

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

用法:在图形界面下使用findbugs，可以新建一个工程，设置类的路径和源代码的路径， 详细的文档请参考官方文档。
       下面主要介绍在Ant里的调用。

  下面是build.xml的相关配置：

< path  id ="findbugs.path" >
   < fileset  dir ="${lib.dir}/findbugs-1.1.1" >
       < include  name ="**/*.jar"   />
   </ fileset >
</ path >
< taskdef  name ="findbugs"  classname ="edu.umd.cs.findbugs.anttask.FindBugsTask"  classpathref ="findbugs.path" />
<!--  以上定义findbugs的task  -->

< property  name ="findbugs.home"  value ="${lib.dir}/findbugs-1.1.1"   />
<!--  定义findbugs的home，findbugs的task要使用  -->

 < target  name ="findbugs" >
    < findbugs  home ="${findbugs.home}"  includeFilter  = "${lib.dir}\findbugs-1.1.1\ plugin\filter.xml"  output ="html"  outputFile ="d:\test.html"   >
        < class  location ="${class.dir}/classes/ "   />
        <!--  以上定义findbugs查找的类路径  -->
        < auxClasspath  refid ="classpath" />
        <!--  以上定义上述类所依赖的类路径  -->
        < sourcePath  path ="${src.dir}"   />
        <!--  以上定义源代码的路径  -->
    </ findbugs >
</ target >

      其中的${lib.dir}\findbugs-1.1.1\ plugin\filter.xml配置文件的内容如下：

使用过滤器我们就可以定义使用哪些bug检测器和针对哪些类进行检查，因为一旦 项目比较庞大，
      那查看冗长的bug报告也是十分痛苦的事情。

< FindBugsFilter >
     <!--  该类使用所有的bug检测器  -->
     < Match  class ="com.foobar.AClass" >     
     <!--  该类使用bugcode为HE的检测器  -->
     < Match  class ="com.foobar.BClass" >
         < BugCode  name ="HE"   />
     </ Match >
     <!--  该类的AMethod和BMethod方法使用bugcode为HE的检测器  -->
     < Match  class ="com.foobar.CClass" >
         < Or >
             < Method  name ="AMethod" />
             < Method  name ="BMethod" />
         </ Or >
         < BugCode  name ="HE" />
     </ Match >
  </ FindBugsFilter >

自带检测器的介绍: 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/