社区编辑申请
注册/登录
Spring MVC中@InitBinder注解是如何应用的?
开发 后端
@InitBinder方法可以注册控制器特定的java.bean.PropertyEditor或Spring Converter和 Formatter组件。

环境:Springboot2.4.12

简介

​@Controller或@ControllerAdvice类可以有@InitBinder方法来初始化WebDataBinder的实例,这些方法可以:

  1. 将请求参数(即表单或查询数据)绑定到模型对象。
  2. 将基于字符串的请求值(如请求参数、路径变量、头、cookie等)转换为控制器方法参数的目标类型。
  3. 渲染HTML表单时,将模型对象的值格式化为字符串值。

@InitBinder方法可以注册控制器特定的java.bean.PropertyEditor或Spring Converter和 Formatter组件。另外,你可以使用MVC配置在全局共享的FormattingConversionService中注册Converter和Formatter类型。

@InitBinder方法支持许多与@RequestMapping方法相同的参数,除了@ModelAttribute(命令对象)参数。通常,它们是用WebDataBinder参数(用于注册)和一个void返回值声明的。

应用示例

@RestController
@RequestMapping("/demos")
public class DemoController {
@InitBinder // 1
public void bind(WebDataBinder binder) { // 2
binder.registerCustomEditor(Long.class, new PropertyEditorSupport() { // 3
@Override
public void setAsText(String text) throws IllegalArgumentException {
setValue(Long.valueOf(text) + 666L) ;
}
}) ;
}
@GetMapping("/index")
public Object index(Long id) {
return "index - " + id ;
}
}

注意以下几点:

  1. 使用@InitBinder注解。
  2. 接收WebDataBinder参数。
  3. 注册自定义的转换器。
  4. 方法返回值必须是void。

在上面的示例中注册了一个类型转换器从字符串转换为Long类型 并且在原来值基础上增加了666L。

原理解读

  • HandlerAdapter执行。
public class RequestMappingHandlerAdapter extends AbstractHandlerMethodAdapter implements BeanFactoryAware, InitializingBean {
protected ModelAndView invokeHandlerMethod(HttpServletRequest request, HttpServletResponse response, HandlerMethod handlerMethod) throws Exception {
// ...
// 这里会查找当前执行的Controller中定义的所有@InitBinder注解的方法
WebDataBinderFactory binderFactory = getDataBinderFactory(handlerMethod);
ServletInvocableHandlerMethod invocableMethod = createInvocableHandlerMethod(handlerMethod);
invocableMethod.invokeAndHandle(webRequest, mavContainer);
// ...
}
}
  • ServletInvocableHandlerMethod执行。
public class ServletInvocableHandlerMethod extends InvocableHandlerMethod {
public void invokeAndHandle(ServletWebRequest webRequest, ModelAndViewContainer mavContainer, Object... providedArgs) throws Exception {
// 调用父类方法
Object returnValue = invokeForRequest(webRequest, mavContainer, providedArgs);
// ...
}
}
// 执行父类方法调用
public class InvocableHandlerMethod extends HandlerMethod {
public Object invokeForRequest(NativeWebRequest request, @Nullable ModelAndViewContainer mavContainer, Object... providedArgs) throws Exception {
Object[] args = getMethodArgumentValues(request, mavContainer, providedArgs);
return doInvoke(args);
}
protected Object[] getMethodArgumentValues(NativeWebRequest request, @Nullable ModelAndViewContainer mavContainer, Object... providedArgs) throws Exception {
Object[] args = new Object[parameters.length];
for (int i = 0; i < parameters.length; i++) {
// 解析参数
args[i] = this.resolvers.resolveArgument(parameter, mavContainer, request, this.dataBinderFactory);
}
}
}
  • 参数解析。

在上面的Controller示例中,参数的解析器是RequestParamMethodArgumentResolver。

调用父类的resolveArgument方法。

