使用Java Stream高效分组JPA实体并转换数据结构

本文详细介绍了如何利用java stream api高效地对jpa实体列表进行分组和数据转换。通过结合`collectors.groupingby`和`collectors.mapping`，我们能够将实体列表按指定字段（如城市）分组，并将每个分组中的实体进一步转换为另一个指定字段（如姓名）的列表，最终得到`map>`形式的简洁结果，从而替代传统循环的复杂实现，提升代码的优雅性和可读性。

1. 背景与问题描述

在数据处理场景中，我们经常需要从数据库中检索实体列表，并根据某个或某几个属性对其进行分组。更进一步的需求是，在分组后，我们不希望保留完整的实体对象，而是将每个分组中的实体转换成其某个特定属性的列表。

例如，假设我们有一个RegistryEntity实体，包含Id、Name和City字段，对应数据库表如下：

我们的目标是根据City字段对这些实体进行分组，并将每个城市下的RegistryEntity转换为该城市下所有Name的列表，最终得到如下结构：

{
  "New York": ["John", "Josh"],
  "Atlanta": ["Paul", "Charles"],
  "Los Angeles": ["Mark", "Susan"]
}

传统的实现方式可能涉及迭代实体列表，手动创建和填充HashMap，如下所示：

立即学习“Java免费学习笔记（深入）”；

public Map> findAllUsersImperative() {
    List items = registryRepository.findAll(); // 假设从JPA Repository获取实体列表
    Map> itemsGrouped = new HashMap<>();
    for (RegistryEntity s : items) {
        // 检查Map中是否已存在该城市对应的列表
        if (itemsGrouped.containsKey(s.getCity())) {
            itemsGrouped.get(s.getCity()).add(s.getName());
        } else {
            // 如果不存在，则创建新列表并添加姓名
            List tempResults = new ArrayList<>();
            tempResults.add(s.getName());
            itemsGrouped.put(s.getCity(), tempResults);
        }
    }
    return itemsGrouped;
}

这种命令式编程风格虽然能够实现功能，但在代码量、可读性和简洁性方面存在改进空间，尤其是在处理更复杂的数据转换逻辑时。

2. Java Stream API解决方案

Java 8引入的Stream API提供了一种更函数式、声明式且高效的数据处理方式。对于上述分组和转换的需求，我们可以利用Stream配合Collectors.groupingBy和Collectors.mapping来优雅地解决。

首先，我们定义RegistryEntity类：

海螺音乐

海螺AI推出的AI音乐生成工具，可以生成个性化的音乐作品。

下载

import jakarta.persistence.Entity;
import jakarta.persistence.Id; // 或者javax.persistence.Id
import jakarta.persistence.Table; // 或者javax.persistence.Table

@Entity
@Table(name = "registry_entity") // 假设表名为registry_entity
public class RegistryEntity {

    @Id
    private Long id;
    private String name;
    private String city;

    // 构造函数
    public RegistryEntity() {}

    public RegistryEntity(Long id, String name, String city) {
        this.id = id;
        this.name = name;
        this.city = city;
    }

    // Getter方法
    public Long getId() {
        return id;
    }

    public String getName() {
        return name;
    }

    public String getCity() {
        return city;
    }

    // Setter方法 (如果需要)
    public void setId(Long id) {
        this.id = id;
    }

    public void setName(String name) {
        this.name = name;
    }

    public void setCity(String city) {
        this.city = city;
    }

    @Override
    public String toString() {
        return "RegistryEntity{" +
               "id=" + id +
               ", name='" + name + '\'' +
               ", city='" + city + '\'' +
               '}';
    }
}

接着，使用Stream API实现分组和转换逻辑：

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

public class RegistryService {

    // 假设 registryRepository 是一个JPA Repository实例
    // private RegistryRepository registryRepository; 

    public Map> findAllUsersStream() {
        // 模拟从Repository获取数据
        List items = List.of(
            new RegistryEntity(1L, "John", "New York"),
            new RegistryEntity(2L, "Paul", "Atlanta"),
            new RegistryEntity(3L, "Mark", "Los Angeles"),
            new RegistryEntity(4L, "Susan", "Los Angeles"),
            new RegistryEntity(5L, "Josh", "New York"),
            new RegistryEntity(6L, "Charles", "Atlanta")
        );
        // 实际应用中：
        // List items = registryRepository.findAll();

        Map> itemsGrouped =
            items.stream()
                 .collect(Collectors.groupingBy(
                     RegistryEntity::getCity, // 分组函数：按城市分组
                     Collectors.mapping(RegistryEntity::getName, Collectors.toList()) // 下游收集器：将每个组内的实体映射为姓名，并收集到列表中
                 ));

        return itemsGrouped;
    }

