Java8 中 List 轉 Map(Collectors.toMap) 使用技巧

zhaozhangxiao 發表於 2021-07-24
Java Java 8

在實際專案中我們經常會用到 List 轉 Map 操作,在過去我們可能使用的是 for 迴圈遍歷的方式。舉個例子:

先定義類:

/ 簡單物件 
@Accessors(chain = true) // 鏈式方法 
@lombok.Data
class User {
    private String id;
    private String name;
}

然後有這樣一個 List:

List<User> userList = Lists.newArrayList(
 new User().setId("A").setName("張三"),
 new User().setId("B").setName("李四"),
 new User().setId("C").setName("王五")
);

我們希望轉成 Map 的格式為:

A-> 張三 
B-> 李四 
C-> 王五 

過去的做法(迴圈):

Map<String, String> map = new HashMap<>();
for (User user : userList) {
    map.put(user.getId(), user.getName());
}

Java8 中新增了 Stream 特性,使得我們在處理集合操作時更方便了。
以上述例子為例,我們可以一句話搞定:

userList.stream().collect(Collectors.toMap(User::getId, User::getName));

當然,如果希望得到 Map 的 value 為物件本身時,可以這樣寫:

userList.stream().collect(Collectors.toMap(User::getId, t -> t));
 或:
userList.stream().collect(Collectors.toMap(User::getId, Function.identity()));

關於 Collectors.toMap 方法

Collectors.toMap 有三個過載方法:

toMap(Function<? super T, ? extends K> keyMapper, Function<? super T, ? extends U> valueMapper);
toMap(Function<? super T, ? extends K> keyMapper, Function<? super T, ? extends U> valueMapper,
        BinaryOperator<U> mergeFunction);
toMap(Function<? super T, ? extends K> keyMapper, Function<? super T, ? extends U> valueMapper,
        BinaryOperator<U> mergeFunction, Supplier<M> mapSupplier);

引數含義分別是:

  1. keyMapper:Key 的對映函式
  2. valueMapper:Value 的對映函式
  3. mergeFunction:當 Key 衝突時,呼叫的合併方法
  4. mapSupplier:Map 構造器,在需要返回特定的 Map 時使用
    還是用上面的例子,如果 List 中 userId 有相同的,使用上面的寫法會拋異常:
List<User> userList = Lists.newArrayList(
        new User().setId("A").setName("張三"),
        new User().setId("A").setName("李四"), // Key 相同 
        new User().setId("C").setName("王五")
);
userList.stream().collect(Collectors.toMap(User::getId, User::getName));

// 異常:
java.lang.IllegalStateException: Duplicate key 張三 
    at java.util.stream.Collectors.lambda$throwingMerger$114(Collectors.java:133)
    at java.util.HashMap.merge(HashMap.java:1245)
    at java.util.stream.Collectors.lambda$toMap$172(Collectors.java:1320)
    at java.util.stream.ReduceOps$3ReducingSink.accept(ReduceOps.java:169)
    at java.util.ArrayList$ArrayListSpliterator.forEachRemaining(ArrayList.java:1374)
    at java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:481)
    at java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:471)
    at java.util.stream.ReduceOps$ReduceOp.evaluateSequential(ReduceOps.java:708)
    at java.util.stream.AbstractPipeline.evaluate(AbstractPipeline.java:234)
    at java.util.stream.ReferencePipeline.collect(ReferencePipeline.java:499)
    at Test.toMap(Test.java:17)
    ...

這時就需要呼叫第二個過載方法,傳入合併函式,如:

userList.stream().collect(Collectors.toMap(User::getId, User::getName, (n1, n2) -> n1 + n2));
// 輸出結果:
A-> 張三李四 
C-> 王五 

第四個引數(mapSupplier)用於自定義返回 Map 型別,比如我們希望返回的 Map 是根據 Key 排序的,可以使用如下寫法:

List<User> userList = Lists.newArrayList(
        new User().setId("B").setName("張三"),
        new User().setId("A").setName("李四"),
        new User().setId("C").setName("王五")
);
userList.stream().collect(
    Collectors.toMap(User::getId, User::getName, (n1, n2) -> n1, TreeMap::new)
);
// 輸出結果:
A-> 李四 
B-> 張三 
C-> 王五 

// 輸出結果:
A-> 李四
B-> 張三
C-> 王五

本作品採用《CC 協議》,轉載必須註明作者和本文連結