Java 集合Hashtable原始碼深入解析

程式設計師歐陽思海發表於2019-01-19

概要

前面,我們已經系統的對List進行了學習。接下來,我們先學習Map,然後再學習Set;因為Set的實現類都是基於Map來實現的(如,HashSet是通過HashMap實現的,TreeSet是通過TreeMap實現的)。

首先,我們看看Map架構。

這裡寫圖片描述
如上圖: (01) Map 是對映介面,Map中儲存的內容是鍵值對(key-value)。 (02) AbstractMap 是繼承於Map的抽象類,它實現了Map中的大部分API。其它Map的實現類可以通過繼承AbstractMap來減少重複編碼。 (03) SortedMap 是繼承於Map的介面。SortedMap中的內容是排序的鍵值對,排序的方法是通過比較器(Comparator)。 (04) NavigableMap 是繼承於SortedMap的介面。相比於SortedMap,NavigableMap有一系列的導航方法;如"獲取大於/等於某物件的鍵值對"、“獲取小於/等於某物件的鍵值對”等等。 (05) TreeMap 繼承於AbstractMap,且實現了NavigableMap介面;因此,TreeMap中的內容是“有序的鍵值對”! (06) HashMap 繼承於AbstractMap,但沒實現NavigableMap介面;因此,HashMap的內容是“鍵值對,但不保證次序”! (07) Hashtable 雖然不是繼承於AbstractMap,但它繼承於Dictionary(Dictionary也是鍵值對的介面),而且也實現Map介面;因此,Hashtable的內容也是“鍵值對,也不保證次序”。但和HashMap相比,Hashtable是執行緒安全的,而且它支援通過Enumeration去遍歷。 (08) WeakHashMap 繼承於AbstractMap。它和HashMap的鍵型別不同,WeakHashMap的鍵是“弱鍵”。

在對各個實現類進行詳細之前,先來看看各個介面和抽象類的大致介紹

1 Map

Map的定義如下:

public interface Map<K,V> { }
複製程式碼

Map 是一個鍵值對(key-value)對映介面。Map對映中不能包含重複的鍵;每個鍵最多隻能對映到一個值。 Map 介面提供三種collection 檢視,允許以鍵集值集鍵-值對映關係集的形式檢視某個對映的內容。 Map 對映順序。有些實現類,可以明確保證其順序,如 TreeMap;另一些對映實現則不保證順序,如 HashMap 類。 Map 的實現類應該提供2個“標準的”構造方法:第一個,void(無引數)構造方法,用於建立空對映;第二個,帶有單個 Map 型別引數的構造方法,用於建立一個與其引數具有相同鍵-值對映關係的新對映。實際上,後一個構造方法允許使用者複製任意對映,生成所需類的一個等價對映。儘管無法強制執行此建議(因為介面不能包含構造方法),但是 JDK 中所有通用的對映實現都遵從它。

Map的API

abstract void                 clear()
abstract boolean              containsKey(Object key)
abstract boolean              containsValue(Object value)
abstract Set<Entry<K, V>>     entrySet()
abstract boolean              equals(Object object)
abstract V                    get(Object key)
abstract int                  hashCode()
abstract boolean              isEmpty()
abstract Set<K>               keySet()
abstract V                    put(K key, V value)
abstract void                 putAll(Map<? extends K, ? extends V> map)
abstract V                    remove(Object key)
abstract int                  size()
abstract Collection<V>        values()
複製程式碼

說明: (01) Map提供介面分別用於返回 鍵集值集鍵-值對映關係集。 entrySet()用於返回鍵-值集的Set集合 keySet()用於返回鍵集的Set集合 values()使用者返回值集的Collection集合 因為Map中不能包含重複的鍵;每個鍵最多隻能對映到一個值。所以,鍵-值集、鍵集都是Set,值集時Collection。

(02) Map提供了“鍵-值對”、“根據鍵獲取值”、“刪除鍵”、“獲取容量大小”等方法。

2 Map.Entry

Map.Entry的定義如下:

interface Entry<K,V> { }
複製程式碼

Map.Entry是Map中內部的一個介面,Map.Entry是鍵值對,Map通過 entrySet() 獲取Map.Entry的鍵值對集合,從而通過該集合實現對鍵值對的操作。

Map.Entry的API

abstract boolean     equals(Object object)
abstract K             getKey()
abstract V             getValue()
abstract int         hashCode()
abstract V             setValue(V object)
複製程式碼

3 AbstractMap

AbstractMap的定義如下:

public abstract class AbstractMap<K,V> implements Map<K,V> {}
複製程式碼

AbstractMap類提供 Map 介面的骨幹實現,以最大限度地減少實現此介面所需的工作。 要實現不可修改的對映,程式設計人員只需擴充套件此類並提供 entrySet 方法的實現即可,該方法將返回對映的對映關係 set 檢視。通常,返回的 set 將依次在 AbstractSet 上實現。此 set 不支援 add() 或 remove() 方法,其迭代器也不支援 remove() 方法。

要實現可修改的對映,程式設計人員必須另外重寫此類的 put 方法(否則將丟擲 UnsupportedOperationException),entrySet().iterator() 返回的迭代器也必須另外實現其 remove 方法。

AbstractMap的API

abstract Set<Entry<K, V>>     entrySet()
         void                 clear()
         boolean              containsKey(Object key)
         boolean              containsValue(Object value)
         boolean              equals(Object object)
         V                    get(Object key)
         int                  hashCode()
         boolean              isEmpty()
         Set<K>               keySet()
         V                    put(K key, V value)
         void                 putAll(Map<? extends K, ? extends V> map)
         V                    remove(Object key)
         int                  size()
         String               toString()
         Collection<V>        values()
         Object               clone()
複製程式碼

4 SortedMap

SortedMap的定義如下:

public interface SortedMap<K,V> extends Map<K,V> { }
複製程式碼

SortedMap是一個繼承於Map介面的介面。它是一個有序的SortedMap鍵值對映。 SortedMap的排序方式有兩種:自然排序 或者 使用者指定比較器。 插入有序 SortedMap 的所有元素都必須實現 Comparable 介面(或者被指定的比較器所接受)。

另外,所有SortedMap 實現類都應該提供 4 個“標準”構造方法: (01) void(無引數)構造方法,它建立一個空的有序對映,按照鍵的自然順序進行排序。 (02) 帶有一個 Comparator 型別引數的構造方法,它建立一個空的有序對映,根據指定的比較器進行排序。 (03) 帶有一個 Map 型別引數的構造方法,它建立一個新的有序對映,其鍵-值對映關係與引數相同,按照鍵的自然順序進行排序。 (04) 帶有一個 SortedMap 型別引數的構造方法,它建立一個新的有序對映,其鍵-值對映關係和排序方法與輸入的有序對映相同。無法保證強制實施此建議,因為介面不能包含構造方法。

SortedMap的API

// 繼承於Map的API
abstract void                 clear()
abstract boolean              containsKey(Object key)
abstract boolean              containsValue(Object value)
abstract Set<Entry<K, V>>     entrySet()
abstract boolean              equals(Object object)
abstract V                    get(Object key)
abstract int                  hashCode()
abstract boolean              isEmpty()
abstract Set<K>               keySet()
abstract V                    put(K key, V value)
abstract void                 putAll(Map<? extends K, ? extends V> map)
abstract V                    remove(Object key)
abstract int                  size()
abstract Collection<V>        values()
// SortedMap新增的API 
abstract Comparator<? super K>     comparator()
abstract K                         firstKey()
abstract SortedMap<K, V>           headMap(K endKey)
abstract K                         lastKey()
abstract SortedMap<K, V>           subMap(K startKey, K endKey)
abstract SortedMap<K, V>           tailMap(K startKey)
複製程式碼

5 NavigableMap

NavigableMap的定義如下:

public interface NavigableMap<K,V> extends SortedMap<K,V> { }
複製程式碼

NavigableMap是繼承於SortedMap的介面。它是一個可導航的鍵-值對集合,具有了為給定搜尋目標報告最接近匹配項的導航方法。 NavigableMap分別提供了獲取“鍵”、“鍵-值對”、“鍵集”、“鍵-值對集”的相關方法。

