Как правильно реализовать Java-метод equals

Реализация в Object проверяет идентичность (обратите внимание, что идентичные переменные также равны), но многие классы заменяют ее чем-то более подходящим. Например, для строк он сравнивает последовательность символов, а для дат он проверяет, чтобы оба указывали на один и тот же день.

Многие структуры данных, в частности собственная коллекция Java, используют equals чтобы проверить, содержат ли они элемент.

Например:

 List<String> list = Arrays.asList("a", "b", "c"); boolean contains = list.contains("b"); 

Переменная contains true потому что, хотя экземпляры "b" не идентичны, они равны.

(Это также момент, когда hashCode вступает в игру.)

Мысли о равенстве

Любая реализация equals должна придерживаться определенного контракта, иначе равенство классов нечетко определено, и происходят всевозможные неожиданные вещи. Мы рассмотрим формальное определение через минуту, но давайте сначала обсудим некоторые свойства равенства.

Это может помочь думать об этом, когда мы сталкиваемся с этим в нашей повседневной жизни. Допустим, мы сравниваем ноутбуки и считаем их равными, если они имеют одинаковые аппаратные характеристики.

1. Одно свойство настолько тривиально, что вряд ли стоит упоминать: каждая вещь равна себе. Duh.
2. Есть еще один, который не намного вдохновляет: если одна вещь равна другой, другая также равна первой. Ясно, что если мой ноутбук равен вашему, то ваш будет равен моему.
3. Это более интересно: если у нас три вещи, и первая и вторая равны, а вторая и третья равны, то первая и третья тоже равны. Опять же, это очевидно в нашем примере с ноутбуком.

Это было бесполезное упражнение, верно? Не так! Мы только что проработали некоторые основные алгебраические свойства отношений эквивалентности. Не жди, не уходи! Это уже все, что нам нужно. Потому что любое отношение, которое имеет три свойства выше, можно назвать равенством.

Да, любой способ составления, который сравнивает вещи и обладает тремя вышеупомянутыми свойствами, может заключаться в том, как мы определяем, равны ли эти вещи. И наоборот, если мы что-то упустим, у нас больше не будет значимого равенства.

Контракт equals

Контракт equals — это чуть больше, чем формализация того, что мы видели выше.
Цитировать источник :

Метод equals реализует отношение эквивалентности для ненулевых ссылок на объекты:

• Это рефлексивно : для любого ненулевого ссылочного значения x , x.equals(x) должно возвращать true .
• Это симметрично : для любых ненулевых ссылочных значений x и y x.equals(y) должен возвращать true если и только если y.equals(x) возвращает true.
• Это транзитивно : для любых ненулевых ссылочных значений x , y и z , если x.equals(y) возвращает true а y.equals(z) возвращает true , тогда x.equals(z) должен возвращать true .
• Это согласуется : для любых ненулевых ссылочных значений x и y множественные вызовы x.equals(y) последовательно возвращают true или последовательно возвращают false при условии, что никакая информация, используемая в сравнениях сравнения для объектов, не изменяется.
• Для любого ненулевого ссылочного значения x , x.equals(null) должен возвращать false .

К настоящему времени первые три должны быть очень знакомы. Остальные пункты скорее технические: без согласованности структуры данных ведут себя хаотично и равны нулю, что не только не имеет смысла, но и усложнит многие реализации.

 @Override public boolean equals(Object o) { // self check if (this == o) return true; // null check if (o == null) return false; // type check and cast if (getClass() != o.getClass()) return false; Person person = (Person) o; // field comparison return Objects.equals(firstName, person.firstName) && Objects.equals(lastName, person.lastName); } 

 public boolean equals(Person person) { return Objects.equals(firstName, person.firstName) && Objects.equals(lastName, person.lastName); } 

 Person elliot = new Person("Elliot", "Alderson"); Person mrRobot = new Person("Elliot", "Alderson"); boolean equal = elliot.equals(mrRobot); 

 Person elliot = new Person("Elliot", "Alderson"); Object mrRobot = new Person("Elliot", "Alderson"); boolean equal = elliot.equals(mrRobot); 

 if (o == null) return false; 

 if (o == null || getClass() != o.getClass()) return false; 

 if (getClass() != o.getClass()) return false; Person person = (Person) o; 

 if (!(o instanceof Person)) return false; 

 Person foo = new Person("Mr", "Foo"); Employee fu = new Employee("Mr", "Foo", "Marketing"); Employee fuu = new Employee("Mr", "Foo", "Engineering"); 

 return (firstName == person.firstName || firstName != null && firstName.equals(person.firstName)) && (lastName == person.lastName || lastName != null && lastName.equals(person.lastName)) 

 return Objects.equals(firstName, person.firstName) && Objects.equals(lastName, person.lastName);