Java：Map 接口

一、常用方法

Map 接口定义了如何存储和检索键值对。一个 Map 对象可以将任意类型的对象作为键（key），并且可以将任意类型的对象作为值（value）。在 Java 中，Map 接口有几个常见的实现： HashMap、LinkedHashMap 和 TreeMap。

方法名	描述
`put(K, V)`	将指定的值与该映射中的指定键相关联。如果映射先前包含一个该键的映射关系，则用指定值替换旧值。
`get(key)`	返回指定键所映射的值；如果此映射不包含该键的映射关系，则返回`null`。
`remove(key)`	如果存在一个键的映射关系，则将其从映射中移除。
`containsKey(key)`	如果此映射包含指定键的映射关系，则返回`true`。
`containsValue(value)`	如果此映射将一个或多个键映射到指定值，则返回`true`。
`size()`	返回此映射中的键-值映射关系数。
`isEmpty()`	如果此映射未包含键-值映射关系，则返回`true`。
`clear()`	从此映射中移除所有映射关系（可选操作）。
`hashCode()`	返回此映射的哈希码值。

1、`put` 方法

将指定的键和值添加到映射中。如果该键已经存在于映射中，则该方法会更新与该键相关的值。

public static void main(String[] args) {
    // 使用实现类HashMap 来演示
    Map map = new HashMap();
    map.put("No1", "张三");
    map.put("No1", "李四");
    System.out.println(map);
    // 输出的结果为：{No1=李四}
}

2、`get` 方法

返回指定键所映射的值；如果此映射不包含该键的映射关系，则返回 null。

public static void main(String[] args) {
    // 使用实现类HashMap 来演示
    Map map = new HashMap();
    map.put("No1", "张三");
    map.put("No1", "李四");
    System.out.println(map.get("No1"));
    // 输出的值为：李四
}

3、`remove` 方法

从映射中移除指定键的映射关系（如果存在）并返回其对应的值。

public static void main(String[] args) {
    // 使用实现类HashMap 来演示
    Map map = new HashMap();
    map.put("No1", "张三");
    map.put("No1", "李四");
    System.out.println(map.remove("No1"));
    System.out.println(map.get("No1"));
}

4、`clear`方法

移除此映射中的所有映射关系。

public static void main(String[] args) {
    // 使用实现类HashMap 来演示
    Map map = new HashMap();
    map.put("No1", "张三");
    map.put("No2", "李四");
    map.put("No3", "李四");
    map.clear();
    System.out.println(map);
}

5、`size` 方法

返回此映射中的映射关系数。

public static void main(String[] args) {
    // 使用实现类HashMap 来演示
    Map map = new HashMap();
    map.put("No1", "张三");
    map.put("No2", "李四");
    map.put("No3", "李四");
    int size = map.size();
    System.out.println(size);
}

6、`isEmpty`方法

如果此映射不包含任何键-值映射关系，如果此映射为空，则为 true；否则为 false。

public static void main(String[] args) {
    // 使用实现类HashMap 来演示
    Map map = new HashMap();
    map.put("No1", "张三");
    map.put("No2", "李四");
    map.put("No3", "李四");
    map.clear();
    System.out.println(map.isEmpty());
}

7、`containsKey` 方法

查找键是否存在，如果存在则为 true；否则为 false。

public static void main(String[] args) {
    // 使用实现类HashMap 来演示
    Map map = new HashMap();
    map.put("No1", "张三");
    map.put("No2", "李四");
    map.put("No3", "李四");
    System.out.println(map.containsKey("No1"));
    System.out.println(map.containsKey("No4"));
}

8、`containsValue` 方法

如果此映射包含至少一个指定值，则返回 true。

public static void main(String[] args) {
    // 使用实现类HashMap 来演示
    Map map = new HashMap();
    map.put("No1", "张三");
    map.put("No2", "李四");
    map.put("No3", "李四");
    System.out.println(map.containsValue("张三"));
    System.out.println(map.containsValue("王五"));
}

二、Map接口遍历

1、使用keySet获取所有的键

keySet 方法返回一个 Set，其中包含了 Map 中的所有键。我们可以使用迭代器或增强型 for 循环来遍历这个 Set。

