一次 @valid注解不生效排查过程

骑猪看日落 2023-06-17 15:58 127阅读 0赞

### 目录 ###

*   *  一、背景
     *  二、解决过程
     *   *  1.测试过程
         *  2.原因探究
         *  3.解决方案
     *  三、Controller 层@Valid注解原理探究

## 一、背景 ##

在进行一次Controller层单测时，方法参数违反Validation约束，发现却没有抛出预期的【违反约束】异常。

方法参数上的@Valid注解不生效？？

但是以`Tomcat`web容器方式启动，请求该API，@Valid注解却生效了，甚是怪异。

代码如下：

@RestController
    @RequestMapping("/api/user/")
    public class UserController
    
        @RequestMapping(value = "")
    	public Response test(@RequestBody @Valid User user) { 
    		...
    	}
    }

其中`Test`对象如下所示

@Data
    public class User { 
    
        @NotNull(message = "用户名称不能为空!")
        private String name;
    }

单元测试代码如下，注意：这里的user对象并没有设置name属性。

@RunWith(SpringJUnit4ClassRunner.class)
    @ContextConfiguration(locations = { 
            "classpath:/config/spring/application-core.xml",
            "classpath:/config/spring/application-mvc.xml"
    })
    @Transactional
    @Commit
    public class UserControllerTest { 
    
       @Autowired
       private UserController controller;
    
       @Test
       public void test(){ 
          controller.test(new User());
       }
    }

以上`UserControllerTest`在进行测试的时候并未抛出参数校验`ConstraintViolationException`的异常。

下面是mvc配置文件：

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
    
        <context:component-scan base-package="com.mtdp" use-default-filters="false">
            <context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
        </context:component-scan>
        
        <mvc:annotation-driven validator="validator"/>
    
        <bean id="validator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean">
            <property name="providerClass" value="org.hibernate.validator.HibernateValidator"/>
        </bean>
      
    </beans>

## 二、解决过程 ##

### 1.测试过程 ###

在执行单元测试的时候首先暴露出的问题是缺少EL的jar包，因为Hibernate validater执行会依赖EL的jar包。引入对应的jar即可，@see [EL依赖][EL]

<dependency>
        <groupId>org.glassfish</groupId>
        <artifactId>jakarta.el</artifactId>
        <version>3.0.3</version>
    </dependency>

web容器默认会引这个jar，所以不需要添加。

### 2.原因探究 ###

众所周知，`Spring Validation`只是一个抽象，真正执行参数校验的是`hibernate validator`，既然以`Tomcat`的方式能够生效。那么我们的办法：以debug的方式启动`Tomcat`，在`org.hibernate.validator.internal.engine.ValidatorFactoryImpl#getValidator`打上断点，执行Controller层API调用，看是谁调用的该方法，进而执行参数校验的。

结果发现是由`HandlerMethodArgumentResolver`（*该接口的作用是对HandlerMethod的方法参数进行校验、解析、转换等工作*）的实现类`RequestResponseBodyMethodProcessor`调用的。

`RequestResponseBodyMethodProcessor`类会转发给`WebDataBinder`类，由`WebDataBinder`最终委托给真正的`Validator`执行参数校验。如下所示：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70]  
下面是整体的调用链路：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70 1]  
继而使用之前的`UserControllerTest`类进行测试，发现执行路径并不是如此，没有进`DispatcherServlet`类。

问题到此明了了，是因为**测试的姿势**不太对，我们应该使用**Mock mvc**的方式去进行测试，这样的话就会mock出一个mvc环境，路由到`RequestResponseBodyMethodProcessor`（标记`@RequestBody`或者`@ResponseBody`注解的参数**解析器**）进行处理，最终执行到方法参数校验的逻辑。

### 3.解决方案 ###

修改后的测试代码如下所示，这样测试返回的结果是符合预期的，【违反约束】的异常信息被封装在了`MvcResult`的`response`字段中了。

@RunWith(SpringJUnit4ClassRunner.class)
    @ContextConfiguration(locations = { 
            "classpath:/config/spring/application-core.xml",
            "classpath:/config/spring/application-mvc.xml"
    })
    @Transactional
    @Commit
    @WebAppConfiguration
    @EnableWebMvc
    public class UserControllerTest { 
    
        @Autowired
        private WebApplicationContext context;
    
        private MockMvc mockMVC;
    
        @Before
        public void initMockMvc() { 
            mockMVC = MockMvcBuilders.webAppContextSetup(context).build();
        }
    
        @Test
        public void testPage() throws Exception { 
            String userJson = new Gson().toJson(new User());
    		MvcResult mvcResult = mockMVC.perform(MockMvcRequestBuilders.post("/api/user").contentType(MediaType.APPLICATION_JSON).content(userJson)).andReturn();
            System.out.println(mvcResult.getResponse());
        }
    }

## 三、Controller 层@Valid注解原理探究 ##

众所周知，spring mvc XML文件中如果配置了`<mvc:annotation-driven>`标签时，`annotation-driven`标签将会使用`MvcNamespaceHandler`中的`org.springframework.web.servlet.config.AnnotationDrivenBeanDefinitionParser`解析器进行解析。  
`MVC xml handler`类如下：

public class MvcNamespaceHandler extends NamespaceHandlerSupport { 
    
    	@Override
    	public void init() { 
    		registerBeanDefinitionParser("annotation-driven", new AnnotationDrivenBeanDefinitionParser());
    		registerBeanDefinitionParser("default-servlet-handler", new DefaultServletHandlerBeanDefinitionParser());
    		registerBeanDefinitionParser("interceptors", new InterceptorsBeanDefinitionParser());
    		registerBeanDefinitionParser("resources", new ResourcesBeanDefinitionParser());
    		registerBeanDefinitionParser("view-controller", new ViewControllerBeanDefinitionParser());
    		registerBeanDefinitionParser("redirect-view-controller", new ViewControllerBeanDefinitionParser());
    		registerBeanDefinitionParser("status-controller", new ViewControllerBeanDefinitionParser());
    		registerBeanDefinitionParser("view-resolvers", new ViewResolversBeanDefinitionParser());
    		registerBeanDefinitionParser("tiles-configurer", new TilesConfigurerBeanDefinitionParser());
    		registerBeanDefinitionParser("freemarker-configurer", new FreeMarkerConfigurerBeanDefinitionParser());
    		registerBeanDefinitionParser("velocity-configurer", new VelocityConfigurerBeanDefinitionParser());
    		registerBeanDefinitionParser("groovy-configurer", new GroovyMarkupConfigurerBeanDefinitionParser());
    		registerBeanDefinitionParser("script-template-configurer", new ScriptTemplateConfigurerBeanDefinitionParser());
    		registerBeanDefinitionParser("cors", new CorsBeanDefinitionParser());
    	}
    
    }

`org.springframework.web.servlet.config.AnnotationDrivenBeanDefinitionParser`解析器主要是向spring容器中注册了几个mvc组件bean，分别是`RequestMappingHandlerMapping`，`RequestMappingHandlerAdapter`，`ExceptionHandlerExceptionResolver`，代码如下所示：

> mvc:annotation-driven will registers a **RequestMappingHandlerMapping**, a **RequestMappingHandlerAdapter**, and an **ExceptionHandlerExceptionResolver** (among others) in support of processing requests with annotated controller methods using annotations such as @RequestMapping, @ExceptionHandler, and others.  
> ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70 2]

可以看到在上图(1)(2)处解析了`<mvc:annotation-driven>`中的validator属性，并将获取到的`validator`赋值给`RequestMappingHandlerAdapter`中的`webBindingInitializer`中的`validator`属性。

获取`validator`的方法如下所示  
这里的逻辑是，如果`<mvc:annotation-driven>`标签里有配置`validator`属性，将会使用该属性引用的validator bean作为检验器执行参数校验，否则会判断classpath下是否存在[JSR validator][]类，如果存在，将会使用FactoryBean的方式创建默认的`OptionalValidatorFactoryBean`。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70 3]  
这个`validator`最终会在`RequestResponseBodyMethodProcessor`执行参数解析，创建`WebDataBinder`类时被赋值给`WebDataBinder`的`validators`属性（准确来说，应该是作为`validators`的一项）。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70 4]  
在`RequestResponseBodyMethodProcessor#validateIfApplicable`方法中执行校验逻辑。`binder.validate`其实会路由给`binder`的`validators`执行校验。  
这里的`validators`是spring的一个抽象，最终会转发给真实的`validator`（也就是配置的`providerClass` 类）执行参数校验。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70 5]  
至此完成了标注`@RequestBody`注解的方法参数的校验。

[EL]: https://docs.jboss.org/hibernate/stable/validator/reference/en-US/html_single/#validator-gettingstarted-uel
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20191205194351290.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20191205202236947.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20191205184030561.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg==,size_16,color_FFFFFF,t_70
[JSR validator]: https://blog.csdn.net/wt_better/article/details/84623330
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20191205185047982.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/2019120520382237.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg_size_16_color_FFFFFF_t_70 5]: https://img-blog.csdnimg.cn/20191205204408138.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3d0X2JldHRlcg==,size_16,color_FFFFFF,t_70