Java集合 HashSet的原理及常用方法

安全劍客發表於2019-09-19

一. HashSet概述

HashSet是Java集合Set的一個實現類,Set是一個介面,其實現類除HashSet之外,還有TreeSet,並繼承了Collection,HashSet集合很常用,同時也是程式設計師面試時經常會被問到的知識點,下面是結構圖

Java集合 HashSet的原理及常用方法

public class HashSet<E>
    extends AbstractSet<E>
    implements Set<E>, Cloneable, java.io.Serializable
{}

二. HashSet構造

HashSet有幾個過載的構造方法,我們來看一下

private transient HashMap<E,Object> map;
//預設構造器
public HashSet() {
    map = new HashMap<>();
}
//將傳入的集合新增到HashSet的構造器
public HashSet(Collection<? extends E> c) {
    map = new HashMap<>(Math.max((int) (c.size()/.75f) + 1, 16));
    addAll(c);
}
//明確初始容量和裝載因子的構造器
public HashSet(int initialCapacity, float loadFactor) {
    map = new HashMap<>(initialCapacity, loadFactor);
}
//僅明確初始容量的構造器(裝載因子預設0.75)
public HashSet(int initialCapacity) {
    map = new HashMap<>(initialCapacity);
}

通過上面的原始碼,我們發現了HashSet就TM是一個皮包公司,它就對外接活兒,活兒接到了就直接扔給HashMap處理了。因為底層是通過HashMap實現的,這裡簡單提一下:

HashMap的資料儲存是通過陣列+連結串列/紅黑樹實現的,儲存大概流程是通過hash函式計算在陣列中儲存的位置,如果該位置已經有值了,判斷key是否相同,相同則覆蓋,不相同則放到元素對應的連結串列中,如果連結串列長度大於8,就轉化為紅黑樹,如果容量不夠,則需擴容(注:這只是大致流程)。

如果對HashMap原理不太清楚的話,可以先去了解一下

HashMap原理(一) 概念和底層架構

HashMap原理(二) 擴容機制及存取原理

三. add方法

HashSet的add方法時通過HashMap的put方法實現的,不過HashMap是key-value鍵值對,而HashSet是集合,那麼是怎麼儲存的呢,我們看一下原始碼

private static final Object PRESENT = new Object();

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

看原始碼我們知道,HashSet新增的元素是存放在HashMap的key位置上,而value取了預設常量PRESENT,是一個空物件,至於map的put方法,大家可以看HashMap原理(二) 擴容機制及存取原理

Java集合 HashSet的原理及常用方法

四. remove方法

HashSet的remove方法通過HashMap的remove方法來實現

//HashSet的remove方法
public boolean remove(Object o) {
    return map.remove(o)==PRESENT;
}
//map的remove方法
public V remove(Object key) {
    Node<K,V> e;
    //通過hash(key)找到元素在陣列中的位置,再呼叫removeNode方法刪除
    return (e = removeNode(hash(key), key, null, false, true)) == null ? null : e.value;
}
/**
 * 
 */
final Node<K,V> removeNode(int hash, Object key, Object value,
                           boolean matchValue, boolean movable) {
    Node<K,V>[] tab; Node<K,V> p; int n, index;
    //步驟1.需要先找到key所對應Node的準確位置,首先通過(n - 1) & hash找到陣列對應位置上的第一個node
    if ((tab = table) != null && (n = tab.length) > 0 &&
        (p = tab[index = (n - 1) & hash]) != null) {
        Node<K,V> node = null, e; K k; V v;
        //1.1 如果這個node剛好key值相同,運氣好,找到了
        if (p.hash == hash &&
            ((k = p.key) == key || (key != null && key.equals(k))))
            node = p;
        /**
         * 1.2 運氣不好,在陣列中找到的Node雖然hash相同了,但key值不同,很明顯不對, 我們需要遍歷繼續
         *     往下找;
         */
        else if ((e = p.next) != null) {
            //1.2.1 如果是TreeNode型別,說明HashMap當前是通過陣列+紅黑樹來實現儲存的,遍歷紅黑樹找到對應node
            if (p instanceof TreeNode)
                node = ((TreeNode<K,V>)p).getTreeNode(hash, key);
            else {
                //1.2.2 如果是連結串列,遍歷連結串列找到對應node
                do {
                    if (e.hash == hash &&
                        ((k = e.key) == key ||
                         (key != null && key.equals(k)))) {
                        node = e;
                        break;
                    }
                    p = e;
                } while ((e = e.next) != null);
            }
        }
        //通過前面的步驟1找到了對應的Node,現在我們就需要刪除它了
        if (node != null && (!matchValue || (v = node.value) == value ||
                             (value != null && value.equals(v)))) {
            /**
             * 如果是TreeNode型別,刪除方法是通過紅黑樹節點刪除實現的,具體可以參考【TreeMap原理實現
             * 及常用方法】
             */
            if (node instanceof TreeNode)
                ((TreeNode<K,V>)node).removeTreeNode(this, tab, movable);
            /** 
             * 如果是連結串列的情況,當找到的節點就是陣列hash位置的第一個元素,那麼該元素刪除後,直接將陣列
             * 第一個位置的引用指向連結串列的下一個即可
             */
            else if (node == p)
                tab[index] = node.next;
            /**
             * 如果找到的本來就是連結串列上的節點,也簡單,將待刪除節點的上一個節點的next指向待刪除節點的
             * next,隔離開待刪除節點即可
             */
            else
                p.next = node.next;
            ++modCount;
            --size;
            //刪除後可能存在儲存結構的調整,可參考【LinkedHashMap如何保證順序性】中remove方法
            afterNodeRemoval(node);
            return node;
        }
    }
    return null;
}