public static void main(String[] args) {
    // 使用实现类HashMap 来演示
    Map map = new HashMap();
    map.put("No1", "张三");
    map.put("No2", "李四");
    map.put("No3", "王五");
    map.put("No4", "赵六");
    // 第一组: 先取出 所有的 Key , 通过 Key 取出对应的 Value
    Set set = map.keySet();
    //方法1：增强for循环
    for (Object key : set) {
        System.out.println(key + "-" + map.get(key));
    }
    // 方法2：迭代器
    Iterator iterator = set.iterator();
    while (iterator.hasNext()) {
        Object key = iterator.next();
        System.out.println(key + "-" + map.get(key));
    }
}

2、把所有的values取出

values 方法返回一个 Collection，其中包含了 Map 中的所有值。我们可以使用迭代器或增强型 for 循环来遍历这个 Collection。

public static void main(String[] args) {
    // 使用实现类HashMap 来演示
    Map map = new HashMap();
    map.put("No1", "张三");
    map.put("No2", "李四");
    map.put("No3", "王五");
    map.put("No4", "赵六");
    // 把所有的 values 取出
    Collection values = map.values();
    // 增强for循环
    for (Object obj : values) {
        System.out.println(obj);
    }
    // 迭代器
    Iterator iterator = values.iterator();
    while (iterator.hasNext()) {
        System.out.println(iterator.next());
    }
}

3、获取所有关系k-v

entrySet 方法返回一个 Set，其中包含了 Map 中的所有键值对。每个元素都是一个 Map.Entry 对象，表示一个键值对。我们可以使用迭代器或增强型 for 循环来遍历这个 Set 并访问每个键值对。

public static void main(String[] args) {
    // 使用实现类HashMap 来演示
    Map map = new HashMap();
    map.put("No1", "张三");
    map.put("No2", "李四");
    map.put("No3", "王五");
    map.put("No4", "赵六");
    // 通过 EntrySet 来获取 k-v
    Set set = map.entrySet();
    //增强 for循环
    for (Object obj : set) {
        // 获取 EntrySet 中的每一个元素
        Map.Entry entry = (Map.Entry) obj;
        System.out.println(entry.getKey() + ":" + entry.getValue());
    }
    System.out.println("-----------------------------------------");
    // 迭代器
    Iterator iterator = set.iterator();
    while (iterator.hasNext()) {
        Map.Entry entry = (Map.Entry) iterator.next();
        System.out.println(entry.getKey() + ":" + entry.getValue());
    }
}

三、HashMap

HashMap 是 Map 接口的常见实现类。HashMap 以 key-value 对的形式存储数据，内部使用了一个名为 Node 的结构来保存这些键值对。Node 类实际上是一个简单的容器，包含一个键和一个值。

1、基本结构

HashMap 的底层主要依赖于数组和链表（在 JDK 1.8 及以后版本中还引入了红黑树）。

HashMap 底层使用一个数组来存储键值对，每个数组元素称为一个桶（bucket）。在创建 HashMap 时，会初始化这个数组。当多个键的哈希值映射到同一个数组位置时，会形成哈希冲突。为了解决冲突，HashMap 使用链表来存储冲突的键值对。即每个桶内可以包含多个键值对。从 JDK 1.8 开始，当链表长度大于8且数组长度大于64时，链表会转换成红黑树，以提高查询效率。

2、put 方法流程

判断键值对数组table是否为空或为null，否则执行resize()进行扩容（初始化）
根据键值key计算hash值得到数组索引
判断table[i]==null，条件成立，直接新建节点添加
如果table[i]==null ,不成立

4.1 判断table[i]的首个元素是否和key一样，如果相同直接覆盖value

4.2 判断table[i] 是否为treeNode，即table[i] 是否是红黑树，如果是红黑树，则直接在树中插入键值对

4.3 遍历table[i]，链表的尾部插入数据，然后判断链表长度是否大于8，大于8的话把链表转换为红黑树，在红黑树中执行插入操作，遍历过程中若发现key已经存在直接覆盖value
插入成功后，判断实际存在的键值对数量size是否超多了最大容量threshold（数组长度*0.75），如果超过，进行扩容。

public V put(K key, V value) {
    return putVal(hash(key), key, value, false, true);
}

