Java AbstractMap虚拟类总结 从模板方法层面去理解

文章目录

• AbstractMap虚拟类源码总结
• AbstractMap虚拟类实现
• • 子类需要实现的方法
  • Object重写方法
  • • hashCode方法
    • toString方法
    • equals方法
    • clone方法
  • 查询操作
  • • size方法
    • get方法
    • containsKey方法
    • containsValue方法
  • 修改操作
  • • put方法
    • remove方法
  • 批量操作
  • • putAll方法
    • clear方法
  • 获取集合视图
  • • keySet方法
    • values方法
    • eq方法
• SimpleEntry静态内部类实现
• • SimpleEntry静态内部类
• SimpleEntry静态内部类实现
• • SimpleEntry静态内部类

AbstractMap虚拟类源码总结

AbstractMap虚拟类实现了Map接口，并且使用了模板方法设计模式，即几乎只使用了Map接口定义的entrySet()方法就实现了几乎所有接口中定义的其他操作，Map接口源码可以看我这篇文章 Map

AbstractMap虚拟类实现 子类需要实现的方法

方法名	作用
public abstract Set> entrySet()	获取Map中键值对Entry的Set集合

子类基本上只需实现这一个方法，就可以获取该类其他所有方法的实现，这就是模板方法设计模式，使用一个虚方法来实现其他实际的方法，还有少部分方法需要实现Map接口的某些方法如remove

Object重写方法 hashCode方法

1. 调用子类实现的entrySet获取Entry的Set集合，然后使用加强for循环遍历，加强for循环底层使用迭代器Iterator实现
2. Map的hashcode就是其内部的所有键值对Entry的hashCode之和

public int hashCode() {
    int h = 0;
    for (Entry entry : entrySet())
        h += entry.hashCode();
    return h;
}

toString方法

获取获取Entry的Set集合的迭代器，使用StringBuilder构造字符串，将每个Entry的key和value都添加进字符串

public String toString() {
    Iterator> i = entrySet().iterator();
    if (! i.hasNext())
        return "{}";

    StringBuilder sb = new StringBuilder();
    sb.append('{');
    for (;;) {
        Entry 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(' ');
    }
}

equals方法

1. 如果是对象o等于this，说明是本对象，直接返回true
2. 如果对象o不是Map的类或其子类则返回false
3. 对象o转型为Map后，先比较Entry键值对的数量size，如果不相等返回false
4. 然后才遍历Entry的Set集合，获取每一个Entry的键key和值value，值value有两种情况
5. 第一种情况，Entry值为null，则去给定的对象o向下转型后的m中查找该键key对应的Entry，如果找到的Entry值也为null，且调用containsKey判断m中含有该Entry的键key，才算比对一个Entry成功，如果有一个不成功，则返回false
6. 第二种情况，Entry值不为null，则去给定的对象o向下转型后的m中查找该键key对应的Entry，如果找到的Entry值和原来的Entry的值相等，才算比对一个Entry成功，如果有一个不成功，则返回false
7. 出现异常，直接返回false

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 {
        for (Entry e : entrySet()) {
            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;
}

clone方法

调用Object的clone方法，Object的Object是一个native原生方法，并将复制的 AbstractMap的keySet和values置为空

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

查询操作

返回Entry的Set集合大小

size方法

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

get方法

迭代Entry的Set集合，找到第一个Entry的键等于给定键key，并将其值返回

public V get(Object key) {
    Iterator> i = entrySet().iterator();
    if (key==null) {
        while (i.hasNext()) {
            Entry e = i.next();
            if (e.getKey()==null)
                return e.getValue();
        }
    } else {
        while (i.hasNext()) {
            Entry e = i.next();
            if (key.equals(e.getKey()))
                return e.getValue();
        }
    }
    return null;
}

containsKey方法

和get操作类似，只不过get返回了Entry的值，而containsKey返回true或false，如果有包含给定key的Entry则返回true

public boolean containsKey(Object key) {
    Iterator> i = entrySet().iterator();
    if (key==null) {
        while (i.hasNext()) {
            Entry e = i.next();
            if (e.getKey()==null)
                return true;
        }
    } else {
        while (i.hasNext()) {
            Entry e = i.next();
            if (key.equals(e.getKey()))
                return true;
        }
    }
    return false;
}

containsValue方法

和containsKey操作类似，只不过containsKey返回比较的是键key，而containsValue比较的是值，如果有包含给定value的Entry则返回true

public boolean containsValue(Object value) {
    Iterator> i = entrySet().iterator();
    if (value==null) {
        while (i.hasNext()) {
            Entry e = i.next();
            if (e.getValue()==null)
                return true;
        }
    } else {
        while (i.hasNext()) {
            Entry e = i.next();
            if (value.equals(e.getValue()))
                return true;
        }
    }
    return false;
}

修改操作 put方法

默认不支持插入操作，如果子类不重写put方法，则抛出异常

public V put(K key, V value) {
    throw new UnsupportedOperationException();
}

remove方法

先在Entry的Set集合中找到包含给定键key的Entry，然后调用子类实现的remove方法移除该Entry，并返回该Entry的值

public V remove(Object key) {
    Iterator> i = entrySet().iterator();
    Entry correctEntry = null;
    if (key==null) {
        while (correctEntry==null && i.hasNext()) {
            Entry e = i.next();
            if (e.getKey()==null)
                correctEntry = e;
        }
    } else {
        while (correctEntry==null && i.hasNext()) {
            Entry e = i.next();
            if (key.equals(e.getKey()))
                correctEntry = e;
        }
    }

    V oldValue = null;
    if (correctEntry !=null) {
        oldValue = correctEntry.getValue();
        i.remove();
    }
    return oldValue;
}

批量操作 putAll方法

获取给定Map的Entry的Set集合，遍历该集合取出键和值，使用子类重写实现的put方法，将所有键值对都添加进Map中

public void putAll(Map m) {
    for (Map.Entry e : m.entrySet())
        put(e.getKey(), e.getValue());
}

clear方法

调用Set集合的clear方法来清理所有Entry键值对

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

获取集合视图 keySet方法

keySet是用AbstractSet虚拟类生成的，AbstractSet虚拟类也类似该类，使用一两个子类实现的方法如iterator()获取迭代器，就可以实现其它Set接口定义的方法了

transient Set keySet;

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

values是用AbstractCollection虚拟类生成的AbstractCollection虚拟类也类似该类，使用一两个子类实现的方法如iterator()获取迭代器，就可以实现其它Collection接口定义的方法了
Collection 接口源码可以看我这篇文章 Collection
AbstractCollection 虚拟类源码可以我这篇文章 AbstractCollection

transient Collection values;

public Collection values() {
    Collection vals = values;
    if (vals == null) {
        vals = new AbstractCollection() {
            public Iterator iterator() {
                return new Iterator() {
                    private Iterator> 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;
}

eq方法

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

SimpleEntry静态内部类实现 SimpleEntry静态内部类

是Map接口的内部接口Entry的可变Entry版本简单实现，值value是可变的

public static class SimpleEntry
        implements Entry, java.io.Serializable {
	  private final K key;
	  private V value;
}

SimpleEntry静态内部类实现 SimpleEntry静态内部类

是Map接口的内部接口Entry的不可变Entry版本简单实现，值value是不可变的

public static class SimpleImmutableEntry
       implements Entry, java.io.Serializable  { 
       private final K key;
       private final V value;
}