NavigableMap的API

abstract Entry<K, V>             ceilingEntry(K key)
abstract Entry<K, V>             firstEntry()
abstract Entry<K, V>             floorEntry(K key)
abstract Entry<K, V>             higherEntry(K key)
abstract Entry<K, V>             lastEntry()
abstract Entry<K, V>             lowerEntry(K key)
abstract Entry<K, V>             pollFirstEntry()
abstract Entry<K, V>             pollLastEntry()
abstract K                       ceilingKey(K key)
abstract K                       floorKey(K key)
abstract K                       higherKey(K key)
abstract K                       lowerKey(K key)
abstract NavigableSet<K>         descendingKeySet()
abstract NavigableSet<K>         navigableKeySet()
abstract NavigableMap<K, V>      descendingMap()
abstract NavigableMap<K, V>      headMap(K toKey, boolean inclusive)
abstract SortedMap<K, V>         headMap(K toKey)
abstract SortedMap<K, V>         subMap(K fromKey, K toKey)
abstract NavigableMap<K, V>      subMap(K fromKey, boolean fromInclusive, K toKey, boolean toInclusive)
abstract SortedMap<K, V>         tailMap(K fromKey)
abstract NavigableMap<K, V>      tailMap(K fromKey, boolean inclusive)
複製程式碼

說明:

NavigableMap除了繼承SortedMap的特性外,它的提供的功能可以分為4類: 第1類,提供操作鍵-值對的方法。 lowerEntry、floorEntry、ceilingEntry 和 higherEntry 方法,它們分別返回與小於、小於等於、大於等於、大於給定鍵的鍵關聯的 Map.Entry 物件。 firstEntry、pollFirstEntry、lastEntry 和 pollLastEntry 方法,它們返回和/或移除最小和最大的對映關係(如果存在),否則返回 null。 第2類,提供操作鍵的方法。這個和第1類比較類似 lowerKey、floorKey、ceilingKey 和 higherKey 方法,它們分別返回與小於、小於等於、大於等於、大於給定鍵的鍵。 第3類,獲取鍵集。 navigableKeySet、descendingKeySet分別獲取正序/反序的鍵集。 第4類,獲取鍵-值對的子集。

6 Dictionary

Dictionary的定義如下:

public abstract class Dictionary<K,V> {}
複製程式碼

NavigableMap是JDK 1.0定義的鍵值對的介面,它也包括了操作鍵值對的基本函式。

Dictionary的API

abstract Enumeration<V>     elements()
abstract V                  get(Object key)
abstract boolean            isEmpty()
abstract Enumeration<K>     keys()
abstract V                  put(K key, V value)
abstract V                  remove(Object key)
abstract int                size()
複製程式碼

概要

前一章,我們學習了HashMap。這一章,我們對Hashtable進行學習。 我們先對Hashtable有個整體認識,然後再學習它的原始碼,最後再通過例項來學會使用Hashtable。

第1部分 Hashtable介紹

Hashtable 簡介

和HashMap一樣,Hashtable 也是一個雜湊表,它儲存的內容是鍵值對(key-value)對映。 Hashtable 繼承於Dictionary,實現了Map、Cloneable、java.io.Serializable介面。 Hashtable 的函式都是同步的,這意味著它是執行緒安全的。它的key、value都不可以為null。此外,Hashtable中的對映不是有序的。

Hashtable 的例項有兩個引數影響其效能:初始容量 和 加載因子。容量 是雜湊表中桶 的數量,初始容量 就是雜湊表建立時的容量。注意,雜湊表的狀態為 open:在發生“雜湊衝突”的情況下,單個桶會儲存多個條目,這些條目必須按順序搜尋。載入因子 是對雜湊表在其容量自動增加之前可以達到多滿的一個尺度。初始容量和載入因子這兩個引數只是對該實現的提示。關於何時以及是否呼叫 rehash 方法的具體細節則依賴於該實現。 通常,預設載入因子是 0.75, 這是在時間和空間成本上尋求一種折衷。載入因子過高雖然減少了空間開銷,但同時也增加了查詢某個條目的時間(在大多數 Hashtable 操作中,包括 get 和 put 操作,都反映了這一點)。

Hashtable的建構函式

// 預設建構函式。
public Hashtable() 

// 指定“容量大小”的建構函式
public Hashtable(int initialCapacity) 

// 指定“容量大小”和“載入因子”的建構函式
public Hashtable(int initialCapacity, float loadFactor) 

// 包含“子Map”的建構函式
public Hashtable(Map<? extends K, ? extends V> t)
複製程式碼

Hashtable的API

synchronized void                clear()
synchronized Object              clone()
             boolean             contains(Object value)
synchronized boolean             containsKey(Object key)
synchronized boolean             containsValue(Object value)
synchronized Enumeration<V>      elements()
synchronized Set<Entry<K, V>>    entrySet()
synchronized boolean             equals(Object object)
synchronized V                   get(Object key)
synchronized int                 hashCode()
synchronized boolean             isEmpty()
synchronized Set<K>              keySet()
synchronized Enumeration<K>      keys()
synchronized V                   put(K key, V value)
synchronized void                putAll(Map<? extends K, ? extends V> map)
synchronized V                   remove(Object key)
synchronized int                 size()
synchronized String              toString()
synchronized Collection<V>       values()
複製程式碼

第2部分 Hashtable資料結構

Hashtable的繼承關係

java.lang.Object
   ↳     java.util.Dictionary<K, V>
         ↳     java.util.Hashtable<K, V>

public class Hashtable<K,V> extends Dictionary<K,V>
    implements Map<K,V>, Cloneable, java.io.Serializable { }
複製程式碼

Hashtable與Map關係如下圖:

這裡寫圖片描述
從圖中可以看出: (01) Hashtable繼承於Dictionary類,實現了Map介面。Map是"key-value鍵值對"介面,Dictionary是宣告瞭操作"鍵值對"函式介面的抽象類。 (02) Hashtable是通過"拉鍊法"實現的雜湊表。它包括幾個重要的成員變數:table, count, threshold, loadFactor, modCount。   table是一個Entry[]陣列型別,而Entry實際上就是一個單向連結串列。雜湊表的"key-value鍵值對"都是儲存在Entry陣列中的。   count是Hashtable的大小,它是Hashtable儲存的鍵值對的數量。   threshold是Hashtable的閾值,用於判斷是否需要調整Hashtable的容量。threshold的值="容量*載入因子"。   loadFactor就是載入因子。   modCount是用來實現fail-fast機制的

第3部分 Hashtable原始碼解析(基於JDK1.6.0_45)

為了更瞭解Hashtable的原理,下面對Hashtable原始碼程式碼作出分析。 在閱讀原始碼時,建議參考後面的說明來建立對Hashtable的整體認識,這樣更容易理解Hashtable。

package java.util;
import java.io.*;

