Java--equals与hashCode

朴灿烈づ我的快乐病毒、 2022-11-25 11:57 183阅读 0赞

原文网址：[Java--equals与hashCode\_IT利刃出鞘的博客-CSDN博客][Java--equals_hashCode_IT_-CSDN]

# 其他网址 #

> [如何重写hashCode()和equals()方法\_王鸿飞的专栏-CSDN博客\_如何重写equals方法][hashCode_equals_-CSDN_equals]
> 
> [Java 重写 hashCode 方法总结 - 知乎][Java _ hashCode _ -]

# 说明 #

下边主要写明equals与hashCode的写法及原因。实际项目中，可以用以下两种方法快速生成：

> **1.使用Idea的自动补全功能**
> 
> 对于我的快捷键来说：ctrl+enter=> equals() and hashCode()=> 选择要包含的字段。  
> （此处不能用Override Methods，因为它只是一个模板，没有进行处理）
> 
> **2.使用Lombok的注解**

# equals #

## **一般写法** ##

>     class User{
>     	private String name;
>     	private int age;
>     	// getters and setters
>     
>         @Override
>         public boolean equals(Object obj) {
>             if (obj == this) {
>                 return true;
>             }
>     
>             if (!(obj instanceof User)) {
>                 return false;
>             }
>     
>             User other = (User) obj;
>             return Objects.equals(name, user.name) &&
>                     Objects.equals(age, user.age);
>         }
>     }

**注意**

> 若obj为null，则obj instanceof User会返回false。
> 
> 最后一句不能这样写：return other.getName().equals(this.name) && other.getAge().equals(this.age); 因为如果other的name为null，会直接报空指针异常。而Objects.equals()内部对null这种情况进行了判断。

**Idea自动生成（可以发现，与我们自己写的基本相同）**

>     @Override
>     public boolean equals(Object o) {
>         if (this == o) return true;
>         if (o == null || getClass() != o.getClass()) return false;
>         User user = (User) o;
>         return Objects.equals(name, user.name) &&
>                 Objects.equals(age, user.age);
>     }

## **Java规范** ##

> 1.  自反性：A.equals(A)要返回true.
> 2.  对称性：如果A.equals(B)返回true, 则B.equals(A)也要返回true.
> 3.  传递性：如果A.equals(B)为true, B.equals(C)为true, 则A.equals(C)也要为true. 说白了就是 A = B , B = C , 那么A = C.
> 4.  一致性：只要A,B对象的状态没有改变，A.equals(B)必须始终返回true.
> 5.  A.equals(null) 要返回false.

> 英文原版（JavaSE 7 Specification）
> 
>  *  It is *reflexive*: for any non-null reference value `x`, `x.equals(x)` should return `true`.
>  *  It is *symmetric*: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`.
>  *  It is *transitive*: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`.
>  *  It is *consistent*: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified.
>  *  For any non-null reference value `x`, `x.equals(null)` should return `false`.

# hashCode #

## **一般写法** ##

>     class User{
>     	private String name;
>     	private int age;
>     	// getters and setters
>     
>         @Override
>         public int hashCode() {
>             return Objects.hashCode(this.name, this.age);
>         }
>     }

**写法思路**

> hashCode() //每一个类都自带的方法  
> Objects.hashCode(Object o) //return o != null ? o.hashCode() : 0;  
> Objects.hash(Object... values) //return Arrays.hashCode(values);  
> Arrays.hashCode(Object\[\] a)  
> 包装器的静态方法 hashCode  
> ^ //异或运算符  
> << or >> or >>> //左移运算符或右移运算符  
> 13、17、31、1231、1237 //重写 hashCode 方法时常用的素数
> 
> 将以上工具单独使用或组合使用即可重写 hashCode 方法。

## 分析 ##

**为什么重写了equals()方法，一定要重写hashCode()**

> Object类的hashCode方法它是JVM实现的，它的没有到子类中获取数据来计算hashCode，有的JVM直接返回的对象的虚拟内存地址，所以说，如果你只覆写了equals方法，equals返回了true，hashCode基本是不同的。此时，如果将元素作为HashMap或者Set的元素进行插入，会发现，插入了两次，这样集合中就出现了重复元素了。（这就与HashMap以及Set的用法冲突了）。

> 只覆写equals导致hashCode不同的程序示例
> 
>     package org.example.a;
>     
>     import java.util.Objects;
>     
>     class User {
>         private String name;
>         private Integer age;
>     
>         public String getName() {
>             return name;
>         }
>     
>         public void setName(String name) {
>             this.name = name;
>         }
>     
>         public Integer getAge() {
>             return age;
>         }
>     
>         public void setAge(Integer age) {
>             this.age = age;
>         }
>     
>         @Override
>         public boolean equals(Object o) {
>             if (this == o) {
>                 return true;
>             }
>             if (!(o instanceof User)) {
>                 return false;
>             }
>     
>             User user = (User) o;
>             return Objects.equals(name, user.name) &&
>                     Objects.equals(age, user.age);
>         }
>     }
>     
>     public class Demo{
>         public static void main(String[] args) {
>             User user = new User();
>             user.setName("Tony");
>             user.setAge(30);
>     
>             User user1 = new User();
>             user1.setName("Tony");
>             user1.setAge(30);
>     
>             System.out.println(user.equals(user1));
>             System.out.println(user.hashCode() == user1.hashCode());
>             System.out.println(user.hashCode());
>             System.out.println(user1.hashCode());
>         }
>     }
> 
> 执行结果
> 
>     true
>     false
>     685325104
>     460141958

**Java API关于hashCode方法的规定**

>  *  在java应用程序执行期间，如果在equals方法比较中所用的信息没有被修改，那么在同一个对象上多次调用hashCode方法时必须一致地返回相同的整数。程序结束后再执行时则允许返回不同的整数。
>  *  如果两个对象通过调用equals方法是相等的，那么这两个对象调用hashCode方法必须返回相同的整数。
>  *  如果两个对象通过调用equals方法是不相等的，不要求这两个对象调用hashCode方法必须返回不同的整数。但是程序员应该意识到对不同的对象产生不同的hash值可以提供哈希表的性能。

[Java--equals_hashCode_IT_-CSDN]: https://knife.blog.csdn.net/article/details/107887088
[hashCode_equals_-CSDN_equals]: https://blog.csdn.net/neosmith/article/details/17068365
[Java _ hashCode _ -]: https://zhuanlan.zhihu.com/p/85423244