Spring Web 嵌套对象校验失效

news/2025/1/13 9:48:49/

问题复现

  • 当开发一个学籍管理系统时,我们会提供了一个 API 接口去添加学生的相关信息,学生中有个嵌套属性联系电话,其对象定义参考下面的代码:

    import lombok.Data;
    import javax.validation.constraints.Size;
    @Data
    public class Student {@Size(max = 10)private String name;private short age;private Phone phone;
    }@Data
    class Phone {@Size(max = 10)private String number;
    }
    
  • 这里我们也给 Phone 对象做了合法性要求(@Size(max = 10)),当我们使用下面的请求(请求 body 携带一个联系电话信息超过 10 位),测试校验会发现这个约束并不生效。

  • 定义完对象后,我们再定义一个 Controller 去使用它,使用方法如下:

    import lombok.extern.slf4j.Slf4j;
    import org.springframework.web.bind.annotation.RequestBody;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestMethod;
    import org.springframework.web.bind.annotation.RestController;
    @RestController
    @Slf4j
    @Validated
    public class StudentController {@RequestMapping(path = "students", method = RequestMethod.POST)public void addStudent(@Validated @RequestBody Student student){log.info("add new student: {}", student.toString());//省略业务代码};
    }
    
  • 我们提供了一个支持学生信息添加的接口。启动服务后,使用 IDEA 自带的 HTTP Client 工具来发送下面的请求以添加一个学生:

    POST http://localhost:8080/students
    Content-Type: application/json
    {"name": "xiaoming","age": 10,"phone": {"number":"12306123061230612306"}
    }
    
  • 发现校验器并没有生效。

案例解析

  • 关于 student 本身的 Phone 类型成员是否校验是在校验过程中(即案例 1 中的代码行 binder.validate(validationHints))决定的。
  • 在校验执行时,首先会根据 Student 的类型定义找出所有的校验点,然后对 Student 对象实例执行校验,这个逻辑过程可以参考代码 ValidatorImpl#validate:
    @Override
    public final <T> Set<ConstraintViolation<T>> validate(T object, Class<?>... groups) {//省略部分非关键代码Class<T> rootBeanClass = (Class<T>) object.getClass();//获取校验对象类型的“信息”(包含“约束”)BeanMetaData<T> rootBeanMetaData = beanMetaDataManager.getBeanMetaData( rootBeanClass );if ( !rootBeanMetaData.hasConstraints() ) {return Collections.emptySet();}//省略部分非关键代码//执行校验return validateInContext( validationContext, valueContext, validationOrder );
    }
    
  • 这里语句"beanMetaDataManager.getBeanMetaData( rootBeanClass )"根据 Student 类型组装出 BeanMetaData,BeanMetaData 即包含了需要做的校验(即 Constraint)。
  • 在组装 BeanMetaData 过程中,会根据成员字段是否标记了 @Valid 来决定(记录)这个字段以后是否做级联校验,参考代码 AnnotationMetaDataProvider#getCascadingMetaData:
    private CascadingMetaDataBuilder getCascadingMetaData(Type type, AnnotatedElement annotatedElement,Map<TypeVariable<?>, CascadingMetaDataBuilder> containerElementTypesCascadingMetaData) {return CascadingMetaDataBuilder.annotatedObject( type, annotatedElement.isAnnotationPresent( Valid.class ), containerElementTypesCascadingMetaData,getGroupConversions( annotatedElement ) );
    }
    
  • 在上述代码中"annotatedElement.isAnnotationPresent( Valid.class )"决定了 CascadingMetaDataBuilder#cascading 是否为 true。如果是,则在后续做具体校验时,做级联校验,而级联校验的过程与宿主对象(即 Student)的校验过程大体相同,即先根据对象类型获取定义再来做校验。
  • 在当前案例代码中,phone 字段并没有被 @Valid 标记,所以关于这个字段信息的 cascading 属性肯定是 false,因此在校验 Student 时并不会级联校验它。

问题修正

  • 从源码级别了解了嵌套 Validation 失败的原因后,我们会发现,要让嵌套校验生效,解决的方法只有一种,就是加上 @Valid,修正代码如下:
    @Valid
    private Phone phone;
    
  • 当修正完问题后,我们会发现校验生效了。而如果此时去调试修正后的案例代码,会看到 phone 字段 MetaData 信息中的 cascading 确实为 true 了,参考下图:
    在这里插入图片描述

http://www.ppmy.cn/news/1562777.html

相关文章

红队工具使用全解析:揭开网络安全神秘面纱一角

红队工具使用全解析&#xff1a;揭开网络安全神秘面纱一角 B站红队公益课&#xff1a;https://space.bilibili.com/350329294 学习网盘资源链接&#xff1a;https://pan.quark.cn/s/4079487939e8 嘿&#xff0c;各位网络安全爱好者们&#xff01;在风云变幻的网络安全战场上&am…

【C++入门】详解(中)

目录 &#x1f495;1.函数的重载 &#x1f495;2.引用的定义 &#x1f495;3.引用的一些常见问题 &#x1f495;4.引用——权限的放大/缩小/平移 &#x1f495;5. 不存在的空引用 &#x1f495;6.引用作为函数参数的速度之快&#xff08;代码体现&#xff09; &#x1f4…

江科大STM32入门——看门狗笔记整理

wx&#xff1a;嵌入式工程师成长日记 &#xff08;一&#xff09;简介 WDG(Watchdog)看门狗看门狗可以监控程序的运行状态&#xff0c;当程序因为设计漏洞&#xff08;无法预料&#xff09;、硬件故障、电磁干扰等原因&#xff0c;出现卡死或跑飞现象时&#xff0c;看门狗能及…

CSS:定位

CSS定位核心知识点详解 CSS定位是网页布局中的重要概念&#xff0c;它允许开发者将元素放置在页面的指定位置。以下是对CSS定位所有相关详细重要知识点的归纳&#xff1a; 为什么要使用定位&#xff1a; 小黄色块在图片上移动&#xff0c;吸引用户的眼球。 当我们滚动窗口的…

【大数据】Apache Superset:可视化开源架构

Apache Superset是什么 Apache Superset 是一个开源的现代化数据可视化和数据探索平台&#xff0c;主要用于帮助用户以交互式的方式分析和展示数据。有不少丰富的可视化组件&#xff0c;可以将数据从多种数据源&#xff08;如 SQL 数据库、数据仓库、NoSQL 数据库等&#xff0…

如何在 Docker 中切换登录用户

在 Docker 中进行身份验证时&#xff0c;通常是使用 Docker Hub 或其他私有仓库。如果你希望在同一仓库地址上切换不同的用户进行登录&#xff0c;以下是详细的操作步骤。 1. 退出当前用户 首先&#xff0c;使用 docker logout 命令退出当前用户的登录状态。这个操作会清除 D…

【dockerros2】ROS2节点通信:docker容器之间/docker容器与宿主机之间

&#x1f300; 一个中大型ROS项目常需要各个人员分别完成特定的功能&#xff0c;而后再组合部署&#xff0c;而各人员完成的功能常常依赖于一定的环境&#xff0c;而我们很难确保这些环境之间不会相互冲突&#xff0c;特别是涉及深度学习环境时。这就给团队项目的部署落地带来了…

计算机网络之---网络安全的基本概念

网络安全的基本概念 网络安全是保护计算机网络及其传输的数据免受未经授权的访问、攻击、破坏、窃取或损坏的措施和技术的集合。它的目标是确保数据的机密性、完整性和可用性&#xff0c;同时保障网络设备、网络资源和服务的安全。 以下是网络安全的几个基本概念&#xff1a; …