removeTreeNode方法具體實現可參考 TreeMap原理實現及常用方法

afterNodeRemoval方法具體實現可參考LinkedHashMap如何保證順序性

五. 遍歷

HashSet作為集合,有多種遍歷方法,如普通for迴圈,增強for迴圈,迭代器,我們通過迭代器遍歷來看一下

public static void main(String[] args) {
    HashSet<String> setString = new HashSet<> ();
    setString.add("星期一");
    setString.add("星期二");
    setString.add("星期三");
    setString.add("星期四");
    setString.add("星期五");

    Iterator it = setString.iterator();
    while (it.hasNext()) {
        System.out.println(it.next());
    }
}

列印出來的結果如何呢?

星期二
星期三
星期四
星期五
星期一

意料之中吧,HashSet是通過HashMap來實現的,HashMap通過hash(key)來確定儲存的位置,是不具備儲存順序性的,因此HashSet遍歷出的元素也並非按照插入的順序。

六. 合計合計

按照我前面的規劃,應該每一塊主要的內容都單獨寫一下,如集合ArrayList,LinkedList,HashMap,TreeMap等。不過我在寫這篇關於HashSet的文章時,發現有前面對HashMap的講解後,確實簡單,HashSet就是一個皮包公司,在HashMap外面加了一個殼,那麼LinkedHashSet是否就是在LinkedHashMap外面加了一個殼呢,而TreeSet是否是在TreeMap外面加了一個殼?我們來驗證一下

先看一下LinkedHashSet

最開始的結構圖已經提到了LinkedHashSet是HashSet的子類,我們來看原始碼

public class LinkedHashSet<E>
    extends HashSet<E>
    implements Set<E>, Cloneable, java.io.Serializable 
{
    
    public LinkedHashSet(int initialCapacity, float loadFactor) {
        super(initialCapacity, loadFactor, true);
    }

    public LinkedHashSet(int initialCapacity) {
        super(initialCapacity, .75f, true);
    }

    public LinkedHashSet() {
        super(16, .75f, true);
    }

    public LinkedHashSet(Collection<? extends E> c) {
        super(Math.max(2*c.size(), 11), .75f, true);
        addAll(c);
    }

    public Spliterator<E> spliterator() {
        return Spliterators.spliterator(this, Spliterator.DISTINCT | Spliterator.ORDERED);
    }
}

上面就是LinkedHashSet的所有程式碼了,是不是感覺智商被否定了,這基本上沒啥東西嘛,構造器還全部呼叫父類的,下面就是其父類HashSet的對此的構造方法

HashSet(int initialCapacity, float loadFactor, boolean dummy) {
    map = new LinkedHashMap<>(initialCapacity, loadFactor);
}

大家也看出來,和我們的猜測一樣,沒有深究下去的必要了。如果有興趣可以看看LinkedHashMap如何保證順序性

在看一下TreeSet

public class TreeSet<E> extends AbstractSet<E>
    implements NavigableSet<E>, Cloneable, java.io.Serializable
{
    public TreeSet() {
        this(new TreeMap<E,Object>());
    }
    public TreeSet(Comparator<? super E> comparator) {
        this(new TreeMap<>(comparator));
    }
    public TreeSet(Collection<? extends E> c) {
        this();
        addAll(c);
    }
    public TreeSet(SortedSet<E> s) {
        this(s.comparator());
        addAll(s);
    }
}

確實如我們所猜測,TreeSet也完全依賴於TreeMap來實現,如果有興趣可以看看TreeMap原理實現及常用方法

七. 總結

本來想三章的內容,一章就算完了,雖然Set實現有點賴皮,畢竟他祖輩是Collection而不是Map,在Map的實現類上穿了一層衣服就成了Set,然後出於某種目的埋伏在Collection中,哈哈,開個玩笑,本文主要介紹了HashSet的原理以及主要方法,同時簡單介紹了LinkedHashSet和TreeSet,若有不對之處,請批評指正,望共同進步,謝謝!

相關文章