ArrayList 的 contains() 方法总是使用自定义对象返回 false

Question

我在编写代码时遇到了一些麻烦，我给你举个简单的例子（虽然它会稍微复杂一点，这个简单的代码也不能正常工作）。

class Sign {

  private String char;
  private Integer freq;

  public Sign(String c) {
  this.char = c; 
  }

  @Override
  public boolean equals(Object o) {

   String check = (String)o;
   return check.equals(this.char);
  }

  @Override
  public int hashCode() {

    int hash = 7;
    hash = 31 * hash + this.char.hashCode();
    return hash;
}

}

为了简单起见，我假设在 equals 方法中总会有一个字符串。还有一些 hashCode() 也可以确保 contains() 方法有效，这是测试本身：

    ArrayList<Sign> queueOfSigns = new ArrayList<>();

    Sign test = new Sign("C");
    String c = "C";
    queueOfSigns.add(test);

    if(queueOfSigns.contains("C"))
        System.out.println("I am here!");

无论如何，这个简单的测试代码在这种情况下总是返回 false - 所以“我在这里”消息永远不会出现。我一直在尝试一些不同的方法来处理我的代码，但这是因为这样做的想法是从字符串文本中获取单个字符并检查单个字符是否已经存在于 ArrayList 中。尽管如此 - 如果没有让这个简单的测试正常工作，我无法继续前进，所以我想问你 - 我错过了什么。这是我第一次真正使用 equals() 和 hashCode() 方法来让我自己的对象与 contains() 方法一起正常工作。

Answer 1

您的equals 实现不正确。 equals 有特定合约；该代码试图违反该合同。来自文档：

equals 方法在非空对象引用上实现等价关系：

• 它是自反的：对于任何非null 的引用值x，x.equals(x) 应该返回true。
• 它是对称的：对于任何非null 参考值x 和y，x.equals(y) 应该返回true 当且仅当y.equals(x) 返回true .
• 它是传递的：对于任何非null 引用值x、y 和z，如果x.equals(y) 返回true 和y.equals(z) 返回@ 987654343@，然后x.equals(z) 应该返回true。
• 一致：对于任何非null 引用值x 和y，x.equals(y) 的多次调用始终返回true 或始终返回false，提供equals 对象比较中使用的信息没有被修改。
• 对于任何非null 参考值x，x.equals(null) 应返回false。

无法将Sign 类equals 的实例设为字符串。

Answer 2

您的equals 方法实现不正确。违反Object.equals的总合约：

• 它不是自反的 - 因为当参数不是字符串时它会引发异常，x.equals(x) 其中x 是Sign 将因异常而崩溃。
• 它不是对称的 - 如果y 是字符串并且x 是Sign，则x.equals(y) 不会返回与y.equals(x) 相同的值
• 不一致 - 因为当参数不是字符串时它可能会抛出异常，而不仅仅是返回 true 或 false。

在低抽象层次上，这个问题的原因是contains的实现。根据文档：

如果此列表包含指定元素，则返回 true。更正式地说，当且仅当此列表包含至少一个元素 e 满足 (o==null ? e==null : o.equals(e)) 时，才返回 true。

ArrayList 实际上调用了o.equals(e)，o 是你传入的字符串。所以它实际上调用了String 中的equals 方法。

如果contains 调用e.equals(o)，那么您的程序会打印“我在这里”，但您的equals 仍然违反合同。

一个更好的equals 实现是这样的：

@Override
public boolean equals(Object o) {
    if (o == null) {
        return false;
    }

    if (o.getClass() == this.getClass()) {
        Sign other = (Sign)o;
        return other.$char.equals($char); // I have renamed 'char' to '$char' since the former is not a valid identifier
    } else {
        return false;
    }
}

还有你的客户端代码：

    ArrayList<Sign> queueOfSigns = new ArrayList<>();

    Sign test = new Sign("C");
    Sign c = new Sign("C");
    queueOfSigns.add(test);

    if(queueOfSigns.contains(c))
        System.out.println("I am here!");

编辑：

我想这就是你要找的：

arrayList.stream()
    .filter(x -> x.getChar().equals("C"))
    .findFirst().isPresent() // this returns true if a sign with C is found in the array list