目录
简介
IDEA安装FindBugs
Findbugs配置
配置排除一些类
扫描级别
IDEA中使用FindBugs:
一些常见错误
补充
简介
Findbugs是一个静态分析工具,它检查类或者JAR 文件,将字节码与一组缺陷模式进行对比以发现可能的问题。Findbugs自带检测器,其中有60余种Bad practice,80余种Correctness,1种 Internationalization,12种Malicious code vulnerability,27种Multithreaded correctness,23种Performance,43种Dodgy。我们还可以自己配置检查规则(做哪些检查,不做哪些检查),也可以自己来实现独有的校验规则(用户自定义特定的bug模式需要继承它的接口,编写自己的校验类)。
IDEA安装FindBugs
(1)在线安装:菜单File->Settings->Plugins->Browse repositories…->搜索框内搜索FindBugs->得到结果FindBugs-IDEA,下载(install)并重新启动就ok了。
(2)离线安装:首先要下载FindBugs压缩包,下载网址:FindBugs压缩包,然后菜单File->Settings->Plugins->Install plug from disk->选择你下载的FindBugs压缩包(因为包含jar包较多),然后apply->OK,重启就ok了。
FindBugs-IDEA
IDEA版本新一点的装不上,评论说用Spotbugs替换了
Findbugs配置
配置排除一些类
选择xml文件, 例如findbugs-exclude-filter.xml
扫描级别
Minimum rank to report错误信息分成了3个级别
Findbugs将错误信息分成了3个级别,依据严重程度High>Medium>Low,用户可以根据需要进行筛选。比如:
(1)High选择项,只有是High级别的提示信息才会被显示。
(2)Medium选择项,只有是Medium和High级别的提示信息才会被显示。
(3)Low选择项,所有级别的提示信息都会被显示。
此外,还有一个拖动条供选择rank等级(1-20),rank越高,严重程度越低,显示的信息越多。一般选择14,15就差不多够用了。
IDEA中使用FindBugs:
选中项目,包,类,右击鼠标,选择FindBugs,
- Analyze Selected File(s)单个文件
- Analyze Package(s) Files包下文件
- Analyze Module Files整个module
- Analyze Project Files整个工程
一些常见错误
Bad practice 坏的实践,主要是代码中的一些坏习惯,没有按Java规范来, 下面列举几个: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 补充 Multithreaded correctnessSleep with lock held当持有对象时调用Thread.sleep()。这可能会导致很差的性能和可扩展性,或陷入死锁,因为其他线程可能正在等待获得锁。调用wait()是一个更好的主意,释放对象的持有以允许其他线程运行。注意:sleep方法没有释放锁,而wait方法释放了锁CorrectnessNull pointer dereference空指针取消引用Method call passes null for non-null parameter方法调用为非null参数传递nullNon-virtual method call passes null for non-null parameter非虚拟方法调用为非null参数传递nullSecurity 关于代码安全性防护HTTP Response splitting vulnerability HTTP响应拆分漏洞HTTP parameter directly written to HTTP header output 估计是把参数直接写进头部了 ,没有做任何处理// responses.setHeader("Access-Control-Allow-Origin", originHeader);responses.addHeader("Access-Control-Allow-Origin", URLEncoder.encode(originHeader, StandardCharsets.UTF_8.displayName()));