快捷導(dǎo)航

SpringMVC 參數(shù)綁定相關(guān)知識(shí)總結(jié)

更新時(shí)間：2021年03月23日 10:34:31 作者：檸檬時(shí)間

這篇文章主要介紹了SpringMVC 參數(shù)綁定相關(guān)知識(shí)總結(jié)，幫助大家更好的理解和學(xué)習(xí)使用SpringMVC，感興趣的朋友可以了解下

請(qǐng)求進(jìn)入DispatcherServlet的doDispatch后，獲取HandlerMethod。然后根據(jù)HandlerMethod來(lái)確認(rèn)HandlerApapter，確認(rèn)后執(zhí)行HandlerAdapter的handle方法。這里確認(rèn)HandlerApater為RequestMappingHandlerAdapter，在執(zhí)行handlerMethod之前，需要處理參數(shù)的綁定。

1. 簡(jiǎn)單參數(shù)綁定

執(zhí)行HandlerAdapter的handler方法后，進(jìn)入RequestMappingHandlerAdapter的invokeHandleMethod方法

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)建一個(gè)ServletInvocableHandlerMethod。后續(xù)把請(qǐng)求直接交給ServletInvocableHandlerMethod執(zhí)行。
 //createRequestMappingMethod方法比較簡(jiǎn)單，把之前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);
}

然后進(jìn)入invokeAndHanldle方法，然后進(jìn)入invokeForRequest方法，這個(gè)方法的職責(zé)是從request中解析出HandlerMethod方法所需要的參數(shù)，然后通過(guò)反射調(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());
  }  
  //通過(guò)反射執(zhí)行HandleMethod中的method，方法參數(shù)為args。并返回方法執(zhí)行的返回值
  Object returnValue = invoke(args);  if (logger.isTraceEnabled()) {
   logger.trace("Method [" + this.getMethod().getName() + "] returned [" + returnValue + "]");
  }  return returnValue;
 }

進(jìn)入getMethodArgumentValues方法

private Object[] getMethodArgumentValues(
  NativeWebRequest request, ModelAndViewContainer mavContainer,  Object... providedArgs) throws Exception { 
  //獲取方法參數(shù)數(shù)組
 MethodParameter[] parameters = getMethodParameters(); 
 //創(chuàng)建一個(gè)參數(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個(gè)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;
}

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

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

再進(jìn)入HandlerMethodArgumentResolver的resolverArgument方法

