自定义对象作为HashMap的Key问题

目录

• 自定义对象作为HashMap的Key
• 首先我们自定义一个学生对象，它有姓名和年龄两个字段.
• HashMap使用自定义对象作为Key的注意点
• 1. 自定义对象不重写hashCode方法和equals会发生什么？
• 2. 在HashMap中使用自定义对象作为key会发生什么？
• 3. 重写hashCode方法和equals方法的原则

自定义对象作为HashMap的Key

这个问题在很多面试者面试时都会被提及，本人也是最近在看effective java第九条:覆盖equals时总要覆盖hashcode回想到了当初面试时也被问到了这个问题.于是动手写了几行代码，还真发现了一些小的问题，所以拿出来分享一下!

首先我们自定义一个学生对象，它有姓名和年龄两个字段.

class Student{
	public String name;
	public Integer age;
	
	Student(String name,Integer age){
		this.name = name;
		this.age = age;
	}
	
	@Override
	public boolean equals(Object o) {
		//return true;
		if(o==this)
			return true;
			if(!(o instanceof Student))
				return false;
			Student s = (Student)o;
		return s.name.equals(name)&&s.age.equals(age);
	}
	
	@Override
	public int hashCode() {
		int result = 17;
		result = 31 * result + name.hashCode();
		result = 31 * result + age;
		return result;
	}
}

(PS)上面的代码是一个能作为hashMap的key对象的完整代码.包括重写了equals方法和hashCode方法.在重写equals方法时我还遇到了一个麻烦事，一开始我是下面这样写的:

@Override
	public boolean equals(Object o) {
		//***********
		return s.name.equals(name)&&s.age==age;
	}

相信都能找到原因，age是Integer对象而不是int所以比较的是地址值，于是乎无论如何都不能得到我想要的结果.

然后我们接着把对象装入HashMap结构中，并取出，看是否能够成功?

static void demo2(){
		Map map = new HashMap();		
		long l1 = System.currentTimeMillis();
		for(int i = 0;i<10000;i++){
			map.put(new Student("dy"+i, i), ""+i);
		}
		long l2 = System.currentTimeMillis();
		System.out.println(map.get(new Student("dy9999",9999)));
		long l3 = System.currentTimeMillis();
		System.out.println((l2-l1));
		System.out.println((l3-l2));
	}

结果如下

9999
8
0

已经成功了!

那么可能有点新的问题了!那就是Student对象的hashCode方法是怎么实现的呢?equals方法大家都会重写.那么究竟怎么一个算法能让不同的对象具有不同的散列值呢?下面这段描述摘抄自effective java给我们的建议:

1.把某个非零的常数值，比如说17(一个你喜欢的数字)，保存在一个名为result的int类型的变量中.

2.对于对象中每个关键域(指equals方法中涉及的每个域)，完成以下步骤:

• a.为该域计算int类型的散列码c:

i.如果该域是boolean类型，则计算(f?1:0)

ii.如果该域是byte，char，short或者int类型，则计算(int)f.

iii.如果该域是long类型，则计算(int)(f^(f>>>32)).

iv.如果该域是float类型，则计算Float.floatToIntBits(f).

v.如果该域是double类型，则计算Double.doubleToLongBits(f)，然后按照步骤2.a.iii，为得到的long类型值计算散列值.

vi.如果该域是一个对象引用，并且该类的equals方法通过递归地调用equals的方式来比较这个域，则同样为这个域递归地调用hashCode.如果需要更加复杂的比较，则为这个域计算一个"范式"，然后针对这个范式调用hashCode.如果这个域的值为null，则返回0(或者其他某个常数，但通常是0).

vii.如果该域是一个数组，则要把每一个元素当做单独的域来处理.也就是说，递归地应用上述规则，对每个重要的元素计算一个散列码，然后根据步骤2.b中的做法把这些散列值组合起来.如果数组域中的每个元素都很重要，可以利用发行版本1.5中增加的其中一个Arrays.hashCode方法.

• b.按照下面的公式，把步骤2.a中计算得到的散列码c合并到result中:

result = 31 * result +c;

3.返回result

当然如果我们不重写hashCode方法会出现什么情况呢？请看：

null
8
0

