Java Stream数据分组与响应属性排除策略

本文探讨在java中使用stream api对数据进行分组后，如何从最终的api响应中排除用于分组的特定属性。文章介绍了两种主要策略：通过jackson库的`@jsonignore`注解直接忽略属性，以及创建专门的响应数据传输对象（dto）进行精细化控制。通过具体代码示例，帮助开发者根据项目需求选择最合适的解决方案，以实现数据模型的清晰分离和灵活的api响应设计。

在构建RESTful API时，我们经常需要对数据进行聚合和转换，以满足客户端的特定需求。一个常见的场景是，我们需要根据某个属性（例如员工的部门）对数据列表进行分组，但在最终返回给客户端的每个分组项中，该分组属性本身却不应出现。这有助于避免数据冗余，并简化API响应的结构。

考虑以下员工记录接口和初始的数据分组逻辑：

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

我们有一个DTO用于封装分组后的结果，其中 String 键代表分组依据（部门），List 是该部门下的员工列表。

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);
    }
}

当前这种分组方式会生成如下的JSON响应，其中每个员工对象都包含了 department 字段：

{
    "employeesRecordList": {
        "finance": [
            {
                "name": "Jerry Doe",
                "department": "finance", // 期望移除
                "email": "jerry@example.com"
            },
            // ...
        ],
        "engineering": [
            {
                "name": "Joe Doe",
                "department": "engineering", // 期望移除
                "email": "joe@example.com"
            },
            // ...
        ]
    }
}

然而，我们的目标响应是每个员工对象中不包含 department 字段，因为它已经作为键存在于外部的分组结构中：

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

为了实现这一目标，我们可以采用以下两种策略。

方案一：使用 @JsonIgnore 注解

Jackson 是 Java 中广泛使用的 JSON 处理库。它提供了一个 @JsonIgnore 注解，允许我们在对象序列化为 JSON 时忽略特定的字段或方法。

实现方式

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

import com.fasterxml.jackson.annotation.JsonIgnore; // 确保导入Jackson库

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

当 EmployeesRecord 接口被序列化为 JSON 时，department 字段将不再出现在输出中。由于 EmployeesDto 的 from 方法仍然使用 EmployeesRecord::getDepartment 进行分组，分组逻辑不受影响，但最终响应中的 EmployeesRecord 对象将不再包含 department 字段。

优点

• 实现简单： 只需添加一个注解，代码改动量小。
• 直接有效： 快速解决特定场景下的序列化问题。

缺点

• 侵入性： 修改了原始数据接口 EmployeesRecord。如果 EmployeesRecord 在其他地方被使用，并且在那些场景下需要 department 字段被序列化，那么这种全局忽略的方式可能会导致问题。
• 全局性： @JsonIgnore 一旦应用，该字段在所有 JSON 序列化场景下都将被忽略，除非有更复杂的 Jackson 配置来覆盖。这可能不符合所有业务需求。
• 依赖特定库： 引入了对 Jackson 库的直接依赖。

方案二：创建专用响应 DTO 进行数据转换

这种方法的核心思想是保持原始数据模型（EmployeesRecord）的纯净性，并通过引入一个专门的响应数据传输对象（DTO）来控制最终的输出结构。在数据分组和转换过程中，将原始的 EmployeesRecord 映射到这个只包含所需字段的新 DTO。

实现方式

1. 定义精简 DTO： 创建一个只包含 name 和 email 字段的 EmployeesNameAndEmail 记录（Record）。同时，为其提供一个从 EmployeesRecord 转换的构造函数。

   public record EmployeesNameAndEmail(String name, String email) {
       // 构造函数用于从 EmployeesRecord 实例创建 EmployeesNameAndEmail
       public EmployeesNameAndEmail(EmployeesRecord record) {
           this(record.getName(), record.getEmail());
       }
   }

2. 修改分组逻辑： 在 EmployeesDto 的 from 方法中，利用 Collectors.groupingBy 的第二个参数 Collector，结合 Collectors.mapping 来实现对每个分组元素的进一步转换。

   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, // 仍使用 department 字段进行分组
                                   Collectors.mapping(
                                           EmployeesNameAndEmail::new, // 将每个 EmployeesRecord 映射到 EmployeesNameAndEmail
                                           Collectors.toList() // 收集为 EmployeesNameAndEmail 的列表
                                   )
                           )
                   );
           return new EmployeesDto(mappedEmployees);
       }
   }

