从原理层面掌握@InitBinder的使用【享学Spring MVC】

大魔王张怡宁:女儿,这堆金牌你拿去玩吧,但我的银牌不能给你玩。你要想玩银牌就去找你王浩叔叔吧,他那银牌多

前言

为了讲述好Spring MVC最为复杂的数据绑定这块,我前面可谓是做足了功课,对此部分知识此处给小伙伴留一个学习入口,有兴趣可以点开看看:聊聊Spring中的数据绑定 --- WebDataBinder、ServletRequestDataBinder、WebBindingInitializer...【享学Spring】

@InitBinder这个注解是Spring 2.5后推出来,用于数据绑定、设置数据转换器等,字面意思是“初始化绑定器”。

关于数据绑定器的概念,前面的功课中有重点详细讲解,此处默认小伙伴是熟悉了的~

在Spring MVC的web项目中,相信小伙伴们经常会遇到一些前端给后端传值比较棘手的问题:比如最经典的问题:

Date类型(或者LocalDate类型)前端如何传?后端可以用Date类型接收吗?

字符串类型,如何保证前段传入的值两端没有空格呢?(99.99%的情况下多余的空格都是木有用的)

对于这些看似不太好弄的问题,看了这篇文章你就可以优雅的搞定了~

---

说明:关于Date类型的传递,业界也有两个通用的解决方案

使用时间戳

使用String字符串(传值的万能方案)

使用者两种方式总感觉不优雅,且不够面向对象。那么本文就介绍一个黑科技:使用@InitBinder来便捷的实现各种数据类型的数据绑定(咱们Java是强类型语言且面向对象的,如果啥都用字符串,是不是也太low了~)

> 一般的string, int, long会自动绑定到参数,但是自定义的格式spring就不知道如何绑定了 .所以要继承PropertyEditorSupport,实现自己的属性编辑器PropertyEditor,绑定到WebDataBinder ( binder.registerCustomEditor),覆盖方法setAsText @InitBinder原理

本文先原理,再案例的方式,让你能够彻头彻尾的掌握到该注解的使用。

1、@InitBinder是什么时候生效的?
这就是前面文章埋下的伏笔:Spring在绑定请求参数到HandlerMethod的时候(此处以RequestParamMethodArgumentResolver为例),会借助WebDataBinder进行数据转换:

// RequestParamMethodArgumentResolver的父类就是它,resolveArgument方法在父类上 // 子类仅仅只需要实现抽象方法resolveName,即:从request里根据name拿值 AbstractNamedValueMethodArgumentResolver: @Override @Nullable public final Object resolveArgument( ... ) { ... Object arg = resolveName(resolvedName.toString(), nestedParameter, webRequest); ... if (binderFactory != null) { // 创建出一个WebDataBinder WebDataBinder binder = binderFactory.createBinder(webRequest, null, namedValueInfo.name); // 完成数据转换(比如String转Date、String转...等等) arg = binder.convertIfNecessary(arg, parameter.getParameterType(), parameter); ... } ... return arg; }

它从请求request拿值得方法便是:request.getParameterValues(name)。

2、web环境使用的数据绑定工厂是:ServletRequestDataBinderFactory
虽然在前面功课中有讲到,但此处为了连贯性还是有必要再简单过一遍:

// @since 3.1 org.springframework.web.bind.support.DefaultDataBinderFactory public class DefaultDataBinderFactory implements WebDataBinderFactory { @Override @SuppressWarnings("deprecation") public final WebDataBinder createBinder(NativeWebRequest webRequest, @Nullable Object target, String objectName) throws Exception { WebDataBinder dataBinder = createBinderInstance(target, objectName, webRequest); // WebBindingInitializer initializer在此处解析完成了 全局生效 if (this.initializer != null) { this.initializer.initBinder(dataBinder, webRequest); } // 解析@InitBinder注解,它是个protected空方法,交给子类复写实现 // InitBinderDataBinderFactory对它有复写 initBinder(dataBinder, webRequest); return dataBinder; } } public class InitBinderDataBinderFactory extends DefaultDataBinderFactory { // 保存所有的, private final List<InvocableHandlerMethod> binderMethods; ... @Override public void initBinder(WebDataBinder dataBinder, NativeWebRequest request) throws Exception { for (InvocableHandlerMethod binderMethod : this.binderMethods) { if (isBinderMethodApplicable(binderMethod, dataBinder)) { // invokeForRequest这个方法不用多说了,和调用普通控制器方法一样 // 方法入参上也可以写格式各样的参数~~~~ Object returnValue = binderMethod.invokeForRequest(request, null, dataBinder); // 标注有@InitBinder注解方法必须返回void if (returnValue != null) { throw new IllegalStateException("@InitBinder methods must not return a value (should be void): " + binderMethod); } } } } // dataBinder.getObjectName()在此处终于起效果了 通过这个名称来匹配 // 也就是说可以做到让@InitBinder注解只作用在指定的入参名字的数据绑定上~~~~~ // 而dataBinder的这个ObjectName,一般就是入参的名字(注解指定的value值~~) // 形参名字的在dataBinder,所以此处有个简单的过滤~~~~~~~ protected boolean isBinderMethodApplicable(HandlerMethod initBinderMethod, WebDataBinder dataBinder) { InitBinder ann = initBinderMethod.getMethodAnnotation(InitBinder.class); Assert.state(ann != null, "No InitBinder annotation"); String[] names = ann.value(); return (ObjectUtils.isEmpty(names) || ObjectUtils.containsElement(names, dataBinder.getObjectName())); } }

WebBindingInitializer接口方式是优先于@InitBinder注解方式执行的(API方式是去全局的,注解方式可不一定,所以更加的灵活些)

子类ServletRequestDataBinderFactory就做了一件事:new ExtendedServletRequestDataBinder(target, objectName)
ExtendedServletRequestDataBinder只做了一件事:处理path变量。

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/zyjxyj.html