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 添加了一些其余方便于编码的新方法，请有兴趣的读者继续发掘。