摘要

• 本文從源碼層面簡單講解SpringMVC的參數(shù)綁定原理

SpringMVC參數(shù)綁定相關(guān)組件的初始化過程

• 在理解初始化之前，先來認(rèn)識一個接口

HandlerMethodArgumentResolver

• 方法參數(shù)解析器接口，這個接口是SpringMVC參數(shù)解析綁定的核心接口。不同的參數(shù)類型綁定都是通過實現(xiàn)這個接口來實現(xiàn)。也可以通過實現(xiàn)這個接口來自定義參數(shù)解析器。這個接口中有如下兩個方法

public interface HandlerMethodArgumentResolver {//該解析器是否支持parameter參數(shù)的解析boolean supportsParameter(MethodParameter parameter);//將方法參數(shù)從給定請求(webRequest)解析為參數(shù)值并返回Object resolveArgument(MethodParameter parameter,ModelAndViewContainer mavContainer,NativeWebRequest webRequest,WebDataBinderFactory binderFactory) throws Exception; } 復(fù)制代碼

初始化

• RequestMappingHandlerAdapter.java類的afterPropertiesSet（line:481）方法初始化相關(guān)方法參數(shù)解析器。代碼如下

public void afterPropertiesSet() {if (this.argumentResolvers == null) {//初始化SpringMVC默認(rèn)的方法參數(shù)解析器，并添加至argumentResolvers（HandlerMethodArgumentResolverComposite）List<HandlerMethodArgumentResolver> resolvers = getDefaultArgumentResolvers();this.argumentResolvers = new HandlerMethodArgumentResolverComposite().addResolvers(resolvers);}if (this.initBinderArgumentResolvers == null) {//初始化SpringMVC默認(rèn)的初始化綁定器(@InitBinder)參數(shù)解析器，并添加至initBinderArgumentResolvers（HandlerMethodArgumentResolverComposite）List<HandlerMethodArgumentResolver> resolvers = getDefaultInitBinderArgumentResolvers();this.initBinderArgumentResolvers = new HandlerMethodArgumentResolverComposite().addResolvers(resolvers);}if (this.returnValueHandlers == null) {//獲取默認(rèn)的方法返回值解析器List<HandlerMethodReturnValueHandler> handlers = getDefaultReturnValueHandlers();this.returnValueHandlers = new HandlerMethodReturnValueHandlerComposite().addHandlers(handlers);}initControllerAdviceCache(); } 復(fù)制代碼

• 現(xiàn)在我們進(jìn)入getDefalutArgumentResolvers方法，代碼如下

//默認(rèn)的參數(shù)解析，創(chuàng)建了默認(rèn)的24個參數(shù)解析器，并添加至resolvers //這里的24個參數(shù)解析器都是針對不同的參數(shù)類型來解析的 private List<HandlerMethodArgumentResolver> getDefaultArgumentResolvers() {List<HandlerMethodArgumentResolver> resolvers = new ArrayList<HandlerMethodArgumentResolver>();// 基于注解的參數(shù)解析器//一般用于帶有@RequestParam注解的簡單參數(shù)綁定，簡單參數(shù)比如byte、int、long、double、String以及對應(yīng)的包裝類型resolvers.add(new RequestParamMethodArgumentResolver(getBeanFactory(), false));//用于處理帶有@RequestParam注解，且參數(shù)類型為Map的解析綁定resolvers.add(new RequestParamMapMethodArgumentResolver());//一般用于處理帶有@PathVariable注解的默認(rèn)參數(shù)綁定resolvers.add(new PathVariableMethodArgumentResolver());//也是用于帶有@PathVariable注解的Map相關(guān)參數(shù)綁定，后續(xù)還有一些默認(rèn)的參數(shù)解析器。后續(xù)還有一些參數(shù)解析器，我這里都不一一解釋了。想具體確認(rèn)某個參數(shù)會交個哪個參數(shù)解析器處理，可以通過以下解析器的supportsParameter(MethodParameter parameter)方法得知resolvers.add(new PathVariableMapMethodArgumentResolver());resolvers.add(new MatrixVariableMethodArgumentResolver());resolvers.add(new MatrixVariableMapMethodArgumentResolver());resolvers.add(new ServletModelAttributeMethodProcessor(false));resolvers.add(new RequestResponseBodyMethodProcessor(getMessageConverters()));resolvers.add(new RequestPartMethodArgumentResolver(getMessageConverters()));resolvers.add(new RequestHeaderMethodArgumentResolver(getBeanFactory()));resolvers.add(new RequestHeaderMapMethodArgumentResolver());resolvers.add(new ServletCookieValueMethodArgumentResolver(getBeanFactory()));resolvers.add(new ExpressionValueMethodArgumentResolver(getBeanFactory()));// 基于類型的參數(shù)解析器resolvers.add(new ServletRequestMethodArgumentResolver());resolvers.add(new ServletResponseMethodArgumentResolver());resolvers.add(new HttpEntityMethodProcessor(getMessageConverters()));resolvers.add(new RedirectAttributesMethodArgumentResolver());resolvers.add(new ModelMethodProcessor());resolvers.add(new MapMethodProcessor());resolvers.add(new ErrorsMethodArgumentResolver());resolvers.add(new SessionStatusMethodArgumentResolver());resolvers.add(new UriComponentsBuilderMethodArgumentResolver());// Custom argumentsif (getCustomArgumentResolvers() != null) {resolvers.addAll(getCustomArgumentResolvers());} 復(fù)制代碼

• 參數(shù)解析器添加至HandlerMethodArgumentResolverComposite這個類，這個也是實現(xiàn)了HandlerMethodArgumentResolver接口。這里運用涉及模式中的composite模式（組合模式），SpringMVC中，所有請求的參數(shù)解析都是進(jìn)入HandlerMethodArgumentResolverComposite類來完成的。它有兩個成員變量，如下

//它的元素在RequestMappingHandlerAdapter類的afterPropertiesSet方法中被添加，存放的是SpringMVC一些默認(rèn)的HandlerMethodArgumentResolver參數(shù)解析器 private final List<HandlerMethodArgumentResolver> argumentResolvers =new LinkedList<HandlerMethodArgumentResolver>(); //存放已經(jīng)解析過的參數(shù)，已經(jīng)對應(yīng)的HandlerMethodArgumentResolver解析器。加快查找過程 private final Map<MethodParameter, HandlerMethodArgumentResolver> argumentResolverCache =new ConcurrentHashMap<MethodParameter, HandlerMethodArgumentResolver>(256); 復(fù)制代碼

• 介紹了這么多，話不多說。直接來看一個詳細(xì)解析綁定過程吧

綁定過程

• 先看一個簡單參數(shù)綁定，有如下Controller和請求,代碼如下。

@Controller @RequestMapping("/ParameterBind") public class ParameterBindTestController {@ResponseBody@RequestMapping("/test1")public String test1(int id){System.out.println(id);return "test1";} } 復(fù)制代碼

• 請求進(jìn)入DispatcherServlet的doDispatch后，獲取HandlerMethod。然后根據(jù)HandlerMethod來確認(rèn)HandlerApapter，確認(rèn)后執(zhí)行HandlerAdapter的handle方法。這里確認(rèn)HandlerApater為RequestMappingHandlerAdapter，在執(zhí)行handlerMethod之前，需要處理參數(shù)的綁定。然后看看詳細(xì)的參數(shù)綁定過程
• 執(zhí)行HandlerAdapter的handler方法后，進(jìn)入RequestMappingHandlerAdapter的invokeHandleMethod方法（line:711）

private ModelAndView invokeHandleMethod(HttpServletRequest request,HttpServletResponse response, HandlerMethod handlerMethod) throws Exception {ServletWebRequest webRequest = new ServletWebRequest(request, response);WebDataBinderFactory binderFactory = getDataBinderFactory(handlerMethod);ModelFactory modelFactory = getModelFactory(handlerMethod, binderFactory);//根據(jù)handlerMethod和binderFactory創(chuàng)建一個ServletInvocableHandlerMethod。后續(xù)把請求直接交給ServletInvocableHandlerMethod執(zhí)行。//createRequestMappingMethod方法比較簡單，把之前RequestMappingHandlerAdapter初始化的argumentResolvers和returnValueHandlers添加至ServletInvocableHandlerMethod中ServletInvocableHandlerMethod requestMappingMethod = createRequestMappingMethod(handlerMethod, binderFactory);ModelAndViewContainer mavContainer = new ModelAndViewContainer();mavContainer.addAllAttributes(RequestContextUtils.getInputFlashMap(request));modelFactory.initModel(webRequest, mavContainer, requestMappingMethod);mavContainer.setIgnoreDefaultModelOnRedirect(this.ignoreDefaultModelOnRedirect);AsyncWebRequest asyncWebRequest = WebAsyncUtils.createAsyncWebRequest(request, response);asyncWebRequest.setTimeout(this.asyncRequestTimeout);final WebAsyncManager asyncManager = WebAsyncUtils.getAsyncManager(request);asyncManager.setTaskExecutor(this.taskExecutor);asyncManager.setAsyncWebRequest(asyncWebRequest);asyncManager.registerCallableInterceptors(this.callableInterceptors);asyncManager.registerDeferredResultInterceptors(this.deferredResultInterceptors);if (asyncManager.hasConcurrentResult()) {Object result = asyncManager.getConcurrentResult();mavContainer = (ModelAndViewContainer) asyncManager.getConcurrentResultContext()[0];asyncManager.clearConcurrentResult();if (logger.isDebugEnabled()) {logger.debug("Found concurrent result value [" + result + "]");}requestMappingMethod = requestMappingMethod.wrapConcurrentResult(result);}requestMappingMethod.invokeAndHandle(webRequest, mavContainer);if (asyncManager.isConcurrentHandlingStarted()) {return null;}return getModelAndView(mavContainer, modelFactory, webRequest); } 復(fù)制代碼

• 然后進(jìn)入invokeAndHanldle方法，然后進(jìn)入invokeForRequest方法，這個方法的職責(zé)是從request中解析出HandlerMethod方法所需要的參數(shù)，然后通過反射調(diào)用HandlerMethod中的method。代碼如下

public final Object invokeForRequest(NativeWebRequest request,ModelAndViewContainer mavContainer,Object... providedArgs) throws Exception {//從request中解析出HandlerMethod方法所需要的參數(shù)，并返回Object[]Object[] args = getMethodArgumentValues(request, mavContainer, providedArgs);if (logger.isTraceEnabled()) {StringBuilder builder = new StringBuilder("Invoking [");builder.append(this.getMethod().getName()).append("] method with arguments ");builder.append(Arrays.asList(args));logger.trace(builder.toString());}//通過反射執(zhí)行HandleMethod中的method，方法參數(shù)為args。并返回方法執(zhí)行的返回值Object returnValue = invoke(args);if (logger.isTraceEnabled()) {logger.trace("Method [" + this.getMethod().getName() + "] returned [" + returnValue + "]");}return returnValue;} 復(fù)制代碼

• 直接進(jìn)入getMethodArgumentValues方法看看其過程，代碼如下

/** * 獲取當(dāng)前請求的方法參數(shù)值。 */ private Object[] getMethodArgumentValues(NativeWebRequest request, ModelAndViewContainer mavContainer,Object... providedArgs) throws Exception {//獲取方法參數(shù)數(shù)組MethodParameter[] parameters = getMethodParameters();//創(chuàng)建一個參數(shù)數(shù)組，保存從request解析出的方法參數(shù)Object[] args = new Object[parameters.length];for (int i = 0; i < parameters.length; i++) {MethodParameter parameter = parameters[i];parameter.initParameterNameDiscovery(parameterNameDiscoverer);GenericTypeResolver.resolveParameterType(parameter, getBean().getClass());args[i] = resolveProvidedArgument(parameter, providedArgs);if (args[i] != null) {continue;}//判斷之前RequestMappingHandlerAdapter初始化的那24個HandlerMethodArgumentResolver（參數(shù)解析器），是否存在支持該參數(shù)解析的解析器if (argumentResolvers.supportsParameter(parameter)) {try {args[i] = argumentResolvers.resolveArgument(parameter, mavContainer, request, dataBinderFactory);continue;} catch (Exception ex) {if (logger.isTraceEnabled()) {logger.trace(getArgumentResolutionErrorMessage("Error resolving argument", i), ex);}throw ex;}}if (args[i] == null) {String msg = getArgumentResolutionErrorMessage("No suitable resolver for argument", i);throw new IllegalStateException(msg);}}return args; } 復(fù)制代碼

• 進(jìn)入HandlerMethodArgumentResolverComposite的resolveArgument方法

public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer,NativeWebRequest webRequest, WebDataBinderFactory binderFactory)throws Exception {//首先獲取參數(shù)解析器，這里獲取的邏輯是首先從argumentResolverCache緩存中獲取該MethodParameter匹配的HandlerMethodArgumentResolver。如果為空，遍歷初始化定義的那24個。查找匹配的HandlerMethodArgumentResolver，然后添加至argumentResolverCache緩存中HandlerMethodArgumentResolver resolver = getArgumentResolver(parameter);Assert.notNull(resolver, "Unknown parameter type [" + parameter.getParameterType().getName() + "]");//解析參數(shù)return resolver.resolveArgument(parameter, mavContainer, webRequest, binderFactory);} 復(fù)制代碼

• 然后進(jìn)入HandlerMethodArgumentResolver的resolverArgument方法

public final Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer,NativeWebRequest webRequest, WebDataBinderFactory binderFactory)throws Exception {//獲取int的Class對象Class<?> paramType = parameter.getParameterType();//根據(jù)參數(shù)定義創(chuàng)建一個NamedValueInfo對象NamedValueInfo namedValueInfo = getNamedValueInfo(parameter);//根據(jù)參數(shù)名解析出對象的值Object arg = resolveName(namedValueInfo.name, parameter, webRequest);if (arg == null) {if (namedValueInfo.defaultValue != null) {arg = resolveDefaultValue(namedValueInfo.defaultValue);}else if (namedValueInfo.required) {handleMissingValue(namedValueInfo.name, parameter);}arg = handleNullValue(namedValueInfo.name, arg, paramType);}else if ("".equals(arg) && (namedValueInfo.defaultValue != null)) {arg = resolveDefaultValue(namedValueInfo.defaultValue);}//上面步驟獲取的args是String類型，然后轉(zhuǎn)換為方法參數(shù)所需要的類型(int)if (binderFactory != null) {WebDataBinder binder = binderFactory.createBinder(webRequest, null, namedValueInfo.name);arg = binder.convertIfNecessary(arg, paramType, parameter);}handleResolvedValue(arg, namedValueInfo.name, parameter, mavContainer, webRequest);return arg;} 復(fù)制代碼

• 這個方法的職責(zé)是，首先獲取paramType。也就是int對應(yīng)的Class對象。然后根據(jù)parameter對象創(chuàng)建一個NamedValueInfo對象。這個對象存放的就是參數(shù)名、是否必須、參數(shù)默認(rèn)值3個成員變量。然后進(jìn)入resolverName方法解析參數(shù)，里面的邏輯其實很簡單，就是根據(jù)方法的參數(shù)名來獲取request中的參數(shù)。關(guān)鍵代碼如下

String[] paramValues = webRequest.getParameterValues(name); if (paramValues != null) {arg = paramValues.length == 1 ? paramValues[0] : paramValues; } 復(fù)制代碼

所以這里返回的值就是9999,這里返回的值還是String類型的。而需要的參數(shù)是int類型的。然后通過binder.coverIfNecessary方法把String轉(zhuǎn)換為int類型返回。

對象綁定

• 新加一個方法，代碼如下

@ResponseBody @RequestMapping("/test2") public String test2(User u){System.out.println(u.toString());return "test1"; } 復(fù)制代碼

• 這個請求的參數(shù)解析綁定便會交給ServletModelAttributeMethodProcessor這個類，在初始化argumentResolvers的時候。是會創(chuàng)建兩個不同的ServletModelAttributeMethodProcessor對象的。

resolvers.add(new ServletModelAttributeMethodProcessor(false)); resolvers.add(new ServletModelAttributeMethodProcessor(true)); 復(fù)制代碼

• 這兩個有什么區(qū)別？進(jìn)入supportsParameter方法看看

/** *帶有@ModelAttribute注解返回true * parameter不是簡單類型也返回true. */ public boolean supportsParameter(MethodParameter parameter) {if (parameter.hasParameterAnnotation(ModelAttribute.class)) {return true;}else if (this.annotationNotRequired) {return !BeanUtils.isSimpleProperty(parameter.getParameterType());}else {return false;}} 復(fù)制代碼

• 雖然test2(User u)方法沒有ModelAttribute注解，但是User.class不是簡單類型。所以該MethodHandler的參數(shù)u還是會交給ServletModelAtttributeMethodProcessor處理。
• 看看ServletModelAttributeMethodProcessor的resolveArgument方法。它的resolveArgument是由父類ModelAttributeMethodProcessor具體實現(xiàn)的，代碼如下。

/** * 解析model中的參數(shù)，如果從ModelAndViewContainer未找到，直接通過反射實例化一個對象。具體實例化是通過父類的createAttribute方法，通過調(diào)用BeanUtils.instantiateClass方法來實例化的。這個對象便是后續(xù)傳給test2(User u)方法的對象，但是此時創(chuàng)建的對象里面的值都還為空，注入值是通過bindRequestParameters方法來實現(xiàn)的。 */ public final Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer,NativeWebRequest request, WebDataBinderFactory binderFactory)throws Exception {String name = ModelFactory.getNameForParameter(parameter);Object attribute = (mavContainer.containsAttribute(name)) ?mavContainer.getModel().get(name) : createAttribute(name, parameter, binderFactory, request);WebDataBinder binder = binderFactory.createBinder(request, attribute, name);if (binder.getTarget() != null) {//將請求綁定至目標(biāo)binder的target對象，也就是剛剛創(chuàng)建的attribute對象。bindRequestParameters(binder, request);//如果有驗證，則驗證參數(shù)validateIfApplicable(binder, parameter);if (binder.getBindingResult().hasErrors()) {if (isBindExceptionRequired(binder, parameter)) {throw new BindException(binder.getBindingResult());}}}// Add resolved attribute and BindingResult at the end of the modelMap<String, Object> bindingResultModel = binder.getBindingResult().getModel();mavContainer.removeAttributes(bindingResultModel);mavContainer.addAllAttributes(bindingResultModel);return binder.getTarget();} 復(fù)制代碼

• 該方法的職責(zé)是實例化一個parameterType的對象，然后根據(jù)request和attribute、name創(chuàng)建一個WebDataBinder對象，其中。然后進(jìn)入bindRequestParameters方法綁定，根據(jù)reqeust中的參數(shù)創(chuàng)建一個MutablePropertyValues對象。MutablePropertyValues里面存放了一個或多個PropertyValue，其中PropertyValue用于保存單個bean屬性的相關(guān)信息，比如參數(shù)名、參數(shù)值。這里需要注意的是PropertyValue并不是保存request對象的所有參數(shù)屬性信息。而是一個參數(shù)屬性對應(yīng)一個PropertyValue。比如這里的reqeust對象，攜帶了兩個參數(shù)，name和age，便會分別創(chuàng)建兩個PropertyValue對象。對應(yīng)的MutablePropertyValues結(jié)構(gòu)如下圖

• 
  
• 創(chuàng)建MutablePropertyValues對象化后，進(jìn)入DataBinder.applyPropertyValues(DataBinder.java line737)。會根據(jù)剛剛創(chuàng)建的User對象。創(chuàng)建一個BeanWrapperImpl對象，BeanWrapperImpl實現(xiàn)了PropertyAccessor（屬性訪問器）接口。這是spring-bean下的一個類，在Sping中，對Bean屬性的存取都是通過BeanWrapperImpl類來實現(xiàn)的。BeanWarapperImpl在這里作用就是通過PropertyValue中的屬性相關(guān)描述，注入到BeanWarapperImpl對應(yīng)的java對象的屬性中去。具體注入的方法是setPropertyValues，這個方法略復(fù)雜。它的職責(zé)簡單總結(jié)起來就是根據(jù)屬性名調(diào)用對應(yīng)的set...方法。比如注入User對象的name屬性時，通過反射獲取setName方法。如果有該方法便調(diào)用。這也是為什么在定義SpringMVC model 對象需要set...方法。如果沒有set方法，參數(shù)注入便會失敗。

參數(shù)解析綁定總結(jié)

SpringMVC初始化時，RequestMappingHandlerAdapter類會把一些默認(rèn)的參數(shù)解析器添加到argumentResolvers中。當(dāng)SpringMVC接收到請求后首先根據(jù)url查找對應(yīng)的HandlerMethod。

遍歷HandlerMethod的MethodParameter數(shù)組

根據(jù)MethodParameter的類型來查找確認(rèn)使用哪個HandlerMethodArgumentResolver，遍歷所有的argumentResolvers的supportsParameter(MethodParameter parameter)方法。。如果返回true，則表示查找成功，當(dāng)前MethodParameter，使用該HandlerMethodArgumentResolver。這里確認(rèn)大多都是根據(jù)參數(shù)的注解已經(jīng)參數(shù)的Type來確認(rèn)。

解析參數(shù)，從request中解析出MethodParameter對應(yīng)的參數(shù)，這里解析出來的結(jié)果都是String類型。

轉(zhuǎn)換參數(shù)，把對應(yīng)String轉(zhuǎn)換成具體方法所需要的類型，這里就包括了基本類型、對象、List、Set、Map。

歡迎工作一到五年的Java工程師朋友們加入Java程序員開發(fā)： 721575865

群內(nèi)提供免費的Java架構(gòu)學(xué)習(xí)資料（里面有高可用、高并發(fā)、高性能及分布式、Jvm性能調(diào)優(yōu)、Spring源碼，MyBatis，Netty,Redis,Kafka,Mysql,Zookeeper,Tomcat,Docker,Dubbo,Nginx等多個知識點的架構(gòu)資料）合理利用自己每一分每一秒的時間來學(xué)習(xí)提升自己，不要再用"沒有時間“來掩飾自己思想上的懶惰！趁年輕，使勁拼，給未來的自己一個交代！

轉(zhuǎn)載于:https://juejin.im/post/5c9c863c6fb9a070c319131e

總結(jié)

以上是生活随笔為你收集整理的SpringMVC源码之参数解析绑定原理的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。