FindBugs：简单介绍与使用

简介

Findbugs是一个静态分析工具，它检查类或者JAR 文件，将字节码与一组缺陷模式进行对比以发现可能的问题。Findbugs自带检测器，其中有60余种Bad practice，80余种Correctness，1种 Internationalization，12种Malicious code vulnerability，27种Multithreaded correctness，23种Performance，43种Dodgy。我们还可以自己配置检查规则(做哪些检查,不做哪些检查)，也可以自己来实现独有的校验规则(用户自定义特定的bug模式需要继承它的接口,编写自己的校验类,属于高级技巧)。

白盒测试中的静态检查一般是检查编码标准规范，错误列表。编码规范往往团队会根据自己的经验和风格进行设置一些规范。现在很多IDE工具都会在编辑代码的时候实时的提醒是否符合代码风格。错误列表，一般是代码潜在的bug，由于某种代码写法虽然没有语法错误，但是可能存在错误，比如会导致线程死锁。这些都是错误列表应该检查的。静态检查的可操作方式：

• 代码走查
  程序员之间可以隔一定的时间抽取代码进行走查。
  走查的时候根据汇总报告，把这些经验汇成列表，作为下次代码走查的依据。
  该方式的特点是，手工、多人讨论、操作简单，但是效率会比较低。
• 代码扫描
  使用软件对我们的代码进行扫描，查找出潜在的问题。现在有许多商业的工具能够进行扫描，比如Parasoft JTest、Software Analyzer、pclint等工具，往往不同的工具会针对不同的语言。当然也有很多开源的工具。在这里java方面主要推荐Findbugs。Findbugs可以在多个环境中运行，同时也可以编写自己的检测器，功能比较完善。我们平时可以收集自己的或者是别人的开发经验，把它做成检测器来完善Findbugs的检测体系。软件扫描的特点是，机器扫描、效率高，但是不够灵活。

FindBugs在Android Studio上应用

• 插件
  首先打开Android Studio的的插件界面，输入FindBugs，点击Browse查找,选择FindBugs-IDEA然后单击右侧的Install plugin按钮进行安装，重启IDE即可在下方看到FindBugs选项。
• Gradle

apply plugin: "findbugs"task findbugs(type: FindBugs) {   //toolVersion = "3.0.1"   gnoreFailures= true   effort= "max"   reportLevel= "low"   classes = files("$project.buildDir/intermediates/classes")   source= fileTree('build/intermediates/classes/debug/com/sn/')   classpath= files()   reports{      xml {      destination "build/findbugs.xml"   }}

• Jenkins
  在Gradle中添加FindBugs相关的task后可以在Jenkins中配置该task到构建模块中实现自动集成

FindBugs错误类型说明

• Bad practice 坏的实践，下面列举几个：
  HE：类中equals()与hashCode()没有同时定义，或者使用了错误的对象的hashCode()或equals()。
  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属性。