java stream中的peek()用法

向右看齐 2024-03-31 12:01 101阅读 0赞

#### 文章目录 ####

*   *  前言
     *  最终操作（terminal operation）
     *  peek() vs forEach()
     *  peek() 的典型用法：协助调试
     *  总结

### 前言 ###

最近看到一段代码：

aeFormList.stream().peek(object -> saveInfomation(object, params)).collect(Collectors.toList());

之前没有用过peek，于是查了一下，peek的作用是：

> 改变元素的内部状态

从这句话中可以看出，上面代码的意思是：对每个`object`执行 `saveInfomation(object, params)`，然后把结果收集到一个 List 里。  
这里涉及到了`最终操作`。

### 最终操作（terminal operation） ###

`peek() 并不是一个最终操作（terminal operation）`。stream 被设计为“`元素只有在最终操作需要时才会被处理`”。如果没有最终操作的“拉动”，那么 stream 中就没有操作会真正执行。

在上面的例子中，`.collect(Collectors.toList())`就是一个最终操作，而且这个操作会“拉动”所有元素。这样一来，每个元素都一定会被应用 peek() 方法。

但在使用 peek() 时仍然需要注意，因为它只保证作用于流经管道的元素，但并不保证全部元素都会流经管道。

### peek() vs forEach() ###

`forEach() 则是一个最终操作`。除此之外，peek() 和 forEach() 再无其他不同。

那么到底什么是最终操作，我们看如下代码：

使用了`forEach()`之后，在结尾使用`.collect`方法会报错。因为`forEach() 已经是一个最终操作`无法再添加最终操作。

![在这里插入图片描述][8b8ee42df5c1431fa92f2e32caab168c.png]  
在使用`peek()`之后，可以使用`.collect`方法。  
![在这里插入图片描述][f2284115a1334d76a054d1410b510243.png]

### peek() 的典型用法：协助调试 ###

正因为 peek() 不是一个最终操作，不会影响“哪些元素会流过”，所以十分适合在调试的时候，用来打印出流经管道的元素。例如：

Stream.of("one", "two", "three", "four")
             .filter(e -> e.length() > 3)
             .peek(e -> System.out.println("Filtered value: " + e))
             .map(String::toUpperCase)
             .peek(e -> System.out.println("Mapped value: " + e))
             .collect(Collectors.toList());

### 总结 ###

1.  如果想对流经的每个元素应用一个函数，从而改变某些状态，那么请用 `forEach()`；
2.  如果想打印流经的每个元素的状态（日志或 debug），这时应该用`peek()`；

[8b8ee42df5c1431fa92f2e32caab168c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/2a1f2c7592f543c1bf00d1dc9a99d55c.png
[f2284115a1334d76a054d1410b510243.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/31/2c5fa3f9716e43e1b217cc95311020ee.png