对HashMap.put()和HashSet.add()的探究

这篇文章主要讨论HashMap.put()和HashSet.add()其中的几点关系和特性，即

1.HashSet的底层调用了HashMap

2.HashMap插入的entry允许key=null,value=null,HashSet也允许添加null对象

3.HashMap中entry的key不会有重复

以下纯粹是自己在阅读相关源码和资料后自己的总结，由于自己的水平有限，如果有任何错误的地方，希望大家能够指出并一起讨论解决。

1.HashSet的底层调用了HashMap

HashSet和HashMap一个重要的关系就是HashSet的底层是调用了HashMap，既然此篇文章探究的是HashMap.put()和HashSet.add()的关系，那就以HashSet.add()方法来举例（似乎不是很严谨），如：

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

再来看map这个实例对象

private transient HashMap<E,Object> map;

从上述源码中，HashSet和HashMap的关系便一目了然

2.HashMap插入的entry允许key=null,value=null，HashSet也允许添加null对象

既然HashMap和HashSet有这么密切的关系，那么它们在方法的某些特性上必有相似的特点，那就先从HashMap.put()说起，先看一段代码：

public class Test {
   	
	public static void main(String[] args){

		HashMap<String,String> hashMap = new HashMap<String,String>();
		System.out.println("这是插入key=null,value=null的Node之前hashMap的长度:"+hashMap.size());
		hashMap.put(null, null);
		System.out.println("这是插入key=null,value=null的Node之后hashMap的长度:"+hashMap.size());
	
	}		
	
}

再看看运行结果打印的日志

从结果可以看到key=null,value=null的键值对成功插入到HashMap中

再来看看在HashMap的源码中是如何实现这一点的

public V put(K key, V value) {
        return putVal(hash(key), key, value, false, true);
    }

先看其中的hash()方法

static final int hash(Object key) {
        int h;
        return (key == null) ? 0 : (h = key.hashCode()) ^ (h >>> 16);
    }

从中可以看出key是允许==null，当key==null时hash值便为0

再看看putVal()方法

final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
        Node<K,V>[] tab; Node<K,V> p; int n, i;
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);
        else {
            Node<K,V> e; K k;
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                e = p;
            else if (p instanceof TreeNode)
                e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
            else {
                for (int binCount = 0; ; ++binCount) {
                    if ((e = p.next) == null) {
                        p.next = newNode(hash, key, value, null);
                        if (binCount >= TREEIFY_THRESHOLD - 1) // -1 for 1st
                            treeifyBin(tab, hash);
                        break;
                    }
                    if (e.hash == hash &&
                        ((k = e.key) == key || (key != null && key.equals(k))))
                        break;
                    p = e;
                }
            }
            if (e != null) { // existing mapping for key
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;
                afterNodeAccess(e);
                return oldValue;
            }
        }
        ++modCount;
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);
        return null;
    }

其中并没有看到对key==null或者value==null时的限制，其中有一段重要的代码

 if ((p = tab[i = (n - 1) & hash]) == null)

从上面的讨论中已知当key==null时hash的值为0，所以i也为0，也就是说当key==null时，对应的entry是安插在索引位置为0，即数组的第一个节点

因此可以得出结论，HashMap的键值对的key和value是允许为null的，由于HashSet.add()的底层是调用HashMap，同理可知HashSet也是允许添加进值为null的对象

3.HashMap中entry的key不会有重复

先看一段关于插入的代码

final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
        Node<K,V>[] tab; Node<K,V> p; int n, i;
        if ((tab = table) == null || (n = tab.length) == 0)
            n = (tab = resize()).length;
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);
        else {                                             //说明此时在对应的索引位置已经有对象了
            Node<K,V> e; K k;
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k)))) // 判断原对象与插入的对象的key是否一样
                e = p;
            else if (p instanceof TreeNode)
               //......
            else {             
               //......

}

            if (e != null) { //说明原对象与插入的对象的key相同 
                V oldValue = e.value;
                if (!onlyIfAbsent || oldValue == null)
                    e.value = value;//将新插入的entry的value覆盖掉原来的entry的value
                afterNodeAccess(e);
                return oldValue;
            }
        }
        ++modCount;
        if (++size > threshold)
            resize();
        afterNodeInsertion(evict);
        return null;
    }

从上述代码可以看出，当插入的entry与已插入的老entry的key和hash都相同时（即哈希冲突），因为key相同，所以对key不进行更改操作，而新entry的value将会覆盖掉老entry的value（即oldValue），因此一个HashMap中不会有重复的key,HashSet恰恰是利用HashMap的这一特性来使得HashSet中的对象没有重复的，先看一段HashSet源码

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

再看看PRESENT对象

private static final Object PRESENT = new Object();

从中可以看出，当HashSet每次add一个对象时都调用map.put，之前的讨论中已知e也就是key是不会重复的，

而value每一次都用PRESENT这个对象代替，因此实现了HashSet不会有重复的元素这个特性