public class Hashtable<K,V>
    extends Dictionary<K,V>
    implements Map<K,V>, Cloneable, java.io.Serializable {

    // Hashtable儲存key-value的陣列。
    // Hashtable是採用拉鍊法實現的,每一個Entry本質上是一個單向連結串列
    private transient Entry[] table;

    // Hashtable中元素的實際數量
    private transient int count;

    // 閾值,用於判斷是否需要調整Hashtable的容量(threshold = 容量*載入因子)
    private int threshold;

    // 載入因子
    private float loadFactor;

    // Hashtable被改變的次數
    private transient int modCount = 0;

    // 序列版本號
    private static final long serialVersionUID = 1421746759512286392L;

    // 指定“容量大小”和“載入因子”的建構函式
    public Hashtable(int initialCapacity, float loadFactor) {
        if (initialCapacity < 0)
            throw new IllegalArgumentException("Illegal Capacity: "+
                                               initialCapacity);
        if (loadFactor <= 0 || Float.isNaN(loadFactor))
            throw new IllegalArgumentException("Illegal Load: "+loadFactor);

        if (initialCapacity==0)
            initialCapacity = 1;
        this.loadFactor = loadFactor;
        table = new Entry[initialCapacity];
        threshold = (int)(initialCapacity * loadFactor);
    }

    // 指定“容量大小”的建構函式
    public Hashtable(int initialCapacity) {
        this(initialCapacity, 0.75f);
    }

    // 預設建構函式。
    public Hashtable() {
        // 預設建構函式,指定的容量大小是11;載入因子是0.75
        this(11, 0.75f);
    }

    // 包含“子Map”的建構函式
    public Hashtable(Map<? extends K, ? extends V> t) {
        this(Math.max(2*t.size(), 11), 0.75f);
        // 將“子Map”的全部元素都新增到Hashtable中
        putAll(t);
    }

    public synchronized int size() {
        return count;
    }

    public synchronized boolean isEmpty() {
        return count == 0;
    }

    // 返回“所有key”的列舉物件
    public synchronized Enumeration<K> keys() {
        return this.<K>getEnumeration(KEYS);
    }

    // 返回“所有value”的列舉物件
    public synchronized Enumeration<V> elements() {
        return this.<V>getEnumeration(VALUES);
    }

    // 判斷Hashtable是否包含“值(value)”
    public synchronized boolean contains(Object value) {
        // Hashtable中“鍵值對”的value不能是null,
        // 若是null的話,丟擲異常!
        if (value == null) {
            throw new NullPointerException();
        }

        // 從後向前遍歷table陣列中的元素(Entry)
        // 對於每個Entry(單向連結串列),逐個遍歷,判斷節點的值是否等於value
        Entry tab[] = table;
        for (int i = tab.length ; i-- > 0 ;) {
            for (Entry<K,V> e = tab[i] ; e != null ; e = e.next) {
                if (e.value.equals(value)) {
                    return true;
                }
            }
        }
        return false;
    }

    public boolean containsValue(Object value) {
        return contains(value);
    }

    // 判斷Hashtable是否包含key
    public synchronized boolean containsKey(Object key) {
        Entry tab[] = table;
        int hash = key.hashCode();
        // 計算索引值,
        // % tab.length 的目的是防止資料越界
        int index = (hash & 0x7FFFFFFF) % tab.length;
        // 找到“key對應的Entry(連結串列)”,然後在連結串列中找出“雜湊值”和“鍵值”與key都相等的元素
        for (Entry<K,V> e = tab[index] ; e != null ; e = e.next) {
            if ((e.hash == hash) && e.key.equals(key)) {
                return true;
            }
        }
        return false;
    }

    // 返回key對應的value,沒有的話返回null
    public synchronized V get(Object key) {
        Entry tab[] = table;
        int hash = key.hashCode();
        // 計算索引值,
        int index = (hash & 0x7FFFFFFF) % tab.length;
        // 找到“key對應的Entry(連結串列)”,然後在連結串列中找出“雜湊值”和“鍵值”與key都相等的元素
        for (Entry<K,V> e = tab[index] ; e != null ; e = e.next) {
            if ((e.hash == hash) && e.key.equals(key)) {
                return e.value;
            }
        }
        return null;
    }

    // 調整Hashtable的長度,將長度變成原來的(2倍+1)
    // (01) 將“舊的Entry陣列”賦值給一個臨時變數。
    // (02) 建立一個“新的Entry陣列”,並賦值給“舊的Entry陣列”
    // (03) 將“Hashtable”中的全部元素依次新增到“新的Entry陣列”中
    protected void rehash() {
        int oldCapacity = table.length;
        Entry[] oldMap = table;

        int newCapacity = oldCapacity * 2 + 1;
        Entry[] newMap = new Entry[newCapacity];

        modCount++;
        threshold = (int)(newCapacity * loadFactor);
        table = newMap;

        for (int i = oldCapacity ; i-- > 0 ;) {
            for (Entry<K,V> old = oldMap[i] ; old != null ; ) {
                Entry<K,V> e = old;
                old = old.next;

                int index = (e.hash & 0x7FFFFFFF) % newCapacity;
                e.next = newMap[index];
                newMap[index] = e;
            }
        }
    }

    // 將“key-value”新增到Hashtable中
    public synchronized V put(K key, V value) {
        // Hashtable中不能插入value為null的元素!!!
        if (value == null) {
            throw new NullPointerException();
        }

        // 若“Hashtable中已存在鍵為key的鍵值對”,
        // 則用“新的value”替換“舊的value”
        Entry tab[] = table;
        int hash = key.hashCode();
        int index = (hash & 0x7FFFFFFF) % tab.length;
        for (Entry<K,V> e = tab[index] ; e != null ; e = e.next) {
            if ((e.hash == hash) && e.key.equals(key)) {
                V old = e.value;
                e.value = value;
                return old;
                }
        }

        // 若“Hashtable中不存在鍵為key的鍵值對”,
        // (01) 將“修改統計數”+1
        modCount++;
        // (02) 若“Hashtable實際容量” > “閾值”(閾值=總的容量 * 載入因子)
        //  則調整Hashtable的大小
        if (count >= threshold) {
            // Rehash the table if the threshold is exceeded
            rehash();

            tab = table;
            index = (hash & 0x7FFFFFFF) % tab.length;
        }

        // (03) 將“Hashtable中index”位置的Entry(連結串列)儲存到e中
        Entry<K,V> e = tab[index];
        // (04) 建立“新的Entry節點”,並將“新的Entry”插入“Hashtable的index位置”,並設定e為“新的Entry”的下一個元素(即“新Entry”為連結串列表頭)。        
        tab[index] = new Entry<K,V>(hash, key, value, e);
        // (05) 將“Hashtable的實際容量”+1
        count++;
        return null;
    }

    // 刪除Hashtable中鍵為key的元素
    public synchronized V remove(Object key) {
        Entry tab[] = table;
        int hash = key.hashCode();
        int index = (hash & 0x7FFFFFFF) % tab.length;
        // 找到“key對應的Entry(連結串列)”
        // 然後在連結串列中找出要刪除的節點,並刪除該節點。
        for (Entry<K,V> e = tab[index], prev = null ; e != null ; prev = e, e = e.next) {
            if ((e.hash == hash) && e.key.equals(key)) {
                modCount++;
                if (prev != null) {
                    prev.next = e.next;
                } else {
                    tab[index] = e.next;
                }
                count--;
                V oldValue = e.value;
                e.value = null;
                return oldValue;
            }
        }
        return null;
    }

    // 將“Map(t)”的中全部元素逐一新增到Hashtable中
    public synchronized void putAll(Map<? extends K, ? extends V> t) {
        for (Map.Entry<? extends K, ? extends V> e : t.entrySet())
            put(e.getKey(), e.getValue());
    }

    // 清空Hashtable
    // 將Hashtable的table陣列的值全部設為null
    public synchronized void clear() {
        Entry tab[] = table;
        modCount++;
        for (int index = tab.length; --index >= 0; )
            tab[index] = null;
        count = 0;
    }

    // 克隆一個Hashtable,並以Object的形式返回。
    public synchronized Object clone() {
        try {
            Hashtable<K,V> t = (Hashtable<K,V>) super.clone();
            t.table = new Entry[table.length];
            for (int i = table.length ; i-- > 0 ; ) {
                t.table[i] = (table[i] != null)
                ? (Entry<K,V>) table[i].clone() : null;
            }
            t.keySet = null;
            t.entrySet = null;
            t.values = null;
            t.modCount = 0;
            return t;
        } catch (CloneNotSupportedException e) {
            // this shouldn't happen, since we are Cloneable
            throw new InternalError();
        }
    }

    public synchronized String toString() {
        int max = size() - 1;
        if (max == -1)
            return "{}";

        StringBuilder sb = new StringBuilder();
        Iterator<Map.Entry<K,V>> it = entrySet().iterator();

        sb.append('{');
        for (int i = 0; ; i++) {
            Map.Entry<K,V> e = it.next();
            K key = e.getKey();
            V value = e.getValue();
            sb.append(key   == this ? "(this Map)" : key.toString());
            sb.append('=');
            sb.append(value == this ? "(this Map)" : value.toString());

            if (i == max)
                return sb.append('}').toString();
            sb.append(", ");
        }
    }

    // 獲取Hashtable的列舉類物件
    // 若Hashtable的實際大小為0,則返回“空列舉類”物件;
    // 否則,返回正常的Enumerator的物件。(Enumerator實現了迭代器和列舉兩個介面)
    private <T> Enumeration<T> getEnumeration(int type) {
    if (count == 0) {
        return (Enumeration<T>)emptyEnumerator;
    } else {
        return new Enumerator<T>(type, false);
    }
    }

    // 獲取Hashtable的迭代器
    // 若Hashtable的實際大小為0,則返回“空迭代器”物件;
    // 否則,返回正常的Enumerator的物件。(Enumerator實現了迭代器和列舉兩個介面)
    private <T> Iterator<T> getIterator(int type) {
        if (count == 0) {
            return (Iterator<T>) emptyIterator;
        } else {
            return new Enumerator<T>(type, true);
        }
    }

    // Hashtable的“key的集合”。它是一個Set,意味著沒有重複元素
    private transient volatile Set<K> keySet = null;
    // Hashtable的“key-value的集合”。它是一個Set,意味著沒有重複元素
    private transient volatile Set<Map.Entry<K,V>> entrySet = null;
    // Hashtable的“key-value的集合”。它是一個Collection,意味著可以有重複元素
    private transient volatile Collection<V> values = null;

    // 返回一個被synchronizedSet封裝後的KeySet物件
    // synchronizedSet封裝的目的是對KeySet的所有方法都新增synchronized,實現多執行緒同步
    public Set<K> keySet() {
        if (keySet == null)
            keySet = Collections.synchronizedSet(new KeySet(), this);
        return keySet;
    }

    // Hashtable的Key的Set集合。
    // KeySet繼承於AbstractSet,所以,KeySet中的元素沒有重複的。
    private class KeySet extends AbstractSet<K> {
        public Iterator<K> iterator() {
            return getIterator(KEYS);
        }
        public int size() {
            return count;
        }
        public boolean contains(Object o) {
            return containsKey(o);
        }
        public boolean remove(Object o) {
            return Hashtable.this.remove(o) != null;
        }
        public void clear() {
            Hashtable.this.clear();
        }
    }

    // 返回一個被synchronizedSet封裝後的EntrySet物件
    // synchronizedSet封裝的目的是對EntrySet的所有方法都新增synchronized,實現多執行緒同步
    public Set<Map.Entry<K,V>> entrySet() {
        if (entrySet==null)
            entrySet = Collections.synchronizedSet(new EntrySet(), this);
        return entrySet;
    }

    // Hashtable的Entry的Set集合。
    // EntrySet繼承於AbstractSet,所以,EntrySet中的元素沒有重複的。
    private class EntrySet extends AbstractSet<Map.Entry<K,V>> {
        public Iterator<Map.Entry<K,V>> iterator() {
            return getIterator(ENTRIES);
        }

        public boolean add(Map.Entry<K,V> o) {
            return super.add(o);
        }

        // 查詢EntrySet中是否包含Object(0)
        // 首先,在table中找到o對應的Entry(Entry是一個單向連結串列)
        // 然後,查詢Entry連結串列中是否存在Object
        public boolean contains(Object o) {
            if (!(o instanceof Map.Entry))
                return false;
            Map.Entry entry = (Map.Entry)o;
            Object key = entry.getKey();
            Entry[] tab = table;
            int hash = key.hashCode();
            int index = (hash & 0x7FFFFFFF) % tab.length;

            for (Entry e = tab[index]; e != null; e = e.next)
                if (e.hash==hash && e.equals(entry))
                    return true;
            return false;
        }

        // 刪除元素Object(0)
        // 首先,在table中找到o對應的Entry(Entry是一個單向連結串列)
        // 然後,刪除連結串列中的元素Object
        public boolean remove(Object o) {
            if (!(o instanceof Map.Entry))
                return false;
            Map.Entry<K,V> entry = (Map.Entry<K,V>) o;
            K key = entry.getKey();
            Entry[] tab = table;
            int hash = key.hashCode();
            int index = (hash & 0x7FFFFFFF) % tab.length;

            for (Entry<K,V> e = tab[index], prev = null; e != null;
                 prev = e, e = e.next) {
                if (e.hash==hash && e.equals(entry)) {
                    modCount++;
                    if (prev != null)
                        prev.next = e.next;
                    else
                        tab[index] = e.next;

                    count--;
                    e.value = null;
                    return true;
                }
            }
            return false;
        }

        public int size() {
            return count;
        }

        public void clear() {
            Hashtable.this.clear();
        }
    }

    // 返回一個被synchronizedCollection封裝後的ValueCollection物件
    // synchronizedCollection封裝的目的是對ValueCollection的所有方法都新增synchronized,實現多執行緒同步
    public Collection<V> values() {
    if (values==null)
        values = Collections.synchronizedCollection(new ValueCollection(),
                                                        this);
        return values;
    }

    // Hashtable的value的Collection集合。
    // ValueCollection繼承於AbstractCollection,所以,ValueCollection中的元素可以重複的。
    private class ValueCollection extends AbstractCollection<V> {
        public Iterator<V> iterator() {
        return getIterator(VALUES);
        }
        public int size() {
            return count;
        }
        public boolean contains(Object o) {
            return containsValue(o);
        }
        public void clear() {
            Hashtable.this.clear();
        }
    }

    // 重新equals()函式
    // 若兩個Hashtable的所有key-value鍵值對都相等,則判斷它們兩個相等
    public synchronized boolean equals(Object o) {
        if (o == this)
            return true;

        if (!(o instanceof Map))
            return false;
        Map<K,V> t = (Map<K,V>) o;
        if (t.size() != size())
            return false;

        try {
            // 通過迭代器依次取出當前Hashtable的key-value鍵值對
            // 並判斷該鍵值對,存在於Hashtable(o)中。
            // 若不存在,則立即返回false;否則,遍歷完“當前Hashtable”並返回true。
            Iterator<Map.Entry<K,V>> i = entrySet().iterator();
            while (i.hasNext()) {
                Map.Entry<K,V> e = i.next();
                K key = e.getKey();
                V value = e.getValue();
                if (value == null) {
                    if (!(t.get(key)==null && t.containsKey(key)))
                        return false;
                } else {
                    if (!value.equals(t.get(key)))
                        return false;
                }
            }
        } catch (ClassCastException unused)   {
            return false;
        } catch (NullPointerException unused) {
            return false;
        }

        return true;
    }

    // 計算Hashtable的雜湊值
    // 若 Hashtable的實際大小為0 或者 載入因子<0,則返回0。
    // 否則,返回“Hashtable中的每個Entry的key和value的異或值 的總和”。
    public synchronized int hashCode() {
        int h = 0;
        if (count == 0 || loadFactor < 0)
            return h;  // Returns zero

        loadFactor = -loadFactor;  // Mark hashCode computation in progress
        Entry[] tab = table;
        for (int i = 0; i < tab.length; i++)
            for (Entry e = tab[i]; e != null; e = e.next)
                h += e.key.hashCode() ^ e.value.hashCode();
        loadFactor = -loadFactor;  // Mark hashCode computation complete

        return h;
    }

    // java.io.Serializable的寫入函式
    // 將Hashtable的“總的容量,實際容量,所有的Entry”都寫入到輸出流中
    private synchronized void writeObject(java.io.ObjectOutputStream s)
        throws IOException
    {
        // Write out the length, threshold, loadfactor
        s.defaultWriteObject();

        // Write out length, count of elements and then the key/value objects
        s.writeInt(table.length);
        s.writeInt(count);
        for (int index = table.length-1; index >= 0; index--) {
            Entry entry = table[index];

            while (entry != null) {
            s.writeObject(entry.key);
            s.writeObject(entry.value);
            entry = entry.next;
            }
        }
    }

    // java.io.Serializable的讀取函式:根據寫入方式讀出
    // 將Hashtable的“總的容量,實際容量,所有的Entry”依次讀出
    private void readObject(java.io.ObjectInputStream s)
         throws IOException, ClassNotFoundException
    {
        // Read in the length, threshold, and loadfactor
        s.defaultReadObject();

        // Read the original length of the array and number of elements
        int origlength = s.readInt();
        int elements = s.readInt();

        // Compute new size with a bit of room 5% to grow but
        // no larger than the original size.  Make the length
        // odd if it's large enough, this helps distribute the entries.
        // Guard against the length ending up zero, that's not valid.
        int length = (int)(elements * loadFactor) + (elements / 20) + 3;
        if (length > elements && (length & 1) == 0)
            length--;
        if (origlength > 0 && length > origlength)
            length = origlength;

        Entry[] table = new Entry[length];
        count = 0;

        // Read the number of elements and then all the key/value objects
        for (; elements > 0; elements--) {
            K key = (K)s.readObject();
            V value = (V)s.readObject();
                // synch could be eliminated for performance
                reconstitutionPut(table, key, value);
        }
        this.table = table;
    }

    private void reconstitutionPut(Entry[] tab, K key, V value)
        throws StreamCorruptedException
    {
        if (value == null) {
            throw new java.io.StreamCorruptedException();
        }
        // Makes sure the key is not already in the hashtable.
        // This should not happen in deserialized version.
        int hash = key.hashCode();
        int index = (hash & 0x7FFFFFFF) % tab.length;
        for (Entry<K,V> e = tab[index] ; e != null ; e = e.next) {
            if ((e.hash == hash) && e.key.equals(key)) {
                throw new java.io.StreamCorruptedException();
            }
        }
        // Creates the new entry.
        Entry<K,V> e = tab[index];
        tab[index] = new Entry<K,V>(hash, key, value, e);
        count++;
    }

    // Hashtable的Entry節點,它本質上是一個單向連結串列。
    // 也因此,我們才能推斷出Hashtable是由拉鍊法實現的雜湊表
    private static class Entry<K,V> implements Map.Entry<K,V> {
        // 雜湊值
        int hash;
        K key;
        V value;
        // 指向的下一個Entry,即連結串列的下一個節點
        Entry<K,V> next;

        // 建構函式
        protected Entry(int hash, K key, V value, Entry<K,V> next) {
            this.hash = hash;
            this.key = key;
            this.value = value;
            this.next = next;
        }

        protected Object clone() {
            return new Entry<K,V>(hash, key, value,
                  (next==null ? null : (Entry<K,V>) next.clone()));
        }

        public K getKey() {
            return key;
        }

        public V getValue() {
            return value;
        }

        // 設定value。若value是null,則丟擲異常。
        public V setValue(V value) {
            if (value == null)
                throw new NullPointerException();

            V oldValue = this.value;
            this.value = value;
            return oldValue;
        }

        // 覆蓋equals()方法,判斷兩個Entry是否相等。
        // 若兩個Entry的key和value都相等,則認為它們相等。
        public boolean equals(Object o) {
            if (!(o instanceof Map.Entry))
                return false;
            Map.Entry e = (Map.Entry)o;

            return (key==null ? e.getKey()==null : key.equals(e.getKey())) &&
               (value==null ? e.getValue()==null : value.equals(e.getValue()));
        }

        public int hashCode() {
            return hash ^ (value==null ? 0 : value.hashCode());
        }

        public String toString() {
            return key.toString()+"="+value.toString();
        }
    }

    private static final int KEYS = 0;
    private static final int VALUES = 1;
    private static final int ENTRIES = 2;

    // Enumerator的作用是提供了“通過elements()遍歷Hashtable的介面” 和 “通過entrySet()遍歷Hashtable的介面”。因為,它同時實現了 “Enumerator介面”和“Iterator介面”。
    private class Enumerator<T> implements Enumeration<T>, Iterator<T> {
        // 指向Hashtable的table
        Entry[] table = Hashtable.this.table;
        // Hashtable的總的大小
        int index = table.length;
        Entry<K,V> entry = null;
        Entry<K,V> lastReturned = null;
        int type;

        // Enumerator是 “迭代器(Iterator)” 還是 “列舉類(Enumeration)”的標誌
        // iterator為true,表示它是迭代器;否則,是列舉類。
        boolean iterator;

        // 在將Enumerator當作迭代器使用時會用到,用來實現fail-fast機制。
        protected int expectedModCount = modCount;

        Enumerator(int type, boolean iterator) {
            this.type = type;
            this.iterator = iterator;
        }

        // 從遍歷table的陣列的末尾向前查詢,直到找到不為null的Entry。
        public boolean hasMoreElements() {
            Entry<K,V> e = entry;
            int i = index;
            Entry[] t = table;
            /* Use locals for faster loop iteration */
            while (e == null && i > 0) {
                e = t[--i];
            }
            entry = e;
            index = i;
            return e != null;
        }

        // 獲取下一個元素
        // 注意:從hasMoreElements() 和nextElement() 可以看出“Hashtable的elements()遍歷方式”
        // 首先,從後向前的遍歷table陣列。table陣列的每個節點都是一個單向連結串列(Entry)。
        // 然後,依次向後遍歷單向連結串列Entry。
        public T nextElement() {
            Entry<K,V> et = entry;
            int i = index;
            Entry[] t = table;
            /* Use locals for faster loop iteration */
            while (et == null && i > 0) {
                et = t[--i];
            }
            entry = et;
            index = i;
            if (et != null) {
                Entry<K,V> e = lastReturned = entry;
                entry = e.next;
                return type == KEYS ? (T)e.key : (type == VALUES ? (T)e.value : (T)e);
            }
            throw new NoSuchElementException("Hashtable Enumerator");
        }

        // 迭代器Iterator的判斷是否存在下一個元素
        // 實際上,它是呼叫的hasMoreElements()
        public boolean hasNext() {
            return hasMoreElements();
        }

        // 迭代器獲取下一個元素
        // 實際上,它是呼叫的nextElement()
        public T next() {
            if (modCount != expectedModCount)
                throw new ConcurrentModificationException();
            return nextElement();
        }

        // 迭代器的remove()介面。
        // 首先,它在table陣列中找出要刪除元素所在的Entry,
        // 然後,刪除單向連結串列Entry中的元素。
        public void remove() {
            if (!iterator)
                throw new UnsupportedOperationException();
            if (lastReturned == null)
                throw new IllegalStateException("Hashtable Enumerator");
            if (modCount != expectedModCount)
                throw new ConcurrentModificationException();

            synchronized(Hashtable.this) {
                Entry[] tab = Hashtable.this.table;
                int index = (lastReturned.hash & 0x7FFFFFFF) % tab.length;

                for (Entry<K,V> e = tab[index], prev = null; e != null;
                     prev = e, e = e.next) {
                    if (e == lastReturned) {
                        modCount++;
                        expectedModCount++;
                        if (prev == null)
                            tab[index] = e.next;
                        else
                            prev.next = e.next;
                        count--;
                        lastReturned = null;
                        return;
                    }
                }
                throw new ConcurrentModificationException();
            }
        }
    }


    private static Enumeration emptyEnumerator = new EmptyEnumerator();
    private static Iterator emptyIterator = new EmptyIterator();

    // 空列舉類
    // 當Hashtable的實際大小為0;此時,又要通過Enumeration遍歷Hashtable時,返回的是“空列舉類”的物件。
    private static class EmptyEnumerator implements Enumeration<Object> {

        EmptyEnumerator() {
        }

        // 空列舉類的hasMoreElements() 始終返回false
        public boolean hasMoreElements() {
            return false;
        }

        // 空列舉類的nextElement() 丟擲異常
        public Object nextElement() {
            throw new NoSuchElementException("Hashtable Enumerator");
        }
    }


    // 空迭代器
    // 當Hashtable的實際大小為0;此時,又要通過迭代器遍歷Hashtable時,返回的是“空迭代器”的物件。
    private static class EmptyIterator implements Iterator<Object> {

        EmptyIterator() {
        }

        public boolean hasNext() {
            return false;
        }

        public Object next() {
            throw new NoSuchElementException("Hashtable Iterator");
        }

        public void remove() {
            throw new IllegalStateException("Hashtable Iterator");
        }

    }
}
複製程式碼

