Java-8-中的-Streams-API-详解
Java 8 中的 Streams API 详解
参考自:https://www.ibm.com/developerworks/cn/java/j-lo-java8streamapi/
注:本文适当调整了原文内容和结构,并修正代码错误
Java 8 中的 Stream 是对集合(Collection)对象功能的增强,它专注于对集合对象进行各种便利、高效的聚合操作(aggregate operation),或者大批量数据操作(bulk data operation)。Stream API 借助于 Lambda 表达式,极大的提高编程效率和程序可读性。同时它提供串行和并行两种模式进行汇聚操作,并发模式能够充分利用多核处理器的优势,使用 fork/join 并行方式来拆分任务和加速处理过程。通常编写并行代码很难而且容易出错, 但使用 Stream API 无需编写一行多线程的代码,就可以很方便地写出高性能的并发程序。
1 前言
详细讨论之前,先展示一个排序、取值案例在 Java 8 之前版本的实现:
1 | // 在原文实现代码基础上添加枚举类 Transaction |
在 Java 8 中使用 Stream 实现的版本更加简洁:
1 | List<Integer> transactionsIds = transactions.parallelStream(). |
2 总览
2-1 什么是流
Stream 不是集合元素,它不是数据结构,并不保存数据,它与算法和计算有关,更像一个高级版本的 Iterator。原始版本的 Iterator,用户只能显式地一个一个遍历元素并对其执行某些操作;使用 Stream,用户只要给出需要对其包含的元素执行什么操作,比如:「过滤掉长度大于 10 的字符串」、「获取每个字符串的首字母」等,Stream 会隐式地在内部进行遍历,做出相应的数据转换。
Stream 的处理过程是单向、不可往复的,数据只能遍历一次,遍历过一次后即用尽了,就好比流水从面前流过,一去不复返。Stream 的另外一大特点是,数据源本身可以是无限的。
和迭代器不同的是,Stream 可以并行化操作,迭代器只能命令式地、串行化操作。顾名思义,当使用串行方式去遍历时,只能读取一个 item 后再读下一个 item。而使用并行去遍历时,数据会被分成多个段,每一段都在不同的线程中处理,然后将结果一起输出。Stream 的并行操作依赖于 Java 7 中引入的 Fork/Join 框架(JSR166y)来拆分任务和加速处理过程。Java 的并行 API 演变历程概括如下:
- 1.0-1.4 中的 java.lang.Thread
- 5.0 中的 java.util.concurrent
- 6.0 中的 Phasers 等
- 7.0 中的 Fork/Join 框架
- 8.0 中的 Lambda
2-2 流的构成
当我们使用一个流的时候,通常包括三个基本步骤:
- 获取一个数据源(source)
- 数据转换
- 执行操作获取想要的结果
每次转换,原有 Stream 对象不改变,返回一个新的 Stream 对象(可以有多次转换),这就允许对其操作可以像链条一样排列,变成一个管道。
2-3 生成 Stream
有多种方式生成 Stream 源
从 Collection 和数组
- Collection.stream()
- Collection.parallelStream()
- Arrays.stream(T array)
- Stream.of()
从 BufferedReader
- java.io.BufferedReader.lines()
静态工厂
- java.util.stream.IntStream.range()
- java.nio.file.Files.walk()
自己构建
- java.util.Spliterator
其它
- Random.ints()
- BitSet.stream()
- Pattern.splitAsStream(java.lang.CharSequence)
- JarFile.stream()
3 流的操作
当把一个数据结构包装成 Stream 后,就要开始对里面的元素进行各类操作了,流的操作类型分为以下几种:
3-1 Intermediate
一个流可以后面跟随零个或多个 intermediate 操作。其目的主要是打开流,做出某种程度的数据映射/过滤,然后返回一个新的流,交给下一个操作使用。这类操作都是惰性化的(lazy),就是说,仅仅调用到这类方法,并没有真正开始流的遍历。常见的操作如下:
map (mapToInt, flatMap 等)、 filter、 distinct、 sorted、 peek、 limit、 skip、 parallel、 sequential、 unordered
3-2 Terminal
一个流只能有一个 terminal 操作,当这个操作执行后,流就被使用「光」了,无法再被操作。所以这必定是流的最后一个操作。Terminal 操作的执行,才会真正开始流的遍历,并且会生成一个结果,或者一个 side effect。常见的操作如下:
forEach、 forEachOrdered、 toArray、 reduce、 collect、 min、 max、 count、 anyMatch、 allMatch、 noneMatch、 findFirst、 findAny、 iterator
在对于一个 Stream 进行多次转换操作 (Intermediate 操作),每次都对 Stream 的每个元素进行转换,而且是执行多次,这样时间复杂度就是 N(转换次数)个 for 循环里把所有操作都做掉的总和吗?其实不是这样的,转换操作都是 lazy 的,多个转换操作只会在 Terminal 操作的时候融合起来,一次循环完成。我们可以这样简单的理解,Stream 里有个操作函数的集合,每次转换操作就是把转换函数放入这个集合中,在 Terminal 操作的时候循环 Stream 对应的集合,然后对每个元素执行所有的函数。
3-3 short-circuiting
还有一种操作被称为 short-circuiting(短路)。用以指:
- 对于一个 intermediate 操作,如果它接受的是一个无限大(infinite/unbounded)的 Stream,但返回一个有限的新 Stream。
- 对于一个 terminal 操作,如果它接受的是一个无限大的 Stream,但能在有限的时间计算出结果。
当操作一个无限大的 Stream,而又希望在有限时间内完成操作,则在管道内拥有一个 short-circuiting 操作是必要非充分条件。常见的操作如下:
anyMatch、 allMatch、 noneMatch、 findFirst、 findAny、 limit
4 流的使用详解
简单说,对 Stream 的使用就是实现一个 filter-map-reduce 过程,产生一个最终结果,或者导致一个副作用(side effect)。
4-1 构造与转换
下面提供最常见的几种构造 Stream 的样例。
案例:构造流的几种常见方法
1 | // 1. Individual values |
需要注意的是,对于基本数值型,目前有三种对应的包装类型 Stream:IntStream、LongStream、DoubleStream。当然我们也可以用 Stream
案例:数值流的构造
1 | IntStream.of(new int[]{1, 2, 3}).forEach(System.out::println); |
案例:流转换为其它数据结构
1 | // 1. Array |
注:一个 Stream 只可以使用一次,上面的代码为了简洁而重复使用了数次。
4-2 典型用法及案例
map、flatMap
我们先来看 map。如果你熟悉 scala 这类函数式语言,对这个方法应该很了解,它的作用就是把 input Stream 的每一个元素,映射成 output Stream 的另外一个元素。
案例:这段代码把所有的单词转换为大写。
1 | List<String> output = wordList.stream() |
案例:这段代码生成一个整数 list 的平方数 {1, 4, 9, 16}。
1 | List<Integer> nums = Arrays.asList(1, 2, 3, 4); |
从上面例子可以看出,map 生成的是个 1:1 映射,每个输入元素,都按照规则转换成为另外一个元素。还有一些场景,是一对多映射关系的,这时需要 flatMap。
案例:一对多。flatMap 把 input Stream 中的层级结构扁平化,就是将最底层元素抽出来放到一起,最终 output 的新 Stream 里面已经没有 List 了,都是直接的数字。
1 | tream<List<Integer>> inputStream = Stream.of( |
filter
filter 对原始 Stream 进行某项测试,通过测试的元素被留下来生成一个新 Stream。
案例:留下偶数,经过条件「被 2 整除」的 filter,剩下的数字为 {2, 4, 6}。
1 | Integer[] sixNums = {1, 2, 3, 4, 5, 6}; |
案例:把单词挑出来,这段代码首先把每行的单词用 flatMap 整理到新的 Stream,然后保留长度不为 0 的,就是整篇文章中的全部单词了。
1 | List<String> output = reader.lines() |
forEach、peek
forEach 方法接收一个 Lambda 表达式,然后在 Stream 的每一个元素上执行该表达式。
案例:打印姓名(forEach 和 pre-java 8 的对比)
1 | // Java 8 |
1 | // Pre-Java 8 |
对一个人员集合遍历,找出男性并打印姓名。可以看出来,forEach 是为 Lambda 而设计的,保持了最紧凑的风格。而且 Lambda 表达式本身是可以重用的,非常方便。当需要为多核系统优化时,可以 parallelStream().forEach(),只是此时原有元素的次序没法保证,并行的情况下将改变串行时操作的行为,此时 forEach 本身的实现不需要调整,而 Java8 以前的 for 循环 code 可能需要加入额外的多线程逻辑。
但一般认为,forEach 和常规 for 循环的差异不涉及到性能,它们仅仅是函数式风格与传统 Java 风格的差别。
另外一点需要注意,forEach 是 terminal 操作,因此它执行后,Stream 的元素就被「消费」掉了,你无法对一个 Stream 进行两次 terminal 运算。下面的代码是错误的:
1 | stream.forEach(element -> doOneThing(element)); |
相反,具有相似功能的 intermediate 操作 peek 可以达到上述目的。如下是出现在该 api javadoc 上的一个示例。
案例:使用 peek 对每个元素执行操作并返回一个新的 Stream
1 | Stream.of("one", "two", "three", "four") |
forEach 不能修改自己包含的本地变量值,也不能用 break/return 之类的关键字提前结束循环。
findFirst
这是一个 termimal 兼 short-circuiting 操作,它总是返回 Stream 的第一个元素,或者空。这里比较重点的是它的返回值类型:Optional。这也是一个模仿 Scala 语言中的概念,作为一个容器,它可能含有某值,或者不包含。使用它的目的是尽可能避免 NullPointerException。
案例:Optional 的两个用例
1 | String strA = " abcd ", strB = null; |
在更复杂的 if (xx != null) 的情况中,使用 Optional 代码的可读性更好,而且它提供的是编译时检查,能极大的降低 NPE 这种 Runtime Exception 对程序的影响,或者迫使程序员更早的在编码阶段处理空值问题,而不是留到运行时再发现和调试。
Stream 中的 findAny、max/min、reduce 等方法等返回 Optional 值。还有例如 IntStream.average() 返回 OptionalDouble 等等。
reduce
这个方法的主要作用是把 Stream 元素组合起来。它提供一个起始值(种子),然后依照运算规则(BinaryOperator),和前面 Stream 的第一个、第二个、第 n 个元素组合。从这个意义上说,字符串拼接、数值的 sum、min、max、average 都是特殊的 reduce。例如 Stream 的 sum 就相当于 Integer sum = integers.reduce(0, (a, b) -> a+b);
或 Integer sum = integers.reduce(0, Integer::sum);
。也有没有起始值的情况,这时会把 Stream 的前面两个元素组合起来,返回的是 Optional。
案例:reduce 的使用
1 | // 字符串连接,concat = "ABCD" |
上面代码例如第一个示例的 reduce(),第一个参数(空白字符)即为起始值,第二个参数(String::concat)为 BinaryOperator。这类有起始值的 reduce() 都返回具体的对象。而对于第四个示例没有起始值的 reduce(),由于可能没有足够的元素,返回的是 Optional,请留意这个区别。
limit、skip
limit 返回 Stream 的前面 n 个元素;skip 则是扔掉前 n 个元素(它是由一个叫 subStream 的方法改名而来)。
案例:limit 和 skip 对运行次数的影响
1 | // 定义一个 Person 类 |
输出结果为:
1 | name1,name2,name3,name4,name5,name6,name7,name8,name9,name10, |
这是一个有 10,000 个元素的 Stream,但在 short-circuiting 操作 limit 和 skip 的作用下,管道中 map 操作指定的 getName() 方法的执行次数为 limit 所限定的 10 次,而最终返回结果在跳过前 3 个元素后只有后面 7 个返回。
有一种情况是 limit/skip 无法达到 short-circuiting 目的的,就是把它们放在 Stream 的排序操作后,原因跟 sorted 这个 intermediate 操作有关:此时系统并不知道 Stream 排序后的次序如何,所以 sorted 中的操作看上去就像完全没有被 limit 或者 skip 一样。
案例:limit 和 skip 对 sorted 后的运行次数无影响
1 | private class Person { |
上面的示例对案例做了微调,将元素容器修改为 Set,以便能清晰显示出排序效果。仅对 5 个元素的 Stream 排序,然后进行 limit 操作。输出结果为:
1 | [{no=1, name='name1'}, {no=5, name='name5'}, {no=4, name='name4'}, {no=3, name='name3'}, {no=2, name='name2'}] |
即虽然最后的返回元素数量是 2,但整个管道中的 sorted 表达式执行次数没有像前面例子相应减少。
最后有一点需要注意的是,对一个 parallel 的 Steam 管道来说,如果其元素是有序的,那么 limit 操作的成本会比较大,因为它的返回对象必须是前 n 个也有一样次序的元素。取而代之的策略是取消元素间的次序,或者不要用 parallel Stream。
sorted
对 Stream 的排序通过 sorted 进行,它比数组的排序更强之处在于你可以首先对 Stream 进行各类 map、filter、limit、skip 甚至 distinct 来减少元素数量后,再排序,这能帮助程序明显缩短执行时间。
案例:排序前使用 limit 和 skip 优化
1 | private class Person { |
结果会简单很多:
1 | [{no=1, name='name1'}, {no=2, name='name2'}, {no=3, name='name3'}, {no=4, name='name4'}, {no=5, name='name5'}] |
当然,这种优化是有 business logic 上的局限性的:即不要求排序后再取值。
min、max、distinct
min 和 max 的功能也可以通过对 Stream 元素先排序,再 findFirst 来实现,但前者的性能会更好,为 O(n),而 sorted 的成本是 O(n log n)。同时它们作为特殊的 reduce 方法被独立出来也是因为求最大最小值是很常见的操作。
案例:找出最长一行的长度
1 | BufferedReader br = new BufferedReader(new FileReader("c:\\SUService.log")); |
案例:使用 distinct 来找出全文不重复的单词,转小写,并排序
1 | List<String> words = br.lines() |
sum
案例:通过 stream() 获取当前小物件的 source,filter 和 mapToInt 是 intermediate 操作,进行数据筛选和转换,最后一个 sum() 为 terminal 操作,对符合条件的全部小物件作重量求和。
1 | int sum = widgets.stream() |
Match
Stream 有三个 match 方法,从语义上说:
- allMatch:Stream 中全部元素符合传入的 predicate,返回 true
- anyMatch:Stream 中只要有一个元素符合传入的 predicate,返回 true
- noneMatch:Stream 中没有一个元素符合传入的 predicate,返回 true
它们都不是要遍历全部元素才能返回结果。例如 allMatch 只要一个元素不满足条件,就 skip 剩下的所有元素,返回 false。对清单 13 中的 Person 类稍做修改,加入一个 age 属性和 getAge 方法。
案例:使用 Match
1 | class Person { |
输出结果:
1 | All are adult? false |
4-3 进阶:自己生成流
Stream.generate
通过实现 Supplier 接口,你可以自己来控制流的生成。这种情形通常用于随机数、常量的 Stream,或者需要前后元素间维持着某种状态信息的 Stream。把 Supplier 实例传递给 Stream.generate() 生成的 Stream,默认是串行(相对 parallel 而言)但无序的(相对 ordered 而言)。由于它是无限的,在管道中,必须利用 limit 之类的操作限制 Stream 大小。
案例:生成 10 个随机整数
1 | Random seed = new Random(); |
Stream.generate() 还接受自己实现的 Supplier。例如在构造海量测试数据的时候,用某种自动的规则给每一个变量赋值;或者依据公式计算 Stream 的每个元素值。这些都是维持状态信息的情形。
案例:自实现 Supplier
1 | Stream.generate(new PersonSupplier()) |
输出结果:
1 | StormTestUser1, 9 |
Stream.iterate
iterate 跟 reduce 操作很像,接受一个种子值,和一个 UnaryOperator(例如 f)。然后种子值成为 Stream 的第一个元素,f(seed) 为第二个,f(f(seed)) 第三个,以此类推。
案例:生成一个等差数列
1 | Stream.iterate(0, n -> n + 3).limit(10). forEach(x -> System.out.print(x + " "));. |
输出结果:
1 | 0 3 6 9 12 15 18 21 24 27 |
与 Stream.generate 相仿,在 iterate 时候管道必须有 limit 这样的操作来限制 Stream 大小。
4-4 进阶:用 Collectors 来进行 reduction 操作
java.util.stream.Collectors 类的主要作用就是辅助进行各类有用的 reduction 操作,例如转变输出为 Collection,把 Stream 元素进行归组。
groupingBy 和 partitioningBy
案例:按照年龄归组
1 | Map<Integer, List<Person>> personGroups = Stream.generate(new PersonSupplier()) |
上面的 code,首先生成 100 人的信息,然后按照年龄归组,相同年龄的人放到同一个 list 中,可以看到如下的输出:
1 | Age 0 = 2 |
案例:按照未成年人和成年人归组
1 | Map<Boolean, List<Person>> children = Stream.generate(new PersonSupplier()) |
输出结果:
1 | Children number: 23 |
在使用条件「年龄小于 18」进行分组后可以看到,不到 18 岁的未成年人是一组,成年人是另外一组。partitioningBy 其实是一种特殊的 groupingBy,它依照条件测试的是否两种结果来构造返回的数据结构,get(true) 和 get(false) 能即为全部的元素对象。
5 结束语
总之,Stream 的特性可以归纳为:
不是数据结构
它没有内部存储,它只是用操作管道从 source(数据结构、数组、generator function、IO channel)抓取数据。
它也绝不修改自己所封装的底层数据结构的数据。例如 Stream 的 filter 操作会产生一个不包含被过滤元素的新 Stream,而不是从 source 删除那些元素。
所有 Stream 的操作必须以 lambda 表达式为参数
不支持索引访问
你可以请求第一个元素,但无法请求第二个,第三个,或最后一个。不过请参阅下一项。
很容易生成数组或者 List
惰性化
很多 Stream 操作是向后延迟的,一直到它弄清楚了最后需要多少数据才会开始。
Intermediate 操作永远是惰性化的。
并行能力
当一个 Stream 是并行化的,就不需要再写多线程代码,所有对它的操作会自动并行进行的。
可以是无限的。集合有固定大小,Stream 则不必。limit(n) 和 findFirst() 这类的 short-circuiting 操作可以对无限的 Stream 进行运算并很快完成。