环境：Springboot2.4.12
简介
@Controller或@ControllerAdvice类可以有@InitBinder方法来初始化WebDataBinder的实例，这些方法可以:
将请求参数(即表单或查询数据)绑定到模型对象。
将基于字符串的请求值(如请求参数、路径变量、头、cookie等)转换为控制器方法参数的目标类型。
渲染HTML表单时，将模型对象的值格式化为字符串值。
@InitBinder方法可以注册控制器特定的java.bean.PropertyEditor或Spring Converter和 Formatter组件。另外，你可以使用MVC配置在全局共享的
FormattingConversionService中注册Converter和Formatter类型。请参考《Spring中自定义数据类型转换详解》
@InitBinder方法支持许多与@RequestMapping方法相同的参数，除了@ModelAttribute(命令对象)参数。通常，它们是用WebDataBinder参数(用于注册)和一个void返回值声明的。
应用示例
("/demos")public class DemoController {// 1public void bind(WebDataBinder binder) { // 2binder.registerCustomEditor(Long.class, new PropertyEditorSupport() { // 3public void setAsText(String text) throws IllegalArgumentException {setValue(Long.valueOf(text) + 666L) ;}}) ;}("/index")public Object index(Long id) {return "index - " + id ;}}
注意以下几点：
使用@InitBinder注解
接收WebDataBinder参数
注册自定义的转换器
方法返回值必须是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, ModelAndViewContainer mavContainer, Object... providedArgs) throws Exception {Object[] args = getMethodArgumentValues(request, mavContainer, providedArgs); return doInvoke(args);}protected Object[] getMethodArgumentValues(NativeWebRequest request, 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 { // 封装方法参数的名称这里为：idNamedValueInfo namedValueInfo = getNamedValueInfo(parameter);// resolvedName = idObject resolvedName = resolveEmbeddedValuesAndExpressions(namedValueInfo.name); // ...// 获取参数名对应的请求参数值：/demos/index?id=100 , 这就返回100Object 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, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, 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( String propertyName, Object oldValue, Object newValue, Class<T> requiredType, 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( Object oldValue, Object newValue, Class<?> requiredType, 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( Object oldValue, String newTextValue, PropertyEditor editor) {try {editor.setValue(oldValue);}// ...editor.setAsText(newTextValue); return editor.getValue();}}
以上就是参数绑定及类型转换的过程。
