FindBugs - 如何解决 EQ_COMPARETO_USE_OBJECT_EQUALS

Question

我在这里一无所知...

 1: private static class ForeignKeyConstraint implements Comparable<ForeignKeyConstraint> {
 2: String tableName;
 3: String fkFieldName;
 4: 
 5: public int compareTo(ForeignKeyConstraint o) {
 6:    if (this.tableName.compareTo(o.tableName) == 0) {
 7:            return this.fkFieldName.compareTo(o.fkFieldName);
 8:        }
 9:        return this.tableName.compareTo(o.tableName);
10:    }
11: }

在第 6 行中，我从 FindBugs 得到： Bug: net.blabla.SqlFixer$ForeignKeyConstraint 定义了compareTo(SqlFixer$ForeignKeyConstraint) 并使用 Object.equals()

定义链接

我不知道如何纠正这个问题。

Answer 1

此错误意味着您没有覆盖 ForeignKeyConstraint 中的 equals （从而从 Object 继承 equals），因此以下内容不正确（来自 比较):

强烈建议（但不严格要求）(x.compareTo(y)==0) == (x.equals(y))。一般来说，任何实现 Comparable 接口并违反此条件的类都应该明确指出这一事实。推荐的语言是“注意：这个类有一个与 equals 不一致的自然顺序。”

要修复 FindBugs 检查，请覆盖 equals - 和 hashCode - 如果有意义（通常是这种情况）（或者排除对该类的检查并记录您的类违反了此规定）使用建议注释的条件）。

Answer 2

它告诉您，compareTo() 和 equals() 可能会出现不一致。他们真的应该永远不同意。

equals() 方法继承自 java.lang.Object，默认情况下它会检查两个对象是否是同一个实例。您的compareTo方法正在比较基于tableName和fkFieldName的对象。因此，您可能会发现自己处于这样的情况：compareTo 声明两个对象相同（因为 tableName 和 fkFieldName 匹配），但 equals 声明它们不同（因为它们是不同的实例）。

有一些 Java API 依赖于 CompareTo 和 equals 的一致性；这是 java 语言的一部分，被认为是核心语言契约。理想情况下，实现 equals（和 hashcode）方法来检查基于 tableName 和 fkFieldName 的相等性。

Answer 3

您可以通过实现 equals() 方法来解决它。参考 FindBugs 的定义：

“一般来说，当且仅当 equals 返回 true 时，compareTo 的值才应返回零。如果违反这一点，PriorityQueue 等类中将会出现奇怪且不可预测的失败。”

“强烈建议，但不严格要求 (x.compareTo(y)==0) == (x.equals(y))。”

另一个例子是 TreeSet。它通过调用compareTo来实现相等性检查，与equals不一致的compareTo实现会使TreeSet违反Set接口的约定，这可能会导致程序故障。

Answer 4

您是否也尝试过在 SqlFixer.ForeignKeyConstraint 中重写 equals 方法？

我相信警告的基础是，正如定义中所述，如果您重写compareTo而不是等于，可能会发生奇怪的事情。

有关详细信息，请查看 Joshua Bloch 的《Effective Java》，第二版。第 12 条更深入地介绍了实现 Comparable 的细节以及一些需要注意的事项。

Answer 5

Findbugs 很满意：

public int compareTo(ForeignKeyConstraint o) {
    if (this.equals(o)) {
        return 0;
    } else if (this.tableName.equals(o.tableName)) {
        // fkFieldName must be different
        return this.fkFieldName.compareTo(o.fkFieldName);
    } else {
        // tableName must be different
        return this.tableName.compareTo(o.tableName);
    }
}

@Override
public equals() {
  ...
}

@Override
public int hashCode() {
  ...
}