如何在 REST 请求中按需排除特定字段而不发送 null 值

千宇大大_7861

千宇大大_7861

2026-06-30

824人浏览

原创

如何在 REST 请求中按需排除特定字段而不发送 null 值

本文介绍两种标准、可靠的方式,使同一 java pojo 能灵活适配不同 rest 接口的字段要求:通过 optional 或 jsonnullable 控制 json 序列化行为,确保目标字段在请求中完全不出现(而非传 null),从而满足接口严格的字段校验规则。

本文介绍两种标准、可靠的方式,使同一 java pojo 能灵活适配不同 rest 接口的字段要求:通过 optional 或 jsonnullable 控制 json 序列化行为,确保目标字段在请求中完全不出现(而非传 null),从而满足接口严格的字段校验规则。

在微服务或前后端分离架构中,常需复用同一请求 DTO(如 UserRequest)对接多个 REST 接口,但各接口对字段的要求不同——有的只需 3 个字段,有的则必须包含第 4 个字段。若简单使用 @JsonIgnore,会导致字段被彻底忽略,无法在 Endpoint-2 中使用;而若保留字段并设为 null,Endpoint-1 又可能因接收了非法字段(即使为 null)而校验失败。

✅ 正确解法是让字段“可选但可序列化控制”,即:字段存在时参与序列化,不存在时完全不输出——这正是 Optional 与 JsonNullable 的核心价值。

方案一:使用 java.util.Optional(推荐,零依赖)

将 field4 声明为 Optional,并配合 Jackson 的 @JsonInclude(JsonInclude.Include.NON_EMPTY) 或更精准的 @JsonInclude(JsonInclude.Include.NON_NULL)(注意:Optional.empty() 默认被视为空,不序列化):

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载
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_NULL) // 或 NON_EMPTY(对 Optional 更安全)
    private Optional<string> field4;

    // 构造器、getter/setter 省略
    public static UserRequest forEndpoint1(String f1, String f2, String f3) {
        UserRequest req = new UserRequest();
        req.field1 = f1;
        req.field2 = f2;
        req.field3 = f3;
        req.field4 = Optional.empty(); // 不参与序列化
        return req;
    }

    public static UserRequest forEndpoint2(String f1, String f2, String f3, String f4) {
        UserRequest req = new UserRequest();
        req.field1 = f1;
        req.field2 = f2;
        req.field3 = f3;
        req.field4 = Optional.of(f4); // 仅此时序列化 field4
        return req;
    }
}</string>

⚠️ 注意:Jackson 默认支持 Optional,但需确保使用 Jackson 2.9+,且全局配置或类级 @JsonInclude 生效。若未生效,可在 ObjectMapper 初始化时添加:

objectMapper.setDefaultPropertyInclusion(JsonInclude.Include.NON_EMPTY);

方案二:使用 JsonNullable(OpenAPI 生态友好)

适用于已集成 OpenAPI Generator 或需严格区分“未设置”与“显式 null”的场景。引入依赖:

<!-- Maven -->
<dependency><groupid>org.openapitools</groupid><artifactid>jackson-databind-nullable</artifactid><version>0.2.6</version></dependency>
import org.openapitools.jackson.nullable.JsonNullable;

public class UserRequest {
    private String field1;
    private String field2;
    private String field3;
    private JsonNullable<string> field4;

    // 使用示例
    public static UserRequest forEndpoint1(...) {
        UserRequest req = new UserRequest();
        req.field4 = JsonNullable.undefined(); // 序列化时完全省略
        return req;
    }

    public static UserRequest forEndpoint2(...) {
        UserRequest req = new UserRequest();
        req.field4 = JsonNullable.of("value"); // 序列化为 "field4": "value"
        return req;
    }
}</string>

总结与选型建议

  • ✅ 优先选用 Optional:JDK 原生、无额外依赖、语义清晰(empty() = 字段未提供),适合绝大多数 Spring Boot / Jackson 项目。
  • ✅ 选用 JsonNullable:当项目已基于 OpenAPI 规范生成客户端,或需明确区分 undefined(不传)、null(显式空值)、"value"(有值)三态时。
  • ❌ 避免 @JsonIgnore + 手动设 null:JSON 中仍可能出现 "field4": null,违反 Endpoint-1 的字段白名单策略。
  • ? 补充技巧:可通过 @JsonInclude 注解粒度控制,或定义两个 Builder 方法(如 toEndpoint1Request() / toEndpoint2Request())封装构造逻辑,提升可维护性。

相关文章

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

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

下载

相关标签:

java

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

相关专题

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

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

2025.08.06

2411

22

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

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

2026.01.26

437

25

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

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

2023.09.05

591

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

4546

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

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习