Stream流的使用详解（以及Optional类型，Supplier，Stream.generate()，Collectors.groupingBy()，通用函数接口）

内容转自：https://www.ibm.com/developerworks/cn/java/j-lo-java8streamapi/

补充内容。（来自：https://www.cnblogs.com/snowInPluto/p/5981400.html）

通用函数接口

JDK 8 中提供了一组常用的核心函数接口：

接口	参数	返回类型	描述
Predicate	T	boolean	用于判别一个对象。比如求一个人是否为男性
Consumer	T	void	用于接收一个对象进行处理但没有返回，比如接收一个人并打印他的名字
Function<T, R>	T	R	转换一个对象为不同类型的对象
Supplier	None	T	提供一个对象
UnaryOperator	T	T	接收对象并返回同类型的对象
BinaryOperator	(T, T)	T	接收两个同类型的对象，并返回一个原类型对象

其中 Cosumer 与 Supplier 对应，一个是消费者，一个是提供者。

Predicate 用于判断对象是否符合某个条件，经常被用来过滤对象。

Function 是将一个对象转换为另一个对象，比如说要装箱或者拆箱某个对象。

UnaryOperator 接收和返回同类型对象，一般用于对对象修改属性。BinaryOperator 则可以理解为合并对象。

流的使用详解

简单说，对 Stream 的使用就是实现一个 filter-map-reduce 过程，产生一个最终结果，或者导致一个副作用（side effect）。

流的构造与转换

构造流的几种常见方法：

// 1. Individual values
Stream stream = Stream.of("a", "b", "c");
// 2. Arrays
String [] strArray = new String[] {"a", "b", "c"};
stream = Stream.of(strArray);
stream = Arrays.stream(strArray);
// 3. Collections
List<String> list = Arrays.asList(strArray);
stream = list.stream();

其他创建方法见：流的生成方式

需要注意的是，对于基本数值型，目前有三种对应的包装类型 Stream：

IntStream、LongStream、DoubleStream。当然我们也可以用 Stream<Integer>、Stream<Long>、Stream<Double>，但是 boxing 和 unboxing 会很耗时，所以特别为这三种基本数值型提供了对应的 Stream。

Java 8 中还没有提供其它数值型 Stream，因为这将导致扩增的内容较多。而常规的数值型聚合运算可以通过上面三种 Stream 进行。

数值流的构造：

IntStream.of(new int[]{1, 2, 3}).forEach(System.out::println);
IntStream.range(1, 3).forEach(System.out::println);
IntStream.rangeClosed(1, 3).forEach(System.out::println);

流转换为其它数据结构：

Stream<String> stream = Stream.of("a","d","c","b");

// 1. Array
String[] strArray1 = stream.toArray(String[]::new);
// 2. Collection
List<String> list1 = stream.collect(Collectors.toList());
List<String> list2 = stream.collect(Collectors.toCollection(ArrayList::new));
Set set1 = stream.collect(Collectors.toSet());
Stack stack1 = stream.collect(Collectors.toCollection(Stack::new));
// 3. String
String str = stream.collect(Collectors.joining()).toString();

//一个 Stream 只可以使用一次，上面的代码为了简洁而重复使用了数次。

流的操作及经典用法

java8 接口文档：https://docs.oracle.com/javase/8/docs/api/

接下来，当把一个数据结构包装成 Stream 后，就要开始对里面的元素进行各类操作了。常见的操作可以归类如下。

Intermediate：
map (mapToInt, flatMap 等)、 filter、 distinct、 sorted、 peek、 limit、 skip、 parallel、 sequential、 unordered
Terminal：
forEach、 forEachOrdered、 toArray、 reduce、 collect、 min、 max、 count、 anyMatch、 allMatch、 noneMatch、 findFirst、 findAny、 iterator
Short-circuiting：
anyMatch、 allMatch、 noneMatch、 findFirst、 findAny、 limit

我们下面看一下 Stream 的比较典型用法。

map/flatMap

把 input Stream 的每一个元素，映射成 output Stream 的另外一个元素。

map一对一映射：

//转换大写
List<String> output = wordList.stream().
map(String::toUpperCase). //String::toUpperCase是非静态方法，相当于e->e.toUpperCase，符合Function<T,F>的定义
collect(Collectors.toList());

