Spring Boot 中 REST 接口的自定义类参数校验完整实践指南

阿磊姑娘_9187

阿磊姑娘_9187

2026-10-13

564人浏览

原创

Spring Boot 中 REST 接口的自定义类参数校验完整实践指南

本文详解如何在 Spring REST 控制器中对 JSON 请求体绑定的自定义对象(如 Search)进行精准、可反馈的字段级校验,确保非法字段名、空值、类型不匹配等错误在反序列化后立即被捕获并返回标准化错误响应。

本文详解如何在 spring rest 控制器中对 json 请求体绑定的自定义对象(如 search)进行精准、可反馈的字段级校验,确保非法字段名、空值、类型不匹配等错误在反序列化后立即被捕获并返回标准化错误响应。

在 Spring Boot 中,仅依赖 @Valid 并不能自动检测 JSON 中的字段拼写错误(如 "seletc" 误写)或未知字段——因为 Jackson 默认会静默忽略不存在的字段,导致对应 Java 字段为 null 或默认值,而校验逻辑(如 @NotEmpty)才真正触发。因此,校验需分两层协同工作:Jackson 的严格反序列化 + Bean 的约束验证。

✅ 正确做法:组合 Jackson 严格模式与 JSR-303 校验

1. 启用 Jackson 严格反序列化(捕获未知/错别字段)

在 application.yml 中配置:

spring:
  jackson:
    deserialization:
      fail-on-unknown-properties: true  # 遇到 JSON 中不存在的字段(如 "seletc")直接抛出 HttpMessageNotReadableException
      fail-on-null-for-primitives: true

⚠️ 注意:此配置全局生效,确保所有控制器统一行为;若需局部控制,可通过 @JsonCreator + @JsonProperty 手动构造函数实现更细粒度校验。

2. 完善 Search 类的校验注解(捕获空集合、非法元素等)

public class Search {

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

    @NotEmpty(message = "filters 字段不能为空列表")
    @Valid // 若 Filter 类自身含 @NotNull/@Size 等注解,必须加此注解触发递归校验
    private List<filter> filters = new ArrayList();

    // 建议提供无参构造器(Jackson 反序列化必需)
    public Search() {}

    public Search(List<string> select, List<filter> filters) {
        this.select = select != null ? select : new ArrayList();
        this.filters = filters != null ? filters : new ArrayList();
    }

    // getter/setter 省略
}</filter></string></filter></string>

✅ 关键点:

Spring Boot Actuator Analyzer
Spring Boot Actuator Analyzer

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

下载
  • 移除 @Valid 在 List<string></string> 上的冗余使用(String 是不可变基础类型,无需递归校验);
  • @Valid 保留在 List<filter></filter> 上,确保每个 Filter 实例内部校验生效;
  • @NotEmpty 比 @NotNull 更精确:它同时校验 null 和空集合(size()==0)。

3. 控制器方法声明(启用全局校验拦截)

@RestController
public class SearchController {

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

? 说明:@Valid 必须与 @RequestBody 配合使用,才能触发 MethodValidationPostProcessor 的校验链。

4. 全局异常处理(返回友好错误响应)

@ControllerAdvice
public class ValidationExceptionHandler {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<map 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);
    }

    // 处理 Jackson 反序列化失败(如未知字段)
    @ExceptionHandler(HttpMessageNotReadableException.class)
    public ResponseEntity<map string>> handleJsonParseException(
            HttpMessageNotReadableException ex) {
        Map<string string> error = new HashMap();
        error.put("error", "JSON 解析失败:请检查字段名是否正确(如 'select' 而非 'seletc'),并确保符合 API 文档结构");
        return ResponseEntity.badRequest().body(error);
    }
}</string></map></string></map>

✅ 最终效果

  • 当客户端发送 {"seletc":["id"],"filters":[]} → 触发 HttpMessageNotReadableException → 返回明确提示“字段名错误”;
  • 当发送 {"select":[],"filters":[]} → 触发 MethodArgumentNotValidException → 返回 {"select":"select 字段不能为空列表"};
  • 所有校验失败均以 400 Bad Request 响应,避免业务逻辑执行,提升 API 可靠性与调试效率。

? 最佳实践总结:

  • Jackson fail-on-unknown-properties=true 是防御字段拼写错误的第一道防线;
  • @Valid + @NotEmpty/@NotNull 等注解是第二道防线,保障业务语义完整性;
  • 全局 @ControllerAdvice 统一错误格式,让前端能精准定位问题。

相关文章

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

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

下载

相关标签:

spring boot

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

相关专题

更多
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

4686

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

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

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

2026.04.17

326

21

Java Spring Boot多租户架构设计与数据隔离实战
Java Spring Boot多租户架构设计与数据隔离实战

本专题聚焦 Java 企业级系统中的多租户架构设计,讲解数据隔离策略、租户路由机制、数据库分库分表方案以及权限控制模型。通过真实 SaaS 系统案例,帮助开发者构建可扩展的多租户应用架构。

2026.06.29

376

13

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习