腳本之家服務(wù)器常用軟件

快捷導(dǎo)航

stream中使用peek一些陷阱避免及解決方法

更新時(shí)間：2023年03月23日 09:09:13 作者：程序那些事

這篇文章主要為大家介紹了stream中使用peek一些陷阱避免及解決方法詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

簡(jiǎn)介

自從JDK中引入了stream之后，仿佛一切都變得很簡(jiǎn)單，根據(jù)stream提供的各種方法，如map，peek，flatmap等等，讓我們的編程變得更美好。

事實(shí)上，我也經(jīng)常在項(xiàng)目中看到有些小伙伴會(huì)經(jīng)常使用peek來(lái)進(jìn)行一些業(yè)務(wù)邏輯處理。

那么既然JDK文檔中說(shuō)peek方法主要是在調(diào)試的情況下使用，那么peek一定存在著某些不為人知的缺點(diǎn)。一起來(lái)看看吧。

peek的定義和基本使用

先來(lái)看看peek的定義：

    Stream<T> peek(Consumer<? super T> action);

peek方法接受一個(gè)Consumer參數(shù)，返回一個(gè)Stream結(jié)果。

而Consumer是一個(gè)FunctionalInterface，它需要實(shí)現(xiàn)的方法是下面這個(gè)：

    void accept(T t);

accept對(duì)傳入的參數(shù)T進(jìn)行處理，但是并不返回任何結(jié)果。

我們先來(lái)看下peek的基本使用：

    public static void peekOne(){
        Stream.of(1, 2, 3)
                .peek(e -> log.info(String.valueOf(e)))
                .toList();
    }

運(yùn)行上面的代碼，我們可以得到：

[main] INFO com.flydean.Main - 1
[main] INFO com.flydean.Main - 2
[main] INFO com.flydean.Main - 3

邏輯很簡(jiǎn)單，就是打印出Stream中的元素而已。

peek的流式處理

peek作為stream的一個(gè)方法，當(dāng)然是流式處理的。接下來(lái)我們用一個(gè)具體的例子來(lái)說(shuō)明流式處理具體是如何操作的。

    public static void peekForEach(){
        Stream.of(1, 2, 3)
                .peek(e -> log.info(String.valueOf(e)))
                .forEach(e->log.info("forEach"+e));
    }

這一次我們把toList方法替換成了forEach，通過(guò)具體的打印日志來(lái)看看到底發(fā)生了什么。

[main] INFO com.flydean.Main - 1
[main] INFO com.flydean.Main - forEach 1
[main] INFO com.flydean.Main - 2
[main] INFO com.flydean.Main - forEach 2
[main] INFO com.flydean.Main - 3
[main] INFO com.flydean.Main - forEach 3

通過(guò)日志，我們可以看出，流式處理的流程是對(duì)應(yīng)流中的每一個(gè)元素，分別經(jīng)歷了peek和forEach操作。而不是先把所有的元素都peek過(guò)后再進(jìn)行forEach。

Stream的懶執(zhí)行策略

之所有會(huì)有流式操作，就是因?yàn)榭赡芤幚淼臄?shù)據(jù)比較多，無(wú)法一次性加載到內(nèi)存中。

所以為了優(yōu)化stream的鏈?zhǔn)秸{(diào)用的效率，stream提供了一個(gè)懶加載的策略。

什么是懶加載呢？

就是說(shuō)stream的方法中，除了部分terminal operation之外，其他的都是intermediate operation.

比如count，toList這些就是terminal operation。當(dāng)接受到這些方法的時(shí)候，整個(gè)stream鏈條就要執(zhí)行了。

而peek和map這些操作就是intermediate operation。

intermediate operation的特點(diǎn)是立即返回，如果最后沒(méi)有以terminal operation結(jié)束,intermediate operation實(shí)際上是不會(huì)執(zhí)行的。

我們來(lái)看個(gè)具體的例子：

    public static void peekLazy(){
        Stream.of(1, 2, 3)
                .peek(e -> log.info(String.valueOf(e)));
    }

運(yùn)行之后你會(huì)發(fā)現(xiàn)，什么輸出都沒(méi)有。

這表示peek中的邏輯并沒(méi)有被調(diào)用，所以這種情況大家一定要注意。

peek為什么只被推薦在debug中使用

如果你閱讀過(guò)peek的文檔，你可能會(huì)發(fā)現(xiàn)peek是只被推薦在debug中使用的，為什么呢？

JDK中的原話是這樣說(shuō)的：

In cases where the stream implementation is able to optimize away the production of some or all the elements (such as with short-circuiting operations like findFirst, or in the example described in count), the action will not be invoked for those elements.

翻譯過(guò)來(lái)的意思就是，因?yàn)閟tream的不同實(shí)現(xiàn)對(duì)實(shí)現(xiàn)方式進(jìn)行了優(yōu)化，所以不能夠保證peek中的邏輯一定會(huì)被調(diào)用。

我們?cè)賮?lái)舉個(gè)例子：

    public static void peekNotExecute(){
        Stream.of(1, 2, 3)
                .peek(e -> log.info("peekNotExecute"+e))
                .count();
    }

這里的terminal operation是count，表示對(duì)stream中的元素進(jìn)行統(tǒng)計(jì)。

因?yàn)閜eek方法中參數(shù)是一個(gè)Consumer，它不會(huì)對(duì)stream中元素的個(gè)數(shù)產(chǎn)生影響，所以最后的運(yùn)行結(jié)果就是3。

peek中的日志輸出并沒(méi)有打印出來(lái)，表示peek沒(méi)有被執(zhí)行。

所以，我們?cè)谑褂胮eek的時(shí)候，一定要注意peek方法是否會(huì)被優(yōu)化。要不然就會(huì)成為一個(gè)隱藏很深的bug。

peek和map的區(qū)別

好了，講到這里，大家應(yīng)該對(duì)peek有了一個(gè)全面的認(rèn)識(shí)了。但是stream中還有一個(gè)和peek類似的方法叫做map。他們有什么區(qū)別呢？

前面我們講到了peek方法需要的參數(shù)是Consumer，而map方法需要的參數(shù)是一個(gè)Function:

    <R> Stream<R> map(Function<? super T, ? extends R> mapper);

Function也是一個(gè)FunctionalInterface,這個(gè)接口需要實(shí)現(xiàn)下面的方法：

    R apply(T t);

可以看出apply方法實(shí)際上是有返回值的，這跟Consumer是不同的。所以一般來(lái)說(shuō)map是用來(lái)修改stream中具體元素的。而peek則沒(méi)有這個(gè)功能。

peek方法接收一個(gè)Consumer的入?yún)? 了解λ表達(dá)式的應(yīng)該明白 Consumer的實(shí)現(xiàn)類應(yīng)該只有一個(gè)方法，該方法返回類型為void. 它只是對(duì)Stream中的元素進(jìn)行某些操作,但是操作之后的數(shù)據(jù)并不返回到Stream中,所以Stream中的元素還是原來(lái)的元素.

map方法接收一個(gè)Function作為入?yún)? Function是有返回值的, 這就表示map對(duì)Stream中的元素的操作結(jié)果都會(huì)返回到Stream中去.

要注意的是，peek對(duì)一個(gè)對(duì)象進(jìn)行操作的時(shí)候,雖然對(duì)象不變,但是可以改變對(duì)象里面的值。

大家可以運(yùn)行下面的例子：

    public static void peekUnModified(){
        Stream.of(1, 2, 3)
                .peek(e -> e=e+1)
                .forEach(e->log.info("peek unModified"+e));
    }
    public static void mapModified(){
        Stream.of(1, 2, 3)
                .map(e -> e=e+1)
                .forEach(e->log.info("map modified"+e));
    }