FindBugs 规则整理：Bad Practice

目前已转至个人博客，本系列地址：Lam's Blog - Knowledge as Action

NM_SAME_SIMPLE_NAME_AS_SUPERCLASS

• 翻译
  The class name ... shadows the simple name of the superclass ...
  This class has a simple name that is identical to that of its superclass, except that its superclass is in a different package (e.g.,alpha.Fooextendsbeta.Foo). This can be exceptionally confusing, create lots of situations in which you have to look at import statements to resolve references and creates many opportunities to accidently define methods that do not override methods in their superclasses.
  某个类的名字和父类名称一样，这将会导致混乱的情况，一旦出现问题也将难以发现。
• 原因
  同翻译
• 解决方案
  修改父类或者子类的名称

ES_COMPARING_STRINGS_WITH_EQ

• 翻译
  Comparison of String objects using == or != in ...
  This code ... for reference equality using the == or != operators. Unless both strings are either constants in a source file, or have been interned using the String.intern() method, the same string value may be represented by two different String objects. Consider using the equals(Object) method instead.
  使用==或者!=来比较字符串对象。除非两个字符串是同一个源文件里的常量，或者使用String.intern()方法，否则两个同样值的字符串可能会被两个不一样的字符串对象持有，考虑使用equals(Object)来比较。
• 原因
  使用==或者!=来比较字符串会比较两个字符串对象的内存地址，通常这是不一样的。
• 解决方案
  如果是想比较值的话通过equals(Object)来比较

SE_BAD_FIELD

• 翻译
  Class ... defines non-transient non-serializable instance field ...
  This Serializable class defines a non-primitive instance field which is neither transient, Serializable, orjava.lang.Object, and does not appear to implement the Externalizableinterface or the readObject() and writeObject() methods. Objects of this class will not be deserialized correctly if a non-Serializable object is stored in this field.
  该可序列化类定义了一个非暂存也不可序列化的非原始实例字段，也没有实现Externalizable接口或者readObject() 和 writeObject()方法，所以如果非序列化对象被存储在该字段里，那么这个类的对象将无法正确将其反序列化
• 原因
  序列化时所有的成员变量都必须递归的实现序列化，否则将导致序列化失败。如果某个成员变量不想被序列化要么标注为瞬态要么重写readObj方法
• 解决方案
  给字段加上序列化或者瞬态关键字transient

AM_CREATES_EMPTY_JAR_FILE_ENTRY

Creates an empty jar file entry
调用putNextEntry()方法写入新的 jar 文件条目时立即调用closeEntry()方法。这样会造成JarFile条目为空。

AM_CREATES_EMPTY_ZIP_FILE_ENTRY

Creates an empty zip file entry
调用putNextEntry()方法写入新的 zip 文件条目时立即调用closeEntry()方法。这样会造成ZipFile条目为空。

BC_EQUALS_METHOD_SHOULD_WORK_FOR_ALL_OBJECTS

Equals method should not assume anything about the type of its argument
equals(Object o)方法不能对参数o的类型做任何的假设。比较此对象与指定的对象。当且仅当该参数不为 null，并且是表示与此对象相同的类型的对象时，结果才为 true。

DMI_RANDOM_USED_ONLY_ONCE

Random object created and used only once
随机创建对象只使用过一次就抛弃

BIT_SIGNED_CHECK

Check for sign of bitwise operation
检查位操作符运行是否合理

CN_IDIOM

Class implements Cloneable but does not define or use clone method
类实现了Cloneable接口，但是没有定义或使用clone方法。按照惯例，实现此接口的类应该使用公共方法重写 Object.clone（它是受保护的），以获得有关重写此方法的详细信息。

CN_IDIOM_NO_SUPER_CALL

clone method does not call super.clone()
一个非final类型的类定义了clone()方法而没有调用super.clone()方法。例如：B扩展自A，如果B中clone方法调用了spuer.clone（），而A中的clone没有调用spuer.clone()，就会造成结果类型不准确。要求A的clone方法中调用spuer.clone()方法。

CN_IMPLEMENTS_CLONE_BUT_NOT_CLONEABLE

Class defines clone() but doesn't implement Cloneable
类中定义了clone方法但是它没有实现Cloneable接口

CO_ABSTRACT_SELF

Abstract class defines covariant compareTo() method
抽象类中定义了多个compareTo()方法，正确的是覆写Comparable中的compareTo方法，方法的参数为Object类型

CO_SELF_NO_OBJECT

Covariant compareTo() method defined
类中定义了多个compareTo()方法，正确的是覆写Comparable中的compareTo方法，方法的参数为Object类型

DE_MIGHT_DROP

Method might drop exception
方法可能抛出异常

DE_MIGHT_IGNORE

Method might ignore exception
方法可能忽略异常

DMI_USING_REMOVEALL_TO_CLEAR_COLLECTION

Don't use removeAll to clear a collection
不要用removeAll方法去clear一个集合

DP_CREATE_CLASSLOADER_INSIDE_DO_PRIVILEGED

