【工具教程】Idea 中使用 FindBugs 插件检测 Bug 和潜在的问题, 代码自动检测

Idea 中使用 FindBugs 插件检测 Bug 和潜在的问题

一、安装

依次点击 File | Settings | Plugins ，进入插件安装。

如图所示，搜索 FindBugs，进行安装，安装完成后，重启 idea。

二、使用

在模块或文件上右击，鼠标移动到 FindBugs，选择分析范围，并进行分析，也可直接打开控制台进行操作。

二、问题类型说明

Bad pratice（不良行为 ）

编程上的一些坏习惯，常见如下几种，严重等级不高，结合实际情况进行修改。

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

Malicious code vulnerability（恶意代码漏洞）

主要是一些属性使用了 public 修饰符，别的类可直接获取让别的类来获取,建议改为 private 并为其提供 get/set 方法. 或者一些 public 的静态字段,可能会被别的包获取等.此类问题需要结合实际项目情况，如果你认为这些不需要修改,完全可以忽略。

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

Dodgy code （糟糕的代码）

具有潜在危险的代码，可能运行期产生错误，此处建议修改。下面列举几个：

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

Internationalization （国际化问题）

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

Performance （性能问题）

可能导致性能不佳的代码，下面列举几个：

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

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。

Multithreaded currectness（线程问题）

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

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

此外还有 Experrimental （实验性问题）、Security （安全问题）等，具体在使用的时候都有相关信息提示，更多请参见官网。

API：http://findbugs.sourceforge.net/api/index.html
技术手册：http://findbugs.sourceforge.net/manual/index.html
官网：http://findbugs.sourceforge.net/bugDescriptions.html