JDK源码之AbstractMap 类分析

一 概述 && Map接口

AbstractMap 是一个基础抽象实现类，实现了 Map接口 的主要方法.
Map接口定义了双列集合的规范 Map<K,V>,一个元素包含两值（一个key，一个value）,key,value都可以为null
key和value的数据类型可以相同，也可以不同,key是不允许重复的，value是可以重复的

Map接口源码分析

定义一般方法

        int size();

        boolean isEmpty();

        boolean containsKey(Object key);

        boolean containsValue(Object value);

        V get(Object key); //可能返回null

        V put(K key, V value); //同一个key,多次put会覆盖

        V remove(Object key);

        void putAll(java.util.Map<? extends K, ? extends V> m);

        void clear();//清除map

        Set<K> keySet(); //返回key的set集合

        Collection<V> values(); // 返回value的Collection集合

        Set<java.util.Map.Entry<K, V>> entrySet(); //返回Entry内部接口的Set集合,内部接口看下面
        boolean equals(Object o);
        int hashCode();

内部接口

Map.Entry是map声明的一个内部接口，此接口为泛型，定义为Entry<K,V>.它表示map中的一个元素的实体

public interface Map<K, V> {
        interface Entry<K, V> {
            K getKey();
            V getValue();
            V setValue(V value);
            boolean equals(Object o);
            int hashCode();
            // 下面四个方法其实都是获取比较器,只不过需要传递的参数不一样,主要是为了StreamAPI和lamdba添加的排序器
            // 1.8新增静态方法,获取key的比较器
            public static <K extends Comparable<? super K>, V> Comparator<java.util.Map.Entry<K, V>> comparingByKey() {
                return (Comparator<java.util.Map.Entry<K, V>> & Serializable)
                        (c1, c2) -> c1.getKey().compareTo(c2.getKey());
            }
            //1.8新增静态方法,获取value的比较器
            public static <K, V extends Comparable<? super V>> Comparator<java.util.Map.Entry<K, V>> comparingByValue() {
                return (Comparator<java.util.Map.Entry<K, V>> & Serializable)
                        (c1, c2) -> c1.getValue().compareTo(c2.getValue());
            }
            //1.8新增静态方法,获取参数是Comparator的比较器,按key排序,这里可传入一个lamdba,自定义排序结果,按正序还是倒叙
            public static <K, V> Comparator<java.util.Map.Entry<K, V>> comparingByKey(Comparator<? super K> cmp) {
                Objects.requireNonNull(cmp);
                return (Comparator<java.util.Map.Entry<K, V>> & Serializable)
                        (c1, c2) -> cmp.compare(c1.getKey(), c2.getKey());
            }
            //1.8新增静态方法,获取参数是Comparator的比较器,按value排序,这里可传入一个lamdba,自定义排序结果,按正序还是倒叙
            public static <K, V> Comparator<java.util.Map.Entry<K, V>> comparingByValue(Comparator<? super V> cmp) {
                Objects.requireNonNull(cmp);
                return (Comparator<java.util.Map.Entry<K, V>> & Serializable)
                        (c1, c2) -> cmp.compare(c1.getValue(), c2.getValue());
            }
        }

//新添加的几个排序器方法使用demo:

        final Map<String, Integer> map = new HashMap<>();
        map.put("10",4);
        map.put("2",20);
        map.put("4",44);
        final List<Map.Entry<String, Integer>> collect = map.entrySet().stream()
                //.sorted(Map.Entry.comparingByKey()) // 使用比较器排序,直接Map.Entry获取,有默认的排序,也可以方法参数里面实现自定义排序规则
                .sorted(Map.Entry.comparingByValue((x, y) -> { // value
                    // 自定义倒序规则
                    if (x > y) return -1;
                    if (x < y) return 1;
                    return 0;
                }))
                .collect(Collectors.toList());

default方法

default方法都是jdk1.8新添加的方法,主要是功能补充的一些API

        // Default方法都是1.8之后新增的