//平方数
List<Integer> nums = Arrays.asList(1, 2, 3, 4);
List<Integer> squareNums = nums.stream().
map(n -> n * n).
collect(Collectors.toList());

flatMap一对多映射：

Stream<List<Integer>> inputStream = Stream.of(
	Arrays.asList(1),
	Arrays.asList(2, 3),
	Arrays.asList(4, 5, 6)
);
Stream<Integer> outputStream = inputStream.
flatMap((childList) -> childList.stream());

java文档中的例子：

If path is the path to a file, then the following produces a stream of the words contained in that file:

Stream<String> lines = Files.lines(path, StandardCharsets.UTF_8);//
Stream<String> words = lines.flatMap(line -> Stream.of(line.split(" ")));
//1.line.split(" ") 根据正则拆分成String数组
//2.Stream.of(line.split(" +")) 构造流，将数组中的多个元素转换成流中的多个元素
//3.flatMap(line -> Stream.of(line.split(" +"))) 将多个流对象合并成一个流对象

The mapper function passed to flatMap splits a line,using a simple regular expression, into an array of words, and then creates a stream of words from that array.

理解flapMap的行为：
flapMap是帮助我们将多个Stream对象合并成一个新的流Stream对象，而我们在方法体中的操作，就是解除不需要的嵌套关系，将包含嵌套关系的Stream流转换成持有目标类型的Stream流对象。比如：

Stream<List<Integer>> inputStream = Stream.of(
	Arrays.asList(1),
	Arrays.asList(2, 3),
	Arrays.asList(4, 5, 6)
);
Stream<Integer> outputStream = inputStream.flatMap((childList) -> childList.stream());

原本的inputStream持有的元素中类型为List<Integer>，而我们在扁平化后的outputStream只想要持有Integer类型的元素，即去除List这层嵌套关系。因此在flapMap中，对每个List<Integer>类型的元素执行childList.stream()方法，转换成Stream<Integer>类型，然后由flatMap进行合并。

filter

filter 对原始 Stream 进行某项测试，通过测试的元素被留下来生成一个新 Stream。

即，保留返回true的元素，抛弃返回false的元素

//留下偶数
Integer[] sixNums = {1, 2, 3, 4, 5, 6};
Integer[] evens =
Stream.of(sixNums).filter(n -> n%2 == 0).toArray(Integer[]::new);

//把单词挑出来
List<String> output = reader.lines().
 flatMap(line -> Stream.of(line.split(REGEXP))).
 filter(word -> word.length() > 0).
 collect(Collectors.toList());
 //首先把每行的单词用 flatMap 整理到新的 Stream，然后保留长度不为 0 的，就是整篇文章中的全部单词了。

forEach/peek

forEach 方法接收一个 Lambda 表达式，然后在 Stream 的每一个元素上执行该表达式。

//打印姓名（forEach 和 pre-java8 的对比）
// Java 8
roster.stream()
 .filter(p -> p.getGender() == Person.Sex.MALE)
 .forEach(p -> System.out.println(p.getName()));
 
// Pre-Java 8
for (Person p : roster) {
 if (p.getGender() == Person.Sex.MALE) {
 System.out.println(p.getName());
 }
}

可以看出来，forEach 是为 Lambda 而设计的，保持了最紧凑的风格。而且 Lambda 表达式本身是可以重用的，非常方便。

当需要为多核系统优化时，可以parallelStream().forEach()，只是此时原有元素的次序没法保证，并行的情况下将改变串行时操作的行为，此时 forEach 本身的实现不需要调整，而 Java8 以前的 for 循环 code 可能需要加入额外的多线程逻辑。

但一般认为，forEach 和常规 for 循环的差异不涉及到性能，它们仅仅是函数式风格与传统 Java 风格的差别。

另外一点需要注意，forEach 是 terminal 操作，因此它执行后，Stream 的元素就被“消费”掉了，你无法对一个 Stream 进行两次 terminal 运算。

相反，具有相似功能的 intermediate 操作 peek 可以达到上述目的。如下是出现在该 api javadoc 上的一个示例。

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());

forEach 不能修改自己包含的本地变量值，也不能用 break/return 之类的关键字提前结束循环。

findFirst

