如何在 REST 请求中按需排除特定字段而不影响其他端点

浅萱酱_1600

浅萱酱_1600

2026-06-29

569人浏览

原创

如何在 REST 请求中按需排除特定字段而不影响其他端点

通过使用 optional 或 jsonnullable 包装可选字段,可在共享同一 pojo 的前提下,灵活控制 json 序列化时是否包含该字段,从而满足不同 rest 端点对请求结构的差异化要求。

通过使用 optional 或 jsonnullable 包装可选字段,可在共享同一 pojo 的前提下,灵活控制 json 序列化时是否包含该字段,从而满足不同 rest 端点对请求结构的差异化要求。

在微服务或前后端协作开发中,常需复用同一数据模型(如 UserRequest)向多个 REST 接口发送请求,但各接口对字段的要求并不一致:有的仅接受子集字段,若多传了字段(哪怕是 null),可能直接导致 400 Bad Request 或服务端校验失败。此时,简单使用 @JsonIgnore 并不可行——它会全局忽略字段,无法按场景动态控制;而为每个端点单独定义 DTO 又违背 DRY 原则、增加维护成本。

推荐方案:用 Optional 实现条件序列化

Jackson 默认不序列化值为 null 的字段(需确保配置 SerializationFeature.WRITE_NULLS 为 false,这是默认行为),但 Optional.empty() 不等于 null,因此需配合 Jackson 的 @JsonInclude(JsonInclude.Include.NON_EMPTY) 或更精准的 @JsonInclude(JsonInclude.Include.NON_ABSENT):

吐槽大师
吐槽大师

一款以 AI 为核心的趣味文案生成工具,主打根据人物或内容生成轻松幽默的吐槽文本,适合社交媒体互动和娱乐表达。

下载
import com.fasterxml.jackson.annotation.JsonInclude;
import java.util.Optional;

public class UserRequest {
    private String field1;
    private String field2;
    private String field3;

    @JsonInclude(JsonInclude.Include.NON_ABSENT)
    private Optional<string> field4;

    // 构造函数、getter/setter 略
    public UserRequest(String field1, String field2, String field3) {
        this.field1 = field1;
        this.field2 = field2;
        this.field3 = field3;
        this.field4 = Optional.empty(); // Endpoint-1 不传 field4
    }

    public UserRequest(String field1, String field2, String field3, String field4) {
        this.field1 = field1;
        this.field2 = field2;
        this.field3 = field3;
        this.field4 = Optional.ofNullable(field4); // Endpoint-2 显式传入
    }
}</string>

✅ 效果说明:

  • 向 Endpoint-1 发送实例时,field4 = Optional.empty() → 序列化后 JSON 完全不包含 field4 字段;
  • 向 Endpoint-2 发送时,field4 = Optional.of("value") → 序列化后 JSON 包含 "field4": "value";
  • 若传入 Optional.ofNullable(null),仍等效于 Optional.empty(),安全可靠。

⚠️ 注意事项:

  • 确保项目中 Jackson 版本 ≥ 2.9(NON_ABSENT 自 2.9 起支持);
  • Optional 仅适用于 只读场景(如请求体),不建议用于 JPA 实体或需要反序列化的响应模型(因 Optional 在反序列化时存在限制);
  • 若需双向支持(即也允许服务端返回 Optional 字段),可搭配 jackson-databind-nullable 库使用 JsonNullable,其专为 JSON 场景设计,语义更清晰:
<!-- Maven -->
<dependency><groupid>org.openapitools</groupid><artifactid>jackson-databind-nullable</artifactid><version>0.2.6</version></dependency>
private JsonNullable<string> field4; // 序列化逻辑同 Optional,但反序列化更健壮</string>

总结:Optional + @JsonInclude(NON_ABSENT) 是轻量、标准、零依赖的解决方案;若项目已引入 OpenAPI 工具链或需更强类型语义,JsonNullable 是更专业的替代选择。二者均能实现「一 POJO 多端点」的灵活适配,避免冗余类与运行时错误。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

2025.08.06

2471

22

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

2026.01.26

457

25

spring boot框架优点
spring boot框架优点

spring boot框架的优点有简化配置、快速开发、内嵌服务器、微服务支持、自动化测试和生态系统支持。本专题为大家提供spring boot相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.05

611

5

spring框架有哪些
spring框架有哪些

spring框架有Spring Core、Spring MVC、Spring Data、Spring Security、Spring AOP和Spring Boot。详细介绍:1、Spring Core,通过将对象的创建和依赖关系的管理交给容器来实现,从而降低了组件之间的耦合度;2、Spring MVC,提供基于模型-视图-控制器的架构,用于开发灵活和可扩展的Web应用程序等。

2023.10.12

1455

7

Java Spring Boot开发
Java Spring Boot开发

本专题围绕 Java 主流开发框架 Spring Boot 展开,系统讲解依赖注入、配置管理、数据访问、RESTful API、微服务架构与安全认证等核心知识,并通过电商平台、博客系统与企业管理系统等项目实战,帮助学员掌握使用 Spring Boot 快速开发高效、稳定的企业级应用。

2025.08.19

4706

10

Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性
Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性

Spring Boot 是一个基于 Spring 框架的 Java 开发框架,它通过 约定优于配置的原则,大幅简化了 Spring 应用的初始搭建、配置和开发过程,让开发者可以快速构建独立的、生产级别的 Spring 应用,无需繁琐的样板配置,通常集成嵌入式服务器(如 Tomcat),提供“开箱即用”的体验,是构建微服务和 Web 应用的流行工具。

2025.12.22

436

5

Java Spring Boot 微服务实战
Java Spring Boot 微服务实战

本专题深入讲解 Java Spring Boot 在微服务架构中的应用,内容涵盖服务注册与发现、REST API开发、配置中心、负载均衡、熔断与限流、日志与监控。通过实际项目案例(如电商订单系统),帮助开发者掌握 从单体应用迁移到高可用微服务系统的完整流程与实战能力。

2025.12.24

640

18

Spring Boot企业级开发与MyBatis Plus实战
Spring Boot企业级开发与MyBatis Plus实战

本专题面向 Java 后端开发者,系统讲解如何基于 Spring Boot 与 MyBatis Plus 构建高效、规范的企业级应用。内容涵盖项目架构设计、数据访问层封装、通用 CRUD 实现、分页与条件查询、代码生成器以及常见性能优化方案。通过完整实战案例,帮助开发者提升后端开发效率,减少重复代码,快速交付稳定可维护的业务系统。

2026.02.11

385

24

Kotlin协程编程与Spring Boot集成实践
Kotlin协程编程与Spring Boot集成实践

本专题围绕 Kotlin 协程机制展开,深入讲解挂起函数、协程作用域、结构化并发与异常处理机制,并结合 Spring Boot 展示协程在后端开发中的实际应用。内容涵盖异步接口设计、数据库调用优化、线程资源管理以及性能调优策略,帮助开发者构建更加简洁高效的 Kotlin 后端服务架构。

2026.02.12

351

18

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.4万人学习