Почему ключ Stream toMap() не может дублироваться, а значение не может быть нулевым

В большинстве JDK, включая Oracle и OpenJDK, метод Collectors.toMap запрещает дубликаты, нулевые ключи и нулевые значения, потому что это возможно! Как ни странно, на самом деле это преимущество.

Прежде всего, давайте посмотрим, что говорит документация. Collectors.toMap говорит: «Нет никаких гарантий относительно типа, изменчивости, сериализуемости или потокобезопасности возвращаемой карты».

Поэтому мы можем только предположить, что возвращаемая карта — это какой-то класс, реализующий интерфейс Map. И, в свою очередь, в документации Map говорится, что «некоторые реализации запрещают нулевые ключи и значения». Следовательно, Collectors.toMap() действительно может запрещать нулевые значения.

Но подождите: в реализациях OpenJDK и Oracle мы видим, что Collectors.toMap() на самом деле возвращает HashMap, а класс HashMap четко задокументирован и допускает нулевые ключи и значения. Так почему же toMap() им не позволяет?

Представьте себе, что это так, и вы пишете программу, которая работает хорошо в течение многих лет, а затем передаете ее коллеге или клиенту, и они запускают ее с использованием JDK другого поставщика. Затем происходит сбой, потому что ваше приложение на самом деле вело себя не очень хорошо, но вы об этом не знали. Запрещая нулевые ключи и значения, эта реализация оказывает вам услугу.

Для коллекционера toMap:

1. Дублирование keys допускается при реализации mergeFunction
2. Null для values запрещены, иначе они будут конфликтовать с функцией удаления записей.

Коллектор toMap, содержащий BinaryOperator<U> mergeFunction, вызывает функцию map.merge, которой также передается BinaryOperator<U> mergeFunction:

BiConsumer<M, T> accumulator = (map, element) -> map.merge(
    keyMapper.apply(element),
    valueMapper.apply(element),
    mergeFunction);                   // <---

Функция merge выглядит следующим образом:

default V merge(K key, V value,
        BiFunction<? super V, ? super V, ? extends V>
            remappingFunction) {      // mergeFunction
    Objects.requireNonNull(remappingFunction);
    Objects.requireNonNull(value);    // <---
    V oldValue = get(key);
    V newValue = (oldValue == null)
        ? value
        : remappingFunction.apply(oldValue, value);
    if (newValue == null) {
        remove(key);                  // <---
    } else {
        put(key, newValue);
    }
    return newValue;
}

То есть mergeFunction позволяет не только выбирать между старым и новым значениями одних и тех же ключей, но и полностью удалить запись.

Например:

class Pair {
    final String k, v;
    public Pair(String k, String v) { this.k = k; this.v = v; }
}

final var arr = new Pair[]{
    new Pair("A", "val_1"),
    new Pair("B", "val_2"),
    new Pair("A", "val_3"),
};

System.out.println(Stream.of(arr).collect(Collectors
    .toMap(p -> p.k, p -> p.v, (v1, v2) -> v1)));       // {A=val_1, B=val_2}
System.out.println(Stream.of(arr).collect(Collectors
    .toMap(p -> p.k, p -> p.v, (v1, v2) -> v2)));       // {A=val_3, B=val_2}
System.out.println(Stream.of(arr).collect(Collectors
    .toMap(p -> p.k, p -> p.v, (v1, v2) -> v1 + v2)));  // {A=val_1val_3, B=val_2}
System.out.println(Stream.of(arr).collect(Collectors
    .toMap(p -> p.k, p -> p.v, (v1, v2) -> null)));     // {B=val_2}

Что делать, если мне не нужен такой toMap функционал коллектора?

Вы можете использовать свой собственный коллектор:

public static <T, K, V> Collector<T, ?, Map<K, V>> toHashMap(
    Function<? super T, ? extends K> keyMapper,
    Function<? super T, ? extends V> valueMapper) {
    return Collectors.collectingAndThen(
        Collectors.toList(),
        list -> {
            var map = new HashMap<K, V>();
            list.forEach(element ->
                map.put(
                    keyMapper.apply(element),
                    valueMapper.apply(element)));
            return map;
        });
}

System.out.println(Stream.of(arr).collect(toHashMap(p -> p.k, p -> p.v)));