让Controller支持对平铺参数执行@Valid数据校验
每篇一句
在金字塔塔尖的是实践,学而不思则罔,思而不学则殆(现在很多编程框架都只是教你碎片化的实践)
相关阅读
【小家Java】深入了解数据校验:Java Bean Validation 2.0(JSR303、JSR349、JSR380)Hibernate-Validation 6.x使用案例
【小家Spring】@Validated和@Valid的区别?教你使用它完成Controller参数校验(含级联属性校验)以及原理分析
【小家Spring】Spring方法级别数据校验:@Validated + MethodValidationPostProcessor优雅的完成数据校验动作
对Spring感兴趣可扫码加入wx群:`Java高工、架构师3群`(文末有二维码)
前言
我们知道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
可看见抛异常:
注意一下:这里
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
能看到如下异常:
同样的完美完成了我们的校验需求。针对我自己书写的这一套,这里继续有必要再说说两个小细节:
- 本例的
@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入群"
字样,会手动邀请入群
让Controller支持对平铺参数执行@Valid数据校验的更多相关文章
- 深度学习原理与框架-递归神经网络-RNN_exmaple(代码) 1.rnn.BasicLSTMCell(构造基本网络) 2.tf.nn.dynamic_rnn(执行rnn网络) 3.tf.expand_dim(增加输入数据的维度) 4.tf.tile(在某个维度上按照倍数进行平铺迭代) 5.tf.squeeze(去除维度上为1的维度)
1. rnn.BasicLSTMCell(num_hidden) # 构造单层的lstm网络结构 参数说明:num_hidden表示隐藏层的个数 2.tf.nn.dynamic_rnn(cell, ...
- C# -- 等待异步操作执行完成的方式 C# -- 使用委托 delegate 执行异步操作 JavaScript -- 原型:prototype的使用 DBHelper类连接数据库 MVC View中获取action、controller、area名称、参数
C# -- 等待异步操作执行完成的方式 C# -- 等待异步操作执行完成的方式 1. 等待异步操作的完成,代码实现: class Program { static void Main(string[] ...
- 平铺式窗口管理器 Musca 初体验
作者: 吴吉庆 Version: 1.0 release: 2009-11-04 update: 2009-11-04 为什么用平铺式窗口管理器? 什么是平铺式窗口管理器(tiling window ...
- Terminix:基于 GTK3 的平铺式 Linux 终端模拟器
现在,你可以很容易的找到大量的 Linux 终端模拟器,每一个都可以给用户留下深刻的印象.但是,很多时候,我们会很难根据我们的喜好来找到一款心仪的日常使用的终端模拟器.这篇文章中,我们将会推荐一款叫做 ...
- 如何用vue封装一个防用户删除的平铺页面的水印组件
需求 为了防止截图等安全问题,在web项目页面中生成一个平铺全屏的水印 要求水印内容为用户名,水印节点用户不能通过开发者工具等删除 效果 如上图 在body节点下插入水印DOM节点,水印节点覆盖在页面 ...
- Mac下的平铺式桌面 - Yabai
Mac下的平铺式桌面 - Yabai 近来无事,凑着周末休息的时间,想折腾一下 Mac.很久之前就有朋友给我推荐过一款名为"Yabai"的平铺式桌面管理软件,今天,就折腾起来了. ...
- CSS背景100%平铺 浏览器缩小背景显示不全解决办法
本文我们分享前端CSS背景100%平铺,浏览器缩小背景显示不全bug解决的两个方法,如果你也遇到了,那么就可以参考下面文章. 把浏览器的窗口缩小时,拖动滚动条时你会发现原本设定的CSS背景100%平铺 ...
- Duilib技巧:背景图片平铺
贴图的描述 方式有两种 // 1.aaa.jpg // 2.file='aaa.jpg' res='' restype='0' dest='0,0,0,0' source='0,0,0,0 ...
- UIImage图片处理,旋转、截取、平铺、缩放等操作
来源:iOS_小松哥 链接:http://www.jianshu.com/p/9ab1205f5166 有时候我们需要处理图片,比如改变大小,旋转,截取等等,所以今天说一说图片处理相关的一些操作. 本 ...
随机推荐
- kali 源文件 更改和使用 更新日期:2018.04.21
我的公众号,正在建设中,欢迎关注: 0x01 源文件格式: kali下常用的更新命令有: apt-get install update和apt-get install upgrade,update是下 ...
- Kafka 学习之路(四)—— Kafka消费者详解
一.消费者和消费者群组 在Kafka中,消费者通常是消费者群组的一部分,多个消费者群组共同读取同一个主题时,彼此之间互不影响.Kafka之所以要引入消费者群组这个概念是因为Kafka消费者经常会做一些 ...
- 【转+存】JVM指令集
jvm指令集: 转载地址:https://www.cnblogs.com/yaoyinglong/p/4300447.html 一.未归类系列A 此系列暂未归类. 指令码 助记符 ...
- 开源joda-time使用demo
开源joda-time 1.maven中引入 <dependency> <groupId>joda-time</groupId> <artifactId> ...
- SQLPLUS执行PL/SQL语句块
1.首先登录Oracle HR schema: 2.对于PL/SQL程序,分号表示语句的结束:而使用 "." 号表示整个语句块的结束,也可以省略.按回车键后,该语句块不会执行,即 ...
- Ruby中的常量:引号、%符号和heredoc
数值字面量 没什么好说的,唯一需要说明的是分数字面量:数值后加上一个后缀字母r表示分数字面量. # 整数字面量 0 1 100 10_000_001 # 千分位 # 浮点数字面量 0.1 1.0 1. ...
- HDU 2089:不要62(数位DP)
http://acm.hdu.edu.cn/showproblem.php?pid=2089 不要62 Problem Description 杭州人称那些傻乎乎粘嗒嗒的人为62(音:laoer) ...
- HttpUtility.UrlEncode讲解
hello 大家好,今天讲讲HttpUtility.UrlEncode编码 HttpUtility.UrlEncode方法有4个重载分别如下 我们有这么一个字符串 string str = " ...
- os.path.join路径拼接的问题
问题一: import os a = os.path.join("/test1", "/test2") print(a) b = os.path.join(&q ...
- django基础知识之验证码:
验证码 在用户注册.登录页面,为了防止暴力请求,可以加入验证码功能,如果验证码错误,则不需要继续处理,可以减轻一些服务器的压力 使用验证码也是一种有效的防止crsf的方法 验证码效果如下图: 验证码视 ...