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

在實際項目中我們經常會用到 List 轉 Map 操作，在過去我們可能使用的是 for 循環遍歷的方式。舉個例子：

先定義類：

1 2 3 4 5 6 7

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

然后有這樣一個 List：

1 2 3 4 5

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

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

1 2 3

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

過去的做法（循環）：

1 2 3 4

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

使用 Java8 特性 

Java8 中新增了 Stream 特性，使得我們在處理集合操作時更方便了。

以上述例子為例，我們可以一句話搞定：

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

當然，如果希望得到 Map 的 value 為對象本身時，可以這樣寫：

1 2 3

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

關於 Collectors.toMap 方法 

Collectors.toMap 有三個重載方法：

1 2 3 4 5

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 有相同的，使用上面的寫法會拋異常：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21

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

這時就需要調用第二個重載方法，傳入合並函數，如：

1 2 3 4 5

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

第四個參數（mapSupplier）用於自定義返回 Map 類型，比如我們希望返回的 Map 是根據 Key 排序的，可以使用如下寫法：

1 2 3 4 5 6 7 8 9 10 11 12 13

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-> 王五