让Controller支持对平铺参数执行@Valid数据校验

程序员文章站 2022-03-22 14:32:56

一个可以沉迷于技术的程序猿，wx加入加入技术群：fsx641385712 ......

每篇一句

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

前言

我们知道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 可看见抛异常：
让Controller支持对平铺参数执行@Valid数据校验

注意一下：这里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 {
    }
    
}

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 能看到如下异常：
让Controller支持对平铺参数执行@Valid数据校验
同样的完美完成了我们的校验需求。针对我自己书写的这一套，这里继续有必要再说说两个小细节：

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

总结

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

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

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

知识交流

若文章格式混乱，可点击：

==the last：如果觉得本文对你有帮助，不妨点个赞呗。当然分享到你的朋友圈让更多小伙伴看到也是被作者本人许可的~==

若对技术内容感兴趣可以加入wx群交流：java高工、架构师3群。
若群二维码失效，请加wx号：fsx641385712（或者扫描下方wx二维码）。并且备注："java入群" 字样，会手动邀请入群

上一篇：四月生辰石为什么是钻石？关于钻石有哪些神秘传说？

下一篇： springmvc原理详解（手写springmvc）

让Controller支持对平铺参数执行@Valid数据校验

每篇一句

相关阅读

前言

controller层平铺参数的校验

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

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

总结

知识交流

让Controller支持对平铺参数执行@Valid数据校验

让Controller支持对平铺参数执行@Valid数据校验