Java 8-Stream流

阿新 • • 發佈：2018-12-12

什麼是流

Stream 不是集合元素，它不是資料結構並不儲存資料，它是有關演算法和計算的，它更像一個高階版本的 Iterator。原始版本的 Iterator，使用者只能顯式地一個一個遍歷元素並對其執行某些操作；高階版本的 Stream，使用者只要給出需要對其包含的元素執行什麼操作，比如 “過濾掉長度大於 10 的字串”、“獲取每個字串的首字母”等，Stream 會隱式地在內部進行遍歷，做出相應的資料轉換。

Stream 就如同一個迭代器（Iterator），單向，不可往復，資料只能遍歷一次，遍歷過一次後即用盡了，就好比流水從面前流過，一去不復返。

而和迭代器又不同的是，Stream 可以並行化操作，迭代器只能命令式地、序列化操作。顧名思義，當使用序列方式去遍歷時，每個 item 讀完後再讀下一個 item。而使用並行去遍歷時，資料會被分成多個段，其中每一個都在不同的執行緒中處理，然後將結果一起輸出。Stream 的並行操作依賴於 Java7 中引入的 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

Stream 的另外一大特點是，資料來源本身可以是無限的。

流的構成

當我們使用一個流的時候，通常包括三個基本步驟：

獲取一個數據源（source）→ 資料轉換→執行操作獲取想要的結果，每次轉換原有 Stream 物件不改變，返回一個新的 Stream 物件（可以有多次轉換），這就允許對其操作可以像鏈條一樣排列，變成一個管道，如下圖所示。

有多種方式生成 Stream Source：

從 Collection 和陣列

- Collection.stream()
- Collection.parallelStream()
- Arrays.stream(T array) or 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()

流的操作型別分為兩種：

Intermediate：一個流可以後面跟隨零個或多個 intermediate 操作。其目的主要是開啟流，做出某種程度的資料對映/過濾，然後返回一個新的流，交給下一個操作使用。這類操作都是惰性化的（lazy），就是說，僅僅呼叫到這類方法，並沒有真正開始流的遍歷。
Terminal：一個流只能有一個 terminal 操作，當這個操作執行後，流就被使用“光”了，無法再被操作。所以這必定是流的最後一個操作。Terminal 操作的執行，才會真正開始流的遍歷，並且會生成一個結果，或者一個 side effect。

在對於一個 Stream 進行多次轉換操作 (Intermediate 操作)，每次都對 Stream 的每個元素進行轉換，而且是執行多次，這樣時間複雜度就是 N（轉換次數）個 for 迴圈裡把所有操作都做掉的總和嗎？其實不是這樣的，轉換操作都是 lazy 的，多個轉換操作只會在 Terminal 操作的時候融合起來，一次迴圈完成。我們可以這樣簡單的理解，Stream 裡有個操作函式的集合，每次轉換操作就是把轉換函式放入這個集合中，在 Terminal 操作的時候迴圈 Stream 對應的集合，然後對每個元素執行所有的函式。

還有一種操作被稱為 short-circuiting。用以指：

對於一個 intermediate 操作，如果它接受的是一個無限大（infinite/unbounded）的 Stream，但返回一個有限的新 Stream。
對於一個 terminal 操作，如果它接受的是一個無限大的 Stream，但能在有限的時間計算出結果。

當操作一個無限大的 Stream，而又希望在有限時間內完成操作，則在管道內擁有一個 short-circuiting 操作是必要非充分條件。

流的使用詳解

簡單說，對 Stream 的使用就是實現一個 filter-map-reduce 過程，產生一個最終結果，或者導致一個副作用（side effect）。

流的構造與轉換

下面提供最常見的幾種構造 Stream 的樣例。

清單 4. 構造流的幾種常見方法

// 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 進行。

清單 5. 數值流的構造

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

清單 6. 流轉換為其它資料結構

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

一個 Stream 只可以使用一次，上面的程式碼為了簡潔而重複使用了數次。

流的操作

接下來，當把一個數據結構包裝成 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

我們先來看 map。如果你熟悉 scala 這類函式式語言，對這個方法應該很瞭解，它的作用就是把 input Stream 的每一個元素，對映成 output Stream 的另外一個元素。

清單 7. 轉換大寫

List<String> output = wordList.stream().
map(String::toUpperCase).
collect(Collectors.toList());

這段程式碼把所有的單詞轉換為大寫。

清單 8. 平方數

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

這段程式碼生成一個整數 list 的平方數 {1, 4, 9, 16}。

