细说equals()方法和hashCode()方法

一、前言

       对于这两个方法的研究,源于一道比较经典的面试题:“x.equals(y)==true;x,y可有不同的hashcode对吗?”,其实这道题的关键在于考我们对equals()方法和hashCode()方法的理解,网上看了不少文章,有说对的,也有说不对的。在我看来对也不对,具体原因,我们下面慢慢分析。

二、equals()方法

       equals()方法是Object中定义的方法,任何类都可以重写,但是需要遵循一定的规范,我们看一下Object中的默认实现

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

可以看到就是对两个对象的比较,也就是两个对象的地址值是否相等。然而有的时候,默认的比较方式并不能满足我们的需求,比如要我们判断两个学生对象是否是同一个,需要从学号、姓名等方面来比较,这时候就要重写equals()方法了,这个重写规则,JAVA是有明确的规范的:

2.1 自反性:x.equals(x)必须为true;
2.2 对称性:x.equals(y)和y.equals(x)返回值必须相等;
2.3 传递性:x.equals(y)为true,和y.equals(z)为true,那么x.equals(z)也必须为true;
2.4 一致性:如果对象x和y在equals()中使用的信息没有改变,那么x.equals(y)的值始终不变;
2.5 非null : x不是null,y是null,那么x.equals(y)必须为false。

三、hashCode()方法

       这是Android SDK中Object类的hashCode()方法实现:

   /**
     * Returns a hash code value for the object. This method is
     * supported for the benefit of hash tables such as those provided by
     * {@link java.util.HashMap}.
     * <p>
*/
  public int hashCode() {
        int lockWord = shadow$_monitor_;
        final int lockWordStateMask = 0xC0000000;  // Top 2 bits.
        final int lockWordStateHash = 0x80000000;  // Top 2 bits are value 2 (kStateHash).
        final int lockWordHashMask = 0x0FFFFFFF;  // Low 28 bits.
        if ((lockWord & lockWordStateMask) == lockWordStateHash) {
            return lockWord & lockWordHashMask;
        }
        return System.identityHashCode(this);
    }

    public static native int identityHashCode(Object x);

通过注释我们可以得知一个很重要的信息,那就是hashCode()这个方法主要是为了更好的支持哈希表(如HashMap、HashSet、HashTable等)。说到这,我们有必要了解一下哈希表的存储原理了:

       当我们向哈希表(如HashMap、HashSet、HashTable等)插入一个object时,首先调用hashcode()方法获得该对象的哈希码,通过该哈希码可以直接定位object在哈希表中的位置(一般是哈希码对哈希表大小取余),如果该位置没有对象,那么直接将object插入到该位置;如果该位置有对象(可能有多个,通过链表实现),则调用equals()方法将这些对象与object比较,如果相等,则不需要保存object,否则,将该对象插入到该链表中。

       这也就解释了,为什么equals()相等,那么hashCode()必须相等。因为,如果两个对象的equals()方法返回true,则它们在哈希表中只应该出现一次;如果hashCode()不相等,那么它们会被散列到表中不同的位置,哈希表中不止出现一次。

       JAVA建议,如果我们重写了equals()方法,那么也要重写hashCode()方法,因为默认的hashCode()方法返回的是该对象内存中的地址。还是上面的例子,我们进行两个学生的比较,依据是学号和姓名,如果都相等,那么认为是同一个对象,有如下代码:

public class Student {

    private int id;
    private String name;


    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

}

public class Main {

    public static void main(String[] args) {

        Student student1 = new Student();
        student1.setId(1);
        student1.setName("name1");

        Student student2 = new Student();
        student2.setId(1);
        student2.setName("name1");

        System.out.println(student1.equals(student2));

    }
}

这时候返回的是false,肯定不是我们想要的,所以我们需要重写equals()方法,让它符合我们的业务需求,重写后的代码如下:

public class Student {

    private int id;
    private String name;


    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }


    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;

        Student student = (Student) o;

        if (getId() != student.getId()) return false;
        return getName() != null ? getName().equals(student.getName()) : student.getName() == null;
    }


public class Main {

    public static void main(String[] args) {

        Student student1 = new Student();
        student1.setId(1);
        student1.setName("name1");

        Student student2 = new Student();
        student2.setId(1);
        student2.setName("name1");

        System.out.println(student1.equals(student2));

    }
}

}

通过重写equals()方法之后,打印结果变成了true,但是这样就完了吗?我们进行另外一种测试:

public class Main {

    public static void main(String[] args) {

        Student student1 = new Student();
        student1.setId(1);
        student1.setName("name1");

        Student student2 = new Student();
        student2.setId(1);
        student2.setName("name1");

        System.out.println(student1.equals(student2));


        Set<Student> set = new HashSet<>();
        set.add(student1);
        set.add(student2);

        System.out.println("setSize: " + set.size());

    }
}

上面student1.equals(student2)返回的是true,setSize理应返回的结果是1才对,但是返回的确是2,这是因为它们的hashCode是不一样的,所以Set集合认为它们是两个不同的对象,因此添加了两次。这时候hashCode()就排上用场了,我们需要重写hashCode()方法,这就是为什么JDK说,如果重写了equals()方法,必须要重写hashCode()方法的原因,:

public class Student {

    private int id;
    private String name;


    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }


    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;

        Student student = (Student) o;

        if (getId() != student.getId()) return false;
        return getName() != null ? getName().equals(student.getName()) : student.getName() == null;
    }


    @Override
    public int hashCode() {
        int result = id;
        result = 31 * result + name.hashCode();
        return result;
    }
}

这样才算完事了。

hashCode()方法重写的一些原则

a.如果重写equals()方法,检查条件“两个对象通过equals()方法判断相等,那么它们的hashCode()也应该相等”是否成立,如果不成立,则重写hashCode()方法。
b.hashCode()不能太简单,否则容易造成hash冲突;
c.hashCode()不能太复杂,否则会影响性能。

但是一般来说我们不需要自己去写,这里有几种便捷的实现方式

(1) Google的Guava项目里有处理hashCode()和equals()的工具类com.google.common.base.Objects;
(2) Apache Commons也有类似的工具类EqualsBuilder和HashCodeBuilder;
(3) Java 7 也提供了工具类java.util.Objects;
(4) 常用IDE都提供hashCode()和equals()的代码生成。

至此,我们已经可以解答最开始的问题:“x.equals(y)==true;x,y可有不同的hashcode对吗?”

严格来说,如果两个对象x.equals(y)==true,那么它们的hashCode()也要相等,如果不相等,当把它们添加到哈希表中时就会出现数据混乱(如重复添加);但是,由于hashCode()方法并不是强制实现的,所以,是可能存在不同的hashcode的。

三、总结

       如果想写出优秀的代码又不想踩坑就遵循官方的规范吧。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,132评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,802评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,566评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,858评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,867评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,695评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,064评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,705评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,915评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,677评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,796评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,432评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,041评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,992评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,223评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,185评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,535评论 2 343

推荐阅读更多精彩内容