Eclipse插件FindBugs使用手册.doc

Eclipse 插件 FindBugs 使用手册 前言： 本文介绍如何利用 Eclipse 插件FindBugs 优化 Java 代码。 本插件是本人在对系统进行代码优化的时候，向迟焕祺同事索取并学习使用的，现在把工具的一些使用方法与大家共享，并把 FindBugs提供给大家！ 感谢迟哥提供良好资源供大家学习、使用！ 问题提出： 当我们编写完代码，做完单元测试等各种测试后就提交正式运行，只能由运行的系统来检测我们代码是否有问题了， 代码中隐藏的错误在系统运行的过程中被发现后，然后再来进行相应的修改，那么后期修改的代价就相当高了。 解决方法： 现在有很多 Java 代码分析工具，FindBugs 中开源项目当中的一个，它可以帮你找到代码中隐藏的一些错误，提升你的代码能力与系统安全可靠性。 FindBugs 介绍 FindBugs 是一个可以在Java 程序中发现Bugs 的程序。 它是专门用来寻找处于“Bug Patterns”列表中的代码的。 Bug Patterns 指很有可能是错误的代码的实例。 原文：FindBugs is a program to find bugs in Java programs. It looks for instances of bug patterns - code instances that are likely to be errors. 使用 FindBugs 至少需要JDK1.4.0 以上版本，FindBugs是平台独立的，可以运行于 GNU/Linux、Windows、MacOS X 等平台上。 运行 FindBugs 至少需要有 256 MB 内存，如果你要分析一个很大的项目，那就需要更加多的内存了。 获取 FindBugs 最新版本:/projects/findbugs/files/ FinBugs 介绍:/manual/ Eclipse 插件 links 文件夹方式配置： 提示：直接的插件配置方式是使用 Eclipse 的Update 方式更新，或者把新下载的插件 PlugIn 放在原始的 Eclipse 目录下去， 这种方式会随着插件的增多而导致插件维护工作量的增加。 鉴于上述原因，可以使用 links 文件夹的方式进行配置。（MyEclipse 插件就是使用 links 的方式进行配置的）配置方式如下： 1. 安装好 Eclipse 工具，可以到 上下载压缩包。比如安装在 E:OpenSourceEclipse目录下， 以下这个目录以%ECLIPSE_HOME%来进行表示； 2. 此时默认的插件是在%ECLIPSE_HOME%plugins目录中的； 3. 在%ECLIPSE_HOME%下建立一个 PlugInsNew的目录； 比如：E:OpenSourceEclipsePlugInsNew 4. 你下载了个新的插件，比如叫做：XYZ 那么就在%ECLIPSE_HOME%PlugInsNew目录下建立 XYZ目录，目录里面是 eclipse 目录，eclipse 目录包含有features与 plugins两个子目录；结构如下图所示： Eclipse 插件目录示例1那么插件配置方式： 1. 把下载的新插件的文件放在以下相应目录中 %ECLIPSE_HOME%PlugInsNewXYZeclipsefeatures %ECLIPSE_HOME%PlugInsNew XYZeclipseplugins 2. 建立相关的.link 的文件 然后在%ECLIPSE_HOME%links目录里建立一个 XYZ.link的文件，内容如是：path=E:/OpenSource/Eclipse/PlugInsNew/XYZ就一行这样的路径指示而已。 3. 重新启动 Eclipse 即可 FindBugs 插件配置：（MyEclipse 的配置方式也一样） FindBugs 插件安装方法采用上一节的Eclipse 使用技巧之插件管理 重新启动 Eclipse 后，在Help = About Eclipse SDK = Plug-in Details你可以看到由“FindBugs Project”提供的“FindBugs Plug-in”版本 0.0.17 插件，如下图所示： FindBugs-Plug-in 版本 2FindBugs 工具的使用 在 Package Explorer或 Navigator视图中，选中你的 Java 项目，右键，可以看到“Find Bugs”菜单项，子菜单项里有“Find Bugs”和“Clear Bug Markers”两项内容，如下图所示： FindBugs插件 3我们建立一个简单的测试文件 Test.java 内容如下： public class Test private String name; public String getName() return name; public void setName(String name) = name; 我们点中“Find Bugs”，运行时会出现如下进度框： 运行结束后可以在 Problems 中看到增加了如下的警告信息内容FindBugs检测结果 4选中 Problems 视图里出现的相应问题，就会在代码编辑器里切换到相应的代码上去，方便根据相应的提示信息进行代码的修改。 will point to locations in your code which have been identified as potential instances of bug patterns. 在 Problems 视图里，选中相应的问题条目，右键，在弹出的菜单中，可以看到“Show Bug Details”，如下图所示：图片 5点中它，会切换到Bug Details 视图上去，显示更加详细的提示信息。 FindBugs 运行后的警告信息内容不仅在Problems 视图中显示，而且将标记在源代码标记框中，在源代码编辑器中我们可以看到警告标识（与 Eclipse 的警告标示类似）当光标指向你的警告信息的代码上面时， 就会有相应的错误提示信息， 与Eclipse本身的错误或警告信息提示类似。 当然，在代码编辑窗口中，点击带有警告提示信息的图标时，也会自动切换到Bud Details 窗口去，查看详细的警告信息，如下图所示。 FindBugs 提示 6根据这里详细的信息，你可以得到 FindBugs 为什么会对你的代码报警告信息，及相应的处理办法，根据它的提示，你可以快速方便地进行代码修改。 FindBugs 提示修改信息 7根据提示，我们将代码修改成如下，再运行就不会报有警告信息了。 public class Test private String name; public String getName() String temp = name; return temp; public void setName(String name) String temp = name; = temp; 配置 FindBugs 选择你的项目，右键 = Properties = FindBugs = FindBugs配置界面 8可以配置的信息包括如上图所示的四个选项的相关设置： 1. Run FindBugs Automatically开关 当此项选中后，FindBugs 将会在你修改Java 类时自动运行，如你设置了Eclipse 自动编译开关后，当你修改完Java 文件保存，FindBugs就会运行，并将相应的信息显示出来。当此项没有选中，你只能每次在需要的时候自己去运行 FindBugs来检查你的代码。2. Minimum priority to report 选择项 这个选择项是让你选择哪个级别的信息进行显示，有 Low、Medium、High三个选择项可以选择，很类似于 Log4J的级别设置啦。比如： 你选择了 High 选择项，那么只有是 High 级别的提示信息才会被显示。 你选择了 Medium 选择项，那么只有是 Medium 和 High 级别的提示信息才会被显示。 你选择了 Low选择项，那么所有级别的提示信息都会被显示。 3. Enable bug categories选择项 在这里是一些显示 Bug分类的选择： Correctness 关于代码正确性相关方面的 Performance 关于代码性能相关方面的 Internationalization 关于代码国际化相关方面的 Multithreaded correctness 关于代码多线程正确性相关方面的 Style 关于代码样式相关方面的 Malicious code vulnerability关于恶意破坏代码相关方面的 比如：如果你把 Style 的检查框去掉不选择中它，那么与 Style 分类相关的警告信息就不会显示了。其它的类似。 4. Select bug p