Czy to antipattern, aby użyć peek () do zmodyfikowania elementu strumienia?

Załóżmy, że mam strumień Rzeczy i chcę je „wzbogacić” w połowie strumienia, mogę peek()to zrobić, np .:

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

Załóżmy, że mutowanie Rzeczy w tym punkcie kodu jest poprawnym zachowaniem - na przykład thingMutatormetoda może ustawić pole „lastProcessor” na bieżący czas.

Jednak peek()w większości kontekstów oznacza „patrz, ale nie dotykaj”.

Używa peek()się mutować elementów Stream antywzorzec projektowy lub nierozważne?

Edytować:

Alternatywnym, bardziej konwencjonalnym podejściem byłoby przekonanie konsumenta:

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

do funkcji, która zwraca parametr:

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

i użyj map()zamiast tego:

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

Ale to wprowadza kod obłędny ( return) i nie jestem przekonany, że jest bardziej przejrzysty, ponieważ wiesz, że peek()zwraca ten sam obiekt, ale map()na pierwszy rzut oka nie jest nawet jasne, że jest to ta sama klasa obiektu.

Co więcej, peek()możesz mieć mutację lambda, ale wraz z map()tobą musisz zbudować wrak pociągu. Porównać:

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

Myślę, że peek()wersja jest wyraźniejsza, a lambda wyraźnie mutuje, więc nie ma „tajemniczego” efektu ubocznego. Podobnie, jeśli używane jest odwołanie do metody, a nazwa metody wyraźnie implikuje mutację, to również jest jasne i oczywiste.

Osobiście nie waham się używać peek()mutacji - uważam to za bardzo wygodne.

Masz rację, „zerknięcie” w angielskim znaczeniu oznacza „patrz, ale nie dotykaj”.

Jednak gdy javadoc stany:

zerkać

Stream peek (akcja konsumencka)

Zwraca strumień składający się z elementów tego strumienia, dodatkowo wykonując podaną akcję na każdym elemencie, gdy elementy są konsumowane z wynikowego strumienia.

Słowa kluczowe: „wykonywanie ... akcji” i „pochłonięty”. JavaDoc jest bardzo jasne, że powinniśmy oczekiwać peekmożliwości modyfikacji strumienia.

Jednak JavaDoc stwierdza również:

Uwaga API:

Ta metoda istnieje głównie w celu obsługi debugowania, w którym chcesz zobaczyć elementy przepływające przez określony punkt w potoku

Wskazuje to, że jest przeznaczony bardziej do obserwacji, np. Rejestruje elementy w strumieniu.

Biorę z tego wszystko, że możemy wykonywać działania przy użyciu elementów w strumieniu, ale powinniśmy unikać mutowania elementów w strumieniu. Na przykład idź dalej i wywoływaj metody na obiektach, ale staraj się unikać mutowania na nich operacji.

Przynajmniej dodam krótki komentarz do twojego kodu w następujący sposób:

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

Opinie na temat przydatności takich komentarzy są różne, ale użyłbym takiego komentarza w tym przypadku.

Może być łatwo źle zinterpretowany, więc unikałbym używania go w ten sposób. Prawdopodobnie najlepszą opcją jest użycie funkcji lambda do połączenia dwóch potrzebnych działań w wywołanie forEach. Możesz również rozważyć zwrócenie nowego obiektu zamiast mutowania istniejącego - może być nieco mniej wydajny, ale może skutkować bardziej czytelnym kodem i zmniejsza ryzyko przypadkowego użycia zmodyfikowanej listy do innej operacji, która powinna otrzymałem oryginał.

Nota API mówi nam, że metoda została dodana głównie do akcji takich jak debugowanie / rejestrowanie / odpalanie statystyk itp.

@apiNote Ta metoda istnieje głównie w celu obsługi debugowania, w której chcesz * widzieć elementy przepływające przez określony punkt w potoku: *

       {@kod
     * Stream.of („jeden”, „dwa”, „trzy”, „cztery”)
     *. filtr (e -> e.length ()> 3)
     * .peek (e -> System.out.println („Filtrowana wartość:” + e))
     * .map (String :: toUpperCase)
     * .peek (e -> System.out.println („Wartość odwzorowana:” + e))
     * .collect (Collectors.toList ());
     *}