說明: 在詳細介紹Hashtable的程式碼之前,我們需要了解:和Hashmap一樣,Hashtable也是一個雜湊表,它也是通過“拉鍊法”解決雜湊衝突的。

第3.1部分 Hashtable的“拉鍊法”相關內容

3.1.1 Hashtable資料儲存陣列

private transient Entry[] table;
複製程式碼

Hashtable中的key-value都是儲存在table陣列中的。

3.1.2 資料節點Entry的資料結構

private static class Entry<K,V> implements Map.Entry<K,V> {
    // 雜湊值
    int hash;
    K key;
    V value;
    // 指向的下一個Entry,即連結串列的下一個節點
    Entry<K,V> next;

    // 建構函式
    protected Entry(int hash, K key, V value, Entry<K,V> next) {
        this.hash = hash;
        this.key = key;
        this.value = value;
        this.next = next;
    }

    protected Object clone() {
        return new Entry<K,V>(hash, key, value,
              (next==null ? null : (Entry<K,V>) next.clone()));
    }

    public K getKey() {
        return key;
    }

    public V getValue() {
        return value;
    }

    // 設定value。若value是null,則丟擲異常。
    public V setValue(V value) {
        if (value == null)
            throw new NullPointerException();

        V oldValue = this.value;
        this.value = value;
        return oldValue;
    }

