java集合框架07——Map架構與源代碼分析
前幾節我們對Collection以及Collection中的List部分進行了分析，Collection中還有個Set，因為Set是基于Map實現的，所以這里我們先分析Map，后面章節再繼續學習Set。首先我們看下Map架構圖：
從圖中能夠看出：
1. Map是一個接口，Map中存儲的內容是鍵值對（key-value）。
2. 為了方便，我們抽象出AbstractMap類來讓其它類繼承，該類實現了Map中的大部分API。其它Map的詳細實現就能夠通過直接繼承AbatractMap類就可以。
3. SortedMap也是一個接口。它繼承與Map接口。SortedMap中的內容與Map中的差別在于。它是有序的鍵值對，里面排序的方法是通過比較器（Comparator）實現的。
4. NavigableMap也是一個接口。它繼承與SortedMap接口，所以它肯定也是有序的。另外。NavigableMap另一些導航的方法：如獲取“大于或等于某個對象的鍵值對”等等。
5. 再往下就是詳細實現類了，TreeMap繼承與AbstractMap，同一時候實現了NavigableMap接口。因此，TreeMap中的內容是有序鍵值對。
6. HashMap不過繼承了AbstractMap，并沒有實現NavigableMap接口。因此，HashMap的內容僅是鍵值對而已。不保證有序。
7. WeakHashMap也是只繼承了AbstractMap，它和HashMap的差別是鍵類型不同。WeakHashMap的鍵是弱鍵。
8. HashTable盡管不是繼承與AbstractMap，可是它繼承與Dictionary（Dictionary也是鍵值對的接口）。并且也實現了Map接口。因此，HashTable的內容也是鍵值對。且不保證順序。可是和HashMap相比，HashTable是線程安全的，并且它支持通過Enumeration去遍歷。
本節主要是討論一下Map的架構，然后對各個接口和抽象類做一些介紹，研究一些源代碼，至于像TreeMap。HashMap等具體實現類的源代碼，我們在興許章節具體的研究。
1.Map
Map的定義及其API例如以下：
package java.util;
public interface Map<K,V> {
boolean isEmpty();
boolean containsKey(Object key);
boolean containsValue(Object value);
V get(Object key);
V put(K key, V value);
V remove(Object key);
void putAll(Map<? extends K, ?
extends V> m);
void clear();
Set<K> keySet(); //保存key的Set
Collection<V> values(); //保存value的Collection
Set<Map.Entry<K, V>> entrySet(); //保存Map.Entry的Set
interface Entry<K,V> { //Map內部的一個接口，Entry中封裝了key和value信息
K getKey();
V getValue();
V setValue(V value);
boolean equals(Object o);
int hashCode();
}
boolean equals(Object o);
int hashCode();
}
由上面的源代碼可知：
1. Map提供了一些接口分別用于返回鍵集、值集以及鍵值映射關系集。
keySet()用于返回鍵的Set集合；
values()用于返回值的Set集合；
entrySet()用于返回鍵值集的Set集合。鍵值信息封裝在Entry中。
2. Map還對外提供了“獲取鍵”、“依據鍵獲取值”、“是否包括某個鍵或值”等等方法。
3. Map.Entry是Map內部的一個接口，Map.Entry是一個鍵值對。我們要想獲取Map中的Map中的鍵值對，能夠通過Map.entrySet()來獲取，獲取到的是一個裝著Map.Entry的集合。然后能夠通過這個Entry來實現對鍵值的操作。
2.AbstractMap
AbstractMap繼承了Map。但沒有實現entrySet()方法（該方法還是abstract修飾），假設要繼承AbstractMap，須要自己實現entrySet()方法。沒有真正實現put(K key, V value)方法，這里“沒有真正實現”的意思是，該方法在形式上已經實現了。即沒實用abstract修飾了，可是方法內部不過拋出個異常。并沒有真正實現方法體內容，從以下的源代碼中能夠看到。
package java.util;
import java.util.Map.Entry;
public abstract class AbstractMap<K,V> implements Map<K,V> {
//空構造方法
protected AbstractMap() {
}
//返回Map中存儲多少鍵值對
public int size() {
return entrySet().size();
}
//推斷Map是否為空
public boolean isEmpty() {
return size() == 0;
}
//推斷Map中是否包括值為value的鍵值對
public boolean containsValue(Object value) {
//entrySet()返回一個裝有Map.Entry<K,V>的Set，然后獲得Set的iterator
Iterator<Entry<K,V>> i = entrySet().iterator();
if (value==null) { //從這里能夠看出Map中同意value==null
while (i.hasNext()) {
Entry<K,V> e = i.next();
if (e.getValue()==null)
return true;
}
} else {
while (i.hasNext()) {
Entry<K,V> e = i.next();
if (value.equals(e.getValue()))
return true;
}
}
return false;
}
//推斷Map中是否含有鍵為key的鍵值對
public boolean containsKey(Object key) {
Iterator<Map.Entry<K,V>> i = entrySet().iterator();
if (key==null) { //從這里能夠看出Map中同意key==null
while (i.hasNext()) {
Entry<K,V> e = i.next();
if (e.getKey()==null)
return true;
}
} else {
while (i.hasNext()) {
Entry<K,V> e = i.next();
if (key.equals(e.getKey()))
return true;
}
}
return false;
}
//通過key獲得相應的value值
public V get(Object key) {
Iterator<Entry<K,V>> i = entrySet().iterator();
if (key==null) {
while (i.hasNext()) {
Entry<K,V> e = i.next();
if (e.getKey()==null) //從這里能夠看出，key=null的必須value=null
return e.getValue();
}
} else {
while (i.hasNext()) {
Entry<K,V> e = i.next();
if (key.equals(e.getKey()))
return e.getValue();
}
}
return null;
}
public V put(K key, V value) { //put方法體內部沒有詳細實現，須要繼承后自己實現
throw new UnsupportedOperationException();
}
//刪除指定key的Entry
public V remove(Object key) {
Iterator<Entry<K,V>> i = entrySet().iterator();
Entry<K,V> correctEntry = null; //用來保存待刪除的Entry
if (key==null) {
while (correctEntry==null && i.hasNext()) {
Entry<K,V> e = i.next();
if (e.getKey()==null)
correctEntry = e;
}
} else {
while (correctEntry==null && i.hasNext()) {
Entry<K,V> e = i.next();
if (key.equals(e.getKey()))
correctEntry = e;
}
}
V oldValue = null; //用來保存待刪除Entry的value值
if (correctEntry !=null) { //correctEntry不為null表示找到了待刪除的Entry
oldValue = correctEntry.getValue();
i.remove();
}
return oldValue;
}
//向Map中加入新的Map m
public void putAll(Map<? extends K, ? extends V> m) {
for (Map.Entry<? extends K, ?
extends V> e : m.entrySet())
put(e.getKey(), e.getValue()); //調用上面未實現的put方法
}
//清空整個Map
public void clear() {
entrySet().clear();
}
//keySet用來保存key的Set。values用來保存value的Collection
transient volatile Set<K> keySet = null;
transient volatile Collection<V> values = null;
//獲取Map中全部的key。保存到keySet成員變量中返回。keySet是個Set<K>類型
public Set<K> keySet() {
if (keySet == null) {
keySet = new AbstractSet<K>() { //內部類AbstractSet<K>
public Iterator<K> iterator() {
return new Iterator<K>() {//內部類Iterator<K>
private Iterator<Entry<K,V>> i = entrySet().iterator();
public boolean hasNext() {
return i.hasNext();
}
public K next() {
return i.next().getKey();
}
public void remove() {
i.remove();
}
};
}
public int size() {
return AbstractMap.this.size();
}
public boolean isEmpty() {
return AbstractMap.this.isEmpty();
}
public void clear() {
AbstractMap.this.clear();
}
public boolean contains(Object k) {
return AbstractMap.this.containsKey(k);
}
};
}
return keySet;
}
//獲取Map中全部的value，保存到values成員變量中返回。
values是個Collection<V>類型
public Collection<V> values() {
if (values == null) {
values = new AbstractCollection<V>() {
public Iterator<V> iterator() {
return new Iterator<V>() {
private Iterator<Entry<K,V>> i = entrySet().iterator();
public boolean hasNext() {
return i.hasNext();
}
public V next() {
return i.next().getValue();
}
public void remove() {
i.remove();
}
};
}
public int size() {
return AbstractMap.this.size();
}
public boolean isEmpty() {
return AbstractMap.this.isEmpty();
}
public void clear() {
AbstractMap.this.clear();
}
public boolean contains(Object v) {
return AbstractMap.this.containsValue(v);
}
};
}
return values;
}
public abstract Set<Entry<K,V>> entrySet(); //未實現，還是抽象方法
//Map中的equals方法，從源代碼中能夠看出。比較的是value的值，全部value值都相等才返回true
public boolean equals(Object o) {
if (o == this) //假設對象都一樣，必定返回true
return true;
if (!(o instanceof Map)) //傳進來的對象若不是Map類型肯定false
return false;
Map<K,V> m = (Map<K,V>) o;
if (m.size() != size()) //兩個對象的size不同肯定false
return false;
try { //好了。上面的條件都滿足了。以下就挨個比較value值了
Iterator<Entry<K,V>> i = entrySet().iterator();
while (i.hasNext()) {
Entry<K,V> e = i.next();
K key = e.getKey();
V value = e.getValue();
if (value == null) {
if (!(m.get(key)==null && m.containsKey(key)))
return false;
} else {
if (!value.equals(m.get(key)))
return false;
}
}
} catch (ClassCastException unused) {
return false;
} catch (NullPointerException unused) {
return false;
}
return true;
}
//hashCode
public int hashCode() {
int h = 0;
Iterator<Entry<K,V>> i = entrySet().iterator();
while (i.hasNext())
h += i.next().hashCode(); //調用Entry中的hashCode()方法
return h;
}
//實現toString方法：{key=value}形式輸出
public String toString() {
Iterator<Entry<K,V>> i = entrySet().iterator();
if (! i.hasNext())
return "{}";
StringBuilder sb = new StringBuilder(); //使用StringBuilder
sb.append('{');
for (;;) {
Entry<K,V> e = i.next();
K key = e.getKey();
V value = e.getValue();
sb.append(key == this ? "(this Map)" : key);
sb.append('=');
sb.append(value == this ? "(this Map)" : value);
if (! i.hasNext())
return sb.append('}').toString();
sb.append(',').append(' ');
}
}
protected Object clone() throws CloneNotSupportedException {
AbstractMap<K,V> result = (AbstractMap<K,V>)super.clone();
result.keySet = null;
result.values = null;
return result;
}
private static boolean eq(Object o1, Object o2) {
return o1 == null ?
o2 == null : o1.equals(o2);
}
//SimpleEntry實現了Map類中的Entry接口，另外也實現了Serializable接口，可序列化
public static class SimpleEntry<K,V>
implements Entry<K,V>, java.io.Serializable
{
private static final long serialVersionUID = -8499721149061103585L;
private final K key;
private V value;
public SimpleEntry(K key, V value) {
this.key = key;
this.value = value;
}
public SimpleEntry(Entry<? extends K, ? extends V> entry) {
this.key = entry.getKey();
this.value = entry.getValue();
}
public K getKey() {
return key;
}
public V getValue() {
return value;
}
public V setValue(V value) {
V oldValue = this.value;
this.value = value;
return oldValue;
}
public boolean equals(Object o) {
if (!(o instanceof Map.Entry))
return false;
Map.Entry e = (Map.Entry)o;
return eq(key, e.getKey()) && eq(value, e.getValue());
}
public int hashCode() {
return (key == null ? 0 : key.hashCode()) ^
(value == null ? 0 : value.hashCode());
}
public String toString() {
return key + "=" + value;
}
}
//SimpleImmutableEntry實現了Map類中的Entry接口，另外也實現了Serializable接口。可序列化
public static class SimpleImmutableEntry<K,V>
implements Entry<K,V>, java.io.Serializable
{
private static final long serialVersionUID = 7138329143949025153L;
private final K key;
private final V value;
public SimpleImmutableEntry(K key, V value) {
this.key = key;
this.value = value;
}
public SimpleImmutableEntry(Entry<?
extends K, ?
extends V> entry) {
this.key = entry.getKey();
this.value = entry.getValue();
}
public K getKey() {
return key;
}
public V getValue() {
return value;
}
public V setValue(V value) {
throw new UnsupportedOperationException();
}
public boolean equals(Object o) {
if (!(o instanceof Map.Entry))
return false;
Map.Entry e = (Map.Entry)o;
return eq(key, e.getKey()) && eq(value, e.getValue());
}
public int hashCode() {
return (key == null ? 0 : key.hashCode()) ^
(value == null ? 0 : value.hashCode());
}
//重寫了toString方法，返回key=value形式
public String toString() {
return key + "=" + value;
}
}
}
從源代碼中能夠看出。AbstractMap類提供了Map接口的主要實現。以最大限度地降低了實現此接口所需的工作，可是AbstractMap沒有實現entrySet()方法。所以假設我們要實現不可改動的Map時，僅僅須要擴展此類并提供entrySet()方法的實現就可以。另外從源代碼中也能夠看出。entrySet()方法返回的Set（即keySet）不支持add()或remove()方法。假設我們要實現可改動的Map，那么就必須另外重寫put()方法，否則將拋出UnsupportedOperationException。并且entrySet.iterator()返回的迭代器i也必須實現其remove方法。
只是一般我們不須要自己實現Map，由于已經有Map的實現類了，如HashMap和TreeMap等。
3.SortedMap
SortedMap也是一個接口，繼承與Map接口，Sorted表示它是一個有序的鍵值映射。
SortedMap的排序方式有兩種：自然排序和指定比較器排序。插入有序的SortedMap的全部元素都必須實現Comparable接口（或被指定的比較器所接受）。
SortedMap定義的API：
//繼承與Map的API不再贅寫
package java.util;
public interface SortedMap<K,V> extends Map<K,V> {
Comparator<? super K> comparator(); //返回比較器對象
SortedMap<K,V> subMap(K fromKey, K toKey); //返回指定key范圍內的Map
SortedMap<K,V> headMap(K toKey); //返回小于指定key的部分集合
SortedMap<K,V> tailMap(K fromKey); //返回大于等于指定key的部分集合
K firstKey(); //返回第一個元素的key
K lastKey(); //返回最后一個元素的key
}
4.NavigableMap
NavigableMap繼承與SortedMap。先看它的API
package java.util;
public interface NavigableMap<K,V> extends SortedMap<K,V> {
Map.Entry<K,V> lowerEntry(K key);
K lowerKey(K key);
Map.Entry<K,V> floorEntry(K key);
K floorKey(K key);
Map.Entry<K,V> ceilingEntry(K key);
K ceilingKey(K key);
Map.Entry<K,V> higherEntry(K key);
K higherKey(K key);
Map.Entry<K,V> lastEntry();
Map.Entry<K,V> pollLastEntry();
NavigableMap<K,V> descendingMap();
NavigableSet<K> navigableKeySet();
NavigableSet<K> descendingKeySet();
NavigableMap<K,V> subMap(K fromKey, boolean fromInclusive,
K toKey, boolean toInclusive);
NavigableMap<K,V> headMap(K toKey, boolean inclusive);
NavigableMap<K,V> tailMap(K fromKey, boolean inclusive);
SortedMap<K,V> subMap(K fromKey, K toKey);
SortedMap<K,V> headMap(K toKey);
SortedMap<K,V> tailMap(K fromKey);
}
從API中我們能夠看出，NavigableMap除了繼承了SortedMap的特性外，還提供了例如以下功能：
1. 提供了操作鍵值對的方法：lowerEntry、floorEntry、cellingEntry和higherEntry方法分別返回小于、小于等于、大于等于和大于給定鍵的鍵所關聯的Map.Entry對象。
2. 提供了操作鍵的方法：lowerKey、floorKey、cellingKey和higherKey方法分別返回小于、小于等于、大于等于和大于給定鍵的鍵。
3. 獲取鍵值對的子集。
5.Dictionary
Dictionary中也包含了操作鍵值對的基本方法呢，它的定義以及API例如以下：
package java.util;
public abstract
class Dictionary<K,V> {
public Dictionary() {
}
abstract public int size();
abstract public boolean isEmpty();
abstract public Enumeration<K> keys();
abstract public Enumeration<V> elements();
abstract public V get(Object key);
abstract public V put(K key, V value);
abstract public V remove(Object key);
}
Map的架構就探討到這吧，從下一節我們開始探討Map接口的詳細實現類。
_____________________________________________________________________________________________________________________________________________________
-----樂于分享，共同進步！
浙公網安備 33010602011771號