詳解Java中AbstractMap抽象類

jdk1.8.0_144 下載地址：https://www.jb51.net/softs/551512.html

AbstractMap抽象類實(shí)現(xiàn)了一些簡(jiǎn)單且通用的方法，本身并不難。但在這個(gè)抽象類中有兩個(gè)方法非常值得關(guān)注，keySet和values方法源碼的實(shí)現(xiàn)可以說是教科書式的典范。

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

Java中Map類型的數(shù)據(jù)結(jié)構(gòu)有相當(dāng)多，AbstractMap作為它們的骨架實(shí)現(xiàn)實(shí)現(xiàn)了Map接口部分方法，也就是說為它的子類各種Map提供了公共的方法，沒有實(shí)現(xiàn)的方法各種Map可能有所不同。

抽象類不能通過new關(guān)鍵字直接創(chuàng)建抽象類的實(shí)例，但它可以有構(gòu)造方法。AbstractMap提供了一個(gè)protected修飾的無參構(gòu)造方法，意味著只有它的子類才能訪問（當(dāng)然它本身就是一個(gè)抽象類，其他類也不能直接對(duì)其實(shí)例化），也就是說只有它的子類才能調(diào)用這個(gè)無參的構(gòu)造方法。

在Map接口中其內(nèi)部定義了一個(gè)Entry接口，這個(gè)接口是Map映射的內(nèi)部實(shí)現(xiàn)用于維護(hù)一個(gè)key-value鍵值對(duì)，key-value存儲(chǔ)在這個(gè)Map.Entry中。AbstractMap對(duì)這個(gè)內(nèi)部接口進(jìn)行了實(shí)現(xiàn)，一共有兩個(gè)：一個(gè)是可變的SimpleEntry和一個(gè)是不可變的SimpleImmutableEntry。

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

實(shí)現(xiàn)了Map.Entry<K, V>接口，并且實(shí)現(xiàn)了Serializable（可被序列化）。

它的方法比較簡(jiǎn)單都是取值存值的操作，對(duì)于key值的定義是一個(gè)final修飾意味著是一個(gè)不可變的引用。另外其setValue方法稍微特殊，存入value值返回的并不是存入的值，而是返回的以前的舊值。需要重點(diǎn)學(xué)習(xí)的是它重寫的equals和hashCode方法。

public boolean equals(Object o) {
  if (!(o instanceof Map.Entry))    //判斷參數(shù)是否是Map.Entry類型，要equals相等首先得是同一個(gè)類型
    return false;
  Map.Entry<?,?> e = (Map.Entry<?,?>)o;    //將Object類型強(qiáng)轉(zhuǎn)為Map.Entry類型，這里參數(shù)使用“?”而不是“K, V”是因?yàn)榉盒驮谶\(yùn)行時(shí)類型會(huì)被擦除，編譯器不知道具體的K,V是什么類型
  return eq(key, e.getKey()) && eq(value, e.getValue());    //key和value分別調(diào)用eq方法進(jìn)行判斷，都返回ture時(shí)equals才相等。
}

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

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

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

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

定義為不可變的Entry，其實(shí)是事實(shí)不可變，因?yàn)樗惶峁﹕etValue方法，在多個(gè)線程同時(shí)訪問時(shí)自然不能通過setValue方法進(jìn)行修改。它相比于SimpleEntry其key和value成員變量都被定義為了final類型。調(diào)用setValue方法將會(huì)拋出UnsupportedOperationException異常。

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

接下來查看AbstractMap抽象類實(shí)現(xiàn)了哪些Map接口中的方法。

public int size()

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

public boolean isEmpty()

調(diào)用上面的size方法，等于0即為空。

public boolean containsKey(Object key)

這個(gè)方法的實(shí)現(xiàn)較為簡(jiǎn)單，通過調(diào)用entrySet方法獲取Set集合的迭代器遍歷Map.Entry，與參數(shù)key比較。Map可以存儲(chǔ)為null的key值，由于key=null在Map中存儲(chǔ)比較特殊（不能計(jì)算hashCode值），所以在這里也做了判斷參數(shù)key是否為空。

public boolean containsValue(Object value)

這個(gè)方法實(shí)現(xiàn)和containsKey一致。

public V get(Object key)

這個(gè)方法實(shí)現(xiàn)和上面兩個(gè)也類似，不同的是上面相等返回boolean，這個(gè)方法返回value值。

public V put(K key, V value)

向Map中存入key-value鍵值對(duì)的方法并沒有具體實(shí)現(xiàn)，會(huì)直接拋出一個(gè)UnsupportedOperationException異常。

public V remove(Object key)

通過參數(shù)key刪除Map中指定的key-value鍵值對(duì)。這個(gè)方法也很簡(jiǎn)單，也是通過迭代器遍歷Map.Entry的Set集合，找到對(duì)應(yīng)key值，通過調(diào)用Iterator#remove方法刪除Map.Entry。

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

這個(gè)方法也很簡(jiǎn)單遍歷傳入的Map，調(diào)用put方法存入就可以了。

public void clear()

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

public Set<K> keySet()

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

首先思考該方法是返回key值的Set集合，很自然的能想到一個(gè)簡(jiǎn)單的實(shí)現(xiàn)方式，遍歷Entry數(shù)組取出key值放到Set集合中，類似下面代碼：

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

這就意味著每次調(diào)用keySet方法都會(huì)遍歷Entry數(shù)組，數(shù)據(jù)量大時(shí)效率會(huì)大大降低。不得不說JDK源碼是寫得非常好，它并沒有采取遍歷的方式。如果不遍歷Entry，那又如何知道此時(shí)Map新增了一個(gè)key-value鍵值對(duì)呢？

答案就是在keySet方法內(nèi)部重新實(shí)現(xiàn)了一個(gè)新的自定義Set集合，在這個(gè)自定義Set集合中又重寫了iterator方法，這里是關(guān)鍵，iterator方法返回Iterator接口，而在這里又重新實(shí)現(xiàn)了Iterator迭代器，通過調(diào)用entrySet方法再調(diào)用它的iterator方法。下面結(jié)合代碼來分析：

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

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

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

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

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

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

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

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

我認(rèn)為這是一種很巧妙的實(shí)現(xiàn)，盡管這個(gè)方法是圍繞key值，但實(shí)際上可以結(jié)合Entry來實(shí)現(xiàn)，而不用遍歷Entry，同時(shí)上面提到了調(diào)用entrySet# iterator方法，這里則又是模板方法模式的最佳實(shí)踐。因?yàn)閑ntrySet在AbstractMap中并未實(shí)現(xiàn)，而是交給了它的子類去完成，但是對(duì)于keySet方法卻可以對(duì)它進(jìn)行一個(gè)“算法骨架” 實(shí)現(xiàn)，這就是模板方法模式。

public Collection<V> values()

對(duì)于values方法則完全可以參考keySet，兩者有著異曲同工之妙，這里為節(jié)省篇幅不再贅述。

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

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

public boolean equals(Object o)

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

public int hashCode()

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

public String toString()

這個(gè)方法沒什么好說的，就是取出所有鍵值對(duì)使用StringBuilder對(duì)其進(jìn)行拼接。

protected Object clone() throws CloneNotSupportedException

實(shí)現(xiàn)一個(gè)淺拷貝，由于是淺拷貝對(duì)于變量keySet和values不進(jìn)行拷貝，防止兩個(gè)淺拷貝引發(fā)的問題。