Работа с хэш-кодом () и равно ()

По умолчанию суперкласс Java  java.lang.Object  предоставляет два важных метода для сравнения объектов: equals () и hashcode () . Эти методы становятся очень полезными при реализации взаимодействий между несколькими классами в больших проектах. В этой статье мы поговорим об отношениях между этими методами, их реализациями по умолчанию и обстоятельствами, которые вынуждают разработчиков предоставлять индивидуальную реализацию для каждого из них.

Определение метода и реализация по умолчанию

• equals (Object obj):  метод, предоставленный java.lang.Object, который указывает, равен ли какой-либо другой объект, переданный в качестве аргумента,текущему экземпляру. Реализация по умолчанию, предоставляемая JDK, основана на расположении памяти — два объекта равны тогда и только тогда, когда они хранятся в одном и том же адресе памяти.

• hashcode ():  метод, предоставленный  java.lang.Object,  который возвращает целочисленное представление адреса памяти объекта. По умолчанию этот метод возвращает случайное целое число, уникальное для каждого экземпляра. Это целое число может измениться между несколькими запусками приложения и не останется прежним.

Контракт между equals () и hashcode ()

Реализации по умолчанию недостаточно для удовлетворения бизнес-потребностей, особенно если мы говорим об огромном приложении, которое рассматривает два объекта как равные, когда происходит какой-то бизнес-факт. В некоторых бизнес-сценариях разработчики предоставляют собственную реализацию, чтобы задействовать собственный механизм равенства независимо от адресов памяти.

Согласно документации Java, разработчики должны переопределить оба метода, чтобы получить полностью работающий механизм равенства — недостаточно просто реализовать метод equals () .

Если два объекта равны в соответствии с методом equals (Object) , то вызов метода hashcode () для каждого из двух объектов должен привести к одному и тому же целочисленному результату.

В следующих разделах мы приводим несколько примеров, которые показывают важность переопределения обоих методов и недостатки переопределения equals () без hashcode () .

Практический пример

Мы определяем класс с именем Student  следующим образом:

package com.programmer.gate.beans;

public class Student {

    private int id;
    private String name;

    public Student(int id, String name) {
        this.name = name;
        this.id = id;
    }

    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 HashcodeEquals {

    public static void main(String[] args) {
        Student alex1 = new Student(1, "Alex");
        Student alex2 = new Student(1, "Alex");

        System.out.println("alex1 hashcode = " + alex1.hashCode());
        System.out.println("alex2 hashcode = " + alex2.hashCode());
        System.out.println("Checking equality between alex1 and alex2 = " + alex1.equals(alex2));
    }
}

alex1 hashcode = 1852704110
alex2 hashcode = 2032578917
Checking equality between alex1 and alex2 = false

@Override
public boolean equals(Object obj) {
    if (obj == null) return false;
    if (!(obj instanceof Student))
        return false;
    if (obj == this)
        return true;
    return this.getId() == ((Student) obj).getId();
}

alex1 hashcode = 2032578917
alex2 hashcode = 1531485190
Checking equality between alex1 and alex2 = true

public class HashcodeEquals {

    public static void main(String[] args) {
        Student alex = new Student(1, "Alex");

        List < Student > studentsLst = new ArrayList < Student > ();
        studentsLst.add(alex);

        System.out.println("Arraylist size = " + studentsLst.size());
        System.out.println("Arraylist contains Alex = " + studentsLst.contains(new Student(1, "Alex")));
    }
}

Arraylist size = 1
Arraylist contains Alex = true

public class HashcodeEquals {

    public static void main(String[] args) {
        Student alex1 = new Student(1, "Alex");
        Student alex2 = new Student(1, "Alex");

        HashSet < Student > students = new HashSet < Student > ();
        students.add(alex1);
        students.add(alex2);

        System.out.println("HashSet size = " + students.size());
        System.out.println("HashSet contains Alex = " + students.contains(new Student(1, "Alex")));
    }
}

HashSet size = 2
HashSet contains Alex = false

@Override
public int hashCode() {
    return id;
}

HashSet size = 1
HashSet contains Alex = true