        // 如果map中没有key对应的value,返回默认的value,负责返回对应的value值(包括null)
        default V getOrDefault(Object key, V defaultValue) {
            V v;
            return (((v = get(key)) != null) || containsKey(key))
                    ? v
                    : defaultValue;
        }

        //提供forEach遍历,参数为BiConsumer labdba表达式,自定义处理逻辑
        default void forEach(BiConsumer<? super K, ? super V> action) {
            Objects.requireNonNull(action);
            for (java.util.Map.Entry<K, V> entry : entrySet()) {
                K k;
                V v;
                try {
                    k = entry.getKey();
                    v = entry.getValue();
                } catch (IllegalStateException ise) {
                    // this usually means the entry is no longer in the map.
                    throw new ConcurrentModificationException(ise);
                }
                action.accept(k, v);
            }
        }

        // 对map中所有元素Entry的value进行修改操作
        default void replaceAll(BiFunction<? super K, ? super V, ? extends V> function) {
            Objects.requireNonNull(function);
            for (java.util.Map.Entry<K, V> entry : entrySet()) {
                K k;
                V v;
                try {
                    k = entry.getKey();
                    v = entry.getValue();
                } catch (IllegalStateException ise) { throw new ConcurrentModificationException(ise); }
                v = function.apply(k, v);
                try {
                    entry.setValue(v); //将lamdba返回的值设置给value
                } catch (IllegalStateException ise) { throw new ConcurrentModificationException(ise); }
            }
        }

        //如果key对应的value不存在或者为null就添加,否则返回value
        default V putIfAbsent(K key, V value) {
            V v = get(key);
            if (v == null) {
                v = put(key, value);
            }
            return v;
        }
        //根据 key和value 删除元素
        default boolean remove(Object key, Object value) {
            Object curValue = get(key);
            if (!Objects.equals(curValue, value) ||   // 传递的value不一样,不会删除
                    (curValue == null && !containsKey(key))) {
                return false;
            }
            remove(key);
            return true;
        }
        // 将key对应的值进行替换并返回结果,需要传递原value值
        default boolean replace(K key, V oldValue, V newValue) {
            Object curValue = get(key);
            if (!Objects.equals(curValue, oldValue) ||   //如果传递的old值和实际获取的值不一样,则不替换,即必须传真实的值
                    (curValue == null && !containsKey(key))) { //key不存在也不会新增
                return false;
            }
            put(key, newValue);
            return true;
        }

        //将key对应的value替换并返回结果
        default V replace(K key, V value) {
            V curValue;
            if (((curValue = get(key)) != null) || containsKey(key)) {
                curValue = put(key, value);
            }
            return curValue;
        }
        // 如果key对应v为null,则进行put,根据key,可以在lamdba设置想要的值,如果是null,则不添加
        default V computeIfAbsent(K key,Function<? super K, ? extends V> mappingFunction) {
            Objects.requireNonNull(mappingFunction);
            V v;
            if ((v = get(key)) == null) {
                V newValue;
                if ((newValue = mappingFunction.apply(key)) != null) {
                    put(key, newValue);
                    return newValue;
                }
            }
            return v;
        }
        // 如果key对应v为null,则进行put,根据key和value,可以在lamdba设置想要的值,如果是null,则不添加
        default V computeIfPresent(K key, BiFunction<? super K, ? super V, ? extends V> remappingFunction) {
            Objects.requireNonNull(remappingFunction);
            V oldValue;
            if ((oldValue = get(key)) != null) {
                V newValue = remappingFunction.apply(key, oldValue);
                if (newValue != null) {
                    put(key, newValue);
                    return newValue;
                } else {
                    remove(key);
                    return null;
                }
            } else {
                return null;
            }
        }
        //如果lamdba返回值不为null则直接put操作,否则remove,key这个元素
        default V compute(K key,BiFunction<? super K, ? super V, ? extends V> remappingFunction) {
            Objects.requireNonNull(remappingFunction);
            V oldValue = get(key);
            V newValue = remappingFunction.apply(key, oldValue);
            if (newValue == null) {
                if (oldValue != null || containsKey(key)) {
                    remove(key);  //lamdba返回null,且原key值存在,则直接remove
                    return null;
                } else {
                    return null;
                }
            } else {
                put(key, newValue);
                return newValue;
            }
        }