從上面例子可以看出，map 生成的是個 1:1 對映，每個輸入元素，都按照規則轉換成為另外一個元素。還有一些場景，是一對多對映關係的，這時需要 flatMap。

清單 9. 一對多

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

flatMap 把 input Stream 中的層級結構扁平化，就是將最底層元素抽出來放到一起，最終 output 的新 Stream 裡面已經沒有 List 了，都是直接的數字。

filter

filter 對原始 Stream 進行某項測試，通過測試的元素被留下來生成一個新 Stream。

清單 10. 留下偶數

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

經過條件“被 2 整除”的 filter，剩下的數字為 {2, 4, 6}。

清單 11. 把單詞挑出來

 List<String> output = reader.lines().
 flatMap(line -> Stream.of(line.split(REGEXP))).
 filter(word -> word.length() > 0).
 collect(Collectors.toList());

這段程式碼首先把每行的單詞用 flatMap 整理到新的 Stream，然後保留長度不為 0 的，就是整篇文章中的全部單詞了。

forEach

forEach 方法接收一個 Lambda 表示式，然後在 Stream 的每一個元素上執行該表示式。

清單 12. 列印姓名（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 運算。下面的程式碼是錯誤的：

stream.forEach(element -> doOneThing(element));
stream.forEach(element -> doAnotherThing(element));

相反，具有相似功能的 intermediate 操作 peek 可以達到上述目的。如下是出現在該 api javadoc 上的一個示例。

清單 13. peek 對每個元素執行操作並返回一個新的 Stream

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。

清單 14. Optional 的兩個用例

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;
 };

在更復雜的 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。

清單 15. reduce 的用例

// 字串連線，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，請留意這個區別。

limit/skip

limit 返回 Stream 的前面 n 個元素；skip 則是扔掉前 n 個元素（它是由一個叫 subStream 的方法改名而來）。

清單 16. limit 和 skip 對執行次數的影響

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 這個 intermediate 操作有關：此時系統並不知道 Stream 排序後的次序如何，所以 sorted 中的操作看上去就像完全沒有被 limit 或者 skip 一樣。

清單 17. limit 和 skip 對 sorted 後的執行次數無影響

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

上面的示例對清單 13 做了微調，首先對 5 個元素的 Stream 排序，然後進行 limit 操作。輸出結果為：

name2
name1
name3
name2
name4
name3
name5
name4
[[email protected], [email protected]]

即雖然最後的返回元素數量是 2，但整個管道中的 sorted 表示式執行次數沒有像前面例子相應減少。

最後有一點需要注意的是，對一個 parallel 的 Steam 管道來說，如果其元素是有序的，那麼 limit 操作的成本會比較大，因為它的返回物件必須是前 n 個也有一樣次序的元素。取而代之的策略是取消元素間的次序，或者不要用 parallel Stream。

sorted

對 Stream 的排序通過 sorted 進行，它比陣列的排序更強之處在於你可以首先對 Stream 進行各類 map、filter、limit、skip 甚至 distinct 來減少元素數量後，再排序，這能幫助程式明顯縮短執行時間。我們對清單 14 進行優化：

清單 18. 優化：排序前進行 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().limit(2).sorted((p1, p2) -> p1.getName().compareTo(p2.getName())).collect(Collectors.toList());
System.out.println(personList2);

結果會簡單很多：

name2
name1
[[email protected], [email protected]]

當然，這種優化是有 business logic 上的侷限性的：即不要求排序後再取值。

min/max/distinct

min 和 max 的功能也可以通過對 Stream 元素先排序，再 findFirst 來實現，但前者的效能會更好，為 O(n)，而 sorted 的成本是 O(n log n)。同時它們作為特殊的 reduce 方法被獨立出來也是因為求最大最小值是很常見的操作。

清單 19. 找出最長一行的長度

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 來找出不重複的單詞。

清單 20. 找出全文的單詞，轉小寫，並排序

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。對清單 13 中的 Person 類稍做修改，加入一個 age 屬性和 getAge 方法。

清單 21. 使用 Match

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

輸出結果：

All are adult? false
Any child? true

進階：用 Collectors 來進行 reduction 操作

java.util.stream.Collectors 類的主要作用就是輔助進行各類有用的 reduction 操作，例如轉變輸出為 Collection，把 Stream 元素進行歸組。

groupingBy/partitioningBy

清單 25. 按照年齡歸組

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
……

清單 26. 按照未成年人和成年人歸組

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