Java8（3）：Java8 中 Map 接口的新方法

我们提一个需求：给定一个 List<String>，统计每个元素出现的所有位置。

比如，给定 list：["a", "b", "b", "c", "c", "c", "d", "d", "d", "f", "f", "g"] ，那么应该返回：
a : [0]
b : [1, 2]
c : [3, 4, 5]
d : [6, 7, 8]
f : [9, 10]
g : [11]

很明显，我们很适合使用 Map 来完成这件事情：

public static Map<String, List<Integer>> getElementPositions(List<String> list) {
    Map<String, List<Integer>> positionsMap = new HashMap<>();

    for (int i = 0; i < list.size(); i++) {
        String str = list.get(i);
        List<Integer> positions = positionsMap.get(str);

        if (positions == null) { // 如果 positionsMap 还不存在 str 这个键及其对应的 List<Integer>
            positions = new ArrayList<>(1);
            positionsMap.put(str, positions); // 将 str 及其对应的 positions 放入 positionsMap
        }

        positions.add(i); // 将索引加入 str 相关联的 List<Integer> 中
    }

    return positionsMap;
}

public static void main(String[] args) throws Exception {
    List<String> list = Arrays.asList("a", "b", "b", "c", "c", "c", "d", "d", "d", "f", "f", "g");

    System.out.println("使用 Java8 之前的 API：");
    Map<String, List<Integer>> elementPositions = getElementPositions(list);
    System.out.println(elementPositions);
}

运行结果：

Java8 时，Map<K, V> 接口添加了一个新的方法，putIfAbsent(K key, V value)，功能是：
如果当前 Map 不存在键 key 或者该 key 关联的值为 null，那么就执行 put(key, value)；否则，便不执行 put 操作。该方法等价于如下代码：

（题外话：putIfAbsent 方法与 put 方法一样，返回的是方法调用之前与参数 key 相关联的 value）

使用 putIfAbsent 修改 getElementPositions 方法：

public static Map<String, List<Integer>> getElementPositions(List<String> list) {
    Map<String, List<Integer>> positionsMap = new HashMap<>();

    for (int i = 0; i < list.size(); i++) {
        String str = list.get(i);
        positionsMap.putIfAbsent(str, new ArrayList<>(1)); // 如果 positionsMap 不存在键 str 或者 str 关联的 List<Integer> 为 null，那么就会进行 put；否则不执行 put
        positionsMap.get(str).add(i);
    }

    return positionsMap;
}

public static void main(String[] args) throws Exception {
    List<String> list = Arrays.asList("a", "b", "b", "c", "c", "c", "d", "d", "d", "f", "f", "g");

    System.out.println("使用 putIfAbsent：");
    Map<String, List<Integer>> elementPositions = getElementPositions(list);
    System.out.println(elementPositions);
}

运行结果：

可以看到使用 putIfAbsent 之后的 getElementPositions 简洁了一点，那还能更简洁吗？

查看 Map 接口的方法，可以发现在 JDK1.8 时，还添加了如下两个方法：

查看 compute 方法的 API 文档，可以发现 compute 方法与如下代码等价

 V oldValue = map.get(key);
 V newValue = remappingFunction.apply(key, oldValue);
 if (oldValue != null ) {
    if (newValue != null)
       map.put(key, newValue);
    else
       map.remove(key);
 } else { // 即 原来的 key 不存在 Map 中或该 key 关联的 value 为 null
    if (newValue != null)
       map.put(key, newValue);
    else
       return null;
 }

compute 方法和原来 put 方法的区别在于：

put(K key, V value) 方法，如果 key 在 Map 中不存在，那么直接加入；如果已经存在，那么使用新的 value 替换旧的 value；

而 compute(K key, BiFunction remappingFunction) 方法可以通过一个 BiFunction 来计算出新的 value，BiFunction 的参数为旧的 key 和 value，返回计算出新的 value —— 与 put 方法不同，compute 方法返回的会是最新的与 key 相关联的 value，而不是旧的 value。
所以可以使用 compute 方法改写 getElementPositions 如下：

