findBugs使用_findbugs-idea使用文档

作者：芋道源码
链接：https://zhuanlan.zhihu.com/p/87056110
来源：知乎
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。
 

1. FindBugs-IDEA

作用：

检测代码中可能的bug及不规范的位置，写完代码后检测下 避免低级bug。

静态分析工具承诺无需开发人员费劲就能找出代码中已有的缺陷。当然，如果有多年的编写经验，就会知道这些承诺并不是一定能兑现。

插件提供地址：

https://plugins.jetbrains.com/plugin/3847-findbugs-idea

成功标志：

重启idea后如果插件加载成功左下角出现：

实际应用：

 

 

扫描完成后：

 

 

附录（网摘）：

FindBugs 它用来查找Java代码中存在的bug。它使用静态分析方法标识出Java程序中上百种潜在的不同类型的错误。

FindBugs支持对包级别、项目级别、模块级别、单个文件级别，以及自定义范围的Bug分析。

FindBugs：特色是能够检查出空指针异常这种bug！

使用：右键单击（module、单个文件等）--->在快捷菜单中选择findbugs即可

附:FindBugs的Bug种类说明

Bad practice 坏的实践

一些不好的实践，下面列举几个：

• HE：类定义了equals()，却没有hashCode()；或类定义了equals()，却使用Object.hashCode()；或类定义了hashCode()，却没有equals()；或类定义了hashCode()，却使用Object.equals()；类继承了equals()，却使用Object.hashCode()。
• SQL：Statement 的execute方法调用了非常量的字符串；或Prepared Statement是由一个非常量的字符串产生。
• DE：方法终止或不处理异常，一般情况下，异常应该被处理或报告，或被方法抛出。
  Malicious code vulnerability 可能受到的恶意攻击

如果代码公开，可能受到恶意攻击的代码，下面列举几个：

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

类名小写问题：

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。

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：如果一个属性从没有被使用，考虑从类中去掉。

Multithreaded correctness 多线程的正确性

多线程编程时可能导致错误的代码，下面列举几个：

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

Internationalization 国际化

当对字符串使用upper或lowercase方法，如果是国际的字符串，可能会不恰当的转换。