Java集合——AbstractMap源码解析

AbstractMap是什么？

AbstractList是Map的抽象子类，为一些通用的方法提供实现

继承结构

public abstract class AbstractMap<K,V> implements Map<K,V> {
}

构造函数

protected AbstractMap() {
}

获取大小和判断

判断entrySet的大小

public int size() {
    return entrySet().size();
}

public boolean isEmpty() {
    return size() == 0;
}

是否包含键值

获取entrySet().iterator()，遍历查找键值，找到返回true，未找到返回false

public boolean containsValue(Object value) {
    Iterator<Entry<K,V>> i = entrySet().iterator();
    if (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;
}

public boolean containsKey(Object key) {
    Iterator<Map.Entry<K,V>> i = entrySet().iterator();
    if (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;
}

操作集合

获取值

获取entrySet().iterator()，遍历对比值，若存在则返回相应的值，不存在返回null

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)
                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) {
    throw new UnsupportedOperationException();
}

添加集合

将传入的map循环取出键值，再put进去

public void putAll(Map<? extends K, ? extends V> m) {
    for (Map.Entry<? extends K, ? extends V> e : m.entrySet())
        put(e.getKey(), e.getValue());
}

删除值

获取entrySet().iterator()，遍历找到对应的Entry，取出数据返回并删除

public V remove(Object key) {
    Iterator<Entry<K,V>> i = entrySet().iterator();
    Entry<K,V> correctEntry = null;
    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;
    if (correctEntry !=null) {
        oldValue = correctEntry.getValue();
        i.remove();
    }
    return oldValue;
}

全清

获取entrySet()，调用其clear()

public void clear() {
    entrySet().clear();
}

获取视图

三个视图关系（重点必看）

• entrySet()才是真正存储数据的集
• keySet()和values()采用适配器模式对entrySet().iterator()和AbstractMap的方法进行封装
• 调用keySet().iterator()或values().iterator()不如直接调用entrySet().iterator()，故AbstractMap的方法都是调用entrySet()里的方法

键值集

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

键集

若keySet为空，则创建匿名AbstractSet，重写其中的方法

• iterator()返回匿名Iterator，通过适配器模式，实际调用的是entrySet().iterator()
• size、isEmpty、clear都调用外部类方法，contains调用containsKey()

transient Set<K>  keySet;

public Set<K> keySet() {
    Set<K> ks = keySet;
    if (ks == null) {
        ks = new AbstractSet<K>() {
            public Iterator<K> iterator() {
                return new 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);
            }
        };
        keySet = ks;
    }
    return ks;
}

值集

若values为空，则创建匿名AbstractCollection，重写其中的方法

• iterator()返回匿名Iterator，通过适配器模式，实际调用的是entrySet().iterator()
• size、isEmpty、clear都调用外部类方法，contains调用containsValue()

transient Collection<V> values;

public Collection<V> values() {
    Collection<V> vals = values;
    if (vals == null) {
        vals = 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);
            }
        };
        values = vals;
    }
    return vals;
}

equals

• 判断地址
• 判断是否是子类
• 转为父类判断大小
• 获取entrySet().iterator()，取出从迭代器取出Entry，从Entry取出键值，依次判断键和值是否相等

public boolean equals(Object o) {
    if (o == this)
        return true;
    if (!(o instanceof Map))
        return false;
    Map<?,?> m = (Map<?,?>) o;
    if (m.size() != size())
        return false;
    try {
        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

获取entrySet().iterator()，将所有Entry的hascode累加

public int hashCode() {
    int h = 0;
    Iterator<Entry<K,V>> i = entrySet().iterator();
    while (i.hasNext())
        h += i.next().hashCode();
    return h;
}

toString

打印如{key=value, key=value}的字符串

public String toString() {
    Iterator<Entry<K,V>> i = entrySet().iterator();
    if (! i.hasNext())
        return "{}";
    StringBuilder sb = new 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(' ');
    }
}

clone

浅拷贝，只拷贝集合地址，不拷贝其元素

protected Object clone() throws CloneNotSupportedException {
    AbstractMap<?,?> result = (AbstractMap<?,?>)super.clone();
    result.keySet = null;
    result.values = null;
    return result;
}

比较

判断传入的参数是否相等（是否都为null）

private static boolean eq(Object o1, Object o2) {
    return o1 == null ? o2 == null : o1.equals(o2);
}

SimpleEntry

SimpleEntry是静态内部类，用于创建Entry

• 构造函数可从外部或entry获取键值
• getKey()、getValue()获取键值，setValue()返回旧值设置新值
• equals()判断对象是否是Entry子类，转为父类比较其键值是否相等
• hashCode()将键值的哈希码进行异或

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

SimpleImmutableEntry相比于SimpleEntry，其value是final类型的，其他都一样

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());
    }
   
    public String toString() {
        return key + "=" + value;
    }
}