使用stream的Collectors.toMap()方法常见问题

一、常见问题

stream的Collectors.toMap()方法常见问题：
1、 key不能有重复，否则会报错。java.lang.IllegalStateException: Duplicate key
2、value不能为空，否则报空指针。java.lang.NullPointerException

第一个是由于在List转Map过程中Map集合的key重复导致的；

第二个是由于在List转Map过程中Map集合的value有null导致的（当存在value值为空时，使用Collectors.toMap()会报NPE，因为底层调用了Map的merge方法，而map方法规定了此处的vlue不能为null，从而抛出空指针异常）；

二、key重复问题

详细内容参考《stream流Collectors.toMap()，key值重复问题》

2.1、报错示例

import lombok.AllArgsConstructor;
import lombok.Data;

import java.util.*;
import java.util.stream.Collectors;

public class Test {
    public static void main(String[] args){
        List<User> list = new ArrayList<>();
        User u1 = new User("张三","男");
        User u2 = new User("张三","女");
        list.add(u1);
        list.add(u2);
        //key:姓名  value:性别
        Map<String,String> userMap = list.stream().collect(Collectors.toMap(User::getName, User::getSex));
        System.out.println(userMap);
    }
}

@Data
@AllArgsConstructor
class User{
    //姓名
    private String name;
    //性别
    private String sex;
}

报错信息：

Exception in thread "main" java.lang.IllegalStateException: Duplicate key 男
	at java.util.stream.Collectors.lambda$throwingMerger$0(Collectors.java:133)
	at java.util.HashMap.merge(HashMap.java:1254)
	at java.util.stream.Collectors.lambda$toMap$58(Collectors.java:1320)
	at java.util.stream.ReduceOps$3ReducingSink.accept(ReduceOps.java:169)
	at java.util.ArrayList$ArrayListSpliterator.forEachRemaining(ArrayList.java:1382)
	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 com.springboot.store.Test.main(Test.java:17)

2.2、解决方法

Collectors.toMap指定merge函数
可以自定义一个merge函数来确定key重复时，如何取value。比如下面这种写法，是保留最后一个value。你也可以保留第一个，或者是做一些更复杂的处理。

//key:姓名  value:性别
Map<String,String> userMap = list.stream().collect(Collectors.toMap(User::getName, User::getSex,(oldValue,newValue)->newValue));
System.out.println(userMap);

三、value为空问题

详细内容参考《stream流的Collectors.toMap方法value值为null时的解决方案》

3.1、报错示例

import lombok.AllArgsConstructor;
import lombok.Data;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;

public class Test {
    public static void main(String[] args){
        List<User> list = new ArrayList<>();
        User u1 = new User("张三",null);
        list.add(u1);
        //key:姓名  value:性别
        Map<String,String> userMap = list.stream().collect(Collectors.toMap(User::getName, User::getSex,(o1,o2)->o1));
        System.out.println(userMap);
    }
}

@Data
@AllArgsConstructor
class User{
    //姓名
    private String name;
    //性别
    private String sex;
}

报错信息：

Exception in thread "main" java.lang.NullPointerException
	at java.util.HashMap.merge(HashMap.java:1225)
	at java.util.stream.Collectors.lambda$toMap$58(Collectors.java:1320)
	at java.util.stream.ReduceOps$3ReducingSink.accept(ReduceOps.java:169)
	at java.util.ArrayList$ArrayListSpliterator.forEachRemaining(ArrayList.java:1382)
	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 com.springboot.store.Test.main(Test.java:17)

3.2、解决方法

3.1、方案一

使用Optional类处理value，优点是可以继续使用Collectors.toMap，缺点是为null的value会被改，而这可能违反业务上的期望。

3.2、方案二

使用 Stream#collect(Supplier<R> supplier,BiConsumer<R, ? super T> accumulator,BiConsumer<R, R> combiner)方法，可以保留为null的value。所以个人推荐方案二。

以上两个解决方法的代码如下：

//解决方案一，使用Optional类处理null  若value为空，设置默认值""
HashMap<String, String> map02 = list.stream()
	.collect(Collectors.toMap(User::getName, s -> Optional.ofNullable(s.getSex()).orElse(""), (a, b) -> b, HashMap::new));
System.out.println(map02);

//解决方案二，直接使用collect()方法进行规约操作  调用hashMap putAll方法， 注意key相同时，value会覆盖。
HashMap<String, String> map03 = list.stream()
	.collect(HashMap::new, (map, item) -> map.put(item.getName(), item.getSex()), HashMap::putAll);
System.out.println(map03);