Findbugs如何使用?Findbugs的使用说明

所属分类: 软件教程 / 其他工具 阅读数: 1799
收藏 0 赞 0 分享

Findbugs使用说明

1 用途

FindBugs 是一个java bytecode静态分析工具,它可以帮助java工程师提高代码质量以及排除隐含的缺陷。

FindBugs检查类或者 JAR 文件,将字节码与一组缺陷模式进行对比以发现可能的问题。

有了静态分析工具,就可以在不实际运行程序的情况对软件进行分析。FindBugs不是通过分析类文件的形式或结构来确定程序的意图,而是通常使用 Visitor 模式进行分析(Visitor 模式的更多信息)。

2 安装

目前findbugs最新的版本是1.3.9,

2.1 Eclipse插件的安装

环境要求,Findbugs要求Eclipse 3.4 以上的版本,JRE/JDK 1.5.0以上的版本。

步骤,将edu.umd.cs.findbugs.plugin.eclipse_1.3.9.20090821.zip解压到Eclipse的 "plugins"子目录下,这样就可以在 <eclipse_install_dir>/plugins/edu.umd.cs.findbugs.plugin.eclipse_1.3.9.20090821/下看到FindBugs logo图片findbugs.png。 

启动Eclipse 然后选择 Help → About Eclipse Platform → Plug-in Details,你应该找到 "FindBugs Plug-in"。 

3 使用

启动

选中java工程,点击鼠标右键,选择名为“Find Bugs”的菜单,FindBugs开始运行,问题指示器将指向根据bug模式识别出来的潜在问题代码位置。

可选项定制

你还可以通过java工程的属性对话框来定制findbugs的运行方式,可选项包括:

控制"Run FindBugs Automatically" 开关的checkbox。 选中时, FindBugs 将在每次修改java类后启动运行。 

选择最小告警优先级和Bug类别。这些选项将选择哪些警告被显示。例如,如果你选择"Medium",只有Medium 和 High priority 警告将被显示。近似地,如果你未选中 "Style" checkbox,Style类的警告信息将不会被显示。

选择探测器。这个列表允许你选择你想在工程中使用的探测器。

4 配套的Bug模式解释

为了有针对性的使用这个工具,减少bug的误报,提高使用效率,我们选择了10个左右的bug模式,下面就是对这10个模式的解释。

这些bug可能会引起程序的性能或逻辑问题.

需要说明的是,findbugs能检测的bug pattern远不仅于此,甚至可以定制自己的探测器,因此,这个文档会不断扩充,同时,也欢迎大家不断探索和分享使用实践.

4.1 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()方法。

4.2 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的原则

4.3 IT_NO_SUCH_ELEMENT

It: Iterator next() method can't throw NoSuchElement exception (IT_NO_SUCH_ELEMENT)

This class implements the java.util.Iterator interface.  However, its next() method is not capable of throwing java.util.NoSuchElementException.  The next() method should be changed so it throws NoSuchElementException if is called when there are no more elements to return.

迭代器Iterator无法抛出NoSuchElement异常,类实现了java.util.Iterator接口,但是next()方法无法抛出java.util.NoSuchElementException异常,因此,next()方法应该做如此修改,当被调用时,如果没有element返回,则抛出NoSuchElementException异常

4.4 J2EE_STORE_OF_NON_SERIALIZABLE_OBJECT_INTO_SESSION

J2EE: Store of non serializable object into HttpSession (J2EE_STORE_OF_NON_SERIALIZABLE_OBJECT_INTO_SESSION)

This code seems to be storing a non-serializable object into an HttpSession. If this session is passivated or migrated, an error will result. 

将没有实现serializable的对象放到HttpSession中,当这个session被钝化和迁移时,将会产生错误,建议放到HttpSession中的对象都实现serializable接口。

4.5 ODR_OPEN_DATABASE_RESOURCE

ODR: Method may fail to close database resource (ODR_OPEN_DATABASE_RESOURCE)

The method creates a database resource (such as a database connection or row set), does not assign it to any fields, pass it to other methods, or return it, and does not appear to close the object on all paths out of the method.  Failure to close database resources on all paths out of a method may result in poor performance, and could cause the application to have problems communicating with the database. 

方法可能未关闭数据库资源,未关闭数据库资源将会导致性能变差,还可能引起应用与服务器间的通讯问题。

4.6 OS_OPEN_STREAM

OS: Method may fail to close stream (OS_OPEN_STREAM)

The method creates an IO stream object, does not assign it to any fields, pass it to other methods that might close it, or return it, and does not appear to close the stream on all paths out of the method.  This may result in a file descriptor leak.  It is generally a good idea to use a finally block to ensure that streams are closed.

