Spring Web 嵌套对象校验失效

问题复现

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

    java 复制代码
    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 去使用它,使用方法如下:

    java 复制代码
    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 工具来发送下面的请求以添加一个学生:

    json 复制代码
    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:

    java 复制代码
    @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:

    java 复制代码
    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,修正代码如下:

    java 复制代码
    @Valid
    private Phone phone;
  • 当修正完问题后,我们会发现校验生效了。而如果此时去调试修正后的案例代码,会看到 phone 字段 MetaData 信息中的 cascading 确实为 true 了,参考下图:

相关推荐
兩尛4 小时前
项目概述、开发环境搭建(day01)
java·spring boot·web
武昌库里写JAVA8 小时前
React方向:react中5种Dom的操作方式
java·开发语言·spring boot·学习·课程设计
前鼻音太阳熊9 小时前
【Spring Boot 应用开发】-02 主要特性
spring boot
Hello Dam10 小时前
基于 FastExcel 与消息队列高效生成及导入机构用户数据
java·数据库·spring boot·excel·easyexcel·fastexcel
Q_274378510910 小时前
springboot高校电子图书馆的大数据平台规划与设计
大数据·spring boot·后端
夕阳之后的黑夜12 小时前
SpringBoot + 九天大模型(文生图接口)
java·spring boot·后端·ai作画
苹果酱056712 小时前
Redis之数据结构
java·spring boot·毕业设计·layui·课程设计
造梦师阿鹏13 小时前
【SpringBoot】用一个常见错误说一下@RequestParam属性
java·spring boot·后端·spring
小奏技术13 小时前
spring boot 2.x升级到3.x需要做哪些改动?让我一步一步带大家实践
spring boot·后端·spring cloud