SpringMvc @InitBinder

article/2025/10/7 13:27:12

这篇博客记录@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方法入参可选范围一样(这里指的是比如HttpServletRequestModelMap这些), 通常一个入参 WebDataBinder 就够我们使用了; @InitBinder标注的方法返回值, 必须为null,这里我理解的是运行期的返回值;如果运行时返回值不为null,抛出异常 “@InitBinder methods should return void:”,编译时IDEA会提示@InitBinder应该返回null,但是不影响编译通过;

@InitBinderpublic  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 {@Overridepublic void registerCustomEditors(PropertyEditorRegistry registry) {registry.registerCustomEditor(Date.class,new MyDateEditor());}public static class MyDateEditor extends PropertyEditorSupport {@Overridepublic void setValue(Object value) {super.setValue(value);}@Overridepublic 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;@Overridepublic 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);}}@Overridepublic 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")@ResponseBodypublic 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对其生效

查看效果图:

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 = 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")@ResponseBodypublic 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 = 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类型转为我们需要的参数,但是从效率、内存分析,感觉一直在创建新的属性编辑器集合,如果属性编辑器太多是不是会占用大量内存呢,那请求达到一定多的数量,这个对象是不是太多了呢?

转载于:https://www.cnblogs.com/lvbinbin2yujie/p/10459303.html


http://chatgpt.dhexx.cn/article/PlP74jTH.shtml

相关文章

java培训之InitBinder注解

InitBinder注解【了解】 InitBinder由 InitBinder 标识的方法&#xff0c;可以对 WebDataBinder 对象进行初始化。WebDataBinder 是 DataBinder 的子类&#xff0c;用于完成由表单字段到 JavaBean 属性的绑定InitBinder方法不能有返回值&#xff0c;它必须声明为void。InitBin…

SpringBoot @InitBinder注解绑定请求参数

参考资料 springMVC之InitBinder 和 ValidatorspringMVC之InitBinder的用法1springMVC之InitBinder的用法2 目录 一. 作用二. 前期准备三. Get请求 URL传值处理3.1 前台-test16.html3.2 Controller层3.3 效果 四. Post请求 表单传值 自定义日期属性绑定器4.1 前台-test16.h…

详细分析@InitBinder注解的使用和原理

前言 由InitBinder注解修饰的方法用于初始化WebDataBinder对象&#xff0c;能够实现&#xff1a;从request获取到handler方法中由RequestParam注解或PathVariable注解修饰的参数后&#xff0c;假如获取到的参数类型与handler方法上的参数类型不匹配&#xff0c;此时可以使用初…

SpringMVC之@InitBinder注解详解

说明与作用 springmvc并不是能对所有类型的参数进行绑定的&#xff0c;如果对日期Date类型参数进行绑定&#xff0c;就会报错IllegalStateException错误。所以需要注册一些类型绑定器用于对参数进行绑定。InitBinder注解就有这个作用。 Controller public class InitBinderCo…

SpringMVC中的@InitBinder注解【记录】

一、Spring请求参数绑定流程&#xff1a; 1、请求参数绑定流程&#xff1a; 我们在开发的时候&#xff0c;经常会从html&#xff0c;jsp中将请求参数通过request对象传递到后台&#xff0c;可是经常会遇到这么一种情况&#xff0c;那就是传过来的数据到后台后&#xff0c;还要…

springMVC之@InitBinder的用法

目录 一、InitBinder的作用二、数据绑定器三、全局数据绑定器3.1. 方式一&#xff1a;ControllerAdvice3.2. 方式二&#xff1a;RequestMappingHandlerAdapter 四、自定义数据校验器五、参数类型转换器 一、InitBinder的作用 InitBinder从字面意思可以看出这个的作用是给Binder…

JAVA-Switch语句

1、完整的语法结构 该语句为选择分支语句&#xff0c;其语法结构为&#xff1a; switch (值){case:值1 java语句;break;case:值2 java语句;break;case:值3 java语句;break;……default&#xff1a;java语句; } 注意在该语法结构中&#xff0c;“值N"可以表示int型的或者S…

java中的常用语句

Java中的常用语句 一、Java中的语句由3大类的结构 1.顺序结构—自上而下一行一行的有序的执行 2.选择结构 (1)If语句结构 (2)Switch语句结构 3.循环结构 (1)For循环 (2)While循环 (3)Do{}while()循环 二、判断语句中if语句的表现方式和用法 1.if(){} 2.if(){}else{} 3.if(){}e…

4.java中的常见语句

1.顺序结构语句 写好的代码从上往下按照顺序一行一行的执行。 2.选择结构语句 根据判断结果有选择性的执行代码. 2.1 if语句 1.if(判断条件){需要执行的java代码} 首先执行判断条件&#xff0c;如果判断条件的结果为true,就执行“{}”中的java代码&#x…

java基本语法(史上最全)

java基本语法&#xff08;史上最全&#xff09; &#xff08;一&#xff09;关键字和保留字 关键字的定义和特点 定义&#xff1a;被java语言赋予了特殊含义&#xff0c;用作专门用途的字符串。 特点&#xff1a;关键字中所有字母都为小写。关键字不能用作变量名&#xff0…

Linux Makefile ifeq正确使用

今晚和昨晚捣鼓了很久ifeq&#xff0c;怎么也得不出正确结果。当时我是这么用ifeq的 all: ifeq("ad","cd") echo yes else echo no endif 得出的结果是&#xff1a; 后来经仔细对比发现要这样写 all: ifeq ("ad", "cd&q…

关于shiro

shiro ​ shiro处理的两个过程&#xff0c;一个是登录&#xff0c;这个过程完成后产生一个用户jwt&#xff0c;一个是访问接口时&#xff0c;通过jwt来完成验证的过程 登录逻辑&#xff1a; 访问接口逻辑&#xff1a; 认证&#xff08;authentication&#xff09;&#xff1a…

shiro的简单介绍

1.Shiro的简单配置 1&#xff09; 获取ShiroFilterFactoryBean&#xff0c;作用是在执行相关操作前&#xff0c;先进行功能过滤&#xff0c;拦截所有请求&#xff0c;进入到shiro中进行认证与授权 例如&#xff1a;设置一些拦截的请求 // 身份认证失败&#xff0c;则跳转到登录…

Shiro相关基础知识

文章目录 前言一、Shiro相关基础知识1.Shiro是什么2.Shiro具体功能3.Shiro的整体结构与重要组件4.Shiro各模块基础知识1&#xff09;Authentication 认证模块2&#xff09;Authorization 授权模块3&#xff09;Realm 认证模块 5.Shiro集成到web应用 二、Shiro相关漏洞1. Shiro漏…

面试总结:Shiro框架

文章目录 Apache Shiro框架1. 简单介绍一下Shiro 框架2. Shiro 主要的四个组件3. Shiro 运行原理4. Shiro 的四种权限控制方式5. 授权实现的流程&#xff08;1&#xff09;、什么是粗颗粒和细颗粒权限&#xff1f;&#xff08;2&#xff09;、粗颗粒和细颗粒如何授权&#xff1…

shiro安全框架详解。面试必备

shiro核心就是过滤器。 认证授权流程&#xff1a; ● 认证&#xff1a;对用户的身份进行检查&#xff08;登录验证&#xff09; ● 授权&#xff1a;对用户的权限进行检查&#xff08;是否有对应的操作权限&#xff09; ● 流程图&#xff1a; 权限管理 实现权限的动态分配&a…

面试专题系列-Shiro

1.什么是shiro Apache Shiro 是 Java 的一个安全框架。使用 shiro 可以非常容易的开发出足够好的应用&#xff0c;其不仅可以用在 JavaSE环境&#xff0c;也可以用在 JavaEE 环境。Shiro 可以帮助我们完成&#xff1a;认证、授权、加密、会话管理、与 Web 集成、缓存等。 2.Sh…

shiro(详解)

这里写自定义目录标题 什么是shiro什么是权限管理什么是身份认证什么是授权SubjectSecurityManagerAuthenticatorAuthorizerRealmSessionManagerSessionDAOCacheManagerCryptography面试题认证的开发1. 创建项目并引入依赖2. 引入shiro配置文件并加入如下配置 自定义Realm自定义…

【JAVA面试题整理】框架之Shiro

一、简单介绍一下Shiro框架 Apache Shiro是java的一个安全框架。使用shiro可以非常容易的开发出足够好的应用&#xff0c;其不仅可以用在JavaSE环境&#xff0c;也可以用在JavaEE环境。Shiro可以帮助我们完成&#xff1a;认证、授权、加密、会话管理、与Web集成、缓存等。 三…

shiro总结

shiro主要内容: 1:SecurityUtils shiro提供的工具类,主要作用是获取 SecurityManager和Subject public abstract class SecurityUtils {private static SecurityManager securityManager;//获取Subjectpublic static Subject getSubject() {Subject subject ThreadContext.…