Classloaders should only be created inside doPrivileged block
类加载器只能建立在特殊的方法体内

DM_EXIT

Method invokes System.exit(...)
在方法中调用System.exit(...)语句，考虑用RuntimeException来代替

DM_RUN_FINALIZERS_ON_EXIT

Method invokes dangerous method runFinalizersOnExit
在方法中调用了System.runFinalizersOnExit 或者Runtime.runFinalizersOnExit方法，因为这样做是很危险的。

ES_COMPARING_PARAMETER_STRING_WITH_EQ

Comparison of String parameter using == or !=
用==或者!=方法去比较String类型的参数

EQ_ABSTRACT_SELF

Abstract class defines covariant equals() method
抽象类定义了共变的compareTo()方法

EQ_CHECK_FOR_OPERAND_NOT_COMPATIBLE_WITH_THIS

Equals checks for noncompatible operand
equals方法检查不一致的操作。两个类根本就是父子关系而去调用equals方法去判读对象是否相等。

EQ_COMPARETO_USE_OBJECT_EQUALS

Class defines compareTo(...) and uses Object.equals()
类定义了compareTo(...)方法，却使用Object.equals()方法

EQ_GETCLASS_AND_CLASS_CONSTANT

equals method fails for subtypes
类中的equals方法可能被子类中的方法所破坏，当使用类似于Foo.class == o.getClass()的判断时考虑用this.getClass() == o.getClass()来替换

EQ_SELF_NO_OBJECT

Covariant equals() method defined
类中定义了多个equals方法。正确的做法是覆写Object中的equals方法，它的参数为Object类型的对象。

FI_EMPTY

Empty finalizer should be deleted
应当删除空的finalize()方法

GC_UNCHECKED_TYPE_IN_GENERIC_CALL

Unchecked type in generic call
泛型调用中使用了未检查的类型

HE_EQUALS_NO_HASHCODE

Class defines equals() but not hashCode()
方法定义了equals方法却没有定义hashCode方法

HE_HASHCODE_NO_EQUALS

Class defines hashCode() but not equals()
类定义了hashCode方法去没有定义equal方法

HE_EQUALS_USE_HASHCODE

Class defines equals() and uses Object.hashCode()
一个类覆写了equals方法，没有覆写hashCode方法，使用了Object对象的hashCode方法

HE_INHERITS_EQUALS_USE_HASHCODE

Class inherits equals() and uses Object.hashCode()
子类继承了父类的equals方法却使用了Object的hashCode方法

IC_SUPERCLASS_USES_SUBCLASS_DURING_INITIALIZATION

Superclass uses subclass during initialization
子类在父类未初始化之前使用父类对象实例

IMSE_DONT_CATCH_IMSE

Dubious catching of IllegalMonitorStateException
可疑的IllegalMonitorStateException异常捕捉

ISC_INSTANTIATE_STATIC_CLASS

Needless instantiation of class that only supplies static methods
为使用静态方法而创建一个实例对象。调用静态方法时只需要使用类名+静态方法名就可以了。

IT_NO_SUCH_ELEMENT

Iterator next() method can't throw NoSuchElementException
迭代器的next方法不能够抛出NoSuchElementException

J2EE_STORE_OF_NON_SERIALIZABLE_OBJECT_INTO_SESSION

Store of non serializable object into HttpSession
在HttpSession对象中保存非连续的对象

JCIP_FIELD_ISNT_FINAL_IN_IMMUTABLE_CLASS

Fields of immutable classes should be final
不可变类的字段应当是final的

NP_BOOLEAN_RETURN_NULL

Method with Boolean return type returns explicit null
返回值为boolean类型的方法直接返回null，这样会导致空指针异常

NP_EQUALS_SHOULD_HANDLE_NULL_ARGUMENT

equals() method does not check for null argument
变量调用equals方法时没有进行是否为null的判断

NP_TOSTRING_COULD_RETURN_NULL

toString method may return null
toString方法可能返回null

NM_CLASS_NAMING_CONVENTION

Class names should start with an upper case letter
类的名称以大写字母名称开头

NM_CLASS_NOT_EXCEPTION

Class is not derived from an Exception, even though it is named as such
类的名称中含有Exception但是却不是一个异常类的子类，这种名称会造成混淆

NM_CONFUSING

Confusing method names
令人迷惑的方法命名

NM_FIELD_NAMING_CONVENTION

Field names should start with a lower case letter
非final类型的字段需要遵循驼峰命名原则

NM_FUTURE_KEYWORD_USED_AS_IDENTIFIER

Use of identifier that is a keyword in later versions of Java
验证是否是java预留关键字

NM_FUTURE_KEYWORD_USED_AS_MEMBER_IDENTIFIER

Use of identifier that is a keyword in later versions of Java
验证是否时java中的关键字

NM_METHOD_NAMING_CONVENTION

Method names should start with a lower case letter
方法名称以小写字母开头

NM_SAME_SIMPLE_NAME_AS_INTERFACE

Class names shouldn't shadow simple name of implemented interface
实现同一接口实现类不能使用相同的名称，即使它们位于不同的包中

