Java常用类 - Stream流函数

2024-09-22 总结总结评论

Stream流函数

初步认识

在JAVA中，涉及到对数组、Collection等集合类中的元素进行操作的时候，通常会通过循环的方式进行逐个处理，或者使用Stream的方式进行处理。

例如，现在有这么一个需求：

从给定句子中返回单词长度大于7的单词列表，按长度倒序输出，最多返回5个：在JAVA7及之前的代码中，我们会可以照如下的方式进行实现：

public List<String> sortGetTop5LongWords(@NotNull String sentence) {
    // 先切割句子，获取具体的单词信息
    String[] words = sentence.split(" ");
    List<String> wordList = new ArrayList<>();
    // 循环判断单词的长度，先过滤出符合长度要求的单词
    for (String word : words) {
        if (word.length() > 7) {
            wordList.add(word);
        }
    }
    // 对符合条件的列表按照长度进行排序
    wordList.sort((o1, o2) -> o2.length() - o1.length());
    // 判断list结果长度，如果大于3则截取前三个数据的子list返回
    if (wordList.size() > 5) {
        wordList = wordList.subList(0, 5);
    }
    return wordList;
}

在JAVA8及之后的版本中，引入了Stream流，我们可以更加优雅的写出如下代码：


public List<String> sortGetTop5LongWordsByStream(@NotNull String sentence) {
    return Arrays.stream(sentence.split(" "))
            .filter(word -> word.length() > 7)
            .sorted((o1, o2) -> o2.length() - o1.length())
            .limit(5)
            .collect(Collectors.toList());
}

直观感受上，Stream的实现方式代码更加简洁、一气呵成。很多的同学在代码中也经常使用Stream流，但是对Stream流的认知往往也是仅限于会一些简单的filter、map、collect等操作，但JAVA的Stream可以适用的场景与能力远不止这些。

基本介绍

Stream流操作分为3种类型：

创建Stream
Stream中间处理
终止Steam

每个Stream管道操作类型都包含若干API方法，先列举下各个API方法的功能介绍。

开始管道

主要负责新建一个Stream流，或者基于现有的数组、List、Set、Map等集合类型对象创建出新的Stream流。

stream()：创建出一个新的stream串行流对象

parallelStream()：创建出一个可并行执行的stream流对象

Stream.of()：通过给定的一系列元素创建一个新的Stream串行流对象

中间管道

负责对Stream进行处理操作，并返回一个新的Stream对象，中间管道操作可以进行叠加。

filter()：按照条件过滤符合要求的元素， 返回新的stream流

map()：将已有元素转换为另一个对象类型，一对一逻辑，返回新的stream流

flatMap()：将已有元素转换为另一个对象类型，一对多逻辑，即原来一个元素对象可能会转换为1个或者多个新类型的元素，返回新的stream流

limit()：仅保留集合前面指定个数的元素，返回新的stream流

skip()：跳过集合前面指定个数的元素，返回新的stream流

concat()：将两个流的数据合并起来为一个新的流，返回新的stream流

distinct()：对Stream中所有元素进行去重，返回新的stream流

sorted()：对stream中所有的元素按照指定规则进行排序，返回新的stream流

终止管道

通过终止管道操作之后，Stream流将会结束，最后可能会执行某些逻辑处理，或者是按照要求返回某些执行后的结果数据。

count()：返回stream处理后最终的元素个数

max()：返回stream处理后的元素最大值

min()：返回stream处理后的元素最小值

findFirst()：找到第一个符合条件的元素时则终止流处理

findAny()：找到任何一个符合条件的元素时则退出流处理，这个对于串行流时与findFirst相同，对于并行流时比较高效，任何分片中找到都会终止后续计算逻辑

anyMatch()：返回一个boolean值，类似于isContains()，用于判断是否有符合条件的元素

allMatch()：返回一个boolean值，用于判断是否所有元素都符合条件

noneMatch()：返回一个boolean值，用于判断是否所有元素都不符合条件

collect()：将流转换为指定的类型，通过Collectors进行指定

toArray()：将流转换为数组

iterator()：将流转换为Iterator对象

foreach()：无返回值，对元素进行逐个遍历，然后执行给定的处理逻辑

方法使用

map与flatMap

map与flatMap都是用于转换已有的元素为其它元素，区别点在于：

map 必须是一对一的，即每个元素都只能转换为1个新的元素
flatMap 可以是一对多的，即每个元素都可以转换为1个或者多个新的元素

比如：有一个字符串ID列表，现在需要将其转为User对象列表。可以使用map来实现：


/**
 * map函数使用：一对一转换
 */
public void stringToIntMap() {
    List<String> ids = Arrays.asList("111", "222", "333", "444", "555", "666", "777");
    // 使用流操作
    List<User> results = ids.stream()
            .map(id -> {
                User user = new User();
                user.setId(id);
                return user;
            })
            .collect(Collectors.toList());
    System.out.println(results);
}

执行之后，会发现每一个元素都被转换为对应新的元素，但是前后总元素个数是一致的：


[User{id='111'}, 
 User{id='222'},
 User{id='333'}, 
 User{id='444'}, 
 User{id='555'}, 
 User{id='666'}, 
 User{id='777'}]

再比如：现有一个句子列表，需要将句子中每个单词都提取出来得到一个所有单词列表。这种情况用map就无法满足需求了，需要使用flatMap的特性：


public void stringToIntFlatmap() {
    List<String> sentences = Arrays.asList("hello world","your name is Chris");
    // 使用流操作
    List<String> results = sentences.stream()
            .flatMap(sentence -> Arrays.stream(sentence.split(" ")))
            .collect(Collectors.toList());
    System.out.println(results);
}

1	[hello, world, your, name, is, Chris]

执行结果如下，可以看到结果列表中元素个数是比原始列表元素个数要多的，是将各个String类型的字符串句子以空格拆分，将结果加入同一个结果集进行返回。这里flatMap操作的时候其实是先每个元素处理并返回一个新的Stream，然后将多个Stream展开合并为了一个完整的新的Stream。

peek和foreach方法

peek和foreach，都可以用于对元素进行遍历然后逐个的进行处理。

但根据前面的介绍，peek属于中间方法，而foreach属于终止方法。这也就意味着peek只能作为管道中途的一个处理步骤，而没法直接执行得到结果，其后面必须还要有其它终止操作的时候才会被执行；而foreach作为无返回值的终止方法，则可以直接执行相关操作。


public void peekAndforeach() {
    List<String> sentences = Arrays.asList("hello world","your name is Chris");
    // 仅peek操作，最终不会执行
    System.out.println("----before peek----");
    sentences.stream().peek(sentence -> System.out.println(sentence));
    System.out.println("----after peek----");
    // 仅foreach操作，最终会执行
    System.out.println("----before foreach----");
    sentences.stream().forEach(sentence -> System.out.println(sentence));
    System.out.println("----after foreach----");
    // peek操作后面增加终止操作，peek会执行
    System.out.println("----before peek and count----");
    sentences.stream().peek(sentence -> System.out.println(sentence)).count();
    System.out.println("----after peek and count----");
}

----before peek----
----after peek----
----before foreach----
hello world
your name is Chris
----after foreach----
----before peek and count----
hello world
your name is Chris
----after peek and count----

输出结果可以看出，peek独自调用时并没有被执行、但peek后面加上终止操作之后便可以被执行，而foreach可以直接被执行。

filter、sorted、distinct、limit

这几个都是常用的Stream的中间操作方法，具体的方法的含义在上面的表格里面有说明。具体使用的时候，可以根据需要选择一个或者多个进行组合使用，或者同时使用多个相同方法的组合：

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Student {
    Integer id;
    String name;
    Integer age;

    public Student(Integer id) {
        this.id = id;
        this.name = "学生";
        this.age = 20;
    }
}


public void testGetTargetStudents() {
    List<String> ids = Arrays.asList("111","222","333","444","555","666","777", "888");
    // 使用流操作
    List<Student> results = ids.stream()
            .filter(s -> s.length() > 2)
            .distinct()
            .map(Integer::valueOf)
            .sorted(Comparator.comparingInt(o -> o))
            .limit(3)
            .map(id -> new Student(id))
            .collect(Collectors.toList());
    System.out.println(results);
}

1	[Student(id=111, name=学生, age=20), Student(id=222, name=学生, age=20), Student(id=333, name=学生, age=20)]

上面的代码片段的处理逻辑很清晰：

使用filter过滤掉不符合条件的数据
通过distinct对存量元素进行去重操作
通过map操作将字符串转成整数类型
借助sorted指定按照数字大小正序排列
使用limit截取排在前3位的元素
又一次使用map将id转为Student对象类型
使用collect终止操作将最终处理后的数据收集到list中

Optional.ofNullable()方法

**Optional.ofNullable()**是可以避免空指针异常的对入参进行封装的方法，举个例子：

public static void main(String[] args) {
    List<String> list = null;
    list.forEach(c -> System.out.println(c));
}

工作中经常会遇到，查询返回空，如果没有判空处理，一不小心就会空指针异常。加上if判断处理也可以，但是Java8有更优雅的处理方式。

