Java 8 Stream 的終極技巧——Collectors 操作

昨天在 Collection移除元素操作相關的文章中提到了 Collectors 。相信很多同學對這個比較感興趣，那我們今天就來研究一下 Collectors ...

1. 前言

昨天在 Collection移除元素操作相關的文章中提到了 Collectors 。相信很多同學對這個比較感興趣，那我們今天就來研究一下 Collectors 。

2. Collectors 的作用

Collectors 是 Java 8 加入的操作類，位於 java.util.stream 包下。它會根據不同的策略將元素收集歸納起來，比如最簡單常用的是將元素裝入Map、Set、List 等可變容器中。特別對於 Java 8 Stream Api 來說非常有用。它提供了collect() 方法來對 Stream 流進行終結操作派生出基於各種策略的結果集。我們就藉助於 Stream 來熟悉一下 Collectors 吧。我們依然用昨天的例子：

    List<String> servers = new ArrayList<>();
        servers.add("Felordcn");
        servers.add("Tomcat");
        servers.add("Jetty");
        servers.add("Undertow");
        servers.add("Resin");

3. Java 8 中 Collectors 的方法

Collectors 提供了一系列的靜態方法供我們使用，通常情況我們靜態導入即可使用。接下來我們來看看都提供了哪些方法吧。

3.1 類型歸納

這是一個系列，作用是將元素分別歸納進可變容器 List、Map、Set、Collection 或者ConcurrentMap 。

    Collectors.toList();
    Collectors.toMap();
    Collectors.toSet();
    Collectors.toCollection();
    Collectors.toConcurrentMap();

我們可以根據以上提供的 API 使用 Stream 的 collect 方法中的轉換為熟悉的集合容器。非常簡單這裡不再演示。

3.2 joining

將元素以某種規則連接起來。該方法有三種重載 joining(CharSequence delimiter) 和 joining(CharSequence delimiter,CharSequence prefix,CharSequence suffix)

 //   輸出 FelordcnTomcatJettyUndertowResin
 servers.stream().collect(Collectors.joining());

 //   輸出 Felordcn,Tomcat,Jetty,Undertow,Resin
 servers.stream().collect(Collectors.joining("," ));

 //   輸出 [Felordcn,Tomcat,Jetty,Undertow,Resin]
 servers.stream().collect(Collectors.joining(",", "[", "]"));

用的比較多的是讀取 HttpServletRequest 中的 body ：

  HttpServletRequest.getReader().lines().collect(Collectors.joining());

3.3 collectingAndThen

該方法先執行了一個歸納操作，然後再對歸納的結果進行 Function 函數處理輸出一個新的結果。

 // 比如我們將servers joining 然後轉成大寫，結果為： FELORDCN,TOMCAT,JETTY,UNDERTOW,RESIN   
 servers.stream.collect(Collectors.collectingAndThen(Collectors.joining(","), String::toUpperCase));

3.4 groupingBy

按照條件對元素進行分組，和 SQL 中的 group by 用法有異曲同工之妙，通常也建議使用 Java 進行分組處理以減輕資料庫壓力。groupingBy 也有三個重載方法
我們將 servers 按照長度進行分組:

// 按照字元串長度進行分組    符合條件的元素將組成一個 List 映射到以條件長度為key 的 Map<Integer, List<String>> 中
servers.stream.collect(Collectors.groupingBy(String::length))

如果我不想 Map 的 value 為 List 怎麼辦？上面的實現實際上調用了下麵的方式：

 //Map<Integer, Set<String>>
 servers.stream.collect(Collectors.groupingBy(String::length, Collectors.toSet()))

我要考慮同步安全問題怎麼辦？當然使用線程安全的同步容器啊，那前兩種都用不成了吧！別急！我們來推斷一下，其實第二種等同於下麵的寫法:

 Supplier<Map<Integer,Set<String>>> mapSupplier = HashMap::new;
 Map<Integer,Set<String>> collect = servers.stream.collect(Collectors.groupingBy(String::length, mapSupplier, Collectors.toSet()));

這就非常好辦了，我們提供一個同步 Map 不就行了，於是問題解決了：

 Supplier<Map<Integer, Set<String>>> mapSupplier = () -> Collections.synchronizedMap(new HashMap<>());
 Map<Integer, Set<String>> collect = servers.stream.collect(Collectors.groupingBy(String::length, mapSupplier, Collectors.toSet()));

其實同步安全問題 Collectors 的另一個方法 groupingByConcurrent 給我們提供瞭解決方案。用法和 groupingBy 差不多。

3.5 partitioningBy

partitioningBy 我們在本文開頭的提到的文章中已經見識過了，可以看作 groupingBy 的一個特例，基於斷言（Predicate）策略分組。這裡不再舉例說明。

3.6 counting

該方法歸納元素的的數量，非常簡單，不再舉例說明。

3.7 maxBy/minBy

這兩個方法分別提供了查找大小元素的操作，它們基於比較器介面 Comparator 來比較，返回的是一個 Optional 對象。我們來獲取 servers 中最小長度的元素:

 // Jetty  
Optional<String> min = servers.stream.collect(Collectors.minBy(Comparator.comparingInt(String::length)));

