java基础之hashCode和equals分析

古城微笑少年丶 2023-01-13 05:46 187阅读 0赞

## 写在前面 ##

本文参考[这篇文章][Link 1]，写的非常详细。

## 1：Object类 ##

hashCode和equals方法是在java的顶层类`java.lang.Object`中定义的，源码如下：

java.lang.Object
    public class Object { 
    	// 返回hash值，即对象对应的一个数字，方便在java.util.HashMap,java.util.HashTable中
    	// 使用，因为这些数据结构底层是数组，所以必须具有转换为整数的能力，关于该方法我们必须遵守如下的契约,
    	// 注意以下契约均建立在对象信息没有被修改的前提下：
    	// 1：在程序的一次执行期间多次调用该方法返回的整数值需要保持一致,但是相同的应用程序不同的执行不需要保持一致
    	// 2：如果是两个对象执行equals返回true，则这两个对象的hashCode必须返回相同的整数(重要！！！)
    	// 3：如果是两个对象执行equals返回false，则这个对象的hashCode不是必须不同
    	public native int hashCode();
    	// 纯粹的用于判断两个类是否相等，必须满足如下的要求
    	// 注意以下契约均建立在对象没有被修改的前提下：
    	// 1：自反的，自己和自己equals必须返回true
    	// 2：对称的，自己去equals其他对象返回true，其他对象equals自己也要返回true
    	// 3：传递的，如有x，y，z，如果x.equsls(y)返回true，y.equals(z)返回true，则x.equals(z)也要返回true
    	// 4：一致的，两个对象equals的结果始终保持一致，要么一直true，要么一直false
    	// 5：不为null的对象去equals(null)是false
    	public boolean equals(Object obj) { 
            return (this == obj);
        }
    }

注意到都是`规定`,我们也都是在这些规定下来工作的，在实际工作中不能违反这些规定，不然会造成`诡异的bug`的发生。

## 2：String类 ##

jdk的`java.lang.String`类复写了`java.lang.Object`的hashCode和equals方法。

### 2.1：equals ###

重点看注释：

java.lang.String
    public final class String
        implements java.io.Serializable, Comparable<String>, CharSequence { 
        // 存储字符串信息的字符数组
        private final char value[];
        public boolean equals(Object anObject) { 
        	// 是同一个对象，则直接返回true
           if (this == anObject) { 
               return true;
           }
           // 是java.lang.String类型，才继续，否则直接返回false
           if (anObject instanceof String) { 
           	   // 强转String
               String anotherString = (String)anObject;
               int n = value.length;
               // 如果长度相等才继续否则直接false
               if (n == anotherString.value.length) { 
               	   // 分别获取字符数组
                   char v1[] = value;
                   char v2[] = anotherString.value;
                   int i = 0;
                   // 分别比较对应位置字符
                   while (n-- != 0) { 
                   	   // 当前位置字符不相等，则返回false
                       if (v1[i] != v2[i])
                           return false;
                       i++;
                   }
                   // 执行到这里，说明字符数组的每个字符都是相等的，即二者的值是相等的，返回true
                   return true;
               }
           }
           return false;
       }
    }

### 2.2：hashCode ###

重点看注释：

public final class String
        implements java.io.Serializable, Comparable<String>, CharSequence { 
        // String的hash结果的缓存值，避免重新计算，提高效率
        private int hash;
        
    	// java.lang.String#hashCode
    	public int hashCode() { 
    		// 先获取缓存的hash值
            int h = hash;
            // 如果有缓存的hash值，则直接返回，否则重新计算
            if (h == 0 && value.length > 0) { 
            	// 获取字符串对应的字符数组
                char val[] = value;
    			// 按照公式s[0]*31^(n-1) + s[1]*31^(n-2) + ... + s[n-1]计算结果
                for (int i = 0; i < value.length; i++) { 
                    h = 31 * h + val[i];
                }
                // 将计算结果存储到hash结果值缓存中
                hash = h;
            }
            // 返回hash值
            return h;
        }
    }

## 3：方法的作用 ##

### 3.1：equals ###

最终判断两个对象`是否相等`。

### 3.2：hashCode ###

能够利用散列表等数据结构，提高数据的查询效率。

[Link 1]: https://www.cnblogs.com/Qian123/p/5703507.html