集合串行流工具 - CollStreamUtil

简介

CollStreamUtil 是 Hutool 针对 Java 8 中 Stream 特性进行封装的工具类，主要用于简化集合处理操作，如集合转 Map、分组、转换提取、合并等操作。这些方法能够大幅减少代码量，提高开发效率。

1. 集合转 Map

通过 toIdentityMap 和 toMap 方法，可以将集合转换为 Map。前者使用对象的某个唯一标识作为键，后者支持自定义键和值的生成规则。

示例：集合转 Map

import cn.hutool.core.collection.CollStreamUtil;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.ToString;

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

@Data
@AllArgsConstructor
@ToString
public class Student {
    private long termId;    // 学期 ID
    private long classId;   // 班级 ID
    private long studentId; // 学生 ID
    private String name;    // 学生名称
}

public class CollStreamUtilExample {
    public static void main(String[] args) {
        // 创建学生列表
        List<Student> list = new ArrayList<>();
        list.add(new Student(1, 1, 1, "张三"));
        list.add(new Student(1, 1, 2, "李四"));
        list.add(new Student(1, 1, 3, "王五"));

        // 将学生列表转换为 Map，键为学生 ID，值为学生对象
        Map<Long, Student> studentMap = CollStreamUtil.toIdentityMap(list, Student::getStudentId);

        // 输出学生名称
        System.out.println("ID 为 1 的学生名称: " + studentMap.get(1L).getName()); // 张三

        // 将学生列表转换为 Map，自定义键为学生 ID，值为学生名称
        Map<Long, String> nameMap = CollStreamUtil.toMap(list, Student::getStudentId, Student::getName);

        // 输出学生名称
        System.out.println("ID 为 1 的学生名称: " + nameMap.get(1L)); // 张三
    }
}

• 方法签名：
  • toIdentityMap(Collection<T> collection, Function<? super T, ? extends K> keyMapper)
  • toMap(Collection<T> collection, Function<? super T, ? extends K> keyMapper, Function<? super T, ? extends V> valueMapper)
• 参数说明：
  • collection: 要转换的集合。
  • keyMapper: 用于生成键的映射函数。
  • valueMapper: 用于生成值的映射函数（toMap 方法独有）。
• 返回值：Map<K, T> 或 Map<K, V>，返回转换后的 Map。
• 作用：将集合转换为键值对映射，适用于需要快速查找或操作集合中某个元素的场景。
• 实际开发场景：在处理学生信息、商品列表等结构化数据时，常需要将集合转换为 Map 进行操作。

2. 分组操作

通过 groupByKey 方法，可以将集合按指定规则分组，返回一个以分组键为键、分组结果为值的 Map。

示例：按班级分组

import cn.hutool.core.collection.CollStreamUtil;
import lombok.AllArgsConstructor;
import lombok.Data;

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

@Data
@AllArgsConstructor
class Student {
    private long termId;    // 学期 ID
    private long classId;   // 班级 ID
    private long studentId; // 学生 ID
    private String name;    // 学生名称
}

public class CollStreamUtilExample {
    public static void main(String[] args) {
        // 创建学生列表
        List<Student> list = new ArrayList<>();
        list.add(new Student(1, 1, 1, "张三"));
        list.add(new Student(1, 2, 2, "李四"));
        list.add(new Student(2, 1, 1, "擎天柱"));
        list.add(new Student(2, 2, 2, "威震天"));
        list.add(new Student(2, 3, 2, "霸天虎"));

        // 按班级 ID 分组
        Map<Long, List<Student>> groupedByClass = CollStreamUtil.groupByKey(list, Student::getClassId);

        // 输出分组结果
        groupedByClass.forEach((classId, students) -> {
            System.out.println("班级 ID: " + classId);
            students.forEach(student -> System.out.println("学生: " + student.getName()));
        });
    }
}

• 方法签名：<T, K> Map<K, List<T>> groupByKey(Collection<T> collection, Function<? super T, ? extends K> classifier)
• 参数说明：
  • collection: 要分组的集合。
  • classifier: 用于分组的键生成规则。