這裡其實 Resin 長度也是最小，這裡遵循了 "先入為主" 的原則。當然 Stream.min() 可以很方便的獲取最小長度的元素。maxBy 同樣的道理。

3.8 summingInt/Double/Long

用來做累加計算。計算元素某個屬性的總和,類似 Mysql 的 sum 函數，比如計算各個項目的盈利總和、計算本月的全部工資總和等等。我們這裡就計算一下 servers 中字元串的長度之和（為了舉例不考慮其它寫法）。

 // 總長度 32 
 servers.stream.collect(Collectors.summingInt(s -> s.length()));

3.9 summarizingInt/Double/Long

如果我們對 3.6章節-3.8章節 的操作結果都要怎麼辦？難不成我們搞5個 Stream 流嗎？所以就有了 summarizingInt、summarizingDouble、summarizingLong 三個方法。
這三個方法通過對元素某個屬性的提取，會返回對元素該屬性的統計數據對象，分別對應 IntSummaryStatistics、DoubleSummaryStatistics、LongSummaryStatistics。我們對 servers 中元素的長度進行統計：

 DoubleSummaryStatistics doubleSummaryStatistics = servers.stream.collect(Collectors.summarizingDouble(String::length));
  // {count=5, sum=32.000000, min=5.000000, average=6.400000, max=8.000000}
  System.out.println("doubleSummaryStatistics.toString() = " + doubleSummaryStatistics.toString());

結果 DoubleSummaryStatistics 中包含了 總數，總和，最小值，最大值，平均值 五個指標。

3.10 mapping

該方法是先對元素使用 Function 進行再加工操作，然後用另一個Collector 歸納。比如我們先去掉 servers 中元素的首字母，然後將它們裝入 List 。

 // [elordcn, omcat, etty, ndertow, esin]
 servers.stream.collect(Collectors.mapping(s -> s.substring(1), Collectors.toList()));

有點類似 Stream 先進行了 map 操作再進行 collect ：

 servers.stream.map(s -> s.substring(1)).collect(Collectors.toList());

3.11 reducing

這個方法非常有用！但是如果要瞭解這個就必須瞭解其參數 BinaryOperator<T> 。這是一個函數式介面，是給兩個相同類型的量，返回一個跟這兩個量相同類型的一個結果，偽表達式為 (T,T) -> T。預設給了兩個實現 maxBy 和 minBy ，根據比較器來比較大小並分別返回最大值或者最小值。當然你可以靈活定製。然後 reducing 就很好理解了，元素兩兩之間進行比較根據策略淘汰一個，隨著輪次的進行元素個數就是 reduce 的。那這個有什麼用處呢？ Java 官方給了一個例子：統計每個城市個子最高的人。

  Comparator<Person> byHeight = Comparator.comparing(Person::getHeight);
     Map<String, Optional<Person>> tallestByCity = people.stream()
                          .collect(Collectors.groupingBy(Person::getCity, Collectors.reducing(BinaryOperator.maxBy(byHeight))));

結合最開始給的例子你可以使用 reducing 找出最長的字元串試試。

上面這一層是根據 Height 屬性找最高的 Person ，而且如果這個屬性沒有初始化值或者沒有數據，很有可能拿不到結果所以給出的是 Optional<Person>。如果我們給出了 identity 作一個基準值，那麼我們首先會跟這個基準值進行 BinaryOperator 操作。
比如我們給出高於 2 米的人作為 identity。我們就可以統計每個城市不低於 2 米而且最高的那個人，當然如果該城市沒有人高於 2 米則返回基準值identity ：

 Comparator<Person> byHeight = Comparator.comparing(Person::getHeight);
 Person identity= new Person();
           identity.setHeight(2.);
           identity.setName("identity");
     Map<String, Person> collect = persons.stream()
                        .collect(Collectors.groupingBy(Person::getCity, Collectors.reducing(identity, BinaryOperator.maxBy(byHeight))));

這時候就確定一定會返回一個 Person 了，最起碼會是基準值identity 不再是 Optional 。

還有些情況，我們想在 reducing 的時候把 Person 的身高先四捨五入一下。這就需要我們做一個映射處理。定義一個 Function<? super T, ? extends U> mapper 來乾這個活。那麼上面的邏輯就可以變更為：

   Comparator<Person> byHeight = Comparator.comparing(Person::getHeight);
        Person identity = new Person();
        identity.setHeight(2.);
        identity.setName("identity");
        // 定義映射 處理 四捨五入
        Function<Person, Person> mapper = ps -> {
            Double height = ps.getHeight();

            BigDecimal decimal = new BigDecimal(height);
            Double d = decimal.setScale(1, BigDecimal.ROUND_HALF_UP).doubleValue();
            ps.setHeight(d);
            return ps;
        };
        Map<String, Person> collect = persons.stream()
                .collect(Collectors.groupingBy(Person::getCity, Collectors.reducing(identity, mapper, BinaryOperator.maxBy(byHeight))));

4. 總結

今天我們對 Java 8 中的 Collectors 進行了詳細的講解。如果你熟悉了 Collectors 操作 Stream 會更加得心應手。當然在 Java 8 之後的 Java 9 和 Java 12 中 Collectors 都有新增的功能，後面有時間我們會繼續進行講解。敬請關註！