讲师中心 微信公众号
AI工具推荐 视频效率加速

Spring Boot 中 REST 接口的自定义 DTO 参数校验最佳实践

老磊大大_3282

老磊大大_3282

发布时间:2026-10-13 12:44:05

|

782人浏览过

|

来源于php中文网

原创

Spring Boot 中 REST 接口的自定义 DTO 参数校验最佳实践

本文详解如何在 Spring REST 控制器中对自定义请求体(如 Search 类)实施严格、可反馈的参数校验,确保 JSON 字段拼写错误、空值或结构缺失能被即时捕获并返回清晰错误响应,避免因反序列化默认行为(如忽略未知字段、设空值)导致校验失效。

本文详解如何在 spring rest 控制器中对自定义请求体(如 `search` 类)实施严格、可反馈的参数校验,确保 json 字段拼写错误、空值或结构缺失能被即时捕获并返回清晰错误响应,避免因反序列化默认行为(如忽略未知字段、设空值)导致校验失效。

在 Spring Boot 的 REST 开发中,仅依赖 @Valid 注解并不足以保障请求体的健壮性——尤其当客户端传入非法 JSON(如字段名拼写错误:"seletc" 代替 "select")时,Jackson 默认会静默跳过该字段,将对应 Java 字段设为 null 或空集合,而 @Valid 仅在校验已成功绑定的字段值时生效,无法感知“缺失字段”本身。

因此,真正的解决方案需结合 JSON 反序列化约束 与 Java Bean 校验规则 两层防护:

✅ 正确做法:启用严格反序列化 + 精准字段级校验

1. 启用 Jackson 严格模式(捕获未知字段)

在 application.yml 中配置,让 Jackson 在遇到 JSON 中不存在的字段时立即抛出异常:

spring:
  jackson:
    deserialization:
      fail-on-unknown-properties: true

⚠️ 注意:此配置会使 "seletc": ["id"] 这类拼写错误直接触发 HttpMessageNotReadableException,由 Spring 全局异常处理器统一返回 400 Bad Request,附带明确错误信息(如 "Unrecognized field 'seletc'")。

2. 优化 Search 类的校验注解(聚焦业务语义)

移除冗余 @Valid,改用语义明确的约束注解,并确保集合非空、元素有效:

Spring Boot Actuator Analyzer
Spring Boot Actuator Analyzer

分析Spring Boot Actuator端点的安全性、健康检查、指标暴露及生产配置——审计信息、健康状态和自定义端点。

下载
public class Search {

    @NotEmpty(message = "select 字段不能为空列表")
    @Size(max = 20, message = "select 最多支持 20 个字段")
    private List<String> select = new ArrayList<>();

    @NotEmpty(message = "filters 字段不能为空列表")
    private List<Filter> filters = new ArrayList<>();

    // 构造函数、getter/setter(略)
}

若 Filter 类自身也需校验(如 field 非空、operator 为枚举),则在其类上添加 @Valid(此时 @Valid 才有意义):

public class Filter {
    @NotBlank(message = "field 不能为空")
    private String field;

    @NotNull(message = "operator 不能为空")
    private Operator operator;

    // ...
}

3. 控制器保持简洁声明

@RestController
public class SearchController {

    @PostMapping("/results")
    public ResponseEntity<?> results(
            @NotBlank(message = "id 不能为空") String id,
            @Valid @RequestBody Search search) { // ✅ @RequestBody 显式声明 JSON 绑定
        // 业务逻辑
        return ResponseEntity.ok().build();
    }
}

? 关键点:@RequestBody 不可省略,它明确指示 Spring 使用 HttpMessageConverter(如 MappingJackson2HttpMessageConverter)进行 JSON → Object 转换,使 @Valid 生效。

4. 全局异常处理(提升用户体验)

建议添加 @ControllerAdvice 统一处理校验失败,返回结构化错误:

@ControllerAdvice
public class ValidationExceptionHandler {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<Map<String, String>> handleValidationExceptions(
            MethodArgumentNotValidException ex) {
        Map<String, String> errors = new HashMap<>();
        ex.getBindingResult().getAllErrors().forEach((error) -> {
            String fieldName = ((FieldError) error).getField();
            String errorMessage = error.getDefaultMessage();
            errors.put(fieldName, errorMessage);
        });
        return ResponseEntity.badRequest().body(errors);
    }
}

✅ 总结:三层防御保障校验可靠性

层级 作用 实现方式
反序列化层 拦截非法 JSON 结构(字段名错误、类型不匹配) spring.jackson.deserialization.fail-on-unknown-properties=true
绑定层 确保必需字段存在且非空/符合格式 @NotEmpty, @NotBlank, @Size 等约束注解
传播层 将校验结果转化为友好的 HTTP 响应 @Valid + @RequestBody + 全局异常处理器

通过以上组合策略,即可彻底解决“字段拼写错误无报错”的问题,让接口既健壮又易调试。

热门AI工具

更多
UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

更多
spring boot框架优点
spring boot框架优点

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

611

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应用程序等。

1455

2023.10.12

Java Spring Boot开发
Java Spring Boot开发

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

4686

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 应用的流行工具。

436

2025.12.22

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

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

640

2025.12.24

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

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

385

2026.02.11

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

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

351

2026.02.12

Spring Boot 项目开发与实战
Spring Boot 项目开发与实战

以 Spring Boot 为核心,讲解项目的快速初始化(Spring Initializr)、自动配置与 Starter 依赖原理、配置文件(application.yml)多环境管理、RESTful API 接口开发与参数校验、MyBatis / MyBatis-Plus / Spring Data JPA 数据持久层整合、Redis 缓存集成、统一异常处理与全局响应封装、Swagger / Knife4j 接口文档生成,以及 Ma

326

2026.04.17

PixTV官网入口地址合集
PixTV官网入口地址合集

本专题汇总了 PixTV AI 一站式视频创作平台的官方入口与使用教程。无需下载软件,浏览器直接访问即可使用。平台将剧本、图像、视频、声音与剪辑整合在“无限画布”中,接入 GPT Image 2.5、Seedance 2.5 等头部模型。本专题整理了从新建画布、角色锚定、分镜拆分到视频生成与导出的完整操作指南,助你快速上手 AI 短剧与漫剧创作。

80

2026.10.10

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Spring Boot 官方快速入门指南
Spring Boot 官方快速入门指南

共0课时 | 0人学习

Spring Boot 官方参考文档
Spring Boot 官方参考文档

共0课时 | 0人学习

尚硅谷新版SpringBoot3教程
尚硅谷新版SpringBoot3教程

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn