本文对 Java8 Stream 的使用做简单小记。

Java8 的新特性主要是 Lambda 表达式和流,当流和 Lambda 表达式结合起来一起使用时,因为流申明式处理数据集合的特点,可以让代码变得简洁易读。转载自:Java8 Stream用法

导入

如果有一个需求,需要对数据库查询到的菜肴进行一个处理:

  • 筛选得到卡路里小于 400 的菜肴
  • 对筛选出的菜肴进行一个排序
  • 获取排序后菜肴的名字

菜肴:Dish.java

1
2
3
4
5
6
7
8
9
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Dish {
    private String name;
    private boolean vegetarian;
    private int calories;
  	private String type;
}

Java8 以前的实现方式

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
private List<String> beforeJava7(List<Dish> dishList) {
        List<Dish> lowCaloricDishes = new ArrayList<>();
        
        //1.筛选出卡路里小于400的菜肴
        for (Dish dish : dishList) {
            if (dish.getCalories() < 400) {
                lowCaloricDishes.add(dish);
            }
        }
        
        //2.对筛选出的菜肴进行排序
        Collections.sort(lowCaloricDishes, new Comparator<Dish>() {
            @Override
            public int compare(Dish o1, Dish o2) {
                return Integer.compare(o1.getCalories(), o2.getCalories());
            }
        });
        
        //3.获取排序后菜肴的名字
        List<String> lowCaloricDishesName = new ArrayList<>();
        for (Dish d : lowCaloricDishes) {
            lowCaloricDishesName.add(d.getName());
        }
        return lowCaloricDishesName;
    }

Java8 之后的实现方式

1
2
3
4
5
6
7
private List<String> afterJava8(List<Dish> dishList) {
    return dishList.stream()
        .filter(d -> d.getCalories() < 400)  //筛选出卡路里小于400的菜肴
        .sorted(Comparator.comparing(Dish::getCalories))  //根据卡路里进行排序
        .map(Dish::getName)  //提取菜肴名称
        .collect(Collectors.toList()); //转换为List
}

不拖泥带水,一气呵成,原来需要写 24 代码实现的功能现在只需 5 行就可以完成了

高高兴兴写完需求这时候又有新需求了,新需求如下:

对数据库查询到的菜肴根据菜肴种类进行分类,返回一个Map<Type, List<Dish>>的结果

这要是放在 jdk8 之前肯定会头皮发麻

Java8以前的实现方式

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
private static Map<String, List<Dish>> beforeJdk8(List<Dish> dishList) {
  	Map<String, List<Dish>> result = new HashMap<>();
    for (Dish dish : dishList) {
        if (!result.containsKey(dish.getName())) {
          	result.put(dish.getName(), new ArrayList<>());
        }
        result.get(dish.getName()).add(dish);
    }
    return result;
}

还好 jdk8 有Stream,再也不用担心复杂集合处理需求

Java8 以后的实现方式

1
2
3
private static Map<String, List<Dish>> afterJdk8(List<Dish> dishList) {
		return dishList.stream().collect(Collectors.groupingBy(Dish::getType));
}

又是一行代码解决了需求,忍不住大喊Stream API牛批 看到流的强大功能了吧,接下来将详细介绍流

什么是流

流是从支持数据处理操作的源生成的元素序列,源可以是数组、文件、集合、函数。流不是集合元素,它不是数据结构并不保存数据,它的主要目的在于计算。

如何生成流

生成流的方式主要有五种

  • 通过集合生成,应用中最常用的一种

    1
    2
    
    List<Integer> integerList = Arrays.asList(1, 2, 3, 4, 5);
    Stream<Integer> stream = integerList.stream();
    
    1
    2
    3
    
    
     通过集合 `List` `stream`方法生成流
    
    
  • 通过数组生成

    1
    2
    
    int[] intArr = new int[]{1, 2, 3, 4, 5};
    IntStream stream = Arrays.stream(intArr);
    
    1
    2
    3
    
    
     通过`Arrays.stream`方法生成流,并且该方法生成的流是数值流【即`IntStream`】而不是`Stream<Integer>`。补充一点**使用数值流可以避免计算过程中拆箱装箱,提高性能。**`Stream API`提供了`mapToInt``mapToDouble``mapToLong`三种方式将对象流【即`Stream<T>`】转换成对应的数值流,同时提供了`boxed`方法将数值流转换为对象流
    
    
  • 通过值生成

    1
    
    Stream<Integer> stream = Stream.of(1, 2, 3, 4, 5);
    
    1
    2
    3
    
    
     通过`Stream``of`方法生成流,通过`Stream``empty`方法可以生成一个空流
    
    
  • 通过文件生成

    1
    
    Stream<String> lines = Files.lines(Paths.get("data.txt"), Charset.defaultCharset())
    
    1
    2
    3
    
    
     通过`Files.line`方法得到一个流,并且得到的每个流是给定文件中的一行
    
    
  • 通过函数生成 提供了iterategenerate两个静态方法从函数中生成流

    • iterator

      ```java
      Stream<Integer> stream = Stream.iterate(0, n -> n + 2).limit(5);
      ```
      
      `iterate`方法接受两个参数,第一个为初始化值,第二个为进行的函数操作,因为`iterator`生成的流为无限流,通过`limit`方法对流进行了截断,只生成5个偶数
      
      • generator

        1
        
        Stream<Double> stream = Stream.generate(Math::random).limit(5);
        
        1
        2
        3
        
        
         `generate`方法接受一个参数,方法参数类型为`Supplier<T>`,由它为流提供值。`generate`生成的流也是无限流,因此通过`limit`对流进行了截断
        
        

流的操作类型

流的操作类型主要分为两种

  • 中间操作:一个流可以后面跟随零个或多个中间操作。其目的主要是打开流,做出某种程度的数据映射/过滤,然后返回一个新的流,交给下一个操作使用。这类操作都是惰性化的,仅仅调用到这类方法,并没有真正开始流的遍历,真正的遍历需等到终端操作时,常见的中间操作有下面即将介绍的filtermap
  • 终端操作:一个流有且只能有一个终端操作,当这个操作执行后,流就被关闭了,无法再被操作,因此一个流只能被遍历一次,若想在遍历需要通过源数据在生成流。终端操作的执行,才会真正开始流的遍历。如下面即将介绍的countcollect

流使用

流的使用将分为中间操作和终端操作

中间操作

filter 筛选留下满足条件的
1
2
List<Integer> integerList = Arrays.asList(1, 1, 2, 3, 4, 5);
Stream<Integer> stream = integerList.stream().filter(i -> i > 3);

通过使用filter方法进行条件筛选,filter的方法参数为一个条件

distinct 去除重复元素
1
2
List<Integer> integerList = Arrays.asList(1, 1, 2, 3, 4, 5);
Stream<Integer> stream = integerList.stream().distinct();

通过distinct方法快速去除重复的元素

limit 得到前几个元素
1
2
List<Integer> integerList = Arrays.asList(1, 1, 2, 3, 4, 5);
Stream<Integer> stream = integerList.stream().limit(3);

通过limit方法指定返回流的个数,limit的参数值必须>=0,否则将会抛出异常

skip 跳过前几个的元素
1
2
 List<Integer> integerList = Arrays.asList(1, 1, 2, 3, 4, 5);
 Stream<Integer> stream = integerList.stream().skip(2);

通过skip方法跳过流中的元素,上述例子跳过前两个元素,所以打印结果为2,3,4,5skip的参数值必须>=0,否则将会抛出异常

map 流映射

所谓流映射就是将接受的元素映射成另外一个元素

1
2
List<String> stringList = Arrays.asList("Java 8", "Lambdas",  "In", "Action");
Stream<Integer> stream = stringList.stream().map(String::length);

通过map方法可以完成映射,该例子完成中String -> Integer的映射,之前上面的例子通过map方法完成了Dish->String的映射

flatMap 流转换

将一个流中的每个值都转换为另一个流

1
2
3
4
5
6
List<String> wordList = Arrays.asList("Hello", "World");
List<String> strList = wordList.stream()
        .map(w -> w.split(" "))
        .flatMap(Arrays::stream)
        .distinct()
        .collect(Collectors.toList());

map(w -> w.split(" "))的返回值为Stream<String[]>,我们想获取Stream<String>,可以通过flatMap方法完成Stream<String[]> ->Stream<String>的转换

元素匹配

提供了三种匹配方式

  • allMatch匹配所有

    1
    2
    3
    4
    
    List<Integer> integerList = Arrays.asList(1, 2, 3, 4, 5);
    if (integerList.stream().allMatch(i -> i > 3)) {
        System.out.println("值都大于3");
    }
    
    1
    
    
    
  • anyMatch匹配其中一个

    1
    2
    3
    4
    
    List<Integer> integerList = Arrays.asList(1, 2, 3, 4, 5);
    if (integerList.stream().anyMatch(i -> i > 3)) {
        System.out.println("存在大于3的值");
    }
    
    1
    
    
    
  • noneMatch全部不匹配

    1
    2
    3
    4
    
    List<Integer> integerList = Arrays.asList(1, 2, 3, 4, 5);
    if (integerList.stream().noneMatch(i -> i > 3)) {
        System.out.println("值都小于3");
    }
    
    1
    2
    
    
    
    

终端操作

count 统计总数
  • 通过 count

    1
    2
    
    List<Integer> integerList = Arrays.asList(1, 2, 3, 4, 5);
    Long result = integerList.stream().count();
    
    1
    2
    3
    
    
     通过使用`count`方法统计出流中元素个数
    
    
  • 通过 counting

    1
    2
    
    List<Integer> integerList = Arrays.asList(1, 2, 3, 4, 5);
    Long result = integerList.stream().collect(Collectors.counting());
    
    1
    2
    3
    
    
     最后一种统计元素个数的方法在与`collect`联合使用的时候特别有用
    
    
findFirst 查找

提供了两种查找方式

  • findFirst 查找第一个

    1
    2
    
    List<Integer> integerList = Arrays.asList(1, 2, 3, 4, 5);
    Optional<Integer> result = integerList.stream().filter(i -> i > 3).findFirst();
    
    1
    2
    3
    
    
     通过`findFirst`方法查找到第一个大于三的元素并打印
    
    
  • findAny 随机查找一个

    1
    2
    
    List<Integer> integerList = Arrays.asList(1, 2, 3, 4, 5);
    Optional<Integer> result = integerList.stream().filter(i -> i > 3).findAny();
    
    1
    2
    3
    
    
     通过`findAny`方法查找到其中一个大于三的元素并打印,因为内部进行优化的原因,当找到第一个满足大于三的元素时就结束,该方法结果和`findFirst`方法结果一样。提供`findAny`方法是为了更好的利用并行流,`findFirst`方法在并行上限制更多【本篇文章将不介绍并行流】
    
    
reduce将流中的元素组合起来

假设我们对一个集合中的值进行求和

  • jdk8之前

    1
    2
    3
    4
    
    int sum = 0;
    for (int i : integerList) {
      sum += i;
    }
    
    1
    
    
    
  • jdk8之后通过reduce进行处理

    1
    
    int sum = integerList.stream().reduce(0, (a, b) -> (a + b));
    
    1
    2
    3
    4
    5
    
    
     一行就可以完成,还可以使用方法引用简写成:
    
     ```java
     int sum = integerList.stream().reduce(0, Integer::sum);
    
    1
    2
    3
    
    
     `reduce`接受两个参数,一个初始值这里是`0`,一个`BinaryOperator<T> accumulator`来将两个元素结合起来产生一个新值, 另外`reduce`方法还有一个没有初始化值的重载方法
    
    
min/max 获取最值
  • 通过min/max获取最小最大值

    1
    2
    
    Optional<Integer> min = menu.stream().map(Dish::getCalories).min(Integer::compareTo);
    Optional<Integer> max = menu.stream().map(Dish::getCalories).max(Integer::compareTo);
    
    1
    2
    3
    4
    5
    6
    
    
     也可以写成:
    
     ```java
     OptionalInt min = menu.stream().mapToInt(Dish::getCalories).min();
     OptionalInt max = menu.stream().mapToInt(Dish::getCalories).max();
    
    1
    2
    3
    
    
     `min`获取流中最小值,`max`获取流中最大值,方法参数为`Comparator<? super T> comparator`
    
    
  • 通过minBy/maxBy获取最小最大值

    1
    2
    
    Optional<Integer> min = menu.stream().map(Dish::getCalories).collect(minBy(Integer::compareTo));
    Optional<Integer> max = menu.stream().map(Dish::getCalories).collect(maxBy(Integer::compareTo));
    
    1
    2
    3
    
    
     `minBy`获取流中最小值,`maxBy`获取流中最大值,方法参数为`Comparator<? super T> comparator`
    
    
  • 通过reduce获取最小最大值

    1
    2
    
    Optional<Integer> min = menu.stream().map(Dish::getCalories).reduce(Integer::min);
    Optional<Integer> max = menu.stream().map(Dish::getCalories).reduce(Integer::max);
    
    1
    
    
    