        //当key对应的value不存在时,直接使用传递的value,否则用lamdba自定义的value值进行put
        default V merge(K key, V value,BiFunction<? super V, ? super V, ? extends V> remappingFunction) {
            Objects.requireNonNull(remappingFunction);
            Objects.requireNonNull(value);
            V oldValue = get(key);
            //当key对应的value不存在时,直接使用传递的value,否则用lamdba自定义的value值
            V newValue = (oldValue == null) ? value :
                    remappingFunction.apply(oldValue, value);
            if (newValue == null) {
                remove(key);
            } else {
                put(key, newValue);
            }
            return newValue;
        }

静态方法

static方法都是jdk1.9新添加的方法,主要是新建map的一些方法

        //of方法都是新建map,jdk9开始新增的,从空map到最多10个k,v的map
        static <K, V> java.util.Map<K, V> of() {
            return ImmutableCollections.emptyMap();
        }
        static <K, V> java.util.Map<K, V> of(K k1, V v1) {
            return new ImmutableCollections.Map1<>(k1, v1);
        }
        // .........
        static <K, V> java.util.Map<K, V> of(K k1, V v1, K k2, V v2, K k3, V v3, K k4, V v4, K k5, V v5,
                                             K k6, V v6, K k7, V v7, K k8, V v8, K k9, V v9, K k10, V v10) {
            return new ImmutableCollections.MapN<>(k1, v1, k2, v2, k3, v3, k4, v4, k5, v5,
                    k6, v6, k7, v7, k8, v8, k9, v9, k10, v10);
        }

        //根据参数构造一个不可变map
        @SafeVarargs
        @SuppressWarnings("varargs")
        static <K, V> java.util.Map<K, V> ofEntries(java.util.Map.Entry<? extends K, ? extends V>... entries) {
            if (entries.length == 0) { // implicit null check of entries array
                return ImmutableCollections.emptyMap();
            } else if (entries.length == 1) {
                // implicit null check of the array slot
                return new ImmutableCollections.Map1<>(entries[0].getKey(),
                        entries[0].getValue());
            } else {
                Object[] kva = new Object[entries.length << 1];
                int a = 0;
                for (java.util.Map.Entry<? extends K, ? extends V> entry : entries) {
                    // implicit null checks of each array slot
                    kva[a++] = entry.getKey();
                    kva[a++] = entry.getValue();
                }
                return new ImmutableCollections.MapN<>(kva);
            }
        }

        //返回Map.Entry空的实例
        static <K, V> java.util.Map.Entry<K, V> entry(K k, V v) {
            // KeyValueHolder checks for nulls
            return new KeyValueHolder<>(k, v);
        }

        // jdk10 新增方法,根据map参数返回一个copy的不可变的map
        @SuppressWarnings({"rawtypes","unchecked"})
        static <K, V> java.util.Map<K, V> copyOf(java.util.Map<? extends K, ? extends V> map) {
            if (map instanceof ImmutableCollections.AbstractImmutableMap) {
                return (java.util.Map<K,V>)map;
            } else {
                return (java.util.Map<K,V>) java.util.Map.ofEntries(map.entrySet().toArray(new java.util.Map.Entry[0]));
            }
        }
    }

二 源码分析

