SpringMvc @InitBinder_Java

这篇博客记录@initbinder怎么起作用、起什么作用？

首先,该注解被解析的时机，是该匹配controller的请求执行映射的方法之前; 同时 @initbinder标注的方法执行是多次的，一次请求来就执行一次。

当某个controller上的第一次请求由springmvc前端控制器匹配到该controller之后，根据controller的 class 类型查找所有方法上标注了@initbinder的方法，并且存入requestmappinghandleradapter的 initbindercache，下次一请求执行对应业务方法之前时,可以走initbindercache缓存,而不用再去解析@initbinder; 所以 initbinder是controller级别的，一个controller实例中的所有@initbinder 只对该controller有效；

功能一.注册controller级别的 mvc属性编辑器 (属性编辑器功能就是将web请求中的属性转成我们需要的类型)

@initbinder唯一的一个属性value,作用是限制对哪些 @requestmapping 方法起作用,具体筛选条件就是通过@requestmapping方法入参来筛选，默认不写就代表对所有@requestmapping的方法起作用;

@initbinder标注的方法, 方法入参和 @requestmapping方法入参可选范围一样(这里指的是比如httpservletrequest、modelmap这些)，通常一个入参 webdatabinder 就够我们使用了； @initbinder标注的方法返回值, 必须为null，这里我理解的是运行期的返回值;如果运行时返回值不为null,抛出异常 “@initbinder methods should return void:”，编译时idea会提示@initbinder应该返回null,但是不影响编译通过;

@initbinder
    public  void initbinder(webdatabinder binder, httpservletrequest request){
        system.out.println(request.getparameter("date"));
        binder.registercustomeditor(date.class,new customdateeditor(new simpledateformat("mm-dd-yyyy"),false));
    }

上面是一个@initbinder的简单用法, 其中binder.registercustomeditor(date.class,new customdateeditor(new simpledateformat("mm-dd-yyyy"),false)); 这样一句话,作用就是将自定义的mvc属性编辑器propertyeditor 注册到当前binder的typeconverter的customeditors集合中,每一次请求和后端交互，每一个controller方法入参都会创建一个binder对象,binder对象相当于来完成请求和后端之间参数类型转换的职能类; 注意，每次请求都会创建新的binder对象，就是说上次请求的customeditors不可复用 , 每次执行都会添加到当前方法入参交互的binder的customeditors中，而且每次执行真正请求方法之前，会把匹配上的@initbinder标注的方法执行一遍才开始处理；

当请求中参数和方法入参开始进行转换的时候，都会先使用自定义注册的propertyeditor，会首先根据需要的类型去binder的typeconverter的typeconverterdelegate的propertyeditorregistry的cutomeditors集合中查找，有点绕，先记录下，typeconverterdelegate的propertyeditorregistry就是typeconverter对象本身, 所以就是去typeconverter对象的cutomeditors寻找自定义注册的属性编辑器,又回到了原点。比如去customeditors中根据key为date.class查找editor, 分为两种情况，一种是找到了合适的属性编辑器,调用其setvalue、setastext方法, 之后使用getvalue就得到转换后的值，得到了转换后的值，可能不是我们想要的类型，这时候就会使用 conversionservice 重新来过，放弃之前的转换；是我们想要的类型就直接返回转换后的值; 第二种情况是没找到合适的属性编辑器，直接调用 conversionservice 进行转换工作;

上面方式是@initbinder作为controller级别的 springmvc属性编辑器, 下面记录一下全局级别（所有@controller）的属性编辑器;

xml中注册全局属性编辑器到 configurablewebbindinginitializer上，再将其注册到 requestmappinghandleradapter里；记录原因，绑定binder的属性编辑器时候，会将当前的

initializer中的属性编辑器也给注册到binder中，这样就能实现全局的属性编辑器

<!--<mvc:annotation-driven/>-->
    <!--取消注解驱动的话spring4.3就要手动注册requestmappinghandlermapping、requestmappinghandleradapter-->

<bean class="org.springframework.web.servlet.mvc.method.annotation.requestmappinghandlermapping">

</bean>
<bean class="org.springframework.web.servlet.mvc.method.annotation.requestmappinghandleradapter">
    <property name="webbindinginitializer" ref="initializer1"/>