    // 覆蓋equals()方法,判斷兩個Entry是否相等。
    // 若兩個Entry的key和value都相等,則認為它們相等。
    public boolean equals(Object o) {
        if (!(o instanceof Map.Entry))
            return false;
        Map.Entry e = (Map.Entry)o;

        return (key==null ? e.getKey()==null : key.equals(e.getKey())) &&
           (value==null ? e.getValue()==null : value.equals(e.getValue()));
    }

    public int hashCode() {
        return hash ^ (value==null ? 0 : value.hashCode());
    }

    public String toString() {
        return key.toString()+"="+value.toString();
    }
}
複製程式碼

從中,我們可以看出 Entry 實際上就是一個單向連結串列。這也是為什麼我們說Hashtable是通過拉鍊法解決雜湊衝突的。 Entry 實現了Map.Entry 介面,即實現getKey(), getValue(), setValue(V value), equals(Object o), hashCode()這些函式。這些都是基本的讀取/修改key、value值的函式。

第3.2部分 Hashtable的建構函式

Hashtable共包括4個建構函式

// 預設建構函式。
public Hashtable() {
    // 預設建構函式,指定的容量大小是11;載入因子是0.75
    this(11, 0.75f);
}

// 指定“容量大小”的建構函式
public Hashtable(int initialCapacity) {
    this(initialCapacity, 0.75f);
}

