让Controller支持对平铺参数执行数据校验（默认Spring MVC使用@Valid只能对JavaBean进行校验）【享学Spring】

亦凉 2021-11-16 16:12 245阅读 0赞

#### 每篇一句 ####

> 在金字塔塔尖的是实践，学而不思则罔，思而不学则殆（现在很多编程框架都只是教你碎片化的实践）

#### 前言 ####

我们知道`Spring MVC`层是**默认**可以支持`Bean Validation`的，但是我在实际使用起来有很多不便之处（相信我的使用痛点也是小伙伴的痛点），就感觉它是个半拉子：只支持对`JavaBean`的验证，而**并不支持对`Controller`处理方法的平铺参数的校验。**

上篇文章一起了解了`Spring MVC`中对`Controller`处理器入参校验的问题，但也仅局限于对`JavaBean`的验证。不可否认对`JavaBean`的校验是我们实际项目使用中较为常见、使用频繁的case，关于此部分详细内容可参见：[【小家Spring】@Validated和@Valid的区别？教你使用它完成Controller参数校验（含级联属性校验）以及原理分析][Spring_Validated_Valid_Controller]

在上文我也提出了使用痛点：我们`Controller`控制器方法中入参，其实大部分情况下都是**平铺参数**而非**JavaBean**的。然而对于平铺参数我们并不能使用`@Validated`像校验`JavaBean`一样去做，并且`Spring MVC`也并没有提供源生的解决方案（其实提供了，哈哈）。  
那怎么办？难道真的只能自己书写重复的`if else`去完成吗？当然不是，那么本文将对此常见的痛点问题（现象）提供两种思路，供给使用者参考~

## Controller层平铺参数的校验 ##

因为`Spring MVC`并不天然支持对**控制器方法**平铺参数的数据校验，但是这种case的却有非常的常见，因此针对这种常见现象提供一些可靠的解决方案，**对你的项目的收益是非常高的。**

##### 方案一：借助Spring对方法级别数据校验的能力 #####

**首先必须明确一点：此能力属于Spring框架的，而部分web框架Spring MVC。**  
`Spring`对方法级别数据校验的能力非常重要（它能对`Service`层、`Dao`层的校验等），前面也重点分析过，具体使用方式参考本文：[【小家Spring】Spring方法级别数据校验：@Validated + MethodValidationPostProcessor优雅的完成数据校验动作][Spring_Spring_Validated _ MethodValidationPostProcessor]

使用此种方案来解决问题的步骤比较简单，使用起来也非常方便。下面我写个简单示例作为参考：

@Configuration
    @EnableWebMvc
    public class WebMvcConfig extends WebMvcConfigurerAdapter { 
        @Bean
        public MethodValidationPostProcessor mvcMethodValidationPostProcessor() { 
            return new MethodValidationPostProcessor();
        }
    }

在`Controller`中 **类** 上使用`@Validated`标注，然后方法上正常使用约束注解标注平铺的属性：

@RestController
    @RequestMapping
    @Validated
    public class HelloController { 
        @PutMapping("/hello/id/{id}/status/{status}")
        public Object helloGet(@Max(5) @PathVariable Integer id, @Min(5) @PathVariable Integer status) { 
            return "hello world";
        }
    }

请求：`/hello/id/6/status/4` 可看见抛异常：  
![在这里插入图片描述][20190730154626124.png]

> 注意一下：这里`arg0 arg1`并没有按照顺序来，字段可别对应错了~~~

由此可见，校验生效了。抛出了`javax.validation.ConstraintViolationException`异常，这样我们再结合一个全局异常的处理程序，也就能达到我们预定的效果了~

这种方案一样有一个**非常值得注意**但是很多人都会忽略的地方：因为我们希望能够代理`Controller`这个Bean，所以仅仅只在父容器中配置`MethodValidationPostProcessor`是无效的，必须在子容器（web容器）的配置文件中再配置一个`MethodValidationPostProcessor`，请务必注意~

> 有小伙伴问我了，为什么它的项目里只配置了一个`MethodValidationPostProcessor`也生效了呢？ **我的回答是：检查一下你是否是用的SpringBoot。**

其实关于配置一个还是多个`MethodValidationPostProcessor`的case，其实是个Bean覆盖有很大关系的，这方面内容可参考：[【小家Spring】聊聊Spring的bean覆盖（存在同名name/id问题），介绍Spring名称生成策略接口BeanNameGenerator][Spring_Spring_bean_name_id_Spring_BeanNameGenerator]

##### 方案二：自己实现，借助HandlerInterceptor做拦截处理（轻量） #####

方案一的使用已经很简单了，但我个人总还觉得怪怪的，因为我一直不喜欢Controller层被代理（可能是洁癖吧）。因此针对这个现象，我自己接下来提供一个自定义拦截器`HandlerInterceptor`的处理方案来实现，大家不一定要使用，也是供以参考嘛~  
设计思路：`Controller`拦截器 + `@Validated`注解 + 自定义校验器（当然这里面涉及到不少细节的：比如入参解析、绑定等等内置的API）

1、准备一个拦截器`ValidationInterceptor`用于处理校验逻辑：

// 注意：此处只支持@RequesrMapping方式~~~~
    public class ValidationInterceptor implements HandlerInterceptor, InitializingBean { 
    
        @Autowired
        private LocalValidatorFactoryBean validatorFactoryBean;
        @Autowired
        private RequestMappingHandlerAdapter adapter;
        private List<HandlerMethodArgumentResolver> argumentResolvers;
    
        @Override
        public void afterPropertiesSet() throws Exception { 
            argumentResolvers = adapter.getArgumentResolvers();
        }
    
        // 缓存
        private final Map<MethodParameter, HandlerMethodArgumentResolver> argumentResolverCache = new ConcurrentHashMap<>(256);
        private final Map<Class<?>, Set<Method>> initBinderCache = new ConcurrentHashMap<>(64);
    
        @Override
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { 
            // 只处理HandlerMethod方式
            if (handler instanceof HandlerMethod) { 
                HandlerMethod method = (HandlerMethod) handler;
                Validated valid = method.getMethodAnnotation(Validated.class); //
                if (valid != null) { 
                    // 根据工厂，拿到一个校验器
                    ValidatorImpl validatorImpl = (ValidatorImpl) validatorFactoryBean.getValidator();
    
                    // 拿到该方法所有的参数们~~~ org.springframework.core.MethodParameter
                    MethodParameter[] parameters = method.getMethodParameters();
                    Object[] parameterValues = new Object[parameters.length];
    
                    //遍历所有的入参：给每个参数做赋值和数据绑定
                    for (int i = 0; i < parameters.length; i++) { 
                        MethodParameter parameter = parameters[i];
                        // 找到适合解析这个参数的处理器~
                        HandlerMethodArgumentResolver resolver = getArgumentResolver(parameter);
                        Assert.notNull(resolver, "Unknown parameter type [" + parameter.getParameterType().getName() + "]");
    
                        ModelAndViewContainer mavContainer = new ModelAndViewContainer();
                        mavContainer.addAllAttributes(RequestContextUtils.getInputFlashMap(request));
    
                        WebDataBinderFactory webDataBinderFactory = getDataBinderFactory(method);
                        Object value = resolver.resolveArgument(parameter, mavContainer, new ServletWebRequest(request, response), webDataBinderFactory);
                        parameterValues[i] = value; // 赋值
                    }
    
                    // 对入参进行统一校验
                    Set<ConstraintViolation<Object>> violations = validatorImpl.validateParameters(method.getBean(), method.getMethod(), parameterValues, valid.value());
                    // 若存在错误消息，此处也做抛出异常处理 javax.validation.ConstraintViolationException
                    if (!violations.isEmpty()) { 
                        System.err.println("方法入参校验失败~~~~~~~");
                        throw new ConstraintViolationException(violations);
                    }
                }
    
            }
    
            return true;
        }
    
        private WebDataBinderFactory getDataBinderFactory(HandlerMethod handlerMethod) { 
            Class<?> handlerType = handlerMethod.getBeanType();
            Set<Method> methods = this.initBinderCache.get(handlerType);
            if (methods == null) { 
                // 支持到@InitBinder注解
                methods = MethodIntrospector.selectMethods(handlerType, RequestMappingHandlerAdapter.INIT_BINDER_METHODS);
                this.initBinderCache.put(handlerType, methods);
            }
            List<InvocableHandlerMethod> initBinderMethods = new ArrayList<>();
            for (Method method : methods) { 
                Object bean = handlerMethod.getBean();
                initBinderMethods.add(new InvocableHandlerMethod(bean, method));
            }
            return new ServletRequestDataBinderFactory(initBinderMethods, adapter.getWebBindingInitializer());
        }
    
        private HandlerMethodArgumentResolver getArgumentResolver(MethodParameter parameter) { 
            HandlerMethodArgumentResolver result = this.argumentResolverCache.get(parameter);
            if (result == null) { 
                for (HandlerMethodArgumentResolver methodArgumentResolver : this.argumentResolvers) { 
                    if (methodArgumentResolver.supportsParameter(parameter)) { 
                        result = methodArgumentResolver;
                        this.argumentResolverCache.put(parameter, result);
                        break;
                    }
                }
            }
            return result;
        }
    
        @Override
        public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { 
        }
        @Override
        public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { 
        }
        
    }

2、配置拦截器到`Web`容器里（拦截所有请求），并且自己配置一个`LocalValidatorFactoryBean`：

@Configuration
    @EnableWebMvc
    public class WebMvcConfig extends WebMvcConfigurerAdapter { 
    
        // 自己配置校验器的工厂 自己随意定制化哦~
        @Bean
        public LocalValidatorFactoryBean localValidatorFactoryBean() { 
            return new LocalValidatorFactoryBean();
        }
    
        // 配置用于校验的拦截器
        @Bean
        public ValidationInterceptor validationInterceptor() { 
            return new ValidationInterceptor();
        }
        @Override
        public void addInterceptors(InterceptorRegistry registry) { 
            registry.addInterceptor(validationInterceptor()).addPathPatterns("/**");
        }
    }

3、`Controller`的**方法**（只需要在方法上标注即可）上标注`@Validated`注解：

@Validated // 只需要方法处标注注解即可 非常简便
        @GetMapping("/hello/id/{id}/status/{status}")
        public Object helloGet(@Max(5) @PathVariable("id") Integer id, @Min(5) @PathVariable("status") Integer status) { 
            return "hello world";
        }

访问`/hello/id/6/status/4` 能看到如下异常：  
![在这里插入图片描述][20190730172541595.png]  
同样的完美完成了我们的校验需求。针对我自己书写的这一套，这里继续有必要再说说两个小细节：

1.  本例的`@PathVariable("id")`是指定的`value`值的，因为在处理`@PathVariable`过程中我并没有去分析字节码来得到形参名，所以为了简便此处写上value值，当然这里是可以优化的，有兴趣的小伙伴可自行定制
2.  因为制定了`value`值，错误信息中也能正确识别出字段名了~
3.  在`Spring MVC`的自动数据封装体系中，`value`值不是必须的，只要字段名对应上了也是`ok`的（这里面运用了字节码技术，后文有讲解）。但是在数据校验中，它可并没有用到字节码结束，请注意做出区分~~~

#### 总结 ####

本文介绍了**两种方案**来处理我们平时遇到`Controller`中对处理方法**平铺类型**的数据校验问题，至于具体你选择哪种方案当然是仁者见仁了。（方案一简便，方案二需要你对`Spring MVC`的处理流程`API`很熟练，可炫技）

数据校验相关知识介绍至此，不管是`Java`上的数据校验，还是`Spring`上的数据校验，都可以统一使用优雅的`Bean Validation`来完成了。希望这么长时间来讲的内容能对你的项目**有实地的作用**，真的能让你的工程变得更加的简介，甚至高能。毕竟真正做技术的人都是追求一定的极致性，甚至是存在代码洁癖，甚至是偏执的~

> 此种洁癖据我了解表现在多个方面：比如没使用的变量一定要删除、代码格式不好看一定要格式化、看到重复代码一定要提取公因子等等~

#### 相关阅读 ####

[深入了解数据校验：Java Bean Validation 2.0（JSR303、JSR349、JSR380）Hibernate-Validation 6.x使用案例【享学Java】][Java Bean Validation 2.0_JSR303_JSR349_JSR380_Hibernate-Validation 6.x_Java]  
[@Validated和@Valid的区别？教你使用它完成Controller参数校验（含级联属性校验）以及原理分析【享学Spring】][Spring_Validated_Valid_Controller]  
[Spring方法级别数据校验：@Validated + MethodValidationPostProcessor优雅的完成数据校验动作【享学Spring】][Spring_Spring_Validated _ MethodValidationPostProcessor]

--------------------

# 关注A哥 #

<table> 
 <thead> 
  <tr> 
   <th>Author</th> 
   <th><a href="https://www.yourbatman.cn/about" rel="nofollow">A哥(YourBatman)</a></th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>个人站点</td> 
   <td><a href="https://www.yourbatman.cn" rel="nofollow">www.yourbatman.cn</a></td> 
  </tr> 
  <tr> 
   <td>E-mail</td> 
   <td>yourbatman@qq.com</td> 
  </tr> 
  <tr> 
   <td><strong>微 信</strong></td> 
   <td><a href="https://www.yourbatman.cn/images/wechat.png" rel="nofollow">fsx641385712</a></td> 
  </tr> 
  <tr> 
   <td><strong><code>活跃平台</code></strong></td> 
   <td><a href="https://www.yourbatman.cn" rel="nofollow"><img src="https://img-blog.csdnimg.cn/2020071015182276.png" alt=""></a> <a href="https://fangshixiang.blog.csdn.net/" rel="nofollow"><img src="https://img-blog.csdnimg.cn/20200710151913394.png" alt=""></a><a href="https://yourbatman.cnblogs.com" rel="nofollow"><img src="https://img-blog.csdnimg.cn/20200710151929355.png" alt=""></a><a href="https://juejin.im/user/5b44d178f265da0fa1220efe/posts" rel="nofollow"><img src="https://img-blog.csdnimg.cn/20200710151938937.png" alt=""></a><a href="https://www.zhihu.com/people/fangshixiang/posts" rel="nofollow"><img src="https://img-blog.csdnimg.cn/20200710151950629.png" alt=""></a><a href="https://www.jianshu.com/u/8740f1fdd684" rel="nofollow"><img src="https://img-blog.csdnimg.cn/20200710152000530.png" alt=""></a><a href="https://segmentfault.com/u/yourbatman/articles" rel="nofollow"><img src="https://img-blog.csdnimg.cn/20200710152008726.png" alt=""></a><a href="https://github.com/yourbatman" rel="nofollow"><img src="https://img-blog.csdnimg.cn/20200710152015895.png" alt=""></a></td> 
  </tr> 
  <tr> 
   <td><strong>公众号</strong></td> 
   <td><a href="https://www.yourbatman.cn/images/wechat_channel.jpg" rel="nofollow">BAT的乌托邦（ID：BAT-utopia）</a></td> 
  </tr> 
  <tr> 
   <td>知识星球</td> 
   <td><a href="https://t.zsxq.com/nQBi66I" rel="nofollow">BAT的乌托邦</a></td> 
  </tr> 
  <tr> 
   <td>每日文章推荐</td> 
   <td><a href="https://github.com/yourbatman/reading/issues" rel="nofollow">每日文章推荐</a></td> 
  </tr> 
 </tbody> 
</table>

![BAT的乌托邦][BAT]

[Spring_Validated_Valid_Controller]: https://blog.csdn.net/f641385712/article/details/97621783
[Spring_Spring_Validated _ MethodValidationPostProcessor]: https://blog.csdn.net/f641385712/article/details/97402946
[20190730154626124.png]: /images/20211116/b9071da07a924d29a411e9adeb4d849c.png
[Spring_Spring_bean_name_id_Spring_BeanNameGenerator]: https://blog.csdn.net/f641385712/article/details/93777536
[20190730172541595.png]: /images/20211116/06eaa86bd64e4bf784bafe48eb103d05.png
[Java Bean Validation 2.0_JSR303_JSR349_JSR380_Hibernate-Validation 6.x_Java]: https://blog.csdn.net/f641385712/article/details/96638596
[BAT]: /images/20211116/3689492fa6f74b4ba80d93a35cf30718.png