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

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

前言


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


上篇文章一起了解了Spring MVC中对Controller处理器入参校验的问题,但也仅局限于对JavaBean的验证。不可否认对JavaBean的校验是我们实际项目使用中较为常见、使用频繁的case,关于此部分详细内容可参见:【小家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优雅的完成数据校验动作


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


@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 可看见抛异常:


image.png


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


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


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


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


其实关于配置一个还是多个MethodValidationPostProcessor的case,其实是个Bean覆盖有很大关系的,这方面内容可参考:【小家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 {
    }
}


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 能看到如下异常:




同样的完美完成了我们的校验需求。针对我自己书写的这一套,这里继续有必要再说说两个小细节:


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


总结


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


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


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

相关文章
|
9月前
|
前端开发 Java 数据库连接
SpringBoot参数校验底层原理和实操。深度历险、深度解析(图解+秒懂+史上最全)
SpringBoot参数校验底层原理和实操。深度历险、深度解析(图解+秒懂+史上最全)
SpringBoot参数校验底层原理和实操。深度历险、深度解析(图解+秒懂+史上最全)
|
JSON 前端开发 Java
Spring MVC——获取参数和响应
本文介绍了如何在Spring框架中通过不同的注解和方法获取URL参数、上传文件、处理cookie和session、以及响应不同类型的数据。具体内容包括使用`@PathVariable`获取URL中的参数,使用`MultipartFile`上传文件,通过`HttpServletRequest`和`@CookieValue`获取cookie,通过`HttpSession`和`@SessionAttribute`获取session,以及如何返回静态页面、HTML代码片段、JSON数据,并设置HTTP状态码和响应头。
337 1
Spring MVC——获取参数和响应
|
前端开发 Java Spring
【Spring】“请求“ 之传递单个参数、传递多个参数和传递对象
【Spring】“请求“ 之传递单个参数、传递多个参数和传递对象
489 2
|
Java Spring
spring boot 启动项目参数的设定
spring boot 启动项目参数的设定
489 0
|
9月前
|
Java Spring 容器
SpringBoot自动配置的原理是什么?
Spring Boot自动配置核心在于@EnableAutoConfiguration注解,它通过@Import导入配置选择器,加载META-INF/spring.factories中定义的自动配置类。这些类根据@Conditional系列注解判断是否生效。但Spring Boot 3.0后已弃用spring.factories,改用新格式的.imports文件进行配置。
1327 0
|
10月前
|
人工智能 Java 测试技术
Spring Boot 集成 JUnit 单元测试
本文介绍了在Spring Boot中使用JUnit 5进行单元测试的常用方法与技巧,包括添加依赖、编写测试类、使用@SpringBootTest参数、自动装配测试模块(如JSON、MVC、WebFlux、JDBC等),以及@MockBean和@SpyBean的应用。内容实用,适合Java开发者参考学习。
1145 0
|
6月前
|
Java 测试技术 数据库连接
【SpringBoot(四)】还不懂文件上传?JUnit使用?本文带你了解SpringBoot的文件上传、异常处理、组件注入等知识!并且带你领悟JUnit单元测试的使用!
Spring专栏第四章,本文带你上手 SpringBoot 的文件上传、异常处理、组件注入等功能 并且为你演示Junit5的基础上手体验
1088 4
|
6月前
|
JavaScript Java Maven
【SpringBoot(二)】带你认识Yaml配置文件类型、SpringMVC的资源访问路径 和 静态资源配置的原理!
SpringBoot专栏第二章,从本章开始正式进入SpringBoot的WEB阶段开发,本章先带你认识yaml配置文件和资源的路径配置原理,以方便在后面的文章中打下基础
566 4
|
前端开发 Java 数据库
微服务——SpringBoot使用归纳——Spring Boot集成Thymeleaf模板引擎——Thymeleaf 介绍
本课介绍Spring Boot集成Thymeleaf模板引擎。Thymeleaf是一款现代服务器端Java模板引擎,支持Web和独立环境,可实现自然模板开发,便于团队协作。与传统JSP不同,Thymeleaf模板可以直接在浏览器中打开,方便前端人员查看静态原型。通过在HTML标签中添加扩展属性(如`th:text`),Thymeleaf能够在服务运行时动态替换内容,展示数据库中的数据,同时兼容静态页面展示,为开发带来灵活性和便利性。
521 0
|
XML Java 数据库连接
微服务——SpringBoot使用归纳——Spring Boot集成MyBatis——基于 xml 的整合
本教程介绍了基于XML的MyBatis整合方式。首先在`application.yml`中配置XML路径,如`classpath:mapper/*.xml`,然后创建`UserMapper.xml`文件定义SQL映射,包括`resultMap`和查询语句。通过设置`namespace`关联Mapper接口,实现如`getUserByName`的方法。Controller层调用Service完成测试,访问`/getUserByName/{name}`即可返回用户信息。为简化Mapper扫描,推荐在Spring Boot启动类用`@MapperScan`注解指定包路径避免逐个添加`@Mapper`
889 0