// 指定“容量大小”和“載入因子”的建構函式
public Hashtable(int initialCapacity, float loadFactor) {
    if (initialCapacity < 0)
        throw new IllegalArgumentException("Illegal Capacity: "+
                                           initialCapacity);
    if (loadFactor <= 0 || Float.isNaN(loadFactor))
        throw new IllegalArgumentException("Illegal Load: "+loadFactor);

    if (initialCapacity==0)
        initialCapacity = 1;
    this.loadFactor = loadFactor;
    table = new Entry[initialCapacity];
    threshold = (int)(initialCapacity * loadFactor);
}

// 包含“子Map”的建構函式
public Hashtable(Map<? extends K, ? extends V> t) {
    this(Math.max(2*t.size(), 11), 0.75f);
    // 將“子Map”的全部元素都新增到Hashtable中
    putAll(t);
}
複製程式碼

第3.3部分 Hashtable的主要對外介面

3.3.1 clear()

clear() 的作用是清空Hashtable。它是將Hashtable的table陣列的值全部設為null

public synchronized void clear() {
    Entry tab[] = table;
    modCount++;
    for (int index = tab.length; --index >= 0; )
        tab[index] = null;
    count = 0;
}
複製程式碼

3.3.2 contains() 和 containsValue()

contains() 和 containsValue() 的作用都是判斷Hashtable是否包含“值(value)”

public boolean containsValue(Object value) {
    return contains(value);
}

public synchronized boolean contains(Object value) {
    // Hashtable中“鍵值對”的value不能是null,
    // 若是null的話,丟擲異常!
    if (value == null) {
        throw new NullPointerException();
    }

    // 從後向前遍歷table陣列中的元素(Entry)
    // 對於每個Entry(單向連結串列),逐個遍歷,判斷節點的值是否等於value
    Entry tab[] = table;
    for (int i = tab.length ; i-- > 0 ;) {
        for (Entry<K,V> e = tab[i] ; e != null ; e = e.next) {
            if (e.value.equals(value)) {
                return true;
            }
        }
    }
    return false;
}
複製程式碼

3.3.3 containsKey()

containsKey() 的作用是判斷Hashtable是否包含key

public synchronized boolean containsKey(Object key) {
    Entry tab[] = table;
    int hash = key.hashCode();
    // 計算索引值,
    // % tab.length 的目的是防止資料越界
    int index = (hash & 0x7FFFFFFF) % tab.length;
    // 找到“key對應的Entry(連結串列)”,然後在連結串列中找出“雜湊值”和“鍵值”與key都相等的元素
    for (Entry<K,V> e = tab[index] ; e != null ; e = e.next) {
        if ((e.hash == hash) && e.key.equals(key)) {
            return true;
        }
    }
    return false;
}
複製程式碼

3.3.4 elements()

elements() 的作用是返回“所有value”的列舉物件

public synchronized Enumeration<V> elements() {
    return this.<V>getEnumeration(VALUES);
}

// 獲取Hashtable的列舉類物件
private <T> Enumeration<T> getEnumeration(int type) {
    if (count == 0) {
        return (Enumeration<T>)emptyEnumerator;
    } else {
        return new Enumerator<T>(type, false);
    }
}
複製程式碼

從中,我們可以看出: (01) 若Hashtable的實際大小為0,則返回“空列舉類”物件emptyEnumerator; (02) 否則,返回正常的Enumerator的物件。(Enumerator實現了迭代器和列舉兩個介面)

我們先看看emptyEnumerator物件是如何實現的

private static Enumeration emptyEnumerator = new EmptyEnumerator();

// 空列舉類
// 當Hashtable的實際大小為0;此時,又要通過Enumeration遍歷Hashtable時,返回的是“空列舉類”的物件。
private static class EmptyEnumerator implements Enumeration<Object> {

    EmptyEnumerator() {
    }

    // 空列舉類的hasMoreElements() 始終返回false
    public boolean hasMoreElements() {
        return false;
    }

    // 空列舉類的nextElement() 丟擲異常
    public Object nextElement() {
        throw new NoSuchElementException("Hashtable Enumerator");
    }
}
複製程式碼

我們在來看看Enumeration類

Enumerator的作用是提供了“通過elements()遍歷Hashtable的介面” 和 “通過entrySet()遍歷Hashtable的介面”。因為,它同時實現了 “Enumerator介面”和“Iterator介面”。

private class Enumerator<T> implements Enumeration<T>, Iterator<T> {
    // 指向Hashtable的table
    Entry[] table = Hashtable.this.table;
    // Hashtable的總的大小
    int index = table.length;
    Entry<K,V> entry = null;
    Entry<K,V> lastReturned = null;
    int type;

    // Enumerator是 “迭代器(Iterator)” 還是 “列舉類(Enumeration)”的標誌
    // iterator為true,表示它是迭代器;否則,是列舉類。
    boolean iterator;

    // 在將Enumerator當作迭代器使用時會用到,用來實現fail-fast機制。
    protected int expectedModCount = modCount;

    Enumerator(int type, boolean iterator) {
        this.type = type;
        this.iterator = iterator;
    }

    // 從遍歷table的陣列的末尾向前查詢,直到找到不為null的Entry。
    public boolean hasMoreElements() {
        Entry<K,V> e = entry;
        int i = index;
        Entry[] t = table;
        /* Use locals for faster loop iteration */
        while (e == null && i > 0) {
            e = t[--i];
        }
        entry = e;
        index = i;
        return e != null;
    }

    // 獲取下一個元素
    // 注意:從hasMoreElements() 和nextElement() 可以看出“Hashtable的elements()遍歷方式”
    // 首先,從後向前的遍歷table陣列。table陣列的每個節點都是一個單向連結串列(Entry)。
    // 然後,依次向後遍歷單向連結串列Entry。
    public T nextElement() {
        Entry<K,V> et = entry;
        int i = index;
        Entry[] t = table;
        /* Use locals for faster loop iteration */
        while (et == null && i > 0) {
            et = t[--i];
        }
        entry = et;
        index = i;
        if (et != null) {
            Entry<K,V> e = lastReturned = entry;
            entry = e.next;
            return type == KEYS ? (T)e.key : (type == VALUES ? (T)e.value : (T)e);
        }
        throw new NoSuchElementException("Hashtable Enumerator");
    }