    public static void main(String[] args) {
        RegistryService service = new RegistryService();
        Map> result = service.findAllUsersStream();
        System.out.println(result);
        // 预期输出: {New York=[John, Josh], Atlanta=[Paul, Charles], Los Angeles=[Mark, Susan]}
    }
}

3. 代码解析与核心概念

上述Stream解决方案的核心在于Collectors.groupingBy和Collectors.mapping这两个下游收集器。

• Collectors.groupingBy(Function super T, ? extends K> classifier): 这个收集器用于将Stream中的元素根据一个分类函数（classifier）进行分组。它会返回一个Map>，其中K是分类函数返回的键，List是属于该键的所有原始元素的列表。 在我们的例子中，RegistryEntity::getCity作为分类函数，它会根据City属性将RegistryEntity对象分组。如果单独使用groupingBy(RegistryEntity::getCity)，结果将是Map>。

• Collectors.groupingBy(Function super T, ? extends K> classifier, Collector super T, A, D> downstream): 这是groupingBy的重载版本，它允许我们指定一个“下游收集器”（downstream）。这个下游收集器会在每个分组内部对元素进行进一步的处理。 在这里，我们使用Collectors.mapping作为下游收集器。

• Collectors.mapping(Function super T, ? extends U> mapper, Collector super U, A, R> downstream): 这个收集器首先对Stream中的每个元素应用一个映射函数（mapper），然后将映射后的结果传递给其自身的下游收集器。 在我们的例子中：

  • RegistryEntity::getName是映射函数，它将每个RegistryEntity对象转换为其Name字符串。
  • Collectors.toList()是mapping的下游收集器，它将映射后的Name字符串收集到一个List中。

因此，整个流程是：

1. items.stream()：创建RegistryEntity对象的Stream。
2. collect(Collectors.groupingBy(...))：开始分组操作。
3. RegistryEntity::getCity：以城市作为分组的键。
4. Collectors.mapping(RegistryEntity::getName, Collectors.toList())：对于每个城市分组内部的RegistryEntity对象：
   • 调用getName()方法，获取姓名字符串。
   • 将所有获取到的姓名字符串收集到一个新的List中。
5. 最终，groupingBy将这些城市键和对应的姓名列表组合成一个Map>。

4. 优势与注意事项

优势：

• 简洁性与可读性： Stream API的链式调用和声明式风格使得代码更加紧凑和易于理解，清晰地表达了“按城市分组，然后将每个城市的实体映射为姓名列表”的意图。
• 函数式编程： 采用函数式编程范式，避免了显式的循环和可变状态，降低了出错的可能性。
• 并行处理潜力： Stream支持并行流（parallelStream()），在处理大量数据时，可以轻松地利用多核处理器进行并行计算，从而提高性能（尽管对于小规模数据，并行流的开销可能不划算）。
• 代码维护性： 更少的代码量和更清晰的逻辑有助于代码的长期维护。

注意事项：

• 空值处理： 如果RegistryEntity::getCity或RegistryEntity::getName可能返回null，需要考虑如何处理。例如，groupingBy会将null键的元素分到null键对应的组中。如果不想包含null键或null值，可以在stream()之后添加filter操作进行过滤。
• 性能考量： 对于非常大的数据集，虽然Stream API通常效率很高，但其内部实现仍涉及迭代。在极端性能敏感的场景，可能需要进行基准测试以确认最佳方案。然而，对于大多数业务场景，Stream API的性能是足够的。
• 依赖： 确保项目使用Java 8或更高版本。

5. 总结

通过本教程，我们学习了如何利用Java Stream API中的Collectors.groupingBy和Collectors.mapping组合，高效且优雅地实现JPA实体列表的分组和数据转换。这种方法不仅显著提升了代码的简洁性和可读性，还为处理复杂数据转换逻辑提供了强大的函数式编程工具。在日常开发中，优先考虑使用Stream API来处理集合操作，将有助于编写出更健壮、更易于维护的代码。