FindBugs使用

title: FindBugs

版 本 历 史

版本	责任人	日期	备注
V1.0	曾维铭	2017-05-08	创建文档。

1. FindBugs简介

FindBugs是一个Java静态分析工具，用来检查类或者jar文件。通过静态分析方式扫描 Java 字节码，发现其中的可能出现 bug 的代码。

2. 如何引入和使用

FindBugs在Gradle中是当做一个插件存在的，可以Install plugin的方式安装，也可以在Gradle脚本配置.

gradle安装

apply plugin: "findbugs"

task findbugs(type: FindBugs,dependsOn:'assembleDebug') {

    ignoreFailures= true
    effort= "default"
    reportLevel= "high"
    println( "$project.buildDir")
    excludeFilter = new File("$configDir/findbugs/findbugs-filter.xml")
    classes = files("$project.buildDir/intermediates/classes")
    source= fileTree("src/main/java/")
    classpath= files()
    reports{
        xml.enabled=false
        html.enabled=true
        xml {
            destination "$project.buildDir/findbugs.xml"
        }
        html{
            destination "$project.buildDir/findbugs.html"
        }
    }
}

findbugs-filter.xml

findbugs-filter.xml过滤文件，设置不需要检测的文件。这里过滤掉系统自动生成的R类，Manifest文件和测试用例文件。

FindBugs的Bug种类说明

Bad practice 坏的实践

HE： 类定义了equals()，却没有hashCode()；或类定义了equals()，却使用Object.hashCode()；或类定义了hashCode()，却没有equals()；或类定义了hashCode()，却使用Object.equals()；类继承了equals()，却使用Object.hashCode()。
SQL：Statement 的execute方法调用了非常量的字符串；或Prepared Statement是由一个非常量的字符串产生。
DE： 方法终止或不处理异常，一般情况下，异常应该被处理或报告，或被方法抛出。
OS：IO流可能没关闭或关闭失败
RV：没有对return的值检查
Nm：方法名没有以小写开头
Se: 类的序列化问题进行检查

Correctness 一般的正确性问题

NP： 空指针被引用；在方法的异常路径里，空指针被引用；方法没有检查参数是否null；null值产生并被引用；null值产生并在方法的异常路径被引用；传给方法一个声明为@NonNull的null参数；方法的返回值声明为@NonNull实际是null。
SQL：方法尝试访问一个Prepared Statement的0索引；方法尝试访问一个ResultSet的0索引。
UwF：所有的write都把属性置成null，这样所有的读取都是null，这样这个属性是否有必要存在；或属性从没有被write。

Internationalization国际化问题

当对字符串使用upper或lowercase方法，如果是国际的字符串，可能会不恰当的转换。
Dm: 发现依赖本地默认编码

Malicious code vulnerability可能受到的恶意攻击

Ms：应该加上final但没加上
MS：属性是可变的数组；属性是可变的Hashtable；属性应该是package protected的。
FI： 一个类的finalize()应该是protected，而不是public的。

Dodgy 危险的

CI： 类声明为final但声明了protected的属性。
DLS：对一个本地变量赋值，但却没有读取该本地变量；本地变量赋值成null，却没有读取该本地变量。
ICAST： 整型数字相乘结果转化为长整型数字，应该将整型先转化为长整型数字再相乘。
INT：没必要的整型数字比较，如X <= Integer.MAX_VALUE。
NP： 对readline()的直接引用，而没有判断是否null；对方法调用的直接引用，而方法可能返回null。
REC：直接捕获Exception，而实际上可能是RuntimeException。
ST： 从实例方法里直接修改类变量，即static属性。

Performance 性能问题

DM：方法调用了低效的Boolean的构造器，而应该用Boolean.valueOf(…)；用类似Integer.toString(1) 代替new Integer(1).toString()；方法调用了低效的float的构造器，应该用静态的valueOf方法。
SIC：如果一个内部类想在更广泛的地方被引用，它应该声明为static。
SS： 如果一个实例属性不被读取，考虑声明为static。
UrF：如果一个属性从没有被read，考虑从类中去掉。
UuF：如果一个属性从没有被使用，考虑从类中去掉。
WMI：Map遍历性能问题

Multithreaded correctness 多线程的正确性

ESync：空的同步块，很难被正确使用。
MWN：错误使用notify()，可能导致IllegalMonitorStateException异常；或错误的使用wait()。
No： 使用notify()而不是notifyAll()，只是唤醒一个线程而不是所有等待的线程。
SC： 构造器调用了Thread.start()，当该类被继承可能会导致错误。
Is：线程加锁不合理

3. Jenkins配置findbugs

增加构建后操作步骤
[图片上传失败...(image-b05eeb-1533529909422)]
[图片上传失败...(image-8796f0-1533529909422)]
修改一下gradle配置,将输出格式改为XML，然后，构建命令也要添加findbugs
[图片上传失败...(image-61c350-1533529909422)]
邮箱也相应添加findbugs报告
[图片上传失败...(image-ce8a5-1533529909422)]
保存配置，立即构建。如果运行正常的话，可以看到如下的报告
[图片上传失败...(image-17c948-1533529909422)]
你也可以从邮箱内容打开链接查看报告
[图片上传失败...(image-846438-1533529909422)]