    // 迭代器Iterator的判斷是否存在下一個元素
    // 實際上,它是呼叫的hasMoreElements()
    public boolean hasNext() {
        return hasMoreElements();
    }

    // 迭代器獲取下一個元素
    // 實際上,它是呼叫的nextElement()
    public T next() {
        if (modCount != expectedModCount)
            throw new ConcurrentModificationException();
        return nextElement();
    }

    // 迭代器的remove()介面。
    // 首先,它在table陣列中找出要刪除元素所在的Entry,
    // 然後,刪除單向連結串列Entry中的元素。
    public void remove() {
        if (!iterator)
            throw new UnsupportedOperationException();
        if (lastReturned == null)
            throw new IllegalStateException("Hashtable Enumerator");
        if (modCount != expectedModCount)
            throw new ConcurrentModificationException();

        synchronized(Hashtable.this) {
            Entry[] tab = Hashtable.this.table;
            int index = (lastReturned.hash & 0x7FFFFFFF) % tab.length;

            for (Entry<K,V> e = tab[index], prev = null; e != null;
                 prev = e, e = e.next) {
                if (e == lastReturned) {
                    modCount++;
                    expectedModCount++;
                    if (prev == null)
                        tab[index] = e.next;
                    else
                        prev.next = e.next;
                    count--;
                    lastReturned = null;
                    return;
                }
            }
            throw new ConcurrentModificationException();
        }
    }
}
複製程式碼

entrySet(), keySet(), keys(), values()的實現方法和elements()差不多,而且原始碼中已經明確的給出了註釋。這裡就不再做過多說明了。

3.3.5 get()

get() 的作用就是獲取key對應的value,沒有的話返回null

public synchronized V get(Object key) {
    Entry tab[] = table;
    int hash = key.hashCode();
    // 計算索引值,
    int index = (hash & 0x7FFFFFFF) % tab.length;
    // 找到“key對應的Entry(連結串列)”,然後在連結串列中找出“雜湊值”和“鍵值”與key都相等的元素
    for (Entry<K,V> e = tab[index] ; e != null ; e = e.next) {
        if ((e.hash == hash) && e.key.equals(key)) {
            return e.value;
        }
    }
    return null;
}
複製程式碼

3.3.6 put()

put() 的作用是對外提供介面,讓Hashtable物件可以通過put()將“key-value”新增到Hashtable中。

public synchronized V put(K key, V value) {
    // Hashtable中不能插入value為null的元素!!!
    if (value == null) {
        throw new NullPointerException();
    }

    // 若“Hashtable中已存在鍵為key的鍵值對”,
    // 則用“新的value”替換“舊的value”
    Entry tab[] = table;
    int hash = key.hashCode();
    int index = (hash & 0x7FFFFFFF) % tab.length;
    for (Entry<K,V> e = tab[index] ; e != null ; e = e.next) {
        if ((e.hash == hash) && e.key.equals(key)) {
            V old = e.value;
            e.value = value;
            return old;
            }
    }

    // 若“Hashtable中不存在鍵為key的鍵值對”,
    // (01) 將“修改統計數”+1
    modCount++;
    // (02) 若“Hashtable實際容量” > “閾值”(閾值=總的容量 * 載入因子)
    //  則調整Hashtable的大小
    if (count >= threshold) {
        // Rehash the table if the threshold is exceeded
        rehash();

        tab = table;
        index = (hash & 0x7FFFFFFF) % tab.length;
    }

    // (03) 將“Hashtable中index”位置的Entry(連結串列)儲存到e中
    Entry<K,V> e = tab[index];
    // (04) 建立“新的Entry節點”,並將“新的Entry”插入“Hashtable的index位置”,並設定e為“新的Entry”的下一個元素(即“新Entry”為連結串列表頭)。        
    tab[index] = new Entry<K,V>(hash, key, value, e);
    // (05) 將“Hashtable的實際容量”+1
    count++;
    return null;
}
複製程式碼

3.3.7 putAll()

putAll() 的作用是將“Map(t)”的中全部元素逐一新增到Hashtable中

public synchronized void putAll(Map<? extends K, ? extends V> t) {
     for (Map.Entry<? extends K, ? extends V> e : t.entrySet())
         put(e.getKey(), e.getValue());
 }
複製程式碼

3.3.8 remove()

remove() 的作用就是刪除Hashtable中鍵為key的元素

public synchronized V remove(Object key) {
    Entry tab[] = table;
    int hash = key.hashCode();
    int index = (hash & 0x7FFFFFFF) % tab.length;
    // 找到“key對應的Entry(連結串列)”
    // 然後在連結串列中找出要刪除的節點,並刪除該節點。
    for (Entry<K,V> e = tab[index], prev = null ; e != null ; prev = e, e = e.next) {
        if ((e.hash == hash) && e.key.equals(key)) {
            modCount++;
            if (prev != null) {
                prev.next = e.next;
            } else {
                tab[index] = e.next;
            }
            count--;
            V oldValue = e.value;
            e.value = null;
            return oldValue;
        }
    }
    return null;
}
複製程式碼

第3.4部分 Hashtable實現的Cloneable介面

Hashtable實現了Cloneable介面,即實現了clone()方法。 clone()方法的作用很簡單,就是克隆一個Hashtable物件並返回。

// 克隆一個Hashtable,並以Object的形式返回。
public synchronized Object clone() {
    try {
        Hashtable<K,V> t = (Hashtable<K,V>) super.clone();
        t.table = new Entry[table.length];
        for (int i = table.length ; i-- > 0 ; ) {
            t.table[i] = (table[i] != null)
            ? (Entry<K,V>) table[i].clone() : null;
        }
        t.keySet = null;
        t.entrySet = null;
        t.values = null;
        t.modCount = 0;
        return t;
    } catch (CloneNotSupportedException e) {
        // this shouldn't happen, since we are Cloneable
        throw new InternalError();
    }
}
複製程式碼

第3.5部分 Hashtable實現的Serializable介面

Hashtable實現java.io.Serializable,分別實現了序列讀取、寫入功能。

序列寫入函式就是將Hashtable的“總的容量,實際容量,所有的Entry”都寫入到輸出流中 序列讀取函式:根據寫入方式讀出將Hashtable的“總的容量,實際容量,所有的Entry”依次讀出

private synchronized void writeObject(java.io.ObjectOutputStream s)
    throws IOException
{
    // Write out the length, threshold, loadfactor
    s.defaultWriteObject();

    // Write out length, count of elements and then the key/value objects
    s.writeInt(table.length);
    s.writeInt(count);
    for (int index = table.length-1; index >= 0; index--) {
        Entry entry = table[index];

        while (entry != null) {
        s.writeObject(entry.key);
        s.writeObject(entry.value);
        entry = entry.next;
        }
    }
}

private void readObject(java.io.ObjectInputStream s)
     throws IOException, ClassNotFoundException
{
    // Read in the length, threshold, and loadfactor
    s.defaultReadObject();

    // Read the original length of the array and number of elements
    int origlength = s.readInt();
    int elements = s.readInt();

    // Compute new size with a bit of room 5% to grow but
    // no larger than the original size.  Make the length
    // odd if it's large enough, this helps distribute the entries.
    // Guard against the length ending up zero, that's not valid.
    int length = (int)(elements * loadFactor) + (elements / 20) + 3;
    if (length > elements && (length & 1) == 0)
        length--;
    if (origlength > 0 && length > origlength)
        length = origlength;

    Entry[] table = new Entry[length];
    count = 0;

    // Read the number of elements and then all the key/value objects
    for (; elements > 0; elements--) {
        K key = (K)s.readObject();
        V value = (V)s.readObject();
            // synch could be eliminated for performance
            reconstitutionPut(table, key, value);
    }
    this.table = table;
}
複製程式碼

第4部分 Hashtable遍歷方式

4.1 遍歷Hashtable的鍵值對

第一步:根據entrySet()獲取Hashtable的“鍵值對”的Set集合。 第二步:通過Iterator迭代器遍歷“第一步”得到的集合

// 假設table是Hashtable物件
// table中的key是String型別,value是Integer型別
Integer integ = null;
Iterator iter = table.entrySet().iterator();
while(iter.hasNext()) {
    Map.Entry entry = (Map.Entry)iter.next();
    // 獲取key
    key = (String)entry.getKey();
        // 獲取value
    integ = (Integer)entry.getValue();
}
複製程式碼

4.2 通過Iterator遍歷Hashtable的鍵

第一步:根據keySet()獲取Hashtable的“鍵”的Set集合。 第二步:通過Iterator迭代器遍歷“第一步”得到的集合。

// 假設table是Hashtable物件
// table中的key是String型別,value是Integer型別
String key = null;
Integer integ = null;
Iterator iter = table.keySet().iterator();
while (iter.hasNext()) {
        // 獲取key
    key = (String)iter.next();
        // 根據key,獲取value
    integ = (Integer)table.get(key);
}
複製程式碼

4.3 通過Iterator遍歷Hashtable的值

第一步:根據value()獲取Hashtable的“值”的集合。 第二步:通過Iterator迭代器遍歷“第一步”得到的集合。

// 假設table是Hashtable物件
// table中的key是String型別,value是Integer型別
Integer value = null;
Collection c = table.values();
Iterator iter= c.iterator();
while (iter.hasNext()) {
    value = (Integer)iter.next();
}
複製程式碼

4.4 通過Enumeration遍歷Hashtable的鍵

第一步:根據keys()獲取Hashtable的集合。 第二步:通過Enumeration遍歷“第一步”得到的集合。

Enumeration enu = table.keys();
while(enu.hasMoreElements()) {
    System.out.println(enu.nextElement());
}   
複製程式碼

4.5 通過Enumeration遍歷Hashtable的值

第一步:根據elements()獲取Hashtable的集合。 第二步:通過Enumeration遍歷“第一步”得到的集合。

Enumeration enu = table.elements();
while(enu.hasMoreElements()) {
    System.out.println(enu.nextElement());
}
複製程式碼

遍歷測試程式如下:

import java.util.*;

/*
 * @desc 遍歷Hashtable的測試程式。
 *   (01) 通過entrySet()去遍歷key、value,參考實現函式:
 *        iteratorHashtableByEntryset()
 *   (02) 通過keySet()去遍歷key,參考實現函式:
 *        iteratorHashtableByKeyset()
 *   (03) 通過values()去遍歷value,參考實現函式:
 *        iteratorHashtableJustValues()
 *   (04) 通過Enumeration去遍歷key,參考實現函式:
 *        enumHashtableKey()
 *   (05) 通過Enumeration去遍歷value,參考實現函式:
 *        enumHashtableValue()
 *
 * @author skywang
 */
public class HashtableIteratorTest {

    public static void main(String[] args) {
        int val = 0;
        String key = null;
        Integer value = null;
        Random r = new Random();
        Hashtable table = new Hashtable();

        for (int i=0; i<12; i++) {
            // 隨機獲取一個[0,100)之間的數字
            val = r.nextInt(100);
            
            key = String.valueOf(val);
            value = r.nextInt(5);
            // 新增到Hashtable中
            table.put(key, value);
            System.out.println(" key:"+key+" value:"+value);
        }
        // 通過entrySet()遍歷Hashtable的key-value
        iteratorHashtableByEntryset(table) ;
        
        // 通過keySet()遍歷Hashtable的key-value
        iteratorHashtableByKeyset(table) ;
        
        // 單單遍歷Hashtable的value
        iteratorHashtableJustValues(table);        

        // 遍歷Hashtable的Enumeration的key
        enumHashtableKey(table);

        // 遍歷Hashtable的Enumeration的value
        //enumHashtableValue(table);
    }
            
    /*
     * 通過Enumeration遍歷Hashtable的key
     * 效率高!
     */
    private static void enumHashtableKey(Hashtable table) {
        if (table == null)
            return ;

        System.out.println("\nenumeration Hashtable");
        Enumeration enu = table.keys();
        while(enu.hasMoreElements()) {
            System.out.println(enu.nextElement());
        }
    }

    
    /*
     * 通過Enumeration遍歷Hashtable的value
     * 效率高!
     */
    private static void enumHashtableValue(Hashtable table) {
        if (table == null)
            return ;

        System.out.println("\nenumeration Hashtable");
        Enumeration enu = table.elements();
        while(enu.hasMoreElements()) {
            System.out.println(enu.nextElement());
        }
    }

    /*
     * 通過entry set遍歷Hashtable
     * 效率高!
     */
    private static void iteratorHashtableByEntryset(Hashtable table) {
        if (table == null)
            return ;

        System.out.println("\niterator Hashtable By entryset");
        String key = null;
        Integer integ = null;
        Iterator iter = table.entrySet().iterator();
        while(iter.hasNext()) {
            Map.Entry entry = (Map.Entry)iter.next();
            
            key = (String)entry.getKey();
            integ = (Integer)entry.getValue();
            System.out.println(key+" -- "+integ.intValue());
        }
    }

    /*
     * 通過keyset來遍歷Hashtable
     * 效率低!
     */
    private static void iteratorHashtableByKeyset(Hashtable table) {
        if (table == null)
            return ;

        System.out.println("\niterator Hashtable By keyset");
        String key = null;
        Integer integ = null;
        Iterator iter = table.keySet().iterator();
        while (iter.hasNext()) {
            key = (String)iter.next();
            integ = (Integer)table.get(key);
            System.out.println(key+" -- "+integ.intValue());
        }
    }
    

    /*
     * 遍歷Hashtable的values
     */
    private static void iteratorHashtableJustValues(Hashtable table) {
        if (table == null)
            return ;
        
        Collection c = table.values();
        Iterator iter= c.iterator();
        while (iter.hasNext()) {
            System.out.println(iter.next());
       }
    }
}
複製程式碼

第5部分 Hashtable示例

下面通過一個例項來學習如何使用Hashtable。

import java.util.*;

/*
 * @desc Hashtable的測試程式。
 *
 * @author skywang
 */
public class HashtableTest {
    public static void main(String[] args) {
        testHashtableAPIs();
    }

    private static void testHashtableAPIs() {
        // 初始化隨機種子
        Random r = new Random();
        // 新建Hashtable
        Hashtable table = new Hashtable();
        // 新增操作
        table.put("one", r.nextInt(10));
        table.put("two", r.nextInt(10));
        table.put("three", r.nextInt(10));

        // 列印出table
        System.out.println("table:"+table );

        // 通過Iterator遍歷key-value
        Iterator iter = table.entrySet().iterator();
        while(iter.hasNext()) {
            Map.Entry entry = (Map.Entry)iter.next();
            System.out.println("next : "+ entry.getKey() +" - "+entry.getValue());
        }

        // Hashtable的鍵值對個數        
        System.out.println("size:"+table.size());

        // containsKey(Object key) :是否包含鍵key
        System.out.println("contains key two : "+table.containsKey("two"));
        System.out.println("contains key five : "+table.containsKey("five"));

        // containsValue(Object value) :是否包含值value
        System.out.println("contains value 0 : "+table.containsValue(new Integer(0)));

        // remove(Object key) : 刪除鍵key對應的鍵值對
        table.remove("three");

        System.out.println("table:"+table );

        // clear() : 清空Hashtable
        table.clear();

        // isEmpty() : Hashtable是否為空
        System.out.println((table.isEmpty()?"table is empty":"table is not empty") );
    }

}
複製程式碼

(某一次)執行結果:

table:{two=5, one=0, three=6}
next : two - 5
next : one - 0
next : three - 6
size:3
contains key two : true
contains key five : false
contains value 0 : true
table:{two=5, one=0}
table is empty
複製程式碼

出處:http://www.cnblogs.com/skywang12345/p/3310887.html

文章有不當之處,歡迎指正,你也可以關注我的微信公眾號:好好學java,獲取優質學習資源。

相關文章