Map接口定义的方法的实现

        //唯一的构造器,即只有子类或者同胞的类才可以调用,进行实例化,其他类都不行
        protected AbstractMap() { }

        //  对Map接口定义的方法的实现
        //Map.Entryde 的一个Set集合,实现在具体子类,HashMap等
        public abstract Set<Entry<K,V>> entrySet();
        public int size() {
            return entrySet().size();
        } //返回Entry元素个数
        public boolean isEmpty() {
            return size() == 0;
        } //判断是否为空,即Entry个数是否为0
        //是否包含value
        public boolean containsValue(Object value) {
            Iterator<Entry<K,V>> i = entrySet().iterator();
            if (value==null) { //判断是否有null
                while (i.hasNext()) {
                    Entry<K,V> e = i.next();
                    if (e.getValue()==null)
                        return true;
                }
            } else {
                while (i.hasNext()) { //判断value值是否包含
                    Entry<K,V> e = i.next();
                    if (value.equals(e.getValue()))
                        return true;
                }
            }
            return false;
        }
        //是否包含key
        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;
        }
        //根据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)
                        return e.getValue();
                }
            } else {
                while (i.hasNext()) {
                    Entry<K,V> e = i.next();
                    if (key.equals(e.getKey()))
                        return e.getValue();
                }
            }
            return null; //找不到返回null
        }
        // 不支持put
        public V put(K key, V value) {
            throw new UnsupportedOperationException();
        }
        //删除
        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(); //删除,返回被删除的value
            }
            return oldValue;
        }
        //添加一个Map
        public void putAll(Map<? extends K, ? extends V> m) {
            for (Map.Entry<? extends K, ? extends V> e : m.entrySet())
                put(e.getKey(), e.getValue());
        }
        //清除
        public void clear() {
            entrySet().clear();
        }
        // Views
        transient Set<K>        keySet; //不序列化
        transient Collection<V> values;
        //获取key的set集合,这个方法实现挺牛逼的,因为AbstractSet也是抽象的,但是因为是同包,所以可以直接new,重新实现,避免了直接遍历一遍entrySet(),反而重新实现迭代器,性能上更好
        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 java.util.AbstractMap.this.size();
                    }
                    public boolean isEmpty() {
                        return java.util.AbstractMap.this.isEmpty();
                    }
                    public void clear() {
                        java.util.AbstractMap.this.clear();
                    }
                    public boolean contains(Object k) {
                        return java.util.AbstractMap.this.containsKey(k);
                    }
                };
                keySet = ks;
            }
            return ks;
        }
        //获取value的集合,与上个方法同理
        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 java.util.AbstractMap.this.size();
                    }
                    public boolean isEmpty() {
                        return java.util.AbstractMap.this.isEmpty();
                    }
                    public void clear() {
                        java.util.AbstractMap.this.clear();
                    }
                    public boolean contains(Object v) {
                        return java.util.AbstractMap.this.containsValue(v);
                    }
                };
                values = vals;
            }
            return vals;
        }
        //
        public boolean equals(Object o) {
            if (o == this)
                return true;
            if (!(o instanceof Map))  //类型是否相同
                return false;
            Map<?,?> m = (Map<?,?>) o; //size是否相等
            if (m.size() != size())
                return false;
            try {
                for (Entry<K, V> e : entrySet()) {
                    K key = e.getKey();
                    V value = e.getValue();
                    if (value == null) {
                        //比较每个Entry,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方法,即每一个ENtry的hashCode相加
        public int hashCode() {
            int h = 0;
            for (Entry<K, V> entry : entrySet())
                h += entry.hashCode();
            return h;
        }
        //toString
        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); //key也可以是本map
                sb.append('=');
                sb.append(value == this ? "(this Map)" : value);
                if (! i.hasNext())
                    return sb.append('}').toString();
                sb.append(',').append(' ');
            }
        }
        //浅克隆
        protected Object clone() throws CloneNotSupportedException {
            java.util.AbstractMap<?,?> result = (java.util.AbstractMap<?,?>)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);
    }

静态内部类

两个静态内部类都是jdk1.6新增的,是对Entry的两种实现,一种可变一种不可变

        //Entry的可变实现,注意:只是Value可变,key依旧不可变
        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;
            }
            // 可以 setValue
            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;
            }
        }

        // Entry的不可变实现,也实现了序列化
        public static class SimpleImmutableEntry<K,V>
                implements Entry<K,V>, java.io.Serializable
        {
            private static final long serialVersionUID = 7138329143949025153L;
            private final K key; //final修饰,不可变
            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;
            }
            //set直接抛异常
            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());
            }
            // key和 value的 hashCode进行异或运算
            public int hashCode() {
                return (key   == null ? 0 :   key.hashCode()) ^
                        (value == null ? 0 : value.hashCode());
            }
            public String toString() {
                return key + "=" + value;
            }
        }