final V putVal(int hash, K key, V value, boolean onlyIfAbsent,
                   boolean evict) {
    Node&lt;K,V&gt;[] tab; Node&lt;K,V&gt; p; int n, i;
    //判断数组是否未初始化
    if ((tab = table) == null || (n = tab.length) == 0)
        //如果未初始化，调用resize方法 进行初始化
        n = (tab = resize()).length;
    //通过 & 运算求出该数据（key）的数组下标并判断该下标位置是否有数据
    if ((p = tab[i = (n - 1) & hash]) == null)
        //如果没有，直接将数据放在该下标位置
        tab[i] = newNode(hash, key, value, null);
    //该数组下标有数据的情况
    else {
        Node&lt;K,V&gt; e; K k;
        //判断该位置数据的key和新来的数据是否一样
        if (p.hash == hash &&
            ((k = p.key) == key || (key != null && key.equals(k))))
            //如果一样，证明为修改操作，该节点的数据赋值给e,后边会用到
            e = p;
        //判断是不是红黑树
        else if (p instanceof TreeNode)
            //如果是红黑树的话，进行红黑树的操作
            e = ((TreeNode&lt;K,V&gt;)p).putTreeVal(this, tab, hash, key, value);
        //新数据和当前数组既不相同，也不是红黑树节点，证明是链表
        else {
            //遍历链表
            for (int binCount = 0; ; ++binCount) {
                //判断next节点，如果为空的话，证明遍历到链表尾部了
                if ((e = p.next) == null) {
                    //把新值放入链表尾部
                    p.next = newNode(hash, key, value, null);
                    //因为新插入了一条数据，所以判断链表长度是不是大于等于8
                    if (binCount &gt;= TREEIFY_THRESHOLD - 1) // -1 for 1st
                        //如果是，进行转换红黑树操作
                        treeifyBin(tab, hash);
                    break;
                }
                //判断链表当中有数据相同的值，如果一样，证明为修改操作
                if (e.hash == hash &&
                    ((k = e.key) == key || (key != null && key.equals(k))))
                    break;
                //把下一个节点赋值为当前节点
                p = e;
            }
        }
        //判断e是否为空（e值为修改操作存放原数据的变量）
        if (e != null) { // existing mapping for key
            //不为空的话证明是修改操作，取出老值
            V oldValue = e.value;
            //一定会执行  onlyIfAbsent传进来的是false
            if (!onlyIfAbsent || oldValue == null)
                //将新值赋值当前节点
                e.value = value;
            afterNodeAccess(e);
            //返回老值
            return oldValue;
        }
    }
    //计数器，计算当前节点的修改次数
    ++modCount;
    //当前数组中的数据数量如果大于扩容阈值
    if (++size &gt; threshold)
        //进行扩容操作
        resize();
    //空方法
    afterNodeInsertion(evict);
    //添加操作时 返回空值
    return null;
}

3、扩容机制

在添加元素或初始化的时候需要调用resize方法进行扩容，第一次添加数据初始化数组长度为16，以后每次每次扩容都是达到了扩容阈值（数组长度 * 0.75）
每次扩容的时候，都是扩容之前容量的2倍；
扩容之后，会新创建一个数组，需要把老数组中的数据挪动到新的数组中
- 没有hash冲突的节点，则直接使用 e.hash & (newCap - 1) 计算新数组的索引位置
- 如果是红黑树，走红黑树的添加
- 如果是链表，则需要遍历链表，可能需要拆分链表，判断(e.hash & oldCap)是否为0，该元素的位置要么停留在原始位置，要么移动到原始位置+增加的数组大小这个位置上