NM_SAME_SIMPLE_NAME_AS_SUPERCLASS

Class names shouldn't shadow simple name of superclass
继承同一父类的子类不能使用相同的名称，即使它们位于不同的包中

NM_VERY_CONFUSING_INTENTIONAL

Very confusing method names (but perhaps intentional)
很容易混淆的方法命名，例如方法的名称使用大小写来区别两个不同的方法。

NM_WRONG_PACKAGE_INTENTIONAL

Method doesn't override method in superclass due to wrong package for parameter
由于错误引用了不同包中相同类名的对象而不能够正确的覆写父类中的方法

ODR_OPEN_DATABASE_RESOURCE

Method may fail to close database resource
方法中可能存在关闭数据连接失败的情况

OS_OPEN_STREAM

Method may fail to close stream
方法中可能存在关闭流失败的情况

OS_OPEN_STREAM_EXCEPTION_PATH

Method may fail to close stream on exception
方法中可能存在关闭流时出现异常情况

RC_REF_COMPARISON_BAD_PRACTICE

Suspicious reference comparison to constant
当两者为不同类型的对象时使用equals方法来比较它们的值是否相等，而不是使用==方法。例如比较的两者为java.lang.Integer, java.lang.Float

RC_REF_COMPARISON_BAD_PRACTICE_BOOLEAN

• Suspicious reference comparison of Boolean values*
  使用== 或者 !=操作符来比较两个 Boolean类型的对象，建议使用equals方法。

RR_NOT_CHECKED

Method ignores results of InputStream.read()
InputStream.read方法忽略返回的多个字符，如果对结果没有检查就没法正确处理用户读取少量字符请求的情况。

SR_NOT_CHECKED

Method ignores results of InputStream.skip()
InputStream.skip()方法忽略返回的多个字符，如果对结果没有检查就没法正确处理用户跳过少量字符请求的情况

RV_RETURN_VALUE_IGNORED_BAD_PRACTICE

Method ignores exceptional return value
方法忽略返回值的异常信息

SI_INSTANCE_BEFORE_FINALS_ASSIGNED

Static initializer creates instance before all static final fields assigned
在所有的static final字段赋值之前去使用静态初始化的方法创建一个类的实例。

SE_BAD_FIELD_STORE

Non-serializable value stored into instance field of a serializable class
非序列化的值保存在声明为序列化的的非序列化字段中

SE_COMPARATOR_SHOULD_BE_SERIALIZABLE

Comparator doesn't implement Serializable
Comparator接口没有实现Serializable接口

SE_INNER_CLASS

Serializable inner class
序列化内部类

SE_NONFINAL_SERIALVERSIONID

serialVersionUID isn't final
serialVersionUID不是final的

SE_NO_SUITABLE_CONSTRUCTOR

Class is Serializable but its superclass doesn't define a void constructor
子类序列化时父类没有提供一个void的构造函数

SE_NO_SUITABLE_CONSTRUCTOR_FOR_EXTERNALIZATION

Class is Externalizable but doesn't define a void constructor
Externalizable 实例类没有定义一个void类型的构造函数

SE_READ_RESOLVE_MUST_RETURN_OBJECT

The readResolve method must be declared with a return type of Object.
readResolve从流中读取类的一个实例，此方法必须声明返回一个Object类型的对象

SE_TRANSIENT_FIELD_NOT_RESTORED

Transient field that isn't set by deserialization.
不需要被反序列化的字段没有声明transient

SE_NO_SERIALVERSIONID

Class is Serializable, but doesn't define serialVersionUID
一个类实现了Serializable接口但是没有定义serialVersionUID类型的变量。序列化运行时使用一个称为 serialVersionUID 的版本号与每个可序列化类相关联，该序列号在反序列化过程中用于验证序列化对象的发送者和接收者是否为该对象加载了与序列化兼容的类。如果接收者加载的该对象的类的 serialVersionUID 与对应的发送者的类的版本号不同，则反序列化将会导致 InvalidClassException。可序列化类可以通过声明名为 "serialVersionUID" 的字段（该字段必须是静态 (static)、最终 (final) 的 long 型字段）显式声明其自己的 serialVersionUID

UI_INHERITANCE_UNSAFE_GETRESOURCE

Usage of GetResource may be unsafe if class is extended
当一个类被子类继承后不要使用this.getClass().getResource(...)来获取资源

其他文章（持续更新）

FindBugs：简介与使用
FindBugs 规则整理：CORRECTNESS
FindBugs 规则整理：Style & Dodgy
FindBugs 规则整理：Malicious Code Vulnerability
FindBugs 规则整理：Multithreaded Correctness
FindBugs 规则整理：Security & Experimental
FindBugs 规则整理：Performance
FindBugs 规则整理：Internationalization

引用

整合以下文章过程中发现部分存在翻译错误，已做修正，同时感谢以下文章作者
FindBugs使用备忘录
FindBugs规则整理
详解FindBugs的各项检测器
Findbugs 缺陷详解与英文代号的对照表