</bean>

<bean id="initializer1" class="org.springframework.web.bind.support.configurablewebbindinginitializer">
    <property name="propertyeditorregistrars">
       <list>
            <bean class="demo2.mypropertyeditor"/>
       </list>
    </property>
</bean>

mypropertyeditor.java

public class mypropertyeditor implements propertyeditorregistrar {

    @override
    public void registercustomeditors(propertyeditorregistry registry) {
        registry.registercustomeditor(date.class,new mydateeditor());
    }

    public static class mydateeditor extends propertyeditorsupport {
        @override
        public void setvalue(object value) {
            super.setvalue(value);
        }

        @override
        public void setastext(string text) throws illegalargumentexception {
            date d=null;
            try {
                system.out.println("我调用自己的全局mvc属性编辑器");
                d=new simpledateformat("mm-dd-yyyy").parse(text);
                setvalue(d);
            } catch (parseexception e) {
                e.printstacktrace();
            }
        }
    }
}

上面两段代码就可以注册自定义的属性编辑器到所有@controller中，相当于之前每个 controller都使用了 @initbinder; 但是这样写不太友好，springmvc<mvc:annotation-driven/>替我们注册的很多东西可能就没法使用了，意义不大，所以简单改造了一下：在之前记录的spring加载初始化容器的流程基础上改造了下;

spring xml文件仍然使用注解驱动:

<mvc:annotation-driven/>
<bean id="globalbeandefinitionregistry" class="demo2.globalbeandefinitionregistry">
    <property name="editorregistrars">
        <list>
            <bean class="demo2.mypropertyeditor"/>
        </list>
    </property>
</bean>

自定义的 globalbeandefinitionregistry代码如下: 简单说下原理，在spring原有注解驱动的基础上，改变了webbindinginitializer，使它可以自由地配置方式添加属性编辑器；优点就是，不破坏springmvc注解驱动带给我们的好处，可以自定义添加属性全局的编辑器；缺点就是代码中判断逻辑的处理器映射器适配器 requestmappinghandleradapter是硬编码的,spring4可能还好用,spring3突然又不支持了,同样也是有解决方案的

用法其实就是在spring初始化容器中对象之前移花接木地替换我们的 webbindinginitalizer.

public class globalbeandefinitionregistry  implements beandefinitionregistrypostprocessor {
        private propertyeditorregistrar[]  editorregistrars;
    @override
    public void postprocessbeandefinitionregistry(beandefinitionregistry registry) throws beansexception {
        if(registry.containsbeandefinition("org.springframework.web.servlet.mvc.method.annotation.requestmappinghandleradapter")){
            beandefinition beandefinition = registry.getbeandefinition("org.springframework.web.servlet.mvc.method.annotation.requestmappinghandleradapter");
            propertyvalue pv = beandefinition.getpropertyvalues().getpropertyvalue("webbindinginitializer");
            beandefinition intializer= (beandefinition) pv.getvalue();
            intializer.getpropertyvalues().addpropertyvalue("propertyeditorregistrars",editorregistrars);
        }
    }

    @override
    public void postprocessbeanfactory(configurablelistablebeanfactory beanfactory) throws beansexception {

    }
    public void seteditorregistrars(propertyeditorregistrar[] editorregistrars) {
        this.editorregistrars = editorregistrars;
    }

因为@initbinder方法作为controller级别的属性编辑器和全局的自定义mvc属性编辑器没有太大差别，所以下面讲一些别的用法：

功能二. webdatabinder的setfielddefaultprefix(string fielddefaultprefix)

作用：将springmvc请求参数带有fielddefaultprefix的参数,去掉该前缀再绑定到对应请求入参上

想来想去，也没搞明白这个方法的意义，以及实际用途，想到一种实际中可能出现的情况，觉得是个有几率出现的事情，正好可以用该方法可以解决；

问题：假设后台用两个对象来接受请求参数(springmvc可以做到)，pojo、pojo2对象，他们两个属性如下：发现两个对象都有个name属性，问题来了，前台我们不能传两个 name属性吧，那样接收肯定会出错（我这里没尝试过），原有对象不修改的基础上可行方案如下：

@setter
@getter
@tostring  // 代码整洁所以使用lombok,可以自行百度
public class pojo {
    private string name;
    private string haircolor;
}

@setter
@tostring
public class pojo2 {
    private string name;
    private int age;
}

在两个对象上各使用@modelattribute，来给对象分别起别名， @initbinder这里value属性指定别名，然后给不同的参数加上了前缀 person. 、cat. ;注意这里的两个 . 号