public static void main(String[] args) {
    List<String> list = null;
    List<String> newList = Optional.ofNullable(list).orElse(Lists.newArrayList());
    newList.forEach(c -> System.out.println(c));
}

代码含义：

如果list集合不为空，将list集合赋值给newList
如果list集合为空创建一个空对象集合赋值给newList，保证list集合永远不为空，也就避免了空指针异常

阅读源码查看如何实现的避免空指针异常：

//静态变量 empty
private static final Optional<?> EMPTY = new Optional<>();
 
//如果对象为空，执行empty()方法；不为空，执行of(value)方法
public static <T> Optional<T> ofNullable(T value) {
    return value == null ? empty() : of(value);
}
 
public static<T> Optional<T> empty() {
    @SuppressWarnings("unchecked")
    Optional<T> t = (Optional<T>) EMPTY;
    return t;
}
 
public static <T> Optional<T> of(T value) {
    return new Optional<>(value);
}

首先执行ofNullable()方法，如果T对象为空，执行empty()方法；不为空，执行of(value)方法；
empty()方法，初始化一个空对象Optional(空对象和null不是一回事)；
of(value)方法，将泛型对象T用于Optional构造方法的参数上，返回一个有值的对象
经过上面两步，从而保证了Optional不为null，避免了空指针；

orElse、orElseGet、orElseThrow

orElse和orElseGet的用法如下所示，相当于value值为null时，给予一个默认值：

@Test
public void test() {
    User user = null;
    user = Optional.ofNullable(user).orElse(createUser());
    user = Optional.ofNullable(user).orElseGet(() -> createUser());
    
}
public User createUser(){
    User user = new User();
    user.setName("zhangsan");
    return user;
}

这两个函数的区别：

当user值不为null时，orElse函数依然会执行createUser()方法
而orElseGet函数并不会执行createUser()方法

至于orElseThrow，就是value值为null时,直接抛一个异常出去，用法如下所示：

1 2	User user = null; Optional.ofNullable(user).orElseThrow(()->new Exception("用户不存在"));

简单结果终止方法

按照前面介绍的，终止方法里面像count、max、min、findAny、findFirst、anyMatch、allMatch、nonneMatch等方法，均属于这里说的简单结果终止方法。所谓简单，指的是其结果形式是数字、布尔值或者Optional对象值等。


public void testSimpleStopOptions() {
    List<String> ids = Arrays.asList("111","222","333","444","555","666","777", "888");
    // 统计stream操作后剩余的元素个数
    System.out.println(ids.stream().filter(s -> s.length() > 2).count());
    // 判断是否有元素值等于222
    System.out.println(ids.stream().filter(s -> s.length() > 2).anyMatch("222"::equals));
    // findFirst操作
    ids.stream().filter(s -> s.length() > 2)
            .findFirst()
            .ifPresent(s -> System.out.println("findFirst:" + s));
}

1
2
3

8
true
findFirst:111

避坑提醒

这里需要补充提醒下，一旦一个Stream被执行了终止操作之后，后续便不可以再读这个流执行其他的操作了，否则会报错，看下面示例：


public void testHandleStreamAfterClosed() {
    List<String> ids = Arrays.asList("111","222","333","444","555","666","777", "888");
    Stream<String> stream = ids.stream().filter(s -> s.length() > 2);
    // 统计stream操作后剩余的元素个数
    System.out.println(stream.count());
    System.out.println("-----下面会报错-----");
    // 判断是否有元素值等于222
    try {
        System.out.println(stream.anyMatch("222"::equals));
    } catch (Exception e) {
        e.printStackTrace();
    }
    System.out.println("-----上面会报错-----");
}


8
-----下面会报错-----
-----上面会报错-----
java.lang.IllegalStateException: stream has already been operated upon or closed
	at java.util.stream.AbstractPipeline.evaluate(AbstractPipeline.java:229)
	at java.util.stream.ReferencePipeline.anyMatch(ReferencePipeline.java:449)
	at JavaKnowledge.StreamStudy.StreamFunction.testHandleStreamAfterClosed(StreamFunction.java:84)
	at JavaKnowledge.StreamStudy.StreamFunction.main(StreamFunction.java:20)

因为stream已经被执行count()终止方法了，所以对stream再执行anyMatch方法的时候，就会报错stream has already been operated upon or closed，这一点在使用的时候需要特别注意。

结果收集终止方法

因为Stream主要用于对集合数据的处理场景，所以除了上面几种获取简单结果的终止方法之外，更多的场景是获取一个集合类的结果对象，比如List、Set或者HashMap等。

