0

0

Spring Boot 中实现特定控制器的 JSON 未知字段校验

心靈之曲

心靈之曲

发布时间:2026-02-03 18:51:00

|

154人浏览过

|

来源于php中文网

原创

Spring Boot 中实现特定控制器的 JSON 未知字段校验

本文介绍如何在 spring boot 应用中,仅对面向客户的 api 请求体启用“禁止未知字段”校验,而不影响内部服务调用(如调用应用 y)时对响应 json 的宽松反序列化。核心方案是结合 `@jsonanysetter` 捕获未知字段,并在控制器层主动校验,兼顾安全性与系统解耦性。

在微服务架构中,面向客户的 API 必须具备强健的输入校验能力——尤其要防范客户端意外或恶意提交未定义字段(如 "colour": "red"),这可能引发数据污染、安全漏洞或下游逻辑异常。但全局启用 spring.jackson.deserialization.fail-on-unknown-properties=true 并不可取:它会强制所有 Jackson 反序列化操作(包括 RestTemplate/WebClient 解析第三方服务响应)都拒绝未知字段,导致应用 X 与应用 Y 之间的接口过度耦合,违背“演进式契约”原则。

因此,推荐采用精准作用域控制策略:仅在关键客户 API 入口处实施未知字段拦截,其余场景(如解析内部服务响应、消息队列 payload 等)保持默认宽容行为。

✅ 推荐实现方式:@JsonAnySetter + 控制器级校验

为待校验的 DTO(如 Product)添加一个通用捕获字段,并通过 @JsonAnySetter 注解将其注册为未知属性接收器:

NexChatGPT
NexChatGPT

火爆全网的IDEA插件,支持IDEA全家桶

下载
public class Product {
    private int id;
    private String name;
    private int price;

    // 捕获所有未声明的 JSON 字段
    private final Map unknownAttributes = new HashMap<>();

    @JsonAnySetter
    public void setUnknown(String key, Object value) {
        unknownAttributes.put(key, value);
    }

    // 提供只读访问(可选)
    public Map getUnknownAttributes() {
        return Collections.unmodifiableMap(unknownAttributes);
    }

    // getter/setter for id, name, price...
}

随后,在目标控制器方法中显式检查该映射是否为空:

@PostMapping("/products")
public ResponseEntity updateProduct(@RequestBody Product product) {
    if (!product.getUnknownAttributes().isEmpty()) {
        String unknownFields = String.join(", ", product.getUnknownAttributes().keySet());
        return ResponseEntity.badRequest()
                .body(new Response("Invalid request: unknown fields detected — " + unknownFields));
    }

    // ✅ 安全执行业务逻辑
    return ResponseEntity.ok(service.update(product));
}

⚠️ 注意事项与增强建议

  • 性能开销极低:@JsonAnySetter 仅在反序列化时触发一次哈希表插入,无反射或动态代理成本。
  • 不干扰全局配置:此方案完全绕过 fail-on-unknown-properties,保留 application.yml 中的默认 Jackson 配置(如 spring.jackson.deserialization.fail-on-null-for-primitives=false),确保内部 HTTP 客户端正常解析含扩展字段的响应。
  • 可封装为通用校验工具:若多处需同类校验,可提取为 @ValidUnknownFields 自定义注解 + ConstraintValidator,配合 @Valid 使用,进一步提升可维护性。
  • 配合 Bean Validation 更佳:建议同时为 Product 添加 @NotNull、@Min 等标准校验注解,并在控制器参数上使用 @Valid,实现字段存在性、格式、语义的全链路防护。

✅ 总结

该方案以最小侵入性实现了“按需严格”的反序列化策略:既杜绝了客户侧非法字段注入风险,又维持了跨服务通信的弹性与兼容性。它体现了微服务设计中“面向外部严守契约、面向内部保持宽容”的最佳实践,是 Spring Boot 应用在开放 API 场景下的稳健选择。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

117

2025.08.06

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

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

69

2026.01.26

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

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

135

2023.09.05

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

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

394

2023.10.12

Java Spring Boot开发
Java Spring Boot开发

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

70

2025.08.19

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

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

59

2025.12.22

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

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

213

2025.12.24

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

425

2023.08.07

全国统一发票查询平台入口合集
全国统一发票查询平台入口合集

本专题整合了全国统一发票查询入口地址合集,阅读专题下面的文章了解更多详细入口。

13

2026.02.03

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.8万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号