详解Map.merge()

今天介绍Map的merge方法，让咱们来看看它的强大之处。

在JDK的API中，这样的一个方法它是很特别的，它很新颖，它是值得咱们花时间去了解的，同时也推荐你能够运用到实际的项目代码中，对大家应该帮助很大。Map.merge（）。这多是Map中最通用的操做。但它也至关模糊，几乎不多人会去使用它。

背景介绍

merge()能够解释以下：它将新的值赋值给到key中（若是不存在）或更新具备给定值的现有key（UPSERT）。让咱们从最基本的例子开始：计算惟一的单词出现次数。在java8以前的时候，代码很是混乱，实际的实现其实已经失去了本质层面的设计意义。

var map = new HashMap<String, Integer>();
words.forEach(word -> {
    var prev = map.get(word);
    if (prev == null) {
        map.put(word, 1);
    } else {
        map.put(word, prev + 1);
    }
});

复制代码

按照上述代码的逻辑，假设给定一个输入集合，输出的结果以下；

var words = List.of("Foo", "Bar", "Foo", "Buzz", "Foo", "Buzz", "Fizz", "Fizz");
//...
{Bar=1, Fizz=2, Foo=3, Buzz=2}
复制代码

改进V1

如今让咱们来重构它，主要去掉它的一些判断逻辑；

words.forEach(word -> {
    map.putIfAbsent(word, 0);
    map.put(word, map.get(word) + 1);
});
复制代码

这样的改进，是能够知足咱们的重构要求。putIfAbsent()的具体用法就不过多描述。putIfAbsent那一行代码是必定须要的，不然，后面的逻辑也就会报错。而在下面代码中，又出现了put、get这一点会很奇怪，让咱们再继续的进行改进设计。

改进V2

words.forEach(word -> {
    map.putIfAbsent(word, 0);
    map.computeIfPresent(word, (w, prev) -> prev + 1);
});

复制代码

computeIfPresent是仅当 word中的的key存在的时候才调用给定的转换。不然它什么都不处理。咱们经过将key初始化为零来确保key存在，所以增量始终有效。这样的实现是否是已经足够完美？未必，还有其余的思路能够减小额外的初始化。

words.forEach(word ->
        map.compute(word, (w, prev) -> prev != null ? prev + 1 : 1)
);
复制代码

compute ()就像是computeIfPresent()，但不管给定key的存在与否如何都会调用它。若是key的值不存在，则prev参数为null。将简单移动if 到隐藏在lambda中的三元表达式也远远没有达到最佳的表现。在我向你展现最终版本以前，让咱们看一下稍微简化的默认实现Map.merge()源码分析。

改进V3

merge()源码

default V merge(K key, V value, BiFunction<V, V, V> remappingFunction) {
    V oldValue = get(key);
    V newValue = (oldValue == null) ? value :
               remappingFunction.apply(oldValue, value);
    if (newValue == null) {
        remove(key);
    } else {
        put(key, newValue);
    }
    return newValue;
}
复制代码

代码片断赛过千言万语。 阅读源码老是可以发现新大陆，merge() 适用于两种状况。若是给定的key不存在，它就变成了put(key, value)。可是，若是key已经存在一些值，咱们 remappingFunction 能够选择合并的方式。这个功能是完美契机上面的场景：

• 只需返回新值便可覆盖旧值： (old, new) -> new
• 只需返回旧值便可保留旧值：(old, new) -> old
• 以某种方式合并二者，例如：(old, new) -> old + new
• 甚至删除旧值：(old, new) -> null

如你所见，它 merge() 是很是通用的。那么，咱们的问题该如何使用merge()呢？代码以下：

words.forEach(word ->
        map.merge(word, 1, (prev, one) -> prev + one)
);
复制代码

你能够按照以下思路理解：若是没有key，那么初始化的value等于1；不然，将1添加到现有值。代码中的 one 是一个常量，由于咱们的场景中，默认一直是加1，具体变化能够随意切换。

场景

想象一下，merge()真的那么好用吗？它的场景能够有什么？

举一个例子。你有一个账户操做类

class Operation {
    private final String accNo;
    private final BigDecimal amount;
}
复制代码

以及针对不一样账户的一系列操做：

operations = List.of(
    new Operation("123", new BigDecimal("10")),
    new Operation("456", new BigDecimal("1200")),
    new Operation("123", new BigDecimal("-4")),
    new Operation("123", new BigDecimal("8")),
    new Operation("456", new BigDecimal("800")),
    new Operation("456", new BigDecimal("-1500")),
    new Operation("123", new BigDecimal("2")),
    new Operation("123", new BigDecimal("-6.5")),
    new Operation("456", new BigDecimal("-600"))
);

复制代码

咱们但愿为每一个账户计算余额（总运营金额）。假如不用merge()，就变得很是麻烦了：

Map balances = new HashMap<String, BigDecimal>();
operations.forEach(op -> {
    var key = op.getAccNo();
    balances.putIfAbsent(key, BigDecimal.ZERO);
    balances.computeIfPresent(key, (accNo, prev) -> prev.add(op.getAmount()));
});

复制代码

使用merge以后的代码

operations.forEach(op ->
        balances.merge(op.getAccNo(), op.getAmount(), 
                (soFar, amount) -> soFar.add(amount))
);


复制代码

再进行优化的逻辑。

operations.forEach(op ->
        balances.merge(op.getAccNo(), op.getAmount(), BigDecimal::add)
);
复制代码

固然结果是正确的，这样简洁的代码心动吗？对于每一个操做，add在给定的amount给定accNo。

{ 123 = 9.5，456 = - 100 }

复制代码

ConcurrentHashMap

当咱们再延伸到ConcurrentHashMap来，当 Map.merge的出现，和ConcurrentHashMap的结合那是很是的完美的。这样的搭配场景是对于那些自动执行插入或者更新操做的单线程安全的逻辑。