Bir stream öğesini değiştirmek için peek () kullanmak bir antipattern mı?

Diyelim ki bir şeyler akışım var ve onları orta akışta "zenginleştirmek" istiyorum, bunu peek()yapmak için kullanabilirim , örneğin:

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

Şeylerin kodda bu noktada mutasyona tabi tutulmasının doğru bir davranış olduğunu varsayalım - örneğin, thingMutatoryöntem "lastProcessed" alanını şimdiki zamana ayarlayabilir.

Ancak, peek()çoğu bağlamda "bak, ama dokunma" anlamına gelir.

Kullanarak mı peek()hiç mutasyon akışı elemanları bir antipattern veya tedbirsiz?

Düzenle:

Alternatif, daha geleneksel yaklaşım, tüketiciyi dönüştürmek olacaktır:

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

parametre döndüren bir işleve:

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

ve map()bunun yerine kullanın:

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

Ancak bu, perfunctory kodunu (the return) tanıtır ve bunun daha açık olduğuna ikna olmadım, çünkü peek()aynı nesneyi döndürdüğünü biliyorsunuz , ancak map()bir bakışta aynı nesne sınıfı olduğu bile belli değil .

Ayrıca, peek()mutasyona uğrayan bir lambdaya sahip olabilirsiniz, ancak map()sizinle birlikte bir tren kazası yapmak zorundasınız. Karşılaştırmak:

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

Bence peek()sürüm daha net ve lambda açıkça mutasyona uğramış, bu yüzden "gizemli" bir yan etkisi yok. Benzer şekilde, eğer bir yöntem referansı kullanılırsa ve yöntemin adı açıkça mutasyon anlamına gelirse, bu da açık ve açıktır.

Kişisel bir notta, peek()mutasyona uğramaktan çekinmekten çekinmiyorum - çok uygun buluyorum.

Haklısın, ingilizce anlamında "gözetleme" anlamında "bak, ama dokunma" anlamına geliyor.

Ancak javadoc durumları:

dikizlemek

Akış peek (Tüketici eylemi)

Bu akıştaki elementlerden oluşan bir akış döndürür, ayrıca elementler elde edilen akıştan tüketilirken her element üzerinde sağlanan eylemi gerçekleştirir.

Anahtar kelimeler: "gerçekleştirme ... eylemi" ve "tüketilen". JavaDoc, peekakışı değiştirme yeteneğine sahip olmamızı beklediğimiz konusunda çok açık .

Ancak JavaDoc ayrıca şunları da belirtir:

API Notu:

Bu yöntem temel olarak, bir boru hattında belirli bir noktadan akarken öğeleri görmek istediğiniz hata ayıklamayı desteklemek için mevcuttur.

Bu, örneğin akıştaki günlük öğelerinin kaydedilmesi için daha fazla amaçlandığını gösterir.

Ya bu tümünden almak biz eylemleri gerçekleştirmek olmasıdır kullanarak akışında elemanları, ancak kaçınmalıdır mutasyona akışında unsurları. Örneğin, devam edin ve nesnelerdeki yöntemleri çağırın, ancak üzerlerindeki işlemleri değiştirmekten kaçının.

En azından bu satırlar boyunca kodunuza kısa bir yorum eklerdim:

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

Görüşler, bu tür yorumların yararlılığına göre farklılık gösterir, ancak bu durumda böyle bir yorum kullanırdım.

Kolayca yanlış yorumlanabilir, bu yüzden böyle kullanmaktan kaçınırdım. Muhtemelen en iyi seçenek, forEach çağrısına ihtiyaç duyduğunuz iki işlemi birleştirmek için bir lambda işlevi kullanmaktır. Ayrıca, mevcut olanı değiştirmek yerine yeni bir nesne döndürmeyi düşünebilirsiniz - biraz daha az verimli olabilir, ancak daha okunabilir bir kodla sonuçlanması muhtemeldir ve yanlışlıkla değiştirilmesi gereken başka bir işlem için değiştirilmiş listeyi kullanma olasılığını azaltır. orijinali aldım.

API notu, yöntemin çoğunlukla hata ayıklama / günlüğe kaydetme / ateşleme istatistikleri gibi eylemler için eklendiğini söyler.

@ apiNote Bu yöntem temel olarak, bir boru hattında belirli bir noktadan akarken öğeleri görmek istediğiniz * ayıklamayı desteklemek için mevcuttur:

       {@code
     * Stream.of ("bir", "iki", "üç", "dört")
     * .filter (e -> e.length ()> 3)
     * .peek (e -> System.out.println ("Süzülmüş değer:" + e))
     * .map (String :: toUpperCase)
     * .peek (e -> System.out.println ("Eşlenmiş değer:" + e))
     * .collect (Collectors.toList ());
     *}