Findbugs使用说明(补足六个汉字).doc

Findbugs使用说明 用途 FindBugs 是一个java bytecode静态分析工具，它可以帮助java工程师提高代码质量以及排除隐含的缺陷。 FindBugs检查类或者 JAR 文件，将字节码与一组缺陷模式进行对比以发现可能的问题。 有了静态分析工具，就可以在不实际运行程序的情况对软件进行分析。FindBugs不是通过分析类文件的形式或结构来确定程序的意图，而是通常使用 Visitor 模式进行分析（ HYPERLINK /wiki/Visitor_patternVisitor 模式的更多信息）。 安装 目前findbugs最新的版本是1.3.9， Eclipse插件的安装 环境要求，Findbugs要求Eclipse 3.4 以上的版本，JRE/JDK 1.5.0以上的版本。 步骤，将edu.umd.cs.findbugs.plugin.eclipse_0090821.zip解压到Eclipse的 plugins子目录下，这样就可以在 eclipse_install_dir/plugins/edu.umd.cs.findbugs.plugin.eclipse_0090821/下看到FindBugs logo图片findbugs.png。 启动Eclipse 然后选择 Help → About Eclipse Platform → Plug-in Details，你应该找到 FindBugs Plug-in。 使用 启动 选中java工程，点击鼠标右键，选择名为“Find Bugs”的菜单，FindBugs开始运行，问题指示器将指向根据bug模式识别出来的潜在问题代码位置。 可选项定制 你还可以通过java工程的属性对话框来定制findbugs的运行方式，可选项包括： 控制Run FindBugs Automatically 开关的checkbox。 选中时, FindBugs 将在每次修改java类后启动运行。 选择最小告警优先级和Bug类别。这些选项将选择哪些警告被显示。例如，如果你选择Medium，只有Medium 和 High priority 警告将被显示。近似地，如果你未选中 Style checkbox，Style类的警告信息将不会被显示。 选择探测器。这个列表允许你选择你想在工程中使用的探测器。 配套的Bug模式解释 为了有针对性的使用这个工具，减少bug的误报，提高使用效率，我们选择了10个左右的bug模式，下面就是对这10个模式的解释。 这些bug可能会引起程序的性能或逻辑问题. 需要说明的是,findbugs能检测的bug pattern远不仅于此,甚至可以定制自己的探测器,因此,这个文档会不断扩充,同时,也欢迎大家不断探索和分享使用实践. ES_COMPARING_PARAMETER_STRING_WITH_EQ ES: Comparison of String parameter using == or != (ES_COMPARING_PARAMETER_STRING_WITH_EQ) This code compares a java.lang.String parameter for reference equality using the == or != operators. Requiring callers to pass only String constants or interned strings to a method is unnecessarily fragile, and rarely leads to measurable performance gains. Consider using the equals(Object) method instead. 使用 == 或者 != 来比较字符串或interned字符串，不会获得显著的性能提升，同时并不可靠，请考虑使用equals()方法。 HE_EQUALS_NO_HASHCODE HE: Class defines equals() but not hashCode() (HE_EQUALS_NO_HASHCODE) This class overrides equals(Object), but does not override hashCode(). Therefore, the class may violate the invariant that equal objects must have equal hashcodes. 类定义了equals()方法但没有重写hashCode()方法，这样违背了相同对象必须具有相同的hashcodes的原则 IT_NO_SUCH_ELEM