这是一个 termimal 兼 short-circuiting 操作，它总是返回 Stream 的第一个元素，或者空。

这里比较重点的是它的返回值类型：Optional。这也是一个模仿 Scala 语言中的概念，作为一个容器，它可能含有某值，或者不包含。使用它的目的是尽可能避免 NullPointerException。

String strA = " abcd ", strB = null;
print(strA);
print("");
print(strB);
getLength(strA);
getLength("");
getLength(strB);
public static void print(String text) {

 // Java 8
 Optional.ofNullable(text).ifPresent(System.out::println);
 
 // Pre-Java 8
 if (text != null) {
 System.out.println(text);
 }
 }
public static int getLength(String text) {

 // Java 8
return Optional.ofNullable(text).map(String::length).orElse(-1);

 // Pre-Java 8
// return if (text != null) ? text.length() : -1;
 };

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。

// 字符串连接，concat = "ABCD"
String concat = Stream.of("A", "B", "C", "D").reduce("", String::concat); 
// 求最小值，minValue = -3.0
double minValue = Stream.of(-1.5, 1.0, -3.0, -2.0).reduce(Double.MAX_VALUE, Double::min); 
// 求和，sumValue = 10, 有起始值
int sumValue = Stream.of(1, 2, 3, 4).reduce(0, Integer::sum);
// 求和，sumValue = 10, 无起始值
sumValue = Stream.of(1, 2, 3, 4).reduce(Integer::sum).get();
// 过滤，字符串连接，concat = "ace"
concat = Stream.of("a", "B", "c", "D", "e", "F").
 filter(x -> x.compareTo("Z") > 0).
 reduce("", String::concat);

上面代码例如第一个示例的 reduce()，

第一个参数（空白字符）即为起始值，
第二个参数（String::concat）为 BinaryOperator。

这类有起始值的 reduce() 都返回具体的对象。

第四个示例没有起始值的 reduce()，由于可能没有足够的元素，返回的是 Optional，请留意这个区别。（Optional类似单元素的Stream）

limit/skip

limit 返回 Stream 的前面 n 个元素；skip 则是扔掉前 n 个元素。

public void testLimitAndSkip() {
	List<Person> persons = new ArrayList();
	for (int i = 1; i <= 10000; i++) {
		Person person = new Person(i, "name" + i);
		persons.add(person);
	}
	List<String> personList2 = persons.stream().
	map(Person::getName).limit(10).skip(3).collect(Collectors.toList());
	System.out.println(personList2);
}
private class Person {
	public int no;
	private String name;
	public Person (int no, String name) {
		this.no = no;
		this.name = name;
	}
	public String getName() {
		System.out.println(name);
		return name;
	}
}

