Java8 Collectors.toMap() 的使用

一、简单介绍

Collectors.toMap()： JDK8 中提供，用于将 Stream 流转换为 Map。

用法1：根据某一属性，对对象的实例或属性做映射

例如：使用 Stream 想要将集合的某一属性（例如手机号）作为 key，对象本身作为 value，这样我们在根据属性获取实例或实例的其他属性时就可以省去遍历每个对象的时间。

// 获取 手机号-UserInfo 映射
Map<String, UserInfo> phoneNumberMap = list.stream().collect(Collectors.toMap(UserInfo::getPhoneNumber(), Function.identity());

用法2：根据某一属性，对对象集合进行去重

原始 JDK8 实现根据某一属性去重：

// 查询数据
List<UserInfo> list = userInfoMapper.getList();
// 根据 姓名 去重
list = list.stream().filter(o -> o.getName() != null).collect(
                Collectors.collectingAndThen(Collectors.toCollection(
                    () -> new TreeSet<>(Comparator.comparing(UserInfo::getName))), ArrayList<Aoo>::new));

通过 Collectors.toMap() 实现根据某一属性去重：

// 查询数据
List<UserInfo> list = userInfoMapper.getList();
// 根据 姓名 去重
Map<String, UserInfo> collect = list.stream()
    .collect(Collectors.toMap(UserInfo::getName, o -> o, (v1, v2) -> v1));
list = new ArrayList<>(collect.values());

二、Duplicate key 异常

1）异常重现：

    public static void main(String[] args) {
        List<User> list = Arrays.asList(
                new User("张三", 15),
                new User("张三", 16));
        // 获取 姓名-年龄 映射
        Map<String, Integer> nameMap = list.stream().collect(Collectors.toMap(User::getName, User::getAge));
        System.out.println(nameMap);
    }

    private static class User {
        private String name;
        private Integer age;
        public User(String name, Integer age) {
            this.name = name;
            this.age = age;
        }
        public String getName() {
            return name;
        }
        public Integer getAge() {
            return age;
        }
        @Override
        public String toString() {
            return "User{" +
                    "name='" + name + '\'' +
                    ", age=" + age +
                    '}';
        }
    }

2）异常截图：

3）异常说明：

​ Collectors.toMap() 在 key 重复的时候，是需要指定处理操作的。默认并不会像 HashMap 一样直接对原值进行覆盖。当出现 key 重复但没有指定操作时，就会抛出一个 IllegalStateException 非法声明异常。

4）异常处理：

​ 我们只需要增加第3个参数，指定当 key 重复时需要进行的操作即可：

// 获取 姓名-年龄 映射
// 第3个参数会执行 Map.merge() 操作，(v1, v2) -> v1 表示重复时抛弃后面的值
Map<String, Integer> nameMap = list.stream()
    .collect(Collectors.toMap(User::getName, User::getAge, (v1, v2) -> v1));

​ 运行程序，输出结果如下：

三、Collectors.toMap() 导致的空指针异常

1）异常重现：

    public static void main(String[] args) {
        List<User> list = Arrays.asList(
                new User("张三", 15),
                new User("李四", null));
        // 获取 姓名-年龄 映射
        Map<String, Integer> nameMap = list.stream()
            .collect(Collectors.toMap(User::getName, User::getAge, (v1, v2) -> v1));
        System.out.println(nameMap);
    }

    private static class User {
        private String name;
        private Integer age;
        public User(String name, Integer age) {
            this.name = name;
            this.age = age;
        }
        public String getName() {
            return name;
        }
        public Integer getAge() {
            return age;
        }
        @Override
        public String toString() {
            return "User{" +
                    "name='" + name + '\'' +
                    ", age=" + age +
                    '}';
        }
    }

2）异常截图：

3）异常说明：

​ 导致空指针是因为 Collectors.toMap() 底层会调用 HashMap.merge() 方法，在执行 merge() 方法的时候会对 value 进行非空判断，从而抛出异常：

4）异常处理：

方法一：替换 null 为一个默认值，比如 -1

// 获取 姓名-年龄 映射
Map<String, Integer> nameMap = list.stream()
    .collect(Collectors.toMap(User::getName, o -> Optional.ofNullable(o.getAge()).orElse(-1), (v1, v2) -> v1));

运行程序，输出结果如下：

方法二：调用 collect() 方法实现

public static void main(String[] args) {
    List<User> list = Arrays.asList(
        new User("张三", 15),
        new User("张三", 16),
        new User("李四", null));
    Map<String, Integer> nameMap = list.stream()
        .collect(HashMap::new, (m, o) -> m.put(o.getName(), userInfo.getAge()), HashMap::putAll);
    System.out.println(nameMap);
}

运行程序，输出结果如下：

四、总结

​ 综合以上两种异常的出现情况和处理方法，考虑到代码的可读性，最终推荐通过如下方式使用 Collectors.toMap()：

// 获取 姓名-年龄 映射
Map<String, Integer> nameMap = list.stream()
    .collect(Collectors.toMap(User::getName, o -> Optional.ofNullable(o.getAge()).orElse(-1), (v1, v2) -> v1));

整理完毕，完结撒花~

参考地址：

1.Java 8中Collectors.toMap空指针异常源码分析，https://blog.csdn.net/ranxiaotop/article/details/125896100