Collectors.toMap使用详解

Posted 2023-05-13

参考技术A toMap(Function, Function) 返回一个 Collector，它将元素累积到一个 Map中，其键和值是将提供的映射函数应用于输入元素的结果。

如果映射的键包含重复项，则在执行收集操作时会抛出IllegalStateException。如果映射的键可能有重复项，请改用  toMap(Function, Function, BinaryOperator)。

然后构造一个List

        List<Student> list = new ArrayList<>();

        for (int i = 1; i < 4; i++)

        list.add(new Student(i+"","学生"+i));

       

1. 将list转成以id为key的map，value是id对应的Sudent对象： 

Map<String, Student> map = list.stream().collect(Collectors.toMap(Student::getId, Function.identity()));

2.假如id存在重复值，则会报错Duplicate key xxx, 解决方案是：

只取后一个key及value：

Map<String, Student> map = list.stream().collect(Collectors.toMap(Student::getId,Function.identity(),(oldValue,newValue) -> newValue))

只取前一个key及value：

Map<String, Student> map = list.stream().collect(Collectors.toMap(Student::getId,Function.identity(),(oldValue,newValue) -> oldValue))

3.想获得一个id和name对应的Map<String, String> ：

Map<String, String> map = list.stream().collect(Collectors.toMap(Student::getId,Student::getName)); 

注意：name可以为空字符串但不能为null，否则会报空指针，解决方案：

Map<String, String> map = list.stream().collect(Collectors.toMap(Student::getId, e->e.getName()==null?"":e.getName()));

假如存在id重复，两个vaue可以这样映射到同一个id：

Map<String, String> map = list.stream().collect(Collectors.toMap(Student::getId,Student::getName,(e1,e2)->e1+","+e2));

4.把Student集合按照group分组到map中

Map<String, List<Student>> map = list.stream().collect(Collectors.groupingBy(Student::getGroup));

5.过滤去重，两个List<Student> 

List<Student> list1 = new ArrayList<>();

List<Student> list2= new ArrayList<>();

HashMap<String, String> hashMap = new HashMap<>();

for (int i = 1; i < 4; i++)

    list1.add(new Student(i+"","学生"+i));



for (int i = 2; i < 5; i++)

    list2.add(new Student(i+"","学生"+i));



Map<String, Student> map2 = list2.stream().collect(Collectors.toMap(Student::getId,Function.identity()));

//把List1和List2中id重复的Student对象的name取出来：

List<String> strings = list1.stream().map(Student::getId).filter(map2::containsKey).map(map2::get).map(Student::getName).collect(Collectors.toList());

System.out.println(strings);// 输出 [学生2, 学生3]

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

在实际项目中我们经常会用到 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 特性

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