从原理层面掌握@InitBinder的使用【享学Spring MVC】

                 本文链接：[https://blog.csdn.net/f641385712/article/details/95473929](https://blog.csdn.net/f641385712/article/details/95473929) 

// RequestParamMethodArgumentResolver的父类就是它，resolveArgument方法在父类上
// 子类仅仅只需要实现抽象方法resolveName，即：从request里根据name拿值
AbstractNamedValueMethodArgumentResolver：

	@Override
	@Nullable
	public final Object resolveArgument( ... ) {
		...
		Object arg = resolveName(resolvedName.toString(), nestedParameter, webRequest);
		...
		if (binderFactory != null) {
			// 创建出一个WebDataBinder
			WebDataBinder binder = binderFactory.createBinder(webRequest, null, namedValueInfo.name);
			// 完成数据转换（比如String转Date、String转...等等）
			arg = binder.convertIfNecessary(arg, parameter.getParameterType(), parameter);
			...
		}
		...
		return arg;
	}

// @since 3.1 org.springframework.web.bind.support.DefaultDataBinderFactory 
public class DefaultDataBinderFactory implements WebDataBinderFactory {

	@Override
	@SuppressWarnings("deprecation")
	public final WebDataBinder createBinder(NativeWebRequest webRequest, @Nullable Object target, String objectName) throws Exception {
		WebDataBinder dataBinder = createBinderInstance(target, objectName, webRequest);
		
		// WebBindingInitializer initializer在此处解析完成了 全局生效
		if (this.initializer != null) {
			this.initializer.initBinder(dataBinder, webRequest);
		}
		// 解析@InitBinder注解，它是个protected空方法，交给子类复写实现
		// InitBinderDataBinderFactory对它有复写
		initBinder(dataBinder, webRequest);
		return dataBinder;
	}
}

public class InitBinderDataBinderFactory extends DefaultDataBinderFactory {
	// 保存所有的，
	private final List<InvocableHandlerMethod> binderMethods;
	...
	@Override
	public void initBinder(WebDataBinder dataBinder, NativeWebRequest request) throws Exception {
		for (InvocableHandlerMethod binderMethod : this.binderMethods) {
			if (isBinderMethodApplicable(binderMethod, dataBinder)) {
				// invokeForRequest这个方法不用多说了，和调用普通控制器方法一样
				// 方法入参上也可以写格式各样的参数~~~~
				Object returnValue = binderMethod.invokeForRequest(request, null, dataBinder);
			
				// 标注有@InitBinder注解方法必须返回void
				if (returnValue != null) {
					throw new IllegalStateException("@InitBinder methods must not return a value (should be void): " + binderMethod);
				}
			}
		}
	}

	// dataBinder.getObjectName()在此处终于起效果了  通过这个名称来匹配
	// 也就是说可以做到让@InitBinder注解只作用在指定的入参名字的数据绑定上~~~~~
	// 而dataBinder的这个ObjectName，一般就是入参的名字（注解指定的value值~~）

	// 形参名字的在dataBinder，所以此处有个简单的过滤~~~~~~~
	protected boolean isBinderMethodApplicable(HandlerMethod initBinderMethod, WebDataBinder dataBinder) {
		InitBinder ann = initBinderMethod.getMethodAnnotation(InitBinder.class);
		Assert.state(ann != null, "No InitBinder annotation");
		String[] names = ann.value();
		return (ObjectUtils.isEmpty(names) || ObjectUtils.containsElement(names, dataBinder.getObjectName()));
	}
}

public class RequestMappingHandlerAdapter extends AbstractHandlerMethodAdapter implements BeanFactoryAware, InitializingBean {
	...
	@Override
	protected ModelAndView handleInternal(HttpServletRequest request, HttpServletResponse response, HandlerMethod handlerMethod) throws Exception {
		...
		// 处理请求，最终其实就是执行控制器的方法，得到一个ModelAndView
		mav = invokeHandlerMethod(request, response, handlerMethod);
		...
	}
	
	// 执行控制器的方法，挺复杂的。但本文我只关心WebDataBinderFactory的创建，方法第一句便是
	@Nullable
	protected ModelAndView invokeHandlerMethod(HttpServletRequest request, HttpServletResponse response, HandlerMethod handlerMethod) throws Exception {
		WebDataBinderFactory binderFactory = getDataBinderFactory(handlerMethod);
		...
	}

	// 创建一个WebDataBinderFactory 
	// Global methods first（放在前面最先执行） 然后再执行本类自己的
	private WebDataBinderFactory getDataBinderFactory(HandlerMethod handlerMethod) throws Exception {
		// handlerType：方法所在的类（控制器方法所在的类，也就是xxxController）
		// 由此可见，此注解的作用范围是类级别的。会用此作为key来缓存
		Class<?> handlerType = handlerMethod.getBeanType();
		Set<Method> methods = this.initBinderCache.get(handlerType);
		if (methods == null) { // 缓存没命中，就去selectMethods找到所有标注有@InitBinder的方法们~~~~
			methods = MethodIntrospector.selectMethods(handlerType, INIT_BINDER_METHODS);
			this.initBinderCache.put(handlerType, methods); // 缓存起来
		}
		
		// 此处注意：Method最终都被包装成了InvocableHandlerMethod，从而具有执行的能力
		List<InvocableHandlerMethod> initBinderMethods = new ArrayList<>();
		
		// 上面找了本类的，现在开始看看全局里有木有@InitBinder
		// Global methods first（先把全局的放进去，再放个性化的~~~~ 所以小细节：有覆盖的效果哟~~~）
		// initBinderAdviceCache它是一个缓存LinkedHashMap(有序哦~~~)，缓存着作用于全局的类。
		// 如@ControllerAdvice，注意和`RequestBodyAdvice`、`ResponseBodyAdvice`区分开来

		// methodSet：说明一个类里面是可以定义N多个标注有@InitBinder的方法~~~~~
		this.initBinderAdviceCache.forEach((clazz, methodSet) -> {
			
			// 简单的说就是`RestControllerAdvice`它可以指定：basePackages之类的属性，看本类是否能被扫描到吧~~~~
			if (clazz.isApplicableToBeanType(handlerType)) {
			
				// 这个resolveBean() 有点意思：它持有的Bean若是个BeanName的话，会getBean()一下的
				// 大多数情况下都是BeanName，这在@ControllerAdvice的初始化时会讲~~~
				Object bean = clazz.resolveBean();
				for (Method method : methodSet) {
					// createInitBinderMethod：把Method适配为可执行的InvocableHandlerMethod
					
					// 特点是把本类的HandlerMethodArgumentResolverComposite传进去了
					// 当然还有DataBinderFactory和ParameterNameDiscoverer等
					initBinderMethods.add(createInitBinderMethod(bean, method));
				}
			}
		});
		// 后一步：再条件标注有@InitBinder的方法
		for (Method method : methods) {
			Object bean = handlerMethod.getBean();
			initBinderMethods.add(createInitBinderMethod(bean, method));
		}

		// protected方法，就一句代码：new ServletRequestDataBinderFactory(binderMethods, getWebBindingInitializer())
		return createDataBinderFactory(initBinderMethods);
	}
	...
}

public class StringTrimmerEditor extends PropertyEditorSupport {

    // 将属性对象用一个字符串表示，以便外部的属性编辑器能以可视化的方式显示。缺省返回null，表示该属性不能以字符串表示
    //@Override
    //public String getAsText() {
    //    Object value = getValue();
    //    return (value != null ? value.toString() : null);
    //}

    // 用一个字符串去更新属性的内部值，这个字符串一般从外部属性编辑器传入
    // 处理请求的入参：test就是你传进来的值（并不是super.getValue()哦~）
    @Override
    public void setAsText(String text) throws IllegalArgumentException {
        text = text == null ? text : text.trim();
        setValue(text);
    }
}

// @since 28.04.2003
// @see java.util.Date
public class CustomDateEditor extends PropertyEditorSupport {
	...
	@Override
	public void setAsText(@Nullable String text) throws IllegalArgumentException {
		...
		setValue(this.dateFormat.parse(text));
		...
	}
	...
	@Override
	public String getAsText() {
		Date value = (Date) getValue();
		return (value != null ? this.dateFormat.format(value) : "");
	}
}

@Controller
@RequestMapping
public class HelloController {

    @InitBinder
    public void initBinder(WebDataBinder binder) {
        //binder.setDisallowedFields("name"); // 不绑定name属性
        binder.registerCustomEditor(String.class, new StringTrimmerEditor());

        // 此处使用Spring内置的CustomDateEditor
        DateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");
        binder.registerCustomEditor(Date.class, new CustomDateEditor(dateFormat, true));
    }

    @ResponseBody
    @GetMapping("/test/initbinder")
    public String testInitBinder(String param, Date date) {
        return param + ":" + date;
    }
}

public @interface InitBinder {
	// 用于限定次注解标注的方法作用于哪个模型key上
	String[] value() default {};
}

@Controller
@RequestMapping
public class HelloController {

    @InitBinder({"param", "user"})
    public void initBinder(WebDataBinder binder, HttpServletRequest request) {
        System.out.println("当前key：" + binder.getObjectName());
    }

    @ResponseBody
    @GetMapping("/test/initbinder")
    public String testInitBinder(String param, String date,
                                 @ModelAttribute("user") User user, @ModelAttribute("person") Person person) {
        return param + ":" + date;
    }
}

当前key：param
当前key：user

@Controller
@RequestMapping
public class HelloController {

    @Getter
    @Setter
    @ToString
    public static class User {
        private String id;
        private String name;
    }

    @Getter
    @Setter
    @ToString
    public static class Addr {
        private String id;
        private String name;
    }

    @InitBinder("user")
    public void initBinderUser(WebDataBinder binder) {
        binder.setFieldDefaultPrefix("user.");
    }

    @InitBinder("addr")
    public void initBinderAddr(WebDataBinder binder) {
        binder.setFieldDefaultPrefix("addr.");
    }

    @ResponseBody
    @GetMapping("/test/initbinder")
    public String testInitBinder(@ModelAttribute("user") User user, @ModelAttribute("addr") Addr addr) {
        return user + ":" + addr;
    }
}