重写equals的详细说明

返回目录

原文地址Java

equals() 方法总结

equals()

超类 Object 中有这个 equals() 方法，该方法主要用于比较两个对象是否相等。该方法的源码如下：

    public boolean equals(Object obj) {
        return (this == obj);
        }

我们知道所有的对象都拥有标识(内存地址)和状态(数据)，同时“==”比较两个对象的的内存地址，所以说使用 Object 的 equals() 方法是比较两个对象的内存地址是否相等，即若 object1.equals(object2) 为 true，则表示 equals1 和 equals2 实际上是引用同一个对象。虽然有时候 Object 的 equals() 方法可以满足我们一些基本的要求，但是我们必须要清楚我们很大部分时间都是进行两个对象的比较，这个时候 Object 的 equals() 方法就不可以了，实际上 JDK 中，String、Math 等封装类都对 equals() 方法进行了重写。下面是 String 的 equals() 方法：

    public boolean equals(Object anObject) {
        if (this == anObject) {
            return true;
        }
        if (anObject instanceof String) {
            String anotherString = (String)anObject;
            int n = count;
            if (n == anotherString.count) {
            char v1[] = value;
            char v2[] = anotherString.value;
            int i = offset;
            int j = anotherString.offset;
            while (n-- != 0) {
                if (v1[i++] != v2[j++])
                return false;
            }
            return true;
            }
        }
        return false;
        }

对于这个代码段:if (v1[i++] != v2[j++])return false;我们可以非常清晰的看到 String 的 equals() 方法是进行内容比较，而不是引用比较。至于其他的封装类都差不多。

在 Java 规范中，它对 equals() 方法的使用必须要遵循如下几个规则：

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

1. 自反性：对于任何非空引用值 x，x.equals(x) 都应返回 true。

2. 对称性：对于任何非空引用值 x 和 y，当且仅当 y.equals(x) 返回 true 时，x.equals(y) 才应返回 true。

3. 传递性：对于任何非空引用值 x、y 和 z，如果 x.equals(y) 返回 true，并且 y.equals(z) 返回 true，那么 x.equals(z) 应返回 true。

4. 一致性：对于任何非空引用值 x 和 y，多次调用 x.equals(y) 始终返回 true 或始终返回 false，前提是对象上 equals 比较中所用的信息没有被修改。

5. 对于任何非空引用值 x，x.equals(null) 都应返回 false。

对于上面几个规则，我们在使用的过程中最好遵守，否则会出现意想不到的错误。

在 java 中进行比较，我们需要根据比较的类型来选择合适的比较方式：

1. 对象域，使用 equals 方法 。

2. 类型安全的枚举，使用 equals 或== 。

3. 可能为 null 的对象域 : 使用 == 和 equals 。

4. 数组域 : 使用 Arrays.equals 。

5. 除 float 和 double 外的原始数据类型 : 使用 == 。

6. float 类型: 使用 Float.foatToIntBits 转换成 int 类型，然后使用==。

7. double 类型: 使用 Double.doubleToLongBit 转换成 long 类型，然后使用==。

至于6）、7）为什么需要进行转换，我们可以参考他们相应封装类的 equals() 方法，下面的是 Float 类的：

    public boolean equals(Object obj) {
        return (obj instanceof Float)
               && (floatToIntBits(((Float)obj).value) ==   floatToIntBits(value));
        }

原因嘛，里面提到了两点：

    However, there are two exceptions:
    If f1 and f2 both represent
    Float.NaN, then the equals method returns
    true, even though Float.NaN==Float.NaN
    has the value false.
    If <code>f1 represents +0.0f while
    f2 represents -0.0f, or vice
    versa, the equal test has the value
    false, even though 0.0f==-0.0f
    has the value true.

重写equals需要重写gethashcode()

object对象中的 public boolean equals(Object obj)，对于任何非空引用值 x 和 y，当且仅当 x 和 y 引用同一个对象时，此方法才返回 true；

注意：当此方法被重写时，通常有必要重写 hashCode 方法，以维护 hashCode 方法的常规协定，该协定声明相等对象必须具有相等的哈希码。如下：

(1)当obj1.equals(obj2)为true时，obj1.hashCode() == obj2.hashCode()必须为true

(2)当obj1.hashCode() == obj2.hashCode()为false时，obj1.equals(obj2)必须为false

如果不重写equals，那么比较的将是对象的引用是否指向同一块内存地址，重写之后目的是为了比较两个对象的value值是否相等。特别指出利用equals比较八大包装对象

（如int，float等）和String类（因为该类已重写了equals和hashcode方法）对象时，默认比较的是值，在比较其它自定义对象时都是比较的引用地址

hashcode是用于散列数据的快速存取，如利用HashSet/HashMap/Hashtable类来存储数据时，都是根据存储对象的hashcode值来进行判断是否相同的。

这样如果我们对一个对象重写了euqals，意思是只要对象的成员变量值都相等那么euqals就等于true，但不重写hashcode，那么我们再new一个新的对象，

当原对象.equals（新对象）等于true时，两者的hashcode却是不一样的，由此将产生了理解的不一致，如在存储散列集合时（如Set类），将会存储了两个值一样的对象，

导致混淆，因此，就也需要重写hashcode()

举例说明：

        public override bool Equals(object obj)
        {
            if (!(obj is BalanceSheetReport expect))
                return false;

            return this.EndSum == expect.EndSum
                 && this.PreSum == expect.PreSum
                 && this.SequenceId == expect.SequenceId
                 && this.ProjectId == expect.ProjectId;
        }

        public override int GetHashCode()
        {
            return this.PreSum.GetHashCode()
                 ^ this.EndSum.GetHashCode()
                 ^ this.SequenceId.GetHashCode()
                 ^ this.ProjectId.GetHashCode();
        }

返回目录