//扩容、初始化数组
final Node&lt;K,V&gt;[] resize() {
        Node&lt;K,V&gt;[] oldTab = table;
    	//如果当前数组为null的时候，把oldCap老数组容量设置为0
        int oldCap = (oldTab == null) ? 0 : oldTab.length;
        //老的扩容阈值
    	int oldThr = threshold;
        int newCap, newThr = 0;
        //判断数组容量是否大于0，大于0说明数组已经初始化
    	if (oldCap &gt; 0) {
            //判断当前数组长度是否大于最大数组长度
            if (oldCap &gt;= MAXIMUM_CAPACITY) {
                //如果是，将扩容阈值直接设置为int类型的最大数值并直接返回
                threshold = Integer.MAX_VALUE;
                return oldTab;
            }
            //如果在最大长度范围内，则需要扩容  OldCap &lt;&lt; 1等价于oldCap*2
            //运算过后判断是不是最大值并且oldCap需要大于16
            else if ((newCap = oldCap &lt;&lt; 1) &lt; MAXIMUM_CAPACITY &&
                     oldCap &gt;= DEFAULT_INITIAL_CAPACITY)
                newThr = oldThr &lt;&lt; 1; // double threshold  等价于oldThr*2
        }
    	//如果oldCap&lt;0，但是已经初始化了，像把元素删除完之后的情况，那么它的临界值肯定还存在，       			如果是首次初始化，它的临界值则为0
        else if (oldThr &gt; 0) // initial capacity was placed in threshold
            newCap = oldThr;
        //数组未初始化的情况，将阈值和扩容因子都设置为默认值
    	else {               // zero initial threshold signifies using defaults
            newCap = DEFAULT_INITIAL_CAPACITY;
            newThr = (int)(DEFAULT_LOAD_FACTOR * DEFAULT_INITIAL_CAPACITY);
        }
    	//初始化容量小于16的时候，扩容阈值是没有赋值的
        if (newThr == 0) {
            //创建阈值
            float ft = (float)newCap * loadFactor;
            //判断新容量和新阈值是否大于最大容量
            newThr = (newCap &lt; MAXIMUM_CAPACITY && ft &lt; (float)MAXIMUM_CAPACITY ?
                      (int)ft : Integer.MAX_VALUE);
        }
    	//计算出来的阈值赋值
        threshold = newThr;
        @SuppressWarnings({"rawtypes","unchecked"})
        //根据上边计算得出的容量 创建新的数组       
    	Node&lt;K,V&gt;[] newTab = (Node&lt;K,V&gt;[])new Node[newCap];
    	//赋值
    	table = newTab;
    	//扩容操作，判断不为空证明不是初始化数组
        if (oldTab != null) {
            //遍历数组
            for (int j = 0; j &lt; oldCap; ++j) {
                Node&lt;K,V&gt; e;
                //判断当前下标为j的数组如果不为空的话赋值个e，进行下一步操作
                if ((e = oldTab[j]) != null) {
                    //将数组位置置空
                    oldTab[j] = null;
                    //判断是否有下个节点
                    if (e.next == null)
                        //如果没有，就重新计算在新数组中的下标并放进去
                        newTab[e.hash & (newCap - 1)] = e;
                   	//有下个节点的情况，并且判断是否已经树化
                    else if (e instanceof TreeNode)
                        //进行红黑树的操作
                        ((TreeNode&lt;K,V&gt;)e).split(this, newTab, j, oldCap);
                    //有下个节点的情况，并且没有树化（链表形式）
                    else {
                        //比如老数组容量是16，那下标就为0-15
                        //扩容操作*2，容量就变为32，下标为0-31
                        //低位：0-15，高位16-31
                        //定义了四个变量
                        //        低位头          低位尾
                        Node&lt;K,V&gt; loHead = null, loTail = null;
                        //        高位头		   高位尾
                        Node&lt;K,V&gt; hiHead = null, hiTail = null;
                        //下个节点
                        Node&lt;K,V&gt; next;
                        //循环遍历
                        do {
                            //取出next节点
                            next = e.next;
                            //通过 与操作 计算得出结果为0
                            if ((e.hash & oldCap) == 0) {
                                //如果低位尾为null，证明当前数组位置为空，没有任何数据
                                if (loTail == null)
                                    //将e值放入低位头
                                    loHead = e;
                                //低位尾不为null，证明已经有数据了
                                else
                                    //将数据放入next节点
                                    loTail.next = e;
                                //记录低位尾数据
                                loTail = e;
                            }
                            //通过 与操作 计算得出结果不为0
                            else {
                                 //如果高位尾为null，证明当前数组位置为空，没有任何数据
                                if (hiTail == null)
                                    //将e值放入高位头
                                    hiHead = e;
                                //高位尾不为null，证明已经有数据了
                                else
                                    //将数据放入next节点
                                    hiTail.next = e;
                               //记录高位尾数据
                               	hiTail = e;
                            }
                            
                        } 
                        //如果e不为空，证明没有到链表尾部，继续执行循环
                        while ((e = next) != null);
                        //低位尾如果记录的有数据，是链表
                        if (loTail != null) {
                            //将下一个元素置空
                            loTail.next = null;
                            //将低位头放入新数组的原下标位置
                            newTab[j] = loHead;
                        }
                        //高位尾如果记录的有数据，是链表
                        if (hiTail != null) {
                            //将下一个元素置空
                            hiTail.next = null;
                            //将高位头放入新数组的(原下标+原数组容量)位置
                            newTab[j + oldCap] = hiHead;
                        }
                    }
                }
            }
        }
    	//返回新的数组对象
        return newTab;
    }

2023-02-23 该篇文章被子夜打上标签: Java 归为分类: 编程手札

一、常用方法

1、put 方法

2、get 方法

3、remove 方法

4、clear方法

5、size 方法

6、isEmpty方法

7、containsKey 方法

8、containsValue 方法