Это антипаттерн, чтобы использовать peek () для изменения элемента потока?

Предположим, у меня есть поток вещей, и я хочу «обогатить» их серединой потока, я могу использовать peek()это, например:

streamOfThings.peek(this::thingMutator).forEach(this::someConsumer);

Предположим, что изменение объектов в этой точке в коде является правильным поведением - например, thingMutatorметод может установить в поле «lastProcessed» текущее время.

Однако peek()в большинстве случаев означает «смотри, но не трогай».

Пользуемся peek()для мутировать элементы потока в антипаттернах или опрометчиво?

Редактировать:

Альтернативный, более традиционный подход заключается в том, чтобы преобразовать потребителя:

private void thingMutator(Thing thing) {
    thing.setLastProcessed(System.currentTimeMillis());
}

к функции, которая возвращает параметр:

private Thing thingMutator(Thing thing) {
    thing.setLastProcessed(currentTimeMillis());
    return thing;
}

и используйте map()вместо этого:

stream.map(this::thingMutator)...

Но это вводит небрежный код ( return), и я не уверен, что он понятнее, потому что, как вы знаете, peek()возвращает тот же объект, но с первого map()взгляда даже не ясно, что это тот же класс объекта.

Кроме того, у peek()вас может быть лямбда, которая мутирует, но с map()вами придется строить крушение поезда. Для сравнения:

stream.peek(t -> t.setLastProcessed(currentTimeMillis())).forEach(...)
stream.map(t -> {t.setLastProcessed(currentTimeMillis()); return t;}).forEach(...)

Я думаю, что peek()версия более понятна, и лямбда явно мутирует, поэтому нет «таинственного» побочного эффекта. Точно так же, если используется ссылка на метод и название метода явно подразумевает мутацию, это тоже ясно и очевидно.

Что peek()касается меня , я не уклоняюсь от использования для изменения - я нахожу это очень удобным.

Вы правы, «заглянуть» в английском смысле слова означает «смотри, но не трогай».

Однако в JavaDoc состояния:

заглядывать

Stream peek (Consumer action)

Возвращает поток, состоящий из элементов этого потока, дополнительно выполняя предоставленное действие для каждого элемента, поскольку элементы потребляются из результирующего потока.

Ключевые слова: «совершать ... действие» и «потреблять». JavaDoc очень ясно, что мы должны peekиметь возможность изменять поток.

Однако JavaDoc также заявляет:

API Примечание:

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

Это указывает на то, что оно предназначено для наблюдения, например, для регистрации элементов в потоке.

То , что я беру из всего этого является то , что мы можем выполнять действия с использованием элементов в потоке, но следует избегать мутирует элементов в потоке. Например, продолжайте и вызывайте методы для объектов, но старайтесь избегать операций с ними над ними.

По крайней мере, я бы добавил краткий комментарий к вашему коду:

// Note: this peek() call will modify the Things in the stream.
streamOfThings.peek(this::thingMutator).forEach(this::someConsumer);

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

Это может быть легко неверно истолковано, поэтому я бы избегал использовать его таким образом. Вероятно, лучший вариант - использовать лямбда-функцию для объединения двух необходимых действий в вызов forEach. Вы также можете рассмотреть возможность возврата нового объекта, а не изменения существующего объекта - он может быть немного менее эффективным, но, вероятно, приведет к более читаемому коду и уменьшит вероятность случайного использования измененного списка для другой операции, которая должна получили оригинал.

Замечание по API говорит нам, что метод был добавлен в основном для таких действий, как отладка / регистрация / статистика запуска и т. Д.

@apiNote Этот метод существует главным образом для поддержки отладки, где вы хотите * видеть элементы по мере их прохождения через определенную точку в конвейере: *

       {@код
     * Stream.of («один», «два», «три», «четыре»)
     * .filter (e -> e.length ()> 3)
     * .peek (e -> System.out.println ("Отфильтрованное значение:" + e))
     * .map (String :: toUpperCase)
     * .peek (e -> System.out.println ("Отображенное значение:" + e))
     * .collect (Collectors.toList ());
     *}