通过这种方式，Collectors.groupingBy 首先根据 department 字段对 EmployeesRecord 列表进行分组，然后 Collectors.mapping 会将每个 EmployeesRecord 实例转换成一个 EmployeesNameAndEmail 实例，最终收集到 Map> 结构中。

优点

• 关注点分离： 原始数据模型 EmployeesRecord 保持不变，不引入任何序列化相关的注解。API 响应模型 EmployeesNameAndEmail 独立定义，职责清晰。
• 灵活性： 可以为不同的 API 响应场景定义不同的 DTO，实现高度定制化，例如，如果另一个 API 需要包含 department 字段，则可以使用另一个 DTO。
• 可维护性： 代码结构清晰，易于理解和维护，尤其是在大型项目中。

缺点

• 增加了代码量： 需要额外定义 DTO 类。
• Stream 操作稍显复杂： 对于初学者来说，Collectors.groupingBy 结合 Collectors.mapping 的用法可能需要一些时间来理解。

选择合适的策略

在选择这两种策略时，需要根据具体的项目需求和设计原则进行权衡：

• 何时使用 @JsonIgnore：

  • 当 department 字段在 所有 JSON 序列化场景下都不需要暴露时。
  • 当原始接口或类是专门为某个特定响应设计的，并且其 department 字段仅用于内部处理而非对外暴露时。
  • 追求最快、最简单的实现方式时。

• 何时使用专用 DTO：

  • 当需要保持原始数据模型（EmployeesRecord）的纯净性，不希望引入序列化注解时。
  • 当 API 响应需要高度定制，或者同一个原始数据模型在不同场景下需要暴露不同的字段组合时。
  • 当需要对数据进行更复杂的转换、过滤或聚合时，专用 DTO 提供更大的灵活性。
  • 在追求代码的解耦、可维护性和长期扩展性时，这是更推荐的做法。

总结

在 Java Stream 中对数据进行分组后，从响应中排除用于分组的属性是一个常见的需求。无论是通过 Jackson 的 @JsonIgnore 注解快速实现，还是通过创建专门的响应 DTO 进行精细化控制，两种方法都能有效解决问题。

@JsonIgnore 适用于快速、简单的场景，但可能对原始数据模型造成侵入。而创建专用 DTO 的方法虽然增加了少量代码，但提供了更好的关注点分离、更高的灵活性和更强的可维护性，是更符合面向对象设计原则和 API 设计最佳实践的选择。开发者应根据具体场景权衡利弊，选择最适合当前项目需求的策略。

# ai  # app  # js  # json  # java  # stream  # restful api 

相关栏目： <？ｍｕｍａ $count = M('archives')->where(['typeid'=>$field['id']])->count(); ?> 【 AI推广<？ｍｕｍａ echo $count; ?> 】 <？ｍｕｍａ $count = M('archives')->where(['typeid'=>$field['id']])->count(); ?> 【 SEO优化<？ｍｕｍａ echo $count; ?> 】 <？ｍｕｍａ $count = M('archives')->where(['typeid'=>$field['id']])->count(); ?> 【 技术百科<？ｍｕｍａ echo $count; ?> 】 <？ｍｕｍａ $count = M('archives')->where(['typeid'=>$field['id']])->count(); ?> 【 谷歌推广<？ｍｕｍａ echo $count; ?> 】 <？ｍｕｍａ $count = M('archives')->where(['typeid'=>$field['id']])->count(); ?> 【 百度推广<？ｍｕｍａ echo $count; ?> 】 <？ｍｕｍａ $count = M('archives')->where(['typeid'=>$field['id']])->count(); ?> 【 网络营销<？ｍｕｍａ echo $count; ?> 】 <？ｍｕｍａ $count = M('archives')->where(['typeid'=>$field['id']])->count(); ?> 【 案例网站<？ｍｕｍａ echo $count; ?> 】 <？ｍｕｍａ $count = M('archives')->where(['typeid'=>$field['id']])->count(); ?> 【 精选文章<？ｍｕｍａ echo $count; ?> 】