HashSet源码分析

概述

HashSet内部是基于HashMap来实现的，所以你如果读懂了HashMap的源码，HashSet就相对简单了。

    private transient HashMap<E,Object> map;

    // Dummy value to associate with an Object in the backing Map
    private static final Object PRESENT = new Object();

    /**
     * Constructs a new, empty set; the backing <tt>HashMap</tt> instance has
     * default initial capacity (16) and load factor (0.75).
     */
    public HashSet() {
        map = new HashMap<>();
    }

HashSet的构造方法创建的是一个HashMap类型的map实例，而之后HashSet的添加、删除等操作都是基于这个map来实现的。

  public boolean add(E e) {
        return map.put(e, PRESENT)==null;
    }

public boolean remove(Object o) {
        return map.remove(o)==PRESENT;
    }

因为HashSet是基于HashMap实现的，所以这里不再对HashSet源码作详细的分析。那么既然是基于HashMap实现，为什么还要一个HashSet类。我们来看看各自的特点就明了了。

HashSet

HashSet实现了Set接口，Set接口不允许重复的元素，但是可以拥有一个Null元素，记住只能有一个Null元素。那么HashSet是通过什么机制或者方法来区别对象的异同呢？加入到Set中对象元素都需要重写hashCode() 和equals()方法，HashSet就是通过这个两个方法来区别对象元素的异同的。首先会调用hashCode()方法来比较两个对象的hash值，如果能区分出不同，就不再调用equals()方法，否则再调用equals()方法来比较。

HashSet添加的是对象。我们通过add()方法可以看到，加入的也是一个键值对map.put(e, PRESENT)，e就是我们添加的对象，但是值都是相同的对象PRESENT。HashSet在意的是这个键，值不是关注的对象，值只是为了维持和HashMap的有一样的键值对结构。

HashMap

HashMap实现了Map接口。HashMap添加的是健值对，不允许有重复的键添加，但也可以加入一个null键的键值对（其实这个null的键会被解析成hash值为0）。HashMap也会使用hashCode()和equals()方法，它是用来比较键的异同的。

说完了两者的区别，我们具体看看HashSet的一个实例

package com.lead.util;

import java.util.HashSet;
import java.util.Iterator;
import java.util.Set;

public class HastSetTest {

	static class Person{
		private String name;
		private int age;
		
		public Person(String name,int age){
			this.name = name;
			this.age = age;
		}
		public String getName() {
			return name;
		}
		public void setName(String name) {
			this.name = name;
		}
		public int getAge() {
			return age;
		}
		public void setAge(int age) {
			this.age = age;
		}
		
		@Override
		public int hashCode() {
			System.out.println("invoke hashCode method");
			final int prime = 31;
			int result = 1;
			result = prime * result + age;
			result = prime * result + ((name == null) ? 0 : name.hashCode());
			return result;
		}
		@Override
		public boolean equals(Object obj) {
			System.out.println("invoke equals method");
			if (this == obj)
				return true;
			if (obj == null)
				return false;
			if (getClass() != obj.getClass())
				return false;
			Person other = (Person) obj;
			if (age != other.age)
				return false;
			if (name == null) {
				if (other.name != null)
					return false;
			} else if (!name.equals(other.name))
				return false;
			return true;
		}
		@Override
		public String toString() {
			return "Person [name=" + name + ", age=" + age + "]";
		}
	}

	public static void main(String[] args) {
		// TODO Auto-generated method stub
		Person p1 = new Person("张三",30);
		Person p = new Person("张三",29);
		Person p2 = new Person("张三",30);
		Set<Person> s = new HashSet<Person>();
		s.add(p);
		s.add(p1);
		s.add(p2);
		s.add(null);
		Iterator<Person> iter = s.iterator();
		while(iter.hasNext()){
		System.out.println(iter.next());
		}
	}

}

这段代码的输出结果：

invoke hashCode method
invoke hashCode method
invoke hashCode method
invoke equals method
null
Person [name=张三, age=29]
Person [name=张三, age=30]

从结果可以看出，HashSet确实是通过hashCode()和equals()来比较对象的，而且调用是有先后顺序的。同时HashSet能添加null元素，但是添加null的时候不会调用hashCode()方法，但是因为null元素的hash值直接会被解析成0。