检查两个对象在Java中是否完全相等

Question

我有一个 Java 类，这里有一个例子：

public class Car {

    private int fuelType;
    private Date made;
    private String name;
.
.
. // and so on

现在假设我有两个汽车对象，我想比较它们的所有变量是否相等。

现在，我通过覆盖方法 equals(Object o) 解决了这个问题，我检查了两个对象中的所有变量是否匹配。

这里的问题是，如果我有 20 个类，我将不得不在每个类中覆盖 equals(Object o)。

有没有办法创建某种通用方法，可以比较我传递给它的两个对象中的任何一个，并让我知道它们是否在每个变量中匹配？

Answer 1

您有几个自动化 Equals & Hashcode 的选项（选项 #3 让我大吃一惊！）：

1. 您的 IDE。对于大多数对象，我不会推荐它，因为它们可能会随着实际的类定义慢慢过时。它们看起来也很丑陋，并且会使用样板代码污染您的代码库。
2. Apache Commons 有很多东西可以让这更容易，包括reflective version，所以没有与类定义过时的风险。它比 #1 好，除非您需要快速的 equals/hashcode，但我喜欢的样板仍然太多。
3. Project Lombok 和注解处理。在 ya 类上打一个 EqualsAndHashCode 注释并完成它。 我推荐使用 Project Lombok。它为构建增加了一点魔力（但不多），因此需要一个插件来让您的 IDE 表现良好，但对于没有样板代码来说，这是一个很小的代价。 Lombok 是一个在编译时运行的注释处理器，因此不会影响运行时性能。
4. 使用开箱即用的支持它的不同语言，但也以 JVM 为目标。 Groovy 使用 annotation 和 Kotlin 支持 data classes。除非您现有的代码可以快速转换，否则我会避免这种情况。
5. Google's Auto 有一个 AutoValue。与 Project Lombok 一样，这是一个注解处理器，但它的魔力更少，但以更少的样板为代价（感谢 Louis Wasserman）

Answer 2

你可以使用：

 org.apache.commons.lang.builder.CompareToBuilder.reflectionCompare(Object lhs, Object rhs);

它使用反射来比较文件 这是javadoc：javadoc

Answer 3

我将在这里接受大多数人的不同意见（使用带有反射的 apache commons）：是的，这是您必须编写的一些代码（让您的 IDE 真正生成），但您只需执行一次并且需要实现 equals/hashcode 的数据类的数量通常相当易于管理 - 至少在我从事的所有大型项目 (250k+ LOC) 中是这样。

当然，如果您向该类添加新成员，您必须记住更新 equals/hashcode 函数，但这通常很容易注意到，最迟在代码审查期间。

老实说，如果您使用 Java7 中的简单小帮助程序类，您可以减少 Wana Ant 大量展示的代码。你真正需要的是：

@Override
public boolean equals(Object o) {
    if (o instanceof Car) { // nb: broken if car is not final - other topic
        Car other = (Car) o;
        return Objects.equals(fuelType, other.fuelType) && 
               Objects.equals(made, other.made) && 
               Objects.equals(name, other.name);
    }
    return false;
}

hashcode 类似：

@Override
public int hashCode() {
    return Objects.hash(fuelType, made, name);
}

不如反射解决方案那么短？没错，但它很简单，易于维护、适应和阅读 - 性能要好几个数量级（这对于实现 equals 和 hashcode 的类通常很重要）

Answer 4

通常，您可以通过 IDE 生成 equals/hashCode 方法 - 该领域的所有大玩家都能够做到这一点（Eclipse、IntelliJ Idea 和 Netbeans）。

通常您可以创建一些将使用反射的代码，但我不推荐使用这种代码，因为客观方法更清晰且更易于维护。反射也不会像“标准”方式那样快。如果你真的想走这条路，有 EqualsBuilder 和 HashCodeBuilder 这样的实用程序。

仅供参考，有一些基于 JVM 的语言已经支持这些功能，例如Kotlin data classes，可以很好地用于现有的 Java 项目。

Answer 5

我将插入一个我最喜欢的解决此问题的方法的插件：@AutoValue。

这是一个来自 Google 的开源项目，它提供了一个注释处理器，可以生成一个合成类，为您实现 equals 和 hashCode。

由于它是自动生成的代码，因此您不必担心意外忘记字段或弄乱equals 或hashCode 实现。但由于代码是在编译时生成的，因此运行时开销为零（与基于反射的解决方案不同）。它也是“API 不可见的”——你的类的用户无法区分 @AutoValue 类型和你自己实现的类型，你可以在未来来回更改而不会破坏调用者。

另请参阅 this presentation，它解释了基本原理并将其与其他方法进行比较。

Answer 6

理论上，您可以使用反射来创建某种实用程序，正如许多人在 cmets 中建议的那样。我个人不建议你这样做。你最终会得到部分工作的东西。

Java 中的许多东西都依赖于equal 或hashCode，例如方法contains，您可以在任何实现Collection 的东西中找到它。

推荐的解决方案是覆盖equal（和hashCode）。此外，我认为任何体面的 IDE 都可以选择为您生成它们。因此，您可以比使用反射更快地做到这一点。

Answer 7

我会这样做：

@Override
public boolean equals(Object obj) {
    if (obj instanceof Car) {
        return internalEquals((Car) obj);
    }
    return super.equals(obj);
}

protected boolean internalEquals(Car other) {
    if(this==other){
        return true;
    }
    if (other != null) {
        //suppose fuelType can be Integer.
        if (this.getFuelType() !=null) {
            if (other.getFuelType() == null) {
                return false;
            } else if (!this.getFuelType().equals(other.getFuelType())) {
                return false;
            }
        } else if(other.getFuelType()!=null){
            return false;
        }
        if (this.getName() != null) {
            if (other.getName() == null) {
                return false;
            } else if (!this.getName().equals(other.getName())) {
                return false;
            }
        }
        else if(other.getName()!=null){
            return false;
        }
         if (this.getDate() != null) {
            if (other.getDate() == null) {
                return false;
            } else if (!this.getDate().getTime()!=(other.getDate().getTime())) {
                return false;
            }
        }
        else if(other.getDate()!=null){
            return false;
        }
        return true;
    } else {
        return false;
    }
}

编辑
简化版

     public class Utils{
          /**
           * Compares the two given objects and returns true, 
           * if they are equal and false, if they are not.
           * @param a one of the two objects to compare
           * @param b the other one of the two objects to compare
           * @return if the two given lists are equal.
           */
           public static boolean areObjectsEqual(Object a, Object b) {

               if (a == b){
                  return true;
               }
               return (a!=null && a.equals(b));
          }

          public static boolean areDatesEqual(Date a, Date b){
             if(a == b){
                return true;
             }
             if(a==null || b==null){ 
                return false;
             }
             return a.getTime() == b.getTime();
          }
   }

   @Override
   public boolean equals(other obj) {
      if(this == other){
         return true;
      } 
      if(other == null){
          return false;
      }
      if (other instanceof Car) {
          return internalEquals((Car) other);
      }
      return super.equals(obj);
   }

   protected boolean internalEquals(Car other) {        
        //suppose fuelType can be Integer.
        if (!Utils.areObjectsEqual(this.getName(), other.getName()){                   
            return false;
        }
        if (!Utils.areObjectsEqual(this.getName(), other.getName()){ 
            return false;
        }
        if (!Utils.areDatesEqual(this.getDate(), other.getDate()){ 
            return false;
        } 
        return true;
    }
}

也不要忘记哈希码，它们是携手编码的。