求和
  • 通过 summingInt

    1
    
    int sum = menu.stream().collect(summingInt(Dish::getCalories));
    
    1
    2
    3
    
    
     如果数据类型为`double``long`,则通过`summingDouble``summingLong`方法进行求和
    
    
  • 通过 reduce

    1
    
    int sum = menu.stream().map(Dish::getCalories).reduce(0, Integer::sum);
    
    1
    
    
    
  • 通过 sum

    1
    
    int sum = menu.stream().mapToInt(Dish::getCalories).sum();
    
    1
    
    
    

在上面求和、求最大值、最小值的时候,对于相同操作有不同的方法可以选择执行。可以选择collectreducemin/max/sum方法,推荐使用minmaxsum方法。因为它最简洁易读,同时通过mapToInt将对象流转换为数值流,避免了装箱和拆箱操作

求平均值
1
double average = menu.stream().collect(averagingInt(Dish::getCalories));

如果数据类型为doublelong,则通过averagingDoubleaveragingLong方法进行求平均

summarizingInt 同时求总和、平均值、最大值、最小值
1
2
3
4
5
IntSummaryStatistics intSummaryStatistics = menu.stream().collect(summarizingInt(Dish::getCalories));
double average = intSummaryStatistics.getAverage();  //获取平均值
int min = intSummaryStatistics.getMin();  //获取最小值
int max = intSummaryStatistics.getMax();  //获取最大值
long sum = intSummaryStatistics.getSum();  //获取总和

如果数据类型为doublelong,则通过summarizingDoublesummarizingLong方法

foreach 进行元素遍历
1
2
List<Integer> integerList = Arrays.asList(1, 2, 3, 4, 5);
integerList.stream().forEach(System.out::println);
Collectors.toList 返回集合
1
2
List<String> strings = menu.stream().map(Dish::getName).collect(Collectors.toList());
Set<String> sets = menu.stream().map(Dish::getName).collect(Collectors.toSet());
joining 拼接元素
1
String result = menu.stream().map(Dish::getName).collect(Collectors.joining(", "));

默认如果不通过map方法进行映射处理拼接的toString方法返回的字符串,joining的方法参数为元素的分界符,如果不指定生成的字符串将是一串的,可读性不强

groupingBy 进行分组
1
Map<String, List<Dish>> result = dishList.stream().collect(groupingBy(Dish::getType));
partitioningBy 进行分区

分区是特殊的分组,它分类依据是true和false,所以返回的结果最多可以分为两组

1
Map<Boolean, List<Dish>> result = menu.stream().collect(partitioningBy(Dish :: isVegetarian))

等同于

1
Map<Boolean, List<Dish>> result = menu.stream().collect(groupingBy(Dish :: isVegetarian))

这个例子可能并不能看出分区和分类的区别,甚至觉得分区根本没有必要,换个明显一点的例子:

1
2
List<Integer> integerList = Arrays.asList(1, 2, 3, 4, 5);
Map<Boolean, List<Integer>> result = integerList.stream().collect(partitioningBy(i -> i < 3));

返回值的键仍然是布尔类型,但是它的分类是根据范围进行分类的,分区比较适合处理根据范围进行分类。