public static Map<String, List<Integer>> getElementPositions(List<String> list) {
    Map<String, List<Integer>> positionsMap = new HashMap<>();

    for (int i = 0; i < list.size(); i++) {
        positionsMap.compute(list.get(i), (k, v) -> v == null ? new ArrayList<>(1) : v).add(i);
    }

    return positionsMap;
}

public static void main(String[] args) throws Exception {
    List<String> list = Arrays.asList("a", "b", "b", "c", "c", "c", "d", "d", "d", "f", "f", "g");

    System.out.println("使用 compute：");
    Map<String, List<Integer>> elementPositions = getElementPositions(list);
    System.out.println(elementPositions);
}

(k, v) -> v == null ? new ArrayList<>(1) : v 即 如果当前的 value 为 null，那么 该 BiFunction 的返回值为 new ArrayList<>(1)；如果不为 null，那么返回值便是本身。而且因为 compute 方法会返回新的 value —— 此时便是与 list.get(i)（key） 相关联的 ArrayList —— 所以我们可以直接调用其 add 方法。

运行结果：

很棒~ 还能更简洁吗？ 我们再看看 computeIfAbsent 方法：
computeIfAbsent 和 compute 的关系，就类似于 putIfAbsent 和 put的关系：
computeIfAbsent 在 key 不在 Map 中或者与 key 相关联的 value 为 null 时，才执行通过函数计算新 value 的操作，否则不执行；computeIfAbsent 的返回值也是与 key 相关联的最新的 value。其默认实现如下：

与 compute 不同，computeIfAbsent 接受的函数操作是 Function 而不是 BiFunction —— 这很好理解，computeIfAbsent 只在 key 不在 Map 中或者与 key 相关联的 value 为 null 时才执行函数操作，那么显然此时与 key 相关的 value 为 null，所以 computeIfAbsent 只接受 Function 作为参数即可 —— 该 Function 可以使用 key 作为参数计算出新的 value。使用 computeIfAbsent 改写 getElementPositions：

public static Map<String, List<Integer>> getElementPositions(List<String> list) {
    Map<String, List<Integer>> positionsMap = new HashMap<>();

    for (int i = 0; i < list.size(); i++) {
        positionsMap.computeIfAbsent(list.get(i), k -> new ArrayList<>(1)).add(i);
    }

    return positionsMap;
}

public static void main(String[] args) throws Exception {
    List<String> list = Arrays.asList("a", "b", "b", "c", "c", "c", "d", "d", "d", "f", "f", "g");

    System.out.println("使用 computeIfAbsent：");
    Map<String, List<Integer>> elementPositions = getElementPositions(list);
    System.out.println(elementPositions);
}

运行结果：

事实上，本文使用 putIfAbsent 时是存在问题的，positionsMap.putIfAbsent(str, new ArrayList<>(1)); 这句代码每次调用时都会产生一个临时的 ArrayList —— 当遍历的 List<String> 较大时，这可能会带来一定的负面影响；相比之下 compute 和 computeIfAbsent 的好处在于，它们接受的参数为函数，只会在必要时才使用函数进行计算得出新 value。在本文类似需求的情况下，就适用性和简洁性而言，computeIfAbsent 要优于 compute。在 JDK1.8 的 API 文档中，也说到在需要生成一个类似于 Map<K, Collection<V>> 的结构时，computeIfAbsent 很适合这种情况：

那 compute 方法适用于什么情况呢？从前面的介绍可知，compute 方法更适用于更新 key 关联的 value 时，新值依赖于旧值的情况 —— 比如统计一个 List<String> 中每个元素出现的次数：

public static Map<String, Integer> getElementCounts(List<String> list) {
    Map<String, Integer> countsMap = new HashMap<>();

    list.forEach(str -> countsMap.compute(str, (k, v) -> v == null ? 1 : v + 1)); // 此时：新值 = 旧值 + 1

    return countsMap;
}

public static void main(String[] args) throws Exception {
    List<String> list = Arrays.asList("a", "b", "b", "c", "c", "c", "d", "d", "d", "f", "f", "g");
    System.out.println("使用 compute 计算元素出现的次数：");
    Map<String, Integer> counts = getElementCounts(list);
    System.out.println(counts);
}

运行结果：

Java8 中还为 Map 添加了一些其他方便于编码的新方法，请有兴趣的读者继续发掘。