返回结果为null，因为Student类没有重写hashCode方法，从而导致两个相等的实例具有不相等的散列码，违反了hashCode的约定.因此put方法把对象放在一个散列桶中，而get方法却在另一个散列桶中取值.即使这两个实例恰好被放在同一个散列桶中，get方法也必定会返回null，因为HashMap有一项优化，可以将与每个相关联的散列码缓存起来，如果散列码不匹配，也不必检查对象的等同性!这正说明了effective java第九条:覆盖equals方法时总要覆盖hashCode.但是现在又有一个问题了，如果我重写的hashCode代码如下会如何呢?

    @Override
    public int hashCode() {
        /*int result = 17;
        result = 31 * result + name.hashCode();
        result = 31 * result + age;*/
        return 32;
    }

运行的结果如下:

9999
2305
1

可以看到的是，由于每个对象都具有相同的散列值，因此，每个对象都被映射到同一个散列桶中，使散列表退化为链表，它使得本该线性时间运行的程序变成了以平方级时间在运行.

关于对象实现Compareable接口可以参考这篇文章(Java 8 HashMap键与Comparable接口).

HashMap使用自定义对象作为Key的注意点

1. 自定义对象不重写hashCode方法和equals会发生什么？

public class AboutHashMap {
    public static void main(String[] args) {
        Student s1 = new Student("张三",18);
        Student s2 = new Student("张三",18);
        System.out.println(s1.hashCode()); //21685669
        System.out.println(s2.hashCode()); //2133927002
        System.out.println(s1.hashCode() == s2.hashCode()); //false
        System.out.println(s1.equals(s2)); //false
    }
}
class Student {
    private String name;
    private int age;
    // 省略getter，setter，有参构造
}

结论：

当我们不重写Student对象的hashCode方法和equals方法时，Student对象沿用的就是Object对象的hashCode方法和equals方法；从上面代码的测试来说，即使两个属性相同的对象他们的hash值都是不一样的，调用equals方法进行比较，他们也是不相同的。

总结：

• Object对象的equals方法比较的是两个对象的内存地址。
• Object类的hashCode返回对象的内存地址经过处理后得到的值，由于每个对象的内存地址都不一样，所以哈希码也不一样。

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

2. 在HashMap中使用自定义对象作为key会发生什么？

public class AboutHashMap {
    public static void main(String[] args) {
        Student s1 = new Student("张三",18); // 两个相同属性的对象
        Student s2 = new Student("张三",18);
        Map hashMap = new HashMap<>();
        hashMap.put(s1, 99);        
        // 使用属性相同的对象s2去调用get方法
        System.out.println( hashMap.get(s2) );  // null
    }
}
class Student {
    private String name;
    private int age;
    // 省略getter，setter，有参构造方法，toString方法
}

分析：

我们可以发现，通过一个属性一模一样的s2去get哈希表中的元素竟然找不到前面put过的 s1-99！！！？？？

解释：

put入的元素在HashMap中数组结构的位置由key的hashCode方法返回值来决定，而此时自定义对象hashCode方法（未重写），返回值是由对象的内存地址值计算而来的，因此即使两个对象的属性完全相同，他们的哈希值也不同，所以即使两个属性完全相同的对象在HashMap中也完全找不到。

总结：

使用自定义对象作为HashMap的key不重写hashCode和equals方法会产生的问题

• get方法：使用属性完全相同的对象作为key去get元素会找不到元素。
• put方法：即使是有属性完全相同的对象put到HashMap中，也不会覆盖已有的value值，只会当作新元素加入到HashMap中
• 即使发生hash冲突，调用equal方法比较两个属性完全相同的对象也会返回false

所以要想顺利使用自定义对象作为hashMap的key就必须正确重写hashCode和equals方法。

3. 重写hashCode方法和equals方法的原则

equals:

• 相等的两个key实例调用equals()必须返回true(相等指的是属性完全相等)。

hashCode：

• 如果两个对象相等，则两个对象的hashCode()必须相等；
• 如果两个对象不相等，则两个对象的hashCode()尽量不要相等, (为了减少发生hash冲突的情况)。

ps：在IDEA中使用 ALT + INSERT可以快速帮我们实现equals和hashcode方法

class Student {
    private String name;
    private int age;
    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        Student student = (Student) o;
        return age == student.age && name.equals(student.name);
    }
    @Override
    public int hashCode() {
        return Objects.hash(name, age);
    }
}

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。