SpringMVC 參數綁定相關知識總結
請求進入DispatcherServlet的doDispatch后,獲取HandlerMethod。然后根據HandlerMethod來確認HandlerApapter,確認后執(zhí)行HandlerAdapter的handle方法。這里確認HandlerApater為RequestMappingHandlerAdapter,在執(zhí)行handlerMethod之前,需要處理參數的綁定。
1. 簡單參數綁定
執(zhí)行HandlerAdapter的handler方法后,進入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); //根據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);
}
然后進入invokeAndHanldle方法,然后進入invokeForRequest方法,這個方法的職責是從request中解析出HandlerMethod方法所需要的參數,然后通過反射調用HandlerMethod中的method
public final Object invokeForRequest(NativeWebRequest request,
ModelAndViewContainer mavContainer, Object... providedArgs) throws Exception { //從request中解析出HandlerMethod方法所需要的參數,并返回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,方法參數為args。并返回方法執(zhí)行的返回值
Object returnValue = invoke(args); if (logger.isTraceEnabled()) {
logger.trace("Method [" + this.getMethod().getName() + "] returned [" + returnValue + "]");
} return returnValue;
}
進入getMethodArgumentValues方法
private Object[] getMethodArgumentValues(
NativeWebRequest request, ModelAndViewContainer mavContainer, Object... providedArgs) throws Exception {
//獲取方法參數數組
MethodParameter[] parameters = getMethodParameters();
//創(chuàng)建一個參數數組,保存從request解析出的方法參數
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(參數解析器),是否存在支持該參數解析的解析器
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;
}
進入HandlerMethodArgumentResolverComposite的resolveArgument方法
public Object resolveArgument(
MethodParameter parameter, ModelAndViewContainer mavContainer,
NativeWebRequest webRequest, WebDataBinderFactory binderFactory)
throws Exception {
//首先獲取參數解析器,這里獲取的邏輯是首先從argumentResolverCache緩存中獲取該MethodParameter匹配的HandlerMethodArgumentResolver。如果為空,遍歷初始化定義的那24個。查找匹配的HandlerMethodArgumentResolver,然后添加至argumentResolverCache緩存中
HandlerMethodArgumentResolver resolver = getArgumentResolver(parameter);
Assert.notNull(resolver, "Unknown parameter type [" + parameter.getParameterType().getName() + "]");
//解析參數
return resolver.resolveArgument(parameter, mavContainer, webRequest, binderFactory);
}
再進入HandlerMethodArgumentResolver的resolverArgument方法
public final Object resolveArgument(
MethodParameter parameter, ModelAndViewContainer mavContainer,
NativeWebRequest webRequest, WebDataBinderFactory binderFactory)
throws Exception {
//獲取int的Class對象
Class<?> paramType = parameter.getParameterType();
//根據參數定義創(chuàng)建一個NamedValueInfo對象
NamedValueInfo namedValueInfo = getNamedValueInfo(parameter); //根據參數名解析出對象的值
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類型,然后轉換為方法參數所需要的類型(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;
}
這個方法的職責是根據parameter對象創(chuàng)建一個NamedValueInfo對象。這個對象存放的就是參數名、是否必須、參數默認值3個成員變量。然后進入resolverName方法解析參數,最后返回
2. 對象參數綁定
對象參數解析綁定會交給ServletModelAttributeMethodProcessor這個類進行解析,進入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;
}
}
進入ServletModelAttributeMethodProcessor的resolveArgument方法。它的resolveArgument是由父類ModelAttributeMethodProcessor具體實現(xiàn)的
/**
* 解析model中的參數,如果從ModelAndViewContainer未找到,直接通過反射實例化一個對象。具體實例化是通過父類的createAttribute方法,通過調用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) {
//將請求綁定至目標binder的target對象,也就是剛剛創(chuàng)建的attribute對象。
bindRequestParameters(binder, request);
//如果有驗證,則驗證參數
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();
}
- 該方法根據request和attribute、name創(chuàng)建一個WebDataBinder對象,其中。然后進入bindRequestParameters方法綁定,根據reqeust中的參數創(chuàng)建一個MutablePropertyValues對象。MutablePropertyValues里面存放了一個或多個PropertyValue,其中PropertyValue用于保存,單個bean屬性的相關信息,比如參數名、參數值。這里需要注意的是PropertyValue并不是保存request對象的所有參數屬性信息。而是一個參數屬性對應一個PropertyValue。比如這里的reqeust對象,攜帶了兩個參數,name和age,便會分別創(chuàng)建兩個PropertyValue對象。
- 創(chuàng)建MutablePropertyValues對象化后,進入DataBinder.applyPropertyValues(DataBinder.java line737)。會根據剛剛創(chuàng)建的User對象。創(chuàng)建一個BeanWrapperImpl對象,BeanWrapperImpl實現(xiàn)了PropertyAccessor(屬性訪問器)接口。這是spring-bean下的一個類,在Sping中,對Bean屬性的存取都是通過BeanWrapperImpl類來實現(xiàn)的。BeanWarapperImpl在這里作用就是通過PropertyValue中的屬性相關描述,注入到BeanWarapperImpl對應的java對象的屬性中去。具體注入的方法是setPropertyValues,這個方法略復雜。它的職責簡單總結起來就是根據屬性名調用對應的set...方法。比如注入User對象的name屬性時,通過反射獲取setName方法。如果有該方法便調用。這也是為什么在定義SpringMVC model 對象需要set...方法。
3. 參數綁定解析總結
- SpringMVC初始化時,RequestMappingHandlerAdapter類會把一些默認的參數解析器添加到argumentResolvers中。當SpringMVC接收到請求后首先根據url查找對應的HandlerMethod。
- 遍歷HandlerMethod的MethodParameter數組
- 根據MethodParameter的類型來查找確認使用哪個HandlerMethodArgumentResolver,遍歷所有的argumentResolvers的supportsParameter(MethodParameter parameter)方法。。如果返回true,則表示查找成功,當前MethodParameter,使用該HandlerMethodArgumentResolver。這里確認大多都是根據參數的注解已經參數的Type來確認。
- 解析參數,從request中解析出MethodParameter對應的參數,這里解析出來的結果都是String類型。
- 轉換參數,把對應String轉換成具體方法所需要的類型,這里就包括了基本類型、對象、List、Set、Map。
以上就是SpringMVC 參數綁定相關知識總結的詳細內容,更多關于SpringMVC 參數綁定的資料請關注腳本之家其它相關文章!
相關文章
Java基礎之重載(Overload)與重寫(Override)詳解
這篇文章主要介紹了Java基礎之重載(Overload)與重寫(Override)詳解,文中有非常詳細的代碼示例,對正在學習java基礎的小伙伴們有非常好的幫助,需要的朋友可以參考下2021-04-04
Spring Integration 實現(xiàn)消息驅動的詳細步驟
Spring Integration是一個用于構建消息驅動的中間件輕量級框架,它提供了一種模型和工具,用于在Spring應用程序中實現(xiàn)企業(yè)集成模式,這篇文章主要介紹了Spring Integration 實現(xiàn)消息驅動,需要的朋友可以參考下2024-05-05
Java Stream的基本概念以及創(chuàng)建方法
這篇文章主要介紹了Java Stream的基本概念以及創(chuàng)建方法,幫助大家更好的理解和學習Java,感興趣的朋友可以了解下2020-08-08
java 將 list 字符串用逗號隔開拼接字符串的多種方法
這篇文章主要介紹了java 將 list 字符串用逗號隔開拼接字符串,本文給大家分享四種方法,每種方法通過實例代碼給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2021-12-12
Spring整合Mybatis使用<context:property-placeholder>時的坑
這篇文章主要介紹了Spring整合Mybatis使用<context:property-placeholder>時的坑 的相關資料,非常不錯,具有參考借鑒價值,需要的朋友可以參考下2016-06-06

