maven项目引入findbugs检查

• 准备工作

     由于findbugs需要依赖较多的jar包，因此建议先修改maven镜像到网速好的点，避免构建时等待下载依赖包时间太长；

     1、在 myeclipse的windows->refrences下输入maven定位到 installations
     2、开打user settings 指向的settings.xml文件编辑
     

     3、在settings.xml的mirrors下增加镜像节点，推荐节点：
         <mirror>     

          <id>repo2</id>     
          <mirrorOf>central</mirrorOf>     
          <name>Human Readable Name for this Mirror.</name>     
          <url>http://repo2.maven.org/maven2/</url>     

          </mirror> 

     如图：

     

     4、保存文件，退出

• 引入findbugs

     1、配置pom.xml文件，增加plusgin如下：

                < plugin >

                     < groupId > org.codehaus.mojo </ groupId >

                    < artifactId > findbugs-maven-plugin </ artifactId >

                    < version > 3.0.2 </ version >

                    < executions >

                         < execution >

                               < goals >

                                     < goal > check </ goal >

                               </ goals >

                         </ execution >

                    </ executions >

                    < configuration >

                         < findbugsXmlOutput > true </ findbugsXmlOutput >

                               < findbugsXmlWithMessages > true </ findbugsXmlWithMessages >

                               < xmlOutput > true </ xmlOutput >

                               < failOnError > false </ failOnError >

                    </ configuration >

                </ plugin >

     2、右键pom.xml选择 run as -> open run dialog

     3、配置name， base directory选择项目路径,  goals 配置 findbugs:gui，如图：

     

     

     4、点击 run即可，等待下载依赖包结束后，即自动分析代码，弹出findbugs界面，如图：

     

• 使用简介

1. 缺陷类型说明

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