HashSet.add()方法解析

這篇文章主要是記錄學習HashSet時關於add()方法的解析,以便個人理解HashSet大概的工作原理,僅作參考。

 

範例一:

TestObj類的任意實例對象a, b, a.equals(b)方法都返回true,並且a.hashcode() == b.hashcode(),即hashcode值一樣。

/**
 * TestObj類的任意實例對象a, b, a.equals(b)方法都返回true
 * 並且a.hashcode() == b.hashcode(),即hashcode值一樣。
 */
public class TestObj{
	String value ;
	public TestObj(String val) {
		value = val;
	}
	@Override
	public boolean equals(Object obj) {
		return true;
	}
	@Override
	public int hashCode() {
		
		return 1;
	}
	@Override
	public String toString() {
		// TODO Auto-generated method stub
		return value;
	}
}

測試代碼塊:

TestObj obj = new TestObj("abc");
TestObj obj2 = new TestObj("def");
Set<TestObj> hashSetObj = new HashSet<>(); 
hashSetObj.add(obj);
hashSetObj.add(obj2);
System.out.println(hashSetObj.size());

將obj1和obj2放入HashSet容器中,容器的大小是1,而不是2。

 

範例二

TestObj類的任意實例對象a, b, a.equals(b)方法表現與a.value.equals(b.value)一致並且a.hashcode() == b.hashcode(),即hashcode值一樣。

/**
 * TestObj類的任意實例對象a, b, a.equals(b)方法表現與a.value.equals(b.value)一致
 * 並且a.hashcode() == b.hashcode(),即hashcode值一樣。
 */
public class TestObj{
	String value ;
	public TestObj(String val) {
		value = val;
	}
	@Override
	public boolean equals(Object obj) {
        if (obj == null) return false;
        if (obj instanceOf TestObj) {
            TestObj instance = (TestObj)obj;
            return value.equals(instance.value);
        }
		return false;
	}
	@Override
	public int hashCode() {
		
		return 1;
	}
	@Override
	public String toString() {
		// TODO Auto-generated method stub
		return value;
	}
}

測試代碼:

TestObj obj = new TestObj("abc");
TestObj obj2 = new TestObj("def");
Set<TestObj> hashSetObj = new HashSet<>(); 
hashSetObj.add(obj);
hashSetObj.add(obj2);
System.out.println(hashSetObj.size());

將obj1和obj2放入HashSet容器中,容器的大小是2,而不是1。

 

解析

在沒有深入瞭解HashSet的源碼之前,錯誤的認爲:向HashSet容器添加一個新對象B,如果能夠在容器中找到一個對象A滿足條件A.hashcode == B.hashcode, 那麼就不會往容器中放入B。下面來看看HashSet add()方法的源碼。

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

這裏的mapPRESENT是什麼東西呢?

map是在HashSet中聲明的,即 HashSet容器的底層是用HashMap來存儲數據的,向容器中添加的元素e (泛型E的實例)作爲key,  PRESENT作爲value。這裏的PRESENT是一個虛擬的值,用來關聯一個對象,即PRESENT是用來幫助填充value的,沒有實際意義。map容器中所有節點的value都指向 PRESENT。

 private transient HashMap<E,Object> map;

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

繼續看看HashMap的 put(K key, V value)方法

 public V put(K key, V value) {
     return putVal(hash(key), key, value, false, true); // hash(key)得到Key的hash值
 }


 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)
         // 如果容器爲空,就初始化這個容器(給容器分配一個默認的大小DEFAULT_INITIAL_CAPACITY)
            n = (tab = resize()).length; 
        // (n - 1) & hash 是根據key的hash值來判斷,元素放到哪個桶(Node)中
        if ((p = tab[i = (n - 1) & hash]) == null)
            tab[i] = newNode(hash, key, value, null);
        else {
            // 如果對應的桶不爲空
            // p.hash == hash &&((k = p.key) == key || (key != null && key.equals(k)))
            // 上面的代碼是比較p節點的hash值與需要放入的元素e的hash,以及e與p.key是否相等(e            
            // 在map容器節點中作爲鍵(key))
            Node<K,V> e; K k;
            if (p.hash == hash &&
                ((k = p.key) == key || (key != null && key.equals(k))))
                // 兩個條件同時滿足就不會將e放入容器中
                e = p;
            else if (p instanceof TreeNode)
                e = ((TreeNode<K,V>)p).putTreeVal(this, tab, hash, key, value);
            else {
                // 二者其一不滿足,就創建一個新節點,放在p節點後即p.next = newNode
                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;
    }

結論:

向HashSet中放入元素e時,不僅需要比較hash值,而且需要比較e是否等於對應節點的key。兩者同時滿足時,e不會放入容器中,否則將e放入容器中。參考代碼:p.hash == hash &&((k = p.key) == key || (key != null && key.equals(k)))

同理,HashMap也是如此。

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章