Java Stream分组后如何从响应对象中排除特定字段

本文探讨了在java中使用stream api进行数据分组后，如何从最终的json响应对象中排除用于分组的特定字段。我们将介绍两种主要方法：利用jackson库的`@jsonignore`注解直接控制序列化，以及创建专门的响应dto（数据传输对象）进行数据转换。通过这两种方法，开发者可以灵活地定制api响应结构，满足不同的业务需求。

在构建RESTful API时，我们经常需要从数据源获取一组记录，并根据某个属性（例如部门）对这些记录进行分组。然而，在最终的API响应中，我们可能不希望每个分组内的记录对象仍然包含用于分组的那个属性，因为它已经作为分组键存在于响应结构中。例如，对于一个员工记录列表，我们希望按department字段分组，但分组后的每个员工对象中不再显示department字段。

假设我们有以下员工记录接口：

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

以及一个用于将这些记录按部门分组并封装为响应的DTO：

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(EmployeesRecord::getDepartment));
        return new EmployeesDto(mappedEmployees);
    }
}

当前的响应会包含每个员工对象中的department字段：

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

{
    "employeesRecordList": {
        "finance": [
            {
                "name": "Jerry Doe",
                "department": "finance", // 存在
                "email": "jerry.doe@example.com"
            }
            // ...
        ]
        // ...
    }
}

而我们期望的响应是这样的，即每个员工对象中移除了department字段：

{
    "employeesRecordList": {
        "finance": [
            {
                "name": "Jerry Doe",
                "email": "jerry.doe@example.com"
            }
            // ...
        ]
        // ...
    }
}

为了实现这一目标，我们可以采用以下两种主要方法。

方法一：利用@JsonIgnore注解控制JSON序列化

最直接的解决方案是使用Jackson库提供的@JsonIgnore注解。这个注解指示Jackson在将Java对象序列化为JSON时忽略带有该注解的字段或方法。通过在EmployeesRecord接口的getDepartment()方法上添加此注解，我们可以确保department字段不会出现在任何通过EmployeesRecord对象生成的JSON中。

实现步骤：

在EmployeesRecord接口的getDepartment()方法上添加@JsonIgnore注解。

代码示例：

Digram

让Figma更好用的AI神器

下载

import com.fasterxml.jackson.annotation.JsonIgnore; // 导入Jackson注解

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

EmployeesDto.from()方法无需任何修改，因为它仍然处理EmployeesRecord对象，而序列化行为由@JsonIgnore在运行时控制。

优点：

• 简单快捷： 实现非常直接，只需添加一个注解。
• 代码改动小： 不需要创建额外的DTO类或修改复杂的流操作。

缺点：

• 全局性影响： @JsonIgnore是全局性的。一旦应用，所有使用EmployeesRecord进行JSON序列化的地方都会忽略department字段。如果某些API响应或内部逻辑确实需要department字段，这种方法就不适用。
• 紧耦合： EmployeesRecord接口现在与特定的序列化行为（Jackson）紧密耦合。

方法二：创建专门的响应DTO进行数据转换

更灵活、更符合职责分离原则的方法是创建一个专门的响应DTO，它只包含我们希望在最终响应中出现的字段。然后，在数据分组之后，将原始的EmployeesRecord对象映射到这个新的响应DTO。

实现步骤：

1. 定义一个新的响应DTO： 创建一个只包含name和email字段的EmployeeResponse（或类似名称）record或类。
2. 修改EmployeesDto的from方法： 在Collectors.groupingBy之后，使用Collectors.mapping将每个EmployeesRecord实例转换为EmployeeResponse实例。

代码示例：

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

// 1. 定义新的响应DTO，只包含需要展示的字段
public record EmployeeResponse(String name, String email) {
    // 提供一个构造函数，方便从 EmployeesRecord 转换
    public EmployeeResponse(EmployeesRecord record) {
        this(record.getName(), record.getEmail());
    }
}

// 2. 修改 EmployeesDto 的 from 方法，使用新的响应DTO
public record EmployeesDto(Map> employeesRecordList) {

    public static EmployeesDto from(List data) {
        Map> mappedEmployees =
                data.stream().collect(
                        Collectors.groupingBy(
                                EmployeesRecord::getDepartment, // 仍然按 department 分组
                                Collectors.mapping(EmployeeResponse::new, Collectors.toList()) // 将 EmployeesRecord 映射为 EmployeeResponse
                        )
                );
        return new EmployeesDto(mappedEmployees);
    }
}

优点：

• 高度灵活性： EmployeesRecord接口保持原样，department字段在其内部或其他地方仍然可用。
• 职责分离： EmployeesRecord代表原始数据模型，EmployeeResponse代表API的响应数据模型，关注点清晰。
• 精确控制： 可以为不同的API端点创建不同的响应DTO，提供定制化的数据视图。
• 可维护性： 这种模式使得API契约更加明确和稳定。

缺点：

• 增加代码量： 需要额外定义一个DTO类，并稍微修改流操作代码。
• 映射开销： 涉及额外的对象创建和数据复制，但在大多数场景下性能影响可以忽略不计。

选择哪种方法？

• 如果department字段在任何API响应中都不需要，且EmployeesRecord主要用作内部数据表示： 那么方法一（@JsonIgnore）是一个快速简便的选择。它适用于那些在整个应用生命周期中都不希望暴露某个特定字段的场景。
• 如果department字段在其他API或内部逻辑中仍有用途，或者需要为不同的API提供不同字段组合的响应： 强烈推荐使用方法二（创建专门的响应DTO）。这是更符合“关注点分离”和“API契约”的设计模式。它提供了更高的灵活性和更好的可维护性，尤其是在大型或复杂的应用中。

总结

在Java中处理数据分组后从响应对象中排除特定字段的需求时，我们有两种有效的策略：使用Jackson的@JsonIgnore注解进行声明式序列化控制，或通过创建和映射专门的响应DTO实现更精细的数据转换。@JsonIgnore简单直接，适用于全局性排除；而响应DTO模式则提供了无与伦比的灵活性和清晰的职责分离，是构建健壮和可演进API的推荐实践。开发者应根据具体的业务需求和系统架构选择最适合的方法。