这里就需要collect方法了，它可以支持生成如下类型的结果数据：

一个集合类，比如List、Set或者HashMap等
StringBuilder对象，支持将多个字符串进行拼接处理并输出拼接后结果
一个可以记录个数或者计算总和的对象（数据批量运算统计）

生成集合

public void testCollectStopOptions() {
    List<Student> ids = Arrays.asList(new Student(17), new Student(22), new Student(23));
    // collect成list
    List<Student> collectList = ids.stream().filter(dept -> dept.getId() > 20)
            .collect(Collectors.toList());
    System.out.println("collectList:" + collectList);
    // collect成Set
    Set<Student> collectSet = ids.stream().filter(dept -> dept.getId() > 20)
            .collect(Collectors.toSet());
    System.out.println("collectSet:" + collectSet);
    // collect成HashMap，key为id，value为Student对象
    Map<Integer, Student> collectMap = ids.stream().filter(dept -> dept.getId() > 20)
            .collect(Collectors.toMap(Student::getId, dept -> dept));
    System.out.println("collectMap:" + collectMap);
}

1
2
3

collectList:[Student(id=22, name=学生, age=20), Student(id=23, name=学生, age=20)]
collectSet:[Student(id=22, name=学生, age=20), Student(id=23, name=学生, age=20)]
collectMap:{22=Student(id=22, name=学生, age=20), 23=Student(id=23, name=学生, age=20)}

生成拼接字符串

将一个List或者数组中的值拼接到一个字符串里并以逗号分隔开，这个场景在日常使用中很常见，如果通过for循环和StringBuilder去循环拼接，还得考虑下最后一个逗号如何处理的问题，很繁琐：

public void testForJoinStrings() {
    List<String> ids = Arrays.asList("111","222","333","444","555","666","777", "888");
    StringBuilder builder = new StringBuilder();
    for (String id : ids) {
        builder.append(id).append(',');
    }
    // 去掉末尾多拼接的逗号
    builder.deleteCharAt(builder.length() - 1);
    System.out.println("拼接后：" + builder.toString());
}

1	拼接后：111,222,333,444,555,666,777,888

Java8提供的Stream使用collect可以轻而易举的实现，代码风格相对优雅：

public void testCollectJoinStrings() {
    List<String> ids = Arrays.asList("111","222","333","444","555","666","777", "888");
    String joinResult = ids.stream().collect(Collectors.joining(","));
    System.out.println("拼接后：" + joinResult);
}

1	拼接后：111,222,333,444,555,666,777,888

数据批量数学运算

使用collect生成数字数据的总和信息：

public void testNumberCalculate() {
    List<Integer> ids = Arrays.asList(10, 20, 30, 40, 50);
    // 计算平均值
    Double average = ids.stream().collect(Collectors.averagingInt(value -> value));
    System.out.println("平均值：" + average);
    // 数据统计信息
    IntSummaryStatistics summary = ids.stream().collect(Collectors.summarizingInt(value -> value));
    System.out.println("数据统计信息： " + summary);
}

1 2	平均值：30.0 数据统计信息： IntSummaryStatistics{count=5, sum=150, min=10, average=30.000000, max=50}

并行Stream

机制说明

使用并行流，可以有效利用计算机的多CPU硬件，提升逻辑的执行速度。并行流通过将一整个stream划分为****多个片段，然后对各个分片流并行执行处理逻辑，最后将各个分片流的执行结果汇总为一个整体流。

约束与限制

并行流类似于多线程在并行处理，所以与多线程场景相关的一些问题同样会存在，比如死锁等问题，所以在并行流终止执行的函数逻辑，必须要保证线程安全。

Stream相较于传统的foreach的方式处理stream，有什么优势？

优点：

代码更简洁：偏声明式的编码风格，更容易体现出代码的逻辑意图
逻辑间解耦：一个stream中间处理逻辑，无需关注上游与下游的内容，只需要按约定实现自身逻辑即可
并行流场景效率会比迭代器逐个循环更高
函数式接口，延迟执行的特性，中间管道操作不管有多少步骤都不会立即执行，只有遇到终止操作的时候才会开始执行，可以避免一些中间不必要的操作消耗

缺点：

代码调测debug不便
程序员从历史写法切换到Stream时，需要一定的适应时间

本文链接： https://junjun.fun/24_09_22_总结3_3/

版权声明： 本博客所有文章除特别声明外，均采用 CC BY 4.0 CN协议许可协议。转载请注明出处！

赵无敌Developer & Designer

苟利国家生死以,岂因祸福避趋之。