Findbugs插件操作手册(Eclipse版).docx

Eclipse安装findbugs插件操作手册
一、 前言
findbugs是一个开源的eclipse 代码检查工具，它可以简单的帮助我们发现程序代码中存在的bug、bad smell与潜在的隐患。针对各种问题，它并且提供了简单的修改意见供我们重构时进行参考。
通过使用findbugs，可以一定程度上降低我们code review的工作量，并且会提高review效率。多重构代码，可以培养我们的编码意识及水平，形成好的习惯提高开发编码能力。
二、 环境准备
本例为基于Eclipse JUNO版作为基础IDE进行安装。
若安装最新版的Findbugs插件（高于3.0版本），Eclipse所使用的JDK必须高于1.7，否则会导致插件安装成功却找不到插件问题。
三、 安装fingbugs插件
1) 点击eclipse工具栏中的help,打开可找到eclipse Markerplace,点击进入。在查找输入框处输入findbugs，点击查找。找到后点击findbugs Eclipse plugin install按钮安装

2) 打开eclipse->window->Preferences，搜索关键字findbugs,如果能找到配置项，那么表示安装成功，如图：

3) 点击eclipse工具栏windows,show view里面的other，找到findbugs,再点击出bug explorer,如下图:

Bug Explorer是用来显示找到的bugs类型和数量。

四、 配置findbugs
Findbugs默认的代码检查比较宽松，建议使用以下步骤将检查类别都开启，使用习惯后可自行调整Findbugs的配置。

五、 findbugs使用例子
1) 在eclipse package Explorer 右键选择目标工程-> build project

2) 选择指定的包或者类进行findbug

3) 此时findbugs会遍历指定的包或者类，进行分析，找出代码bug，然后集中显示在 find bugs 的bugs explorer 中,我们就可以查看刚刚找到的bugs了，如图：

找出的bug有3中颜色， 黑色的臭虫标志是分类， 红色的臭虫表示严重bug发现后必须修改代码，橘黄色的臭虫表示潜在警告性bug 尽量修改。
4) 双击bug项目就可以在右边编辑窗口自动打开相关代码文件并连接到代码片段。 点击行号旁边的小臭虫图标后再eclipse下方输出区将提供详细的bug描述，以及修改建议等信息。我们可以根据此信息进行修改。

5) Bug Info中说明每个Bug的具体原因：

六、 注意事项
1. Findbugs只是一个可以帮我们检测出某种类型的错误与显而易见的隐患，不代表通过了findbugs校验的代码就正确无误，请勿形成过分依赖；
2. 请通过每一条修改意见提高自己的编码意识，工具不仅是工具；
3. Findbugs针对资源关闭的检查与三元表达式的检查有缺陷，可能对正确的代码产生错误提醒，若有看不出问题所在的错误提醒，请与项目组讨论；
4. Findbugs运行时比较耗内存，最好针对某个模块进行代码检查，若需要针对整个工作区进行扫描，请将eclipse最大栈调大；
5. 提交CVS前，建议先使用Findbugs进行检查。