public final Object resolveArgument(
   MethodParameter parameter, ModelAndViewContainer mavContainer,
   NativeWebRequest webRequest, WebDataBinderFactory binderFactory)
   throws Exception {  
   //獲取int的Class對(duì)象
  Class<?> paramType = parameter.getParameterType();  
  //根據(jù)參數(shù)定義創(chuàng)建一個(gè)NamedValueInfo對(duì)象
  NamedValueInfo namedValueInfo = getNamedValueInfo(parameter);  //根據(jù)參數(shù)名解析出對(duì)象的值
  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類(lèi)型，然后轉(zhuǎn)換為方法參數(shù)所需要的類(lèi)型(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;
 }

這個(gè)方法的職責(zé)是根據(jù)parameter對(duì)象創(chuàng)建一個(gè)NamedValueInfo對(duì)象。這個(gè)對(duì)象存放的就是參數(shù)名、是否必須、參數(shù)默認(rèn)值3個(gè)成員變量。然后進(jìn)入resolverName方法解析參數(shù)，最后返回

2. 對(duì)象參數(shù)綁定

對(duì)象參數(shù)解析綁定會(huì)交給ServletModelAttributeMethodProcessor這個(gè)類(lèi)進(jìn)行解析，進(jìn)入supportsParameter方法

/**
*帶有@ModelAttribute注解返回true
* parameter不是簡(jiǎn)單類(lèi)型也返回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;
 }
}

進(jìn)入ServletModelAttributeMethodProcessor的resolveArgument方法。它的resolveArgument是由父類(lèi)ModelAttributeMethodProcessor具體實(shí)現(xiàn)的

/**
* 解析model中的參數(shù)，如果從ModelAndViewContainer未找到，直接通過(guò)反射實(shí)例化一個(gè)對(duì)象。具體實(shí)例化是通過(guò)父類(lèi)的createAttribute方法，通過(guò)調(diào)用BeanUtils.instantiateClass方法來(lái)實(shí)例化的。這個(gè)對(duì)象便是后續(xù)傳給test2(User u)方法的對(duì)象，但是此時(shí)創(chuàng)建的對(duì)象里面的值都還為空，注入值是通過(guò)bindRequestParameters方法來(lái)實(shí)現(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) {   
 //將請(qǐng)求綁定至目標(biāo)binder的target對(duì)象，也就是剛剛創(chuàng)建的attribute對(duì)象。
 bindRequestParameters(binder, request);   
 //如果有驗(yàn)證，則驗(yàn)證參數(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 model

  Map<String, Object> bindingResultModel = binder.getBindingResult().getModel();
  mavContainer.removeAttributes(bindingResultModel);
  mavContainer.addAllAttributes(bindingResultModel);  
  return binder.getTarget();
 }

該方法根據(jù)request和attribute、name創(chuàng)建一個(gè)WebDataBinder對(duì)象，其中。然后進(jìn)入bindRequestParameters方法綁定，根據(jù)reqeust中的參數(shù)創(chuàng)建一個(gè)MutablePropertyValues對(duì)象。MutablePropertyValues里面存放了一個(gè)或多個(gè)PropertyValue，其中PropertyValue用于保存,單個(gè)bean屬性的相關(guān)信息，比如參數(shù)名、參數(shù)值。這里需要注意的是PropertyValue并不是保存request對(duì)象的所有參數(shù)屬性信息。而是一個(gè)參數(shù)屬性對(duì)應(yīng)一個(gè)PropertyValue。比如這里的reqeust對(duì)象，攜帶了兩個(gè)參數(shù)，name和age，便會(huì)分別創(chuàng)建兩個(gè)PropertyValue對(duì)象。
創(chuàng)建MutablePropertyValues對(duì)象化后，進(jìn)入DataBinder.applyPropertyValues(DataBinder.java line737)。會(huì)根據(jù)剛剛創(chuàng)建的User對(duì)象。創(chuàng)建一個(gè)BeanWrapperImpl對(duì)象，BeanWrapperImpl實(shí)現(xiàn)了PropertyAccessor（屬性訪問(wèn)器）接口。這是spring-bean下的一個(gè)類(lèi)，在Sping中，對(duì)Bean屬性的存取都是通過(guò)BeanWrapperImpl類(lèi)來(lái)實(shí)現(xiàn)的。BeanWarapperImpl在這里作用就是通過(guò)PropertyValue中的屬性相關(guān)描述，注入到BeanWarapperImpl對(duì)應(yīng)的java對(duì)象的屬性中去。具體注入的方法是setPropertyValues，這個(gè)方法略復(fù)雜。它的職責(zé)簡(jiǎn)單總結(jié)起來(lái)就是根據(jù)屬性名調(diào)用對(duì)應(yīng)的set...方法。比如注入U(xiǎn)ser對(duì)象的name屬性時(shí)，通過(guò)反射獲取setName方法。如果有該方法便調(diào)用。這也是為什么在定義SpringMVC model 對(duì)象需要set...方法。

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

SpringMVC初始化時(shí)，RequestMappingHandlerAdapter類(lèi)會(huì)把一些默認(rèn)的參數(shù)解析器添加到argumentResolvers中。當(dāng)SpringMVC接收到請(qǐng)求后首先根據(jù)url查找對(duì)應(yīng)的HandlerMethod。
遍歷HandlerMethod的MethodParameter數(shù)組
根據(jù)MethodParameter的類(lèi)型來(lái)查找確認(rèn)使用哪個(gè)HandlerMethodArgumentResolver，遍歷所有的argumentResolvers的supportsParameter(MethodParameter parameter)方法。。如果返回true，則表示查找成功，當(dāng)前MethodParameter，使用該HandlerMethodArgumentResolver。這里確認(rèn)大多都是根據(jù)參數(shù)的注解已經(jīng)參數(shù)的Type來(lái)確認(rèn)。
解析參數(shù)，從request中解析出MethodParameter對(duì)應(yīng)的參數(shù)，這里解析出來(lái)的結(jié)果都是String類(lèi)型。
轉(zhuǎn)換參數(shù)，把對(duì)應(yīng)String轉(zhuǎn)換成具體方法所需要的類(lèi)型，這里就包括了基本類(lèi)型、對(duì)象、List、Set、Map。

以上就是SpringMVC 參數(shù)綁定相關(guān)知識(shí)總結(jié)的詳細(xì)內(nèi)容，更多關(guān)于SpringMVC 參數(shù)綁定的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: