SpringMvc@InitBinder
这篇博客记录@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⽅法⼊参可选范围⼀样(这⾥指的是⽐如HttpSer
vletRequest、ModelMap这些)，通常⼀个⼊参 WebDataBinder 就够我们使⽤了； @InitBinder标注的⽅法返回值, 必须为null，这⾥我理解的是运⾏期的返回值；如果运⾏时返回值不为null，抛出异常methods should return void:”，编译时IDEA会提⽰@InitBinder应该返回null，但是不影响编译通过;
@InitBinder
public  void initBinder(WebDataBinder binder, HttpServletRequest request){
System.out.Parameter("date"));
}
上⾯是⼀个@InitBinder的简单⽤法, 其中isterCustomEditor(Date.class,new CustomDateEditor(new SimpleDateFormat("MM-dd-yyyy"),false)); 这样⼀句话，作⽤就是将⾃定义的MVC属性编辑器PropertyEditor 注册到当前binder的typeConverter的customEditors集合中，每⼀次请求和后端交互，每⼀个Controller⽅法⼊参都会创建⼀个Binder对象,binder对象相当于来完成请求和后端之间参数类型转换的职能类;  注意，每次请求都会创建新的binder对象，就是说上次请求的customE
ditors不可复⽤ , 每次执⾏都会添加到当前⽅法⼊参交互的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.hod.annotation.RequestMappingHandlerMapping">
</bean>
<bean class="org.springframework.web.hod.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) {
}
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加载初始化容器的流程基础上改造了下;
image
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 {
ainsBeanDefinition("org.springframework.web.hod.annotation.RequestMappingHandlerAdapter")){
BeanDefinition beanDefinition = BeanDefinition("org.springframework.web.hod.annotation.RequestMappingHandlerAdapter");
PropertyValue pv = PropertyValues().getPropertyValue("webBindingInitializer");
BeanDefinition intializer= (BeanDefinition) pv.getValue();
}
}
@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：………… 这⾥前台改动的地⽅就是 person.name和 cat.name，⽽其他独有属性不需要前缀也可以对应赋给pojo、pojo2;  补充说明,@ModelAttribute注解不可以省略，通过这个取的别名来决定哪个@InitBinder对其⽣效；
查看效果图:
image
简单记录下，因为这个 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 = PropertyValues();
for (PropertyValue pv : pvArray) {
if (pv.getName().startsWith(fieldDefaultPrefix)) {
String field = pv.getName().substring(fieldDefaultPrefix.length());
if (getPropertyAccessor().isWritableProperty(field) && !ains(field)) {
mpvs.add(field, pv.getValue());
}
}
}
}
}
功能三.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");
}
简单贴下效果图：
image
正好发现了⽇志输出证明这⼀点：
image
那就顺便把代码贴⼀下，万⼀要⽤呢；另外补充⼀下，disallowedFields⽀持 * 通配符；
protected void checkAllowedFields(MutablePropertyValues mpvs) {
PropertyValue[] pvs = PropertyValues();
for (PropertyValue pv : pvs) {
springmvc的注解有哪些
String field = PropertyAccessorUtils.Name());
if (!isAllowed(field)) {
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类型转为我们需要的参数，但是从效率、内存分析，感觉⼀直在创建新的属性编辑器集合，如果属性编辑器太多是不是会占⽤⼤量内存呢，那请求达到⼀定多的数量，这个对象是不是太多了呢？

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。