public abstract class AbstractNamedValueMethodArgumentResolver {
public final Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer, NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception {
// 封装方法参数的名称这里为:id
NamedValueInfo namedValueInfo = getNamedValueInfo(parameter);
// resolvedName = id
Object resolvedName = resolveEmbeddedValuesAndExpressions(namedValueInfo.name);
// ...
// 获取参数名对应的请求参数值:/demos/index?id=100 , 这就返回100
Object arg = resolveName(resolvedName.toString(), nestedParameter, webRequest);
// ...
if (binderFactory != null) {
// 根据当前的Request对象及请求参数名创建WebDataBinder对象
// 内部创建的ExtendedServletRequestDataBinder对象
WebDataBinder binder = binderFactory.createBinder(webRequest, null, namedValueInfo.name);
try {
// 执行类型转换
arg = binder.convertIfNecessary(arg, parameter.getParameterType(), parameter);
}
}
}
}
// 创建WebDataBinder对象
public class DefaultDataBinderFactory implements WebDataBinderFactory {
public final WebDataBinder createBinder(NativeWebRequest webRequest, @Nullable Object target, String objectName) throws Exception {
WebDataBinder dataBinder = createBinderInstance(target, objectName, webRequest);
if (this.initializer != null) {
// 初始化WebDataBinder对象,这里最主要的就是为其设置类型转换器
this.initializer.initBinder(dataBinder, webRequest);
}
// 初始化执行@InitBinder注解的方法
initBinder(dataBinder, webRequest);
return dataBinder;
}
}
public class InitBinderDataBinderFactory extends DefaultDataBinderFactory {
public void initBinder(WebDataBinder dataBinder, NativeWebRequest request) throws Exception {
// 遍历所有@InitBinder注解的方法
for (InvocableHandlerMethod binderMethod : this.binderMethods) {
if (isBinderMethodApplicable(binderMethod, dataBinder)) {
// 这里就是执行@InitBinder注解的方法
Object returnValue = binderMethod.invokeForRequest(request, null, dataBinder);
// 如果@InitBinder注解的方法有返回值则抛出异常
if (returnValue != null) {
throw new IllegalStateException("@InitBinder methods must not return a value (should be void): " + binderMethod);
}
}
}
}
}
// 解析@InitBinder注解方法的参数及方法执行
public class InvocableHandlerMethod extends HandlerMethod {
public Object invokeForRequest(NativeWebRequest request, @Nullable ModelAndViewContainer mavContainer, Object... providedArgs) throws Exception {
// 解析获取@InitBinder注解方法的参数
Object[] args = getMethodArgumentValues(request, mavContainer, providedArgs);
// 执行调用
return doInvoke(args);
}
}
  • 执行类型转换。

在上面执行流程中,我们知道获取了一个WebDataBinder对象和由@InitBinder 注解的方法的调用执行。接下来就是进行类型的转换。

public abstract class AbstractNamedValueMethodArgumentResolver {
public final Object resolveArgument(MethodParameter parameter, @Nullable ModelAndViewContainer mavContainer, NativeWebRequest webRequest, @Nullable WebDataBinderFactory binderFactory) throws Exception {
if (binderFactory != null) {
// 根据当前的Request对象及请求参数名创建WebDataBinder对象
// 内部创建的ExtendedServletRequestDataBinder对象
WebDataBinder binder = binderFactory.createBinder(webRequest, null, namedValueInfo.name);
try {
// 执行类型转换
arg = binder.convertIfNecessary(arg, parameter.getParameterType(), parameter);
}
}
}
}
// 最终通过该类调用类型转换
class TypeConverterDelegate {
public <T> T convertIfNecessary(@Nullable String propertyName, @Nullable Object oldValue, @Nullable Object newValue, @Nullable Class<T> requiredType, @Nullable TypeDescriptor typeDescriptor) throws IllegalArgumentException {
// Custom editor for this type?
// 获取自定义的类型转换器(首先获取的就是我们上面自定义的)
PropertyEditor editor = this.propertyEditorRegistry.findCustomEditor(requiredType, propertyName);
// ...
Object convertedValue = newValue;
// ...
convertedValue = doConvertValue(oldValue, convertedValue, requiredType, editor);
}
private Object doConvertValue(@Nullable Object oldValue, @Nullable Object newValue, @Nullable Class<?> requiredType, @Nullable PropertyEditor editor) {
// ...
if (convertedValue instanceof String) {
if (editor != null) {
String newTextValue = (String) convertedValue;
// 最终的调用
return doConvertTextValue(oldValue, newTextValue, editor);
} else if (String.class == requiredType) {
returnValue = convertedValue;
}
}
return returnValue;
}
// 最终得到了我们想要的值
private Object doConvertTextValue(@Nullable Object oldValue, String newTextValue, PropertyEditor editor) {
try {
editor.setValue(oldValue);
}
// ...
editor.setAsText(newTextValue);
return editor.getValue();
}
}

以上就是参数绑定及类型转换的过程。

责任编辑:姜华 来源: 今日头条

同话题下的热门内容

八个流行的 Python 可视化工具包,你喜欢哪个?超全!Python图形界面框架PyQt5使用指南!Python办公自动化,五分钟掌握openpyxl操作!跟着 Guava 学 Java 之 不可变集合速度起飞!替代 pandas 的八个神库浅谈Python+requests+pytest接口自动化测试框架的搭建如何在 Windows 上写 Python 代码?优秀攻略来袭!用 Taichi 加速 Python:提速 100+ 倍!

编辑推荐

使用Kotlin做开发一个月后的感想面试官问你什么是消息队列?把这篇甩给他!五大自动化测试的Python框架图文详解两种算法:深度优先遍历(DFS)和广度优先遍历(BFS)2018年最流行的十大编程语言,其中包括你用的语言吗?
我收藏的内容
点赞
收藏

51CTO技术栈公众号