结果：
name1
name2
name3
name4
name5
name6
name7
name8
name9
name10
[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）后。原因跟 sorted 这个 intermediate 操作有关：此时系统并不知道 Stream 排序后的次序如何，所以 sorted 中的操作看上去就像完全没有被 limit 或者 skip 一样。

List<Person> persons = new ArrayList();
for (int i = 1; i <= 5; i++) {
	Person person = new Person(i, "name" + i);
	persons.add(person);
}
List<Person> personList2 = persons.stream().sorted((p1, p2) -> p1.getName().compareTo(p2.getName()))
		.limit(2).collect(Collectors.toList());
System.out.println(personList2);

结果：
name2
name1
name3
name2
name4
name3
name5
name4
[stream.StreamDW$Person@816f27d, stream.StreamDW$Person@87aac27]

即虽然最后的返回元素数量是 2，但整个管道中的 sorted 表达式执行次数没有像前面例子相应减少。

简单来说就是先排序后限制个数

最后有一点需要注意的是，对一个 parallel 的 Steam 管道来说，如果其元素是有序的，那么 limit 操作的成本会比较大，因为它的返回对象必须是前 n 个也有一样次序的元素。取而代之的策略是取消元素间的次序，或者不要用 parallel Stream。

sorted

对 Stream 的排序通过 sorted 进行，它比数组的排序更强之处在于你可以首先对 Stream 进行各类 map、filter、limit、skip 甚至 distinct 来减少元素数量后，再排序，这能帮助程序明显缩短执行时间。

List<Person> persons = new ArrayList();
for (int i = 1; i <= 5; i++) {
	Person person = new Person(i, "name" + i);
	persons.add(person);
}
List<Person> personList2 = persons.stream().limit(2)
		.sorted((p1, p2) -> p1.getName().compareTo(p2.getName())).collect(Collectors.toList());
System.out.println(personList2);

结果：
name2
name1
[stream.StreamDW$Person@6ce253f1, stream.StreamDW$Person@53d8d10a]

当然，这种优化是有 business logic 上的局限性的：即不要求排序后再取值。

min/max/distinct

min 和 max 的功能也可以通过对 Stream 元素先排序，再 findFirst 来实现，但前者的性能会更好，为 O(n)，而 sorted 的成本是 O(n log n)。同时它们作为特殊的 reduce 方法被独立出来也是因为求最大最小值是很常见的操作。

//找出最长一行的长度
BufferedReader br = new BufferedReader(new FileReader("c:\\SUService.log"));
int longest = br.lines().mapToInt(String::length).max().getAsInt();
br.close();
System.out.println(longest);

使用 distinct 来找出不重复的单词：

//找出全文的单词，转小写，去重，并排序
List<String> words = br.lines().flatMap(line -> Stream.of(line.split(" ")))
				.filter(word -> word.length() > 0).map(String::toLowerCase).distinct().sorted()
				.collect(Collectors.toList());
br.close();
System.out.println(words);

Match

Stream 有三个 match 方法，从语义上说：

allMatch：Stream 中全部元素符合传入的 predicate，返回 true
anyMatch：Stream 中只要有一个元素符合传入的 predicate，返回 true
noneMatch：Stream 中没有一个元素符合传入的 predicate，返回 true

它们都不是要遍历全部元素才能返回结果。例如 allMatch 只要一个元素不满足条件，就 skip 剩下的所有元素，返回 false。

对Person 类稍做修改，加入一个 age 属性和 getAge 方法。

List<Person> persons = new ArrayList();
persons.add(new Person(1, "name" + 1, 10));
persons.add(new Person(2, "name" + 2, 21));
persons.add(new Person(3, "name" + 3, 34));
persons.add(new Person(4, "name" + 4, 6));
persons.add(new Person(5, "name" + 5, 55));
boolean isAllAdult = persons.stream().allMatch(p -> p.getAge() > 18);
System.out.println("All are adult? " + isAllAdult);
boolean isThereAnyChild = persons.stream().anyMatch(p -> p.getAge() < 12);
System.out.println("Any child? " + isThereAnyChild);

private class Person {
	public int no;
	private String name;
	public Person (int no, String name) {
		this.no = no;
		this.name = name;
	}
	public String getName() {
		System.out.println(name);
		return name;
	}
}

结果：
All are adult? false
Any child? true

Supplier接口 ——进阶：自己生成流

Stream.generate

通过实现 Supplier 接口，你可以自己来控制流的生成。这种情形通常用于随机数、常量的 Stream，或者需要前后元素间维持着某种状态信息的 Stream。把 Supplier 实例传递给 Stream.generate() 生成的 Stream，默认是串行（相对 parallel 而言）但无序的（相对 ordered 而言）。由于它是无限的，在管道中，必须利用 limit 之类的操作限制 Stream 大小。

关于构造函数式接口实例

Random seed = new Random();
Supplier<Integer> random = seed::nextInt;//使用方法引用的方式创建函数式接口引用的实例，等价于使用匿名内部类或Lambda表达式
Stream.generate(random).limit(10).forEach(System.out::println);

//Another way
//使用Lambda表达式创建函数式接口引用的实例
IntStream.generate(() -> (int) (System.nanoTime() % 100)).
limit(10).forEach(System.out::println);

Stream.generate() 还接受自己实现的 Supplier。例如在构造海量测试数据的时候，用某种自动的规则给每一个变量赋值；或者依据公式计算 Stream 的每个元素值。这些都是维持状态信息的情形。

Stream.generate(new PersonSupplier()).limit(10)
		.forEach(p -> System.out.println(p.getName() + ", " + p.getAge()));
		
private class PersonSupplier implements Supplier<Person> {
	private int index = 0;
	private Random random = new Random();

	@Override
	public Person get() {
		return new Person(index++, "StormTestUser" + index, random.nextInt(100));
	}
}

输出结果：
StormTestUser1, 9
StormTestUser2, 12
StormTestUser3, 88
StormTestUser4, 51
StormTestUser5, 22
StormTestUser6, 28
StormTestUser7, 81
StormTestUser8, 51
StormTestUser9, 4
StormTestUser10, 76

Stream.iterate

iterate 跟 reduce 操作很像，接受一个种子值，和一个 UnaryOperator（例如 f）。然后种子值成为 Stream 的第一个元素，f(seed) 为第二个，f(f(seed)) 第三个，以此类推。

Stream.iterate(0, n -> n + 3).limit(10). forEach(x -> System.out.print(x + " "));.

与 Stream.generate 相仿，在 iterate 时候管道必须有 limit 这样的操作来限制 Stream 大小。

进阶：用 Collectors 来进行 reduction 操作

java.util.stream.Collectors 类的主要作用就是辅助进行各类有用的 reduction 操作，例如转变输出为 Collection，把 Stream 元素进行归组。

groupingBy/partitioningBy

//按照年龄归组
Map<Integer, List<Person>> personGroups = Stream.generate(new PersonSupplier()).limit(100)
		.collect(Collectors.groupingBy(Person::getAge));
Iterator it = personGroups.entrySet().iterator();
while (it.hasNext()) {
	Map.Entry<Integer, List<Person>> persons = (Map.Entry) it.next();
	System.out.println("Age " + persons.getKey() + " = " + persons.getValue().size());
}

上面的 code，首先生成 100 人的信息，然后按照年龄归组，相同年龄的人放到同一个 list 中，可以看到如下的输出：

结果：
Age 0 = 2
Age 1 = 2
Age 5 = 2
Age 8 = 1
Age 9 = 1
Age 11 = 2
……

按照未成年人和成年人归组

Map<Boolean, List<Person>> children = Stream.generate(new PersonSupplier()).limit(100)
		.collect(Collectors.partitioningBy(p -> p.getAge() < 18));
System.out.println("Children number: " + children.get(true).size());
System.out.println("Adult number: " + children.get(false).size());

结果：
Children number: 23 
Adult number: 77

在使用条件“年龄小于 18”进行分组后可以看到，不到 18 岁的未成年人是一组，成年人是另外一组。partitioningBy 其实是一种特殊的 groupingBy，它依照条件测试的是否两种结果来构造返回的数据结构，get(true) 和 get(false) 能即为全部的元素对象。

串行和并行的流

串行流上的操作是在一个线程中依次完成，而并行流则是在多个线程上同时执行。

并行与串行的流可以相互切换：

通过 stream.sequential() 返回串行的流
通过 stream.parallel() 返回并行的流。

例子：

List<String> list = new ArrayList<String>();
for(int i=0;i<1000000;i++){
	double d = Math.random()*1000;
	list.add(d+"");
}
long start = System.nanoTime();//获取系统开始排序的时间点

//串行和并行
int count= (int) ((Stream) list.stream().sequential()).sorted().count();
int count = (int)((Stream) list.stream().parallel()).sorted().count();

long end = System.nanoTime();//获取系统结束排序的时间点
long ms = TimeUnit.NANOSECONDS.toMillis(end-start);//得到串行排序所用的时间
System.out.println(ms+”ms”);

结果：串行输出为 1200ms，并行输出为 800ms。

Optional类型

这也是一个模仿 Scala 语言中的概念，作为一个容器，它可能含有某值，或者不包含。使用它的目的是尽可能避免 NullPointerException。

Optional里面只持有一个元素，而Stream可持有多个元素

两个用例：

String strA = " abcd ", strB = null;
print(strA);
print("");
print(strB);
getLength(strA);
getLength("");
getLength(strB);

public static void print(String text) {
	//Java 8
	Optional.ofNullable(text).ifPresent(System.out::println);
	 
	// Pre-Java 8
	if (text != null) {
	System.out.println(text);
	}
}
public static int getLength(String text) {
	// Java 8
	return Optional.ofNullable(text).map(String::length).orElse(-1);
	
	// Pre-Java 8
	// return if (text != null) ? text.length() : -1;
};

//还有ifPresentOrElse()方法等