Java中实现数据分组并定制化响应字段的策略

本文探讨了在java中，当需要根据某个属性对数据进行分组，但在最终响应中希望省略该分组属性时，可采用的两种主要策略。我们将详细介绍使用`@jsonignore`注解的简单方法，以及通过创建专用数据传输对象（dto）并结合java stream api进行数据转换的更灵活、更专业的方案，旨在帮助开发者构建清晰、高效的api响应。

在开发API时，我们经常需要从数据源获取一组记录，并根据其中一个或多个属性进行分组。例如，将员工列表按部门分组。然而，在将分组后的数据作为响应返回给客户端时，分组所依据的属性（如部门名称）在每个分组内部的员工记录中可能变得冗余。理想的响应是，分组键作为Map的键存在，而分组内的每个对象不再包含该冗余字段。

考虑以下原始员工记录接口：

public interface EmployeeRecord {
    String getName();
    String getDepartment();
    String getEmail();
}

我们的目标是将这些记录按部门分组，但最终的响应中，每个员工对象只包含 name 和 email 字段，而不包含 department。

方法一：使用 @JsonIgnore 注解

最直接的解决方案是利用Jackson库提供的@JsonIgnore注解。这个注解告诉Jackson在序列化对象到JSON时忽略标记的字段或方法。

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

实现步骤：

1. 在 EmployeeRecord 接口或实现类中，将 @JsonIgnore 注解添加到 getDepartment() 方法上。

import com.fasterxml.jackson.annotation.JsonIgnore;

public interface EmployeeRecord {
    String getName();
    @JsonIgnore // 在序列化时忽略此字段
    String getDepartment();
    String getEmail();
}

2. 分组逻辑保持不变：

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

public record EmployeesDto(Map> employeesRecordList) {

    public static EmployeesDto from(List data) {
        Map> mappedEmployees =
                data.stream().collect(Collectors.groupingBy(EmployeeRecord::getDepartment));
        return new EmployeesDto(mappedEmployees);
    }
}

优点：

• 简单快捷： 实现成本低，只需添加一个注解。
• 无需额外类： 不需要创建新的DTO类。

缺点：

码上飞

码上飞（CodeFlying） 是一款AI自动化开发平台，通过自然语言描述即可自动生成完整应用程序。

下载

• 侵入性： 修改了原始数据模型 EmployeeRecord。如果 department 字段在应用程序的其他部分需要被序列化，或者需要针对不同的API端点有不同的序列化行为，这种方法就不适用。
• 缺乏灵活性： 无法为同一个数据模型提供多种不同的JSON视图。

方法二：创建专用响应 DTO 并结合 Stream API 转换

这种方法更为推荐，因为它遵循了“关注点分离”原则，将内部数据模型与外部API响应模型明确区分开来。它通过创建专门的响应DTO，并在分组过程中进行数据转换，从而实现定制化的输出。

实现步骤：

1. 定义一个简洁的响应 DTO： 创建一个只包含 name 和 email 字段的DTO。

public class EmployeeDetailsDto {
    private String name;
    private String email;

    // 构造函数用于从原始 EmployeeRecord 转换
    public EmployeeDetailsDto(EmployeeRecord employeeRecord) {
        this.name = employeeRecord.getName();
        this.email = employeeRecord.getEmail();
    }

    // Getters (Jackson会通过Getters/Setters或直接字段访问进行序列化)
    public String getName() {
        return name;
    }

    public String getEmail() {
        return email;
    }
}

2. 修改 EmployeesDto 的 from 方法： 在分组操作之后，使用 Collectors.mapping 对每个分组内的 EmployeeRecord 对象进行转换，生成 EmployeeDetailsDto 实例。

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

public record EmployeesDto(Map> employeesRecordList) {

    public static EmployeesDto from(List data) {
        Map> mappedEmployees =
                data.stream().collect(
                        Collectors.groupingBy(
                                EmployeeRecord::getDepartment, // 按部门分组
                                Collectors.mapping(
                                        EmployeeDetailsDto::new, // 将每个 EmployeeRecord 映射为 EmployeeDetailsDto
                                        Collectors.toList() // 收集到列表中
                                )
                        )
                );
        return new EmployeesDto(mappedEmployees);
    }
}

原始 EmployeeRecord 接口保持不变：

public interface EmployeeRecord {
    String getName();
    String getDepartment(); // 不再需要 @JsonIgnore
    String getEmail();
}

预期响应：

{
    "employeesRecordList": {
        "finance": [
            {
                "name": "Jerry Doe",
                "email": "jerry.doe@example.com"
            },
            {
                "name": "Jimmy Doe",
                "email": "jimmy.doe@example.com"
            }
        ],
        "engineering": [
            {
                "name": "Joe Doe",
                "email": "joe.doe@example.com"
            },
            {
                "name": "Joana Doe",
                "email": "joana.doe@example.com"
            }
        ]
    }
}

优点：

• 清晰的分离： 原始数据模型与API响应模型完全解耦，提高了代码的可维护性和可读性。
• 高度灵活： 可以为不同的API端点创建不同的响应DTO，即使它们基于相同的基础数据。
• 非侵入性： 不会修改原始数据模型，使其保持纯净。
• 可测试性强： 转换逻辑集中在 from 方法中，易于测试。

缺点：

• 额外类： 需要创建额外的DTO类。对于非常简单的场景，这可能显得有些繁琐。

选择合适的策略

• 何时使用 @JsonIgnore： 如果 department 字段在整个应用程序的任何JSON序列化场景中都不需要，或者你对修改原始数据模型没有顾虑，且追求最快的实现速度，那么 @JsonIgnore 是一个快速有效的方案。
• 何时使用专用响应 DTO： 对于大多数生产级应用，尤其是在需要维护清晰的API契约、支持不同视图或希望保持数据模型纯净时，创建专用响应 DTO 的方法是更健壮、更专业的选择。它提供了更高的灵活性和更好的架构设计。

总结

在Java中处理数据分组并定制API响应是一个常见需求。无论是通过简单的@JsonIgnore注解，还是通过创建专用DTO并结合Java Stream API的强大转换能力，我们都能够有效地控制API的输出格式。选择哪种方法取决于项目的具体需求、团队的编码规范以及对代码灵活性和可维护性的考量。在多数情况下，推荐使用专用响应DTO的方法，以构建更健壮、更易于扩展的API。