代码检查工具系列——FindBugs

时间：2022-10-22 16:19:51

前言

　　随着项目越来越复杂，工程越来越庞大，单纯的依靠人工去检查代码中存在的潜在问题是不现实的，单元测试也无法完全覆盖，因此借助自动化工具去做一些代码检查的事情是十分必要的，因此本系列文章将主要讲述几个常用的代码检查工具。

FindBugs

　　FindBugs 是一个静态分析工具，它检查类或者 JAR 文件，将字节码与一组缺陷模式进行对比以发现可能的问题。
　　FindBugs 不注重样式或者格式，它试图只寻找真正的缺陷或者潜在的性能问题。

安装

　　FindBugs可以通过两种方式集成到Eclipse中：

在线安装

　　eclipse –> help –> Install NewSoftware
　　弹出对话框，点击add，如下图配置：
　　代码检查工具系列——FindBugs
　　http://findbugs.cs.umd.edu/eclipse
　　然后点击OK，一路安装就OK了。

离线安装

　　下载FindBugs的安装包，并解压，将其中的features和 plugins目录下的文件分别拷贝到Eclipse下对应的目录中，并重启Eclipse即可。
　　在完成上述步骤后，点击Windows –> showViews –> others
　　代码检查工具系列——FindBugs
　　则表示安装成功。

使用

　　FindBugs的使用十分简单，只需在项目上右键–>Find Bugs–>FindBugs
　　工具就运行了，然后可以在Windows–>showViews–>others–>FindBugs–>Bugs Explore
　　就可以查看到存在的潜在的bug了，如下图所示：
　　代码检查工具系列——FindBugs
　　根据相应的提示信息，就可以查看可能存在的问题了。

FindBugs规则设置

右键项目–>properties–>FindBugs调出FindBugs的配置图：
代码检查工具系列——FindBugs
勾选图中箭头所指位置，就可以启用自定义的规则了。

可以配置的信息包括如上图所示的四个选项的相关设置：

  • .Run Automatically开关

当此项选中后，FindBugs将会在你修改Java类时自动运行，如你设置了Eclipse自动编译开关后，当你修改完Java文件保存，FindBugs就会运行，并将相应的信息显示出来。当此项没有选中，你只能每次在需要的时候自己去运行FindBugs来检查你的代码。

  • Reporter Configuration页

设置FindBugs报告的bug等级，类别以及对不同的bug以哪种方式来报告，可以制定为错误，警告等。

  • Filter files页

手动制定bug过滤规则，导入的文件格式为xml文件，具体没有格式没有仔细研究过。
- Plugins and misc Settings页

没啥用
- Detector configuration页

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

FindBugs自带检测的简单说明

  • 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属性。

总结

　　FindBugs是刚刚接触，它是一个用于代码检测的工具，很强大，十分好用，当然它的规则也很多，以后变用边学，暂且了解这么多。
标签：

相关文章