方法可能未关闭stream,方法产生了一个IO流,却未关闭,将会导致文件描绘符的泄漏,建议使用finally block来确保io stream被关闭。

4.7 DMI_CALLING_NEXT_FROM_HASNEXT

DMI: hasNext method invokes next (DMI_CALLING_NEXT_FROM_HASNEXT)

The hasNext() method invokes the next() method. This is almost certainly wrong, since the hasNext() method is not supposed to change the state of the iterator, and the next method is supposed to change the state of the iterator. 

4.8 IL_INFINITE_LOOP

IL: An apparent infinite loop (IL_INFINITE_LOOP)

This loop doesn't seem to have a way to terminate (other than by perhaps throwing an exception).

明显的无限循环.

4.9 IL_INFINITE_RECURSIVE_LOOP

IL: An apparent infinite recursive loop (IL_INFINITE_RECURSIVE_LOOP)

This method unconditionally invokes itself. This would seem to indicate an infinite recursive loop that will result in a stack overflow.

明显的无限迭代循环,将导致堆栈溢出.

4.10 WMI_WRONG_MAP_ITERATOR

WMI: Inefficient use of keySet iterator instead of entrySet iterator (WMI_WRONG_MAP_ITERATOR)

This method accesses the value of a Map entry, using a key that was retrieved from a keySet iterator. It is more efficient to use an iterator on the entrySet of the map, to avoid the Map.get(key) lookup.

使用了keySet iterator和Map.get(key)来获取Map值,这种方式效率低,建议使用entrySet的iterator效率更高.

4.11 IM_BAD_CHECK_FOR_ODD

IM: Check for oddness that won't work for negative numbers (IM_BAD_CHECK_FOR_ODD)

The code uses x % 2 == 1 to check to see if a value is odd, but this won't work for negative numbers (e.g., (-5) % 2 == -1). If this code is intending to check for oddness, consider using x & 1 == 1, or x % 2 != 0. 

奇偶检测逻辑,未考虑负数情况.

更多精彩内容其他人还在看

印象笔记同步方法介绍

印象笔记作为一个非常有用的记笔记程序,它的强大之处在于它可以同步你的笔记到印象笔记服务器
收藏 0 赞 0 分享

VMware Workstation 无法恢复错误: (vcpu-0) 问题的解决方法

今天运行VMware Workstation 的时候提示VMware Workstation 无法恢复错误: (vcpu-0),通过如下方法解决,特分享下,方便需要的朋友
收藏 0 赞 0 分享

种子搜索神器P2PSearcher云点播怎么用

本文详细讲述一下在P2PSearcher使用过程中对云播的设置和使用技巧
收藏 0 赞 0 分享

大势至局域网接入管理软件、网络准入控制系统 有效禁止外来电脑接入公司局域网

大势至内网安全卫士是一款专业的局域网安全管理软件、局域网接入管理软件,可以有效防止非公司的人员携带笔记本电脑、手机或平板电脑接入公司的无线局域网,禁止访问局域网服务器共享文件或与局域网其他电脑或设备通讯等
收藏 0 赞 0 分享

大势至局域网共享文件管理软件详细记录服务器共享文件访问日志、保护共享文件安全

本文以“大势至共享文件审计系统”为例,详细说明如何控制共享文件访问、如何保护共享文件安全,如何详细记录共享文件操作日志
收藏 0 赞 0 分享

大势至USB控制大师 专业的USB管理软件、禁用U盘软件、U盘禁用工具使用说明

当前国内最有效的屏蔽USB接口的软件,可以让你不用注册表禁用U盘、不用组策略禁用U盘就可以完全控制局域网电脑的USB端口的使用,完全禁止U盘、移动硬盘或手机,而不影响非USB存储设备的使用
收藏 0 赞 0 分享

千牛是什么? 淘宝卖家必备的工具千牛介绍附下载

你是淘宝卖家吗?那一定要看下下面这篇文章,是关于千牛软件的,淘宝卖家必备的工具。大家可以看看
收藏 0 赞 0 分享

百度迁徙是什么? 怎么用? 百度迁徙动态图网页查看方法 百度迁徙动态图网址

百度迁徙图怎么看?有些网友很想了解下自己地区的百度迁徙图是怎样的,但是不知道百度迁徙实时动态图怎么查看,下面看下百度迁徙动态图网页查看方法
收藏 0 赞 0 分享

eml是什么文件 eml文件怎么打开

eml格式是微软公司在outlook中所使用的一种遵循RFC822及其后续扩展的文件格式,并成为各类电子邮件软件的通用格式
收藏 0 赞 0 分享

JAR是什么文件

JAR(Java ARchive,Java 归档)是一种与平台无关的文件格式,可将多个文件合成一个文件
收藏 0 赞 0 分享
查看更多