Java集合中的AbstractMap抽象類

jdk1.8.0_144

AbstractMap抽象類實現了一些簡單且通用的方法，本身並不難。但在這個抽象類中有兩個方法非常值得關注，keySet和values方法源碼的實現可以說是教科書式的典范。

　　抽象類通常作為一種骨架實現，為各自子類實現公共的方法。上一篇我們講解了Map接口，此篇對AbstractMap抽象類進行剖析研究。

　　Java中Map類型的數據結構有相當多，AbstractMap作為它們的骨架實現實現了Map接口部分方法，也就是說為它的子類各種Map提供了公共的方法，沒有實現的方法各種Map可能有所不同。

　　抽象類不能通過new關鍵字直接創建抽象類的實例，但它可以有構造方法。AbstractMap提供了一個protected修飾的無參構造方法，意味着只有它的子類才能訪問（當然它本身就是一個抽象類，其他類也不能直接對其實例化），也就是說只有它的子類才能調用這個無參的構造方法。

　　在Map接口中其內部定義了一個Entry接口，這個接口是Map映射的內部實現用於維護一個key-value鍵值對，key-value存儲在這個Map.Entry中。AbstractMap對這個內部接口進行了實現，一共有兩個：一個是可變的SimpleEntry和一個是不可變的SimpleImmutableEntry。

public static class SimpleEntry<K,V> implements Entry<K,V>, java.io.Serializable

　　實現了Map.Entry<K, V>接口，並且實現了Serializable（可被序列化）。

　　它的方法比較簡單都是取值存值的操作，對於key值的定義是一個final修飾意味着是一個不可變的引用。另外其setValue方法稍微特殊，存入value值返回的並不是存入的值，而是返回的以前的舊值。需要重點學習的是它重寫的equals和hashCode方法。

public boolean equals(Object o) {
    if (!(o instanceof Map.Entry))        //判斷參數是否是Map.Entry類型，要equals相等首先得是同一個類型
        return false;
    Map.Entry<?,?> e = (Map.Entry<?,?>)o;        //將Object類型強轉為Map.Entry類型，這里參數使用“?”而不是“K, V”是因為泛型在運行時類型會被擦除，編譯器不知道具體的K,V是什么類型
    return eq(key, e.getKey()) && eq(value, e.getValue());        //key和value分別調用eq方法進行判斷，都返回ture時equals才相等。
}

private static boolean eq(Object o1, Object o2) {
    return o1 == null ? o2 == null : o1.equals(o2);    //這個三目運算符也很簡單，只不過需要注意的是盡管這里o1、o2是Object類型，Object類型的equals方法是通過“==”比較的引用，所以不要認為這里有問題，因為在實際中，o1類型有可能是String，盡管被轉為了Object，所以此時在調用equals方法時還是調用的String#equals方法。
}

　　要想正確重寫equals方法並能正確使用，通常還需要重寫hashCode方法。

public int hashCode() {
    return (key == null ? 0 : key.hashCode()) ^ (value == null ? 0 : value.hashCode());    //key和value的值不為null時，將它們的hashCode進行異或運算。
}

public static class SimpleImmutableEntry<K,V> implements Entry<K,V>, java.io.Serializable SimpleImmutableEntry

　　定義為不可變的Entry，其實是事實不可變，因為它不提供setValue方法，在多個線程同時訪問時自然不能通過setValue方法進行修改。它相比於SimpleEntry其key和value成員變量都被定義為了final類型。調用setValue方法將會拋出UnsupportedOperationException異常。

 　　它的equals和hashCode方法和SimpleEntry一致。

　　接下來查看AbstractMap抽象類實現了哪些Map接口中的方法。

public int size()

　　Map中定義了一個entrySet方法，返回的是Map.Entry的Set集合，直接調用Set集合的size方法即是Map的大小。

public boolean isEmpty()

　　調用上面的size方法，等於0即為空。

public boolean containsKey(Object key)

　　這個方法的實現較為簡單，通過調用entrySet方法獲取Set集合的迭代器遍歷Map.Entry，與參數key比較。Map可以存儲為null的key值，由於key=null在Map中存儲比較特殊（不能計算hashCode值），所以在這里也做了判斷參數key是否為空。

public boolean containsValue(Object value)

　　這個方法實現和containsKey一致。

public V get(Object key)

　　這個方法實現和上面兩個也類似，不同的是上面相等返回boolean，這個方法返回value值。

public V put(K key, V value)

　　向Map中存入key-value鍵值對的方法並沒有具體實現，會直接拋出一個UnsupportedOperationException異常。

public V remove(Object key)

　　通過參數key刪除Map中指定的key-value鍵值對。這個方法也很簡單，也是通過迭代器遍歷Map.Entry的Set集合，找到對應key值，通過調用Iterator#remove方法刪除Map.Entry。

public void putAll(Map<? extends K, ? extends V> m)

　　這個方法也很簡單遍歷傳入的Map，調用put方法存入就可以了。

public void clear()

　　調用entrySet方法獲取Set集合再調用Set#clear()方法清空。

public Set<K> keySet()

　　返回Map key值的Set集合。AbstractMap中定義了一個成員變量“transient Set<K> keySet”，在JDK7中keySet變量是由volatile修飾的，但在JDK8中並沒有使用volatile修飾。在對keySet變量的注釋中解釋道，訪問這些字段的方法本身就沒有同步，加上volatile也不能保證線程安全。關於keySet方法的實現就有點意思了。

　　首先思考該方法是返回key值的Set集合，很自然的能想到一個簡單的實現方式，遍歷Entry數組取出key值放到Set集合中，類似下面代碼：

public Set<K> keySet() {
    Set<K> ks = null;
    for (Map.Entry<K, V> entry : entrySet()) {
        ks.add(entry.getKey());
    }
    return ks;
}

　　這就意味着每次調用keySet方法都會遍歷Entry數組，數據量大時效率會大大降低。不得不說JDK源碼是寫得非常好，它並沒有采取遍歷的方式。如果不遍歷Entry，那又如何知道此時Map新增了一個key-value鍵值對呢？

　　答案就是在keySet方法內部重新實現了一個新的自定義Set集合，在這個自定義Set集合中又重寫了iterator方法，這里是關鍵，iterator方法返回Iterator接口，而在這里又重新實現了Iterator迭代器，通過調用entrySet方法再調用它的iterator方法。下面結合代碼來分析：

public Set<K> keySet() {
    Set<K> ks = keySet;        //定義的transient Set<K> keySet
    if (ks == null) {        //第一次調用肯定為null，則通過下面代碼創建一個Set示例
        ks = new AbstractSet<K>() {        //創建一個自定義Set
            public Iterator<K> iterator() {        //重寫Set集合的iterator方法
                return new Iterator<K>() {    //重新實現Iterator接口
                    private Iterator<Entry<K,V>> i = entrySet().iterator();    //引用Entry的Set集合Iterator迭代器

                    public boolean hasNext() {
                        return i.hasNext();        //對key值的判斷，就是對entry的判斷
                    }

                    public K next() {
                        return i.next().getKey();    //取下一個key值，就是取entry#getKey
                    }

                    public void remove() {
                        i.remove();    //刪除key值，就是刪除entry
                    }
                };
            }

            public int size() {    //重寫的Set#size方法
                return AbstractMap.this.size();    //key值有多少就是整個Map有多大，所以調用本類的size方法即可。這個是內部類，直接使用this關鍵字代表這個類，應該指明是調用AbstractMap中的size方法，沒有this則表示是static靜態方法
            }

            public boolean isEmpty() {    //重寫的Set#isEmpty方法
                return AbstractMap.this.isEmpty();    //對是否有key值，就是判斷Map是否為空，，所以調用本類的isEmpty方法即可
            }

            public void clear() {        //重寫的Set#clear方法
                AbstractMap.this.clear();    //清空key值，就是清空Map，，所以調用本類的clear方法即可
            }

            public boolean contains(Object k) {    //重寫Set#contains方法
                return AbstractMap.this.containsKey(k);    //判斷Set是否包含數據k，就是判斷Map中是否包含key值，所以調用本類的containsKey方法即可
            }
        };
        keySet = ks;    //將這個自定義Set集合賦值給變量keySet，在以后再次調用keySet方法時，因為keySet不為null，只需直接返回。
    }
    return ks;

　　我認為這是一種很巧妙的實現，盡管這個方法是圍繞key值，但實際上可以結合Entry來實現，而不用遍歷Entry，同時上面提到了調用entrySet# iterator方法，這里則又是模板方法模式的最佳實踐。因為entrySet在AbstractMap中並未實現，而是交給了它的子類去完成，但是對於keySet方法卻可以對它進行一個“算法骨架” 實現，這就是模板方法模式。

public Collection<V> values()

　　對於values方法則完全可以參考keySet，兩者有着異曲同工之妙，這里為節省篇幅不再贅述。

public abstract Set<Entry<K,V>> entrySet()

　　一個抽象方法，交給它的子類去完成，說明這個方法並不是特別“通用”。

public boolean equals(Object o)

　　Map中規定只有在Map中的每對key-value鍵值對的key和value都一一對應時他們的equals比較才返回true。在方法中先判斷簡單的條件，如果引用相等，直接返回true，如果參數o不是Map類型直接返回false，如果兩個Map的數量不同也直接返回false。后面才再遍歷Entry數組比較Entry中的key和value是否一一對應。方法簡單，但這給了我們一個啟示，在條件判斷中，先判斷簡單的基本的，再判斷復雜的。

public int hashCode()

　　重寫了Object類的equals方法，重寫hashCode也是必須的。AbstractMap對hashCode的實現是將所有Map.Entry（這里就是SimpleEntry或SimpleImmutableEntry）的hashCode值向加，最后得出的總和作為Map的hashCode值。

public String toString()

　　這個方法沒什么好說的，就是取出所有鍵值對使用StringBuilder對其進行拼接。

protected Object clone() throws CloneNotSupportedException

　　實現一個淺拷貝，由於是淺拷貝對於變量keySet和values不進行拷貝，防止兩個淺拷貝引發的問題，關於Object中的clone方法在《萬類之父——Object》已有解析。

 

 

這是一個能給程序員加buff的公眾號