 @requestmapping("/test3")
    @responsebody
    public string test3(@modelattribute("person") pojo person, @modelattribute("cat") pojo2 cat){
        return "test response ok!"+person+","+cat;
    }

    @initbinder("person")
    public void initperson(webdatabinder binder){
          binder.setfielddefaultprefix("person.");
    }

    @initbinder("cat")
    public void initcat(webdatabinder binder){
        binder.setfielddefaultprefix("cat.");
    }

这样请求url：………… test3?person.name=lvbinbin&cat.name=xiaobinggan&haircolor=black&age=20 这里前台改动的地方就是 person.name和 cat.name，而其他独有属性不需要前缀也可以对应赋给pojo、pojo2; 补充说明,@modelattribute注解不可以省略，通过这个取的别名来决定哪个@initbinder对其生效；

查看效果图:

简单记录下，因为这个 defaultprefix 所在代码确实不好找:

protected void dobind(mutablepropertyvalues mpvs) {
		checkfielddefaults(mpvs);    //这里就是 defaultprefix生效的地方
		checkfieldmarkers(mpvs);
		super.dobind(mpvs);
	}
//效果就是请求中包含defaultprefix的,将其前缀去掉保存
protected void checkfielddefaults(mutablepropertyvalues mpvs) {
	if (getfielddefaultprefix() != null) {
		string fielddefaultprefix = getfielddefaultprefix();
		propertyvalue[] pvarray = mpvs.getpropertyvalues();
		for (propertyvalue pv : pvarray) {
			if (pv.getname().startswith(fielddefaultprefix)) {
				string field = pv.getname().substring(fielddefaultprefix.length());
				if (getpropertyaccessor().iswritableproperty(field) && !mpvs.contains(field)) {
					mpvs.add(field, pv.getvalue());
				}
				mpvs.removepropertyvalue(pv);
			}
		}
	}
}

功能三.webdatabinder的setdisallowedfields(string ….disallowedfields);

作用：springmvc接收请求参数时候，有些参数禁止的，不想接收，我也没遇到过啥情况禁止接收参数，这时候可以设置setdisallowedfields不接受参数

 @requestmapping("/test4")
    @responsebody
    public string test4(@modelattribute("pojo2") pojo2 pojo){
        return "test response ok!"+pojo;
    }

    @initbinder("pojo2")
    public void disallowflied(webdatabinder binder){
        binder.setdisallowedfields("age");
    }

简单贴下效果图：

正好发现了日志输出证明这一点：

那就顺便把代码贴一下，万一要用呢；另外补充一下，disallowedfields支持 * 通配符；

protected void checkallowedfields(mutablepropertyvalues mpvs) {
		propertyvalue[] pvs = mpvs.getpropertyvalues();
		for (propertyvalue pv : pvs) {
			string field = propertyaccessorutils.canonicalpropertyname(pv.getname());
			if (!isallowed(field)) {
				mpvs.removepropertyvalue(pv);
				getbindingresult().recordsuppressedfield(field);
				if (logger.isdebugenabled()) {
					logger.debug("field [" + field + "] has been removed from propertyvalues " +
							"and will not be bound, because it has not been found in the list of allowed fields");
				}
			}
		}
	}
protected boolean isallowed(string field) {
	string[] allowed = getallowedfields();
	string[] disallowed = getdisallowedfields();
	return ((objectutils.isempty(allowed) || patternmatchutils.simplematch(allowed, field)) &&
			(objectutils.isempty(disallowed) || !patternmatchutils.simplematch(disallowed, field)));
}

@initbinder的用法简而言之,就是controller级别的属性编辑器,将请求中的string类型转为我们需要的参数,但是从效率、内存分析，感觉一直在创建新的属性编辑器集合，如果属性编辑器太多是不是会占用大量内存呢，那请求达到一定多的数量，这个对象是不是太多了呢？