• 返回值：Map<K, List<T>>，返回分组后的 Map。
• 作用：将集合按指定规则分组，便于后续批量处理或分类操作。
• 实际开发场景：在处理数据分析、统计分类等场景时，常需要按某个字段对数据进行分组。

3. 转换提取

通过 toList 方法，可以将集合中的元素按照指定规则进行提取和转换，生成一个新的列表。

示例：提取学生姓名列表

import cn.hutool.core.collection.CollStreamUtil;
import lombok.AllArgsConstructor;
import lombok.Data;

import java.util.ArrayList;
import java.util.List;

@Data
@AllArgsConstructor
class Student {
    private long termId;    // 学期 ID
    private long classId;   // 班级 ID
    private long studentId; // 学生 ID
    private String name;    // 学生名称
}

public class CollStreamUtilExample {
    public static void main(String[] args) {
        // 创建学生列表
        List<Student> list = new ArrayList<>();
        list.add(new Student(1, 1, 1, "张三"));
        list.add(new Student(1, 2, 2, "李四"));
        list.add(new Student(2, 1, 1, "擎天柱"));
        list.add(new Student(2, 2, 2, "威震天"));
        list.add(new Student(2, 3, 2, "霸天虎"));

        // 提取学生姓名列表
        List<String> nameList = CollStreamUtil.toList(list, Student::getName);

        // 输出姓名列表
        System.out.println("学生姓名列表: " + nameList);
    }
}

• 方法签名：<T, R> List<R> toList(Collection<T> collection, Function<? super T, ? extends R> mapper)
• 参数说明：
  • collection: 要转换的集合。
  • mapper: 用于生成新列表的映射规则。
• 返回值：List<R>，返回转换后的新列表。
• 作用：将集合中的元素进行转换或提取，生成一个新的列表。
• 实际开发场景：在需要批量提取某个字段或生成新的数据集时，可以使用此方法。

4. 合并两个 Map

通过 merge 方法，可以合并两个具有相同键类型的 Map，并自定义合并规则。对于同一键的不同值，支持自定义处理逻辑。

示例：合并两个学生信息 Map

import cn.hutool.core.collection.CollStreamUtil;
import lombok.AllArgsConstructor;
import lombok.Data;

import java.util.HashMap;
import java.util.Map;

@Data
@AllArgsConstructor
class Student {
    private long termId;    // 学期 ID
    private long classId;   // 班级 ID
    private long studentId; // 学生 ID
    private String name;    // 学生名称
}

public class CollStreamUtilExample {
    public static void main(String[] args) {
        // 创建第一个学生信息 Map
        Map<Long, Student> map1 = new HashMap<>();
        map1.put(1L, new Student(1, 1, 1, "张三"));

        // 创建第二个学生信息 Map
        Map<Long, Student> map2 = new HashMap<>();
        map2.put(1L, new Student(2, 1, 1, "李四"));

        // 定义合并规则：合并两个学生的姓名
        Map<Long, String> mergedMap = CollStreamUtil.merge(map1, map2, (student1, student2) -> {
            if (student1 == null && student2 == null) {
                return null;
            } else if (student1 == null) {
                return student2.getName();
            } else if (student2 ==

 null) {
                return student1.getName();
            } else {
                return student1.getName() + " & " + student2.getName();
            }
        });

        // 输出合并后的结果
        System.out.println("合并后的学生姓名: " + mergedMap.get(1L)); // 张三 & 李四
    }
}

• 方法签名：<K, V, R> Map<K, R> merge(Map<K, V> map1, Map<K, V> map2, BiFunction<? super V, ? super V, ? extends R> mergeFunction)
• 参数说明：
  • map1: 第一个 Map。
  • map2: 第二个 Map。
  • mergeFunction: 合并规则，定义如何处理同一键的不同值。
• 返回值：Map<K, R>，返回合并后的新 Map。
• 作用：将两个 Map 进行合并，并支持自定义合并逻辑。
• 实际开发场景：在多源数据合并、配置项整合等场景中，可以使用此方法处理冲突数据。