Eclipse下使用findbugs进行代码审查

1、FindBugs介绍

FindBugs是一款Java静态代码分析工具，与其他静态分析工具（如Checkstyle和PMD）不同，FindBugs 不注重样式或者格式，它专注于寻找真正的缺陷或者潜在的性能问题,它可以帮助java工程师提高代码质量以及排除隐含的缺陷。有了静态分析工具，就可以在不实际运行程序的情况对软件进行分析。

最新版本是1.3.9.20090821，下载地址http://findbugs.sourceforge.net/downloads.html。

FindBugs运用Apache BCEL 库分析类文件（class文件）而不是源代码，将字节码与一组缺陷模式进行对比以发现可能的问题。FindBugs的检测器已增至300多条，被分为不同的类型，常见的类型如下：

· 正确性（Correctness）：这种归类下的问题在某种情况下会导致bug，比如错误的强制类型转换等。

· 最佳实践反例（Bad practice）：这种类别下的代码违反了公认的最佳实践标准，比如某个类实现了equals方法但未实现hashCode方法等。

· 多线程正确性（Multithreaded correctness）：关注于同步和多线程问题。

· 性能（Performance）：潜在的性能问题。

· 安全（Security）：安全相关。

· 高危（Dodgy）：FindBugs团队认为该类型下的问题代码导致bug的可能性很高。

 

2、在Eclipse中安装FindBugs插件

   下载Eclipse plugin 的版本，解压zip文件。

   将解压后的文件放到Eclipse的Plugin中。

   重新启动Eclipse 。

 

    我使用的是MyEclipse8.5可能路径和大家的不太一样，我是放到了路径Genuitec/MyEclipse 8.5/dropins下面

 

 

3、在Eclipse中使用FindBugs

重新启动eclipse

打开FindBugs视图

 

 

执行Find Bug 任务

右键单击你要检测的工程、包或文件，-->Find Bugs-->Find Bugs。

check完成后将在Bug Explorer视图中看到问题列表，该列表以问题类型组织。

 

 

 

展开列表，双击列表中具体的问题就可以定位的具体的代码行。

 

 

 

4、配置FindBugs
在这里可以对FindBugs规则等进行详细设置。 
　　选择你的项目，右键 => Properties => FindBugs =>

 

1 Run Automatically开关

当此项选中后，FindBugs将会在你修改Java类时自动运行，如你设置了Eclipse自动编译开关后，当你修改完Java文件保存，FindBugs就会运行，并将相应的信息显示出来。
当此项没有选中，你只能每次在需要的时候自己去运行FindBugs来检查你的代码。

2 Detector Configuration选择项

在这里你可以选择所要进行检查的相关的Bug Pattern条目,你可以根据需要选择或去掉相应的 检查条件。

 

3 Minimum priority to report选择项
这个选择项是让你选择哪个级别的信息进行显示，有Low、Medium、High三个选择项可以选择，很类似于Log4J的级别设置啦。 比如：

你选择了High选择项，那么只有是High级别的提示信息才会被显示。
你选择了Medium选择项，那么只有是Medium和High级别的提示信息才会被显示。
你选择了Low选择项，那么所有级别的提示信息都会被显示。

4 Report bug categories选择项
在这里是一些显示Bug分类的选择：
Malicious code vulnerability关于恶意破坏代码相关方面的
Correctness关于代码正确性相关方面的
Internationalization关于代码国际化相关方面的
Performance关于代码性能相关方面的
Multithreaded correctness关于代码多线程正确性相关方面的

另外FindBugs有UI页面，可以单独运行。也可以通过Ant以及命令行方式运行。

 

 

5、其它分析工具

除FingBugs静态分析工具外，还有PMD和Checkstyle，FingBugs、PMD和Checkstyle三个工具各有不同的特点，联合使用有助于减少误报错误，提高报告的准确率。

 

这三个工具检查的侧重点各有不同： 

工具

目的

主要检查内容

FindBugs

基于Bug Patterns概念，查找java bytecode中的潜在bug。在目前版本中，它不检查java源文件。

主要检查bytecode中的bug patterns，也允许用户自定义特定的bug patterns。

PMD

检查java源文件中的潜在问题。

主要包括：

  -  空try/catch/finally/switch语句块

 -       未使用的局部变量、参数和private方法

 -       空if/while语句

 -       过于复杂的表达式，如不必要的if语句等

 -       复杂类

CheckStyle

检查java源文件是否与代码规范相符

主要包括

 -       Javadoc注释

 -       命名规范

 -       Headers

 -       Imports

 -       Size冲突和度量，如过长的方法

 -       Whitespace

 -       Modifiers

 -       Blocks

 -       Coding Problems

 -       Class Design

 -       重复代码

 -       Miscellaneous Checks

 -       Optional Checks

 

 

Findbug官网地址：http://findbugs.sourceforge.net/

FindBugs的详细bug描述清单见：http://findbugs.sourceforge.net/bugDescriptions.html