Чи антипатерн використовувати 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)...

Але це вводить функціональний код (the return), і я не переконаний, що це зрозуміліше, тому що ви знаєте, peek()повертає той самий об'єкт, але з першого map()погляду навіть не зрозуміло, що це той самий клас об'єктів.

Далі, у peek()вас може бути лямбда, яка мутує, але з map()вами доведеться побудувати аварію поїзда. Порівняйте:

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

Я думаю, що peek()версія зрозуміліша, а лямбда явно мутує, тому "загадкового" побічного ефекту немає. Аналогічно, якщо використовується посилання на метод, а назва методу чітко передбачає мутацію, це теж зрозуміло і очевидно.

В особистій записці я не цураюся використання peek()мутації - мені здається, що це дуже зручно.

Ви правильні, "заглянути" в англійському розумінні цього слова означає "дивись, але не чіпай".

Однак в JavaDoc стану:

заглянути

Потоковий погляд (Споживчі дії)

Повертає потік, що складається з елементів цього потоку, додатково виконуючи надану дію на кожен елемент, оскільки елементи споживаються з отриманого потоку.

Ключові слова: "виконання ... дії" та "спожито". У 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 Цей метод існує головним чином для підтримки налагодження, де потрібно * бачити елементи, коли вони проходять повз певну точку трубопроводу: *

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