摘要
- 本文從源碼層面簡單講解SpringMVC的參數(shù)綁定原理
SpringMVC參數(shù)綁定相關(guān)組件的初始化過程
- 在理解初始化之前，先來認(rèn)識(shí)一個(gè)接口
HandlerMethodArgumentResolver
- 方法參數(shù)解析器接口，這個(gè)接口是SpringMVC參數(shù)解析綁定的核心接口。不同的參數(shù)類型綁定都是通過實(shí)現(xiàn)這個(gè)接口來實(shí)現(xiàn)。也可以通過實(shí)現(xiàn)這個(gè)接口來自定義參數(shù)解析器。這個(gè)接口中有如下兩個(gè)方法
public interface HandlerMethodArgumentResolver {
//該解析器是否支持parameter參數(shù)的解析
boolean supportsParameter(MethodParameter parameter);
//將方法參數(shù)從給定請(qǐng)求(webRequest)解析為參數(shù)值并返回
Object resolveArgument(MethodParameter parameter,
ModelAndViewContainer mavContainer,
NativeWebRequest webRequest,
WebDataBinderFactory binderFactory) throws Exception;
}
初始化
- 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();
}
- 現(xiàn)在我們進(jìn)入getDefalutArgumentResolvers方法，代碼如下
//默認(rèn)的參數(shù)解析，創(chuàng)建了默認(rèn)的24個(gè)參數(shù)解析器，并添加至resolvers
//這里的24個(gè)參數(shù)解析器都是針對(duì)不同的參數(shù)類型來解析的
private List<HandlerMethodArgumentResolver> getDefaultArgumentResolvers() {
List<HandlerMethodArgumentResolver> resolvers = new ArrayList<HandlerMethodArgumentResolver>();
// 基于注解的參數(shù)解析器
//一般用于帶有@RequestParam注解的簡單參數(shù)綁定，簡單參數(shù)比如byte、int、long、double、String以及對(duì)應(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)某個(gè)參數(shù)會(huì)交個(gè)哪個(gè)參數(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 arguments
if (getCustomArgumentResolvers() != null) {
resolvers.addAll(getCustomArgumentResolvers());
}
- 參數(shù)解析器添加至HandlerMethodArgumentResolverComposite這個(gè)類，這個(gè)也是實(shí)現(xiàn)了HandlerMethodArgumentResolver接口。這里運(yùn)用涉及模式中的composite模式（組合模式），SpringMVC中，所有請(qǐng)求的參數(shù)解析都是進(jìn)入HandlerMethodArgumentResolverComposite類來完成的。它有兩個(gè)成員變量，如下
//它的元素在RequestMappingHandlerAdapter類的afterPropertiesSet方法中被添加，存放的是SpringMVC一些默認(rèn)的HandlerMethodArgumentResolver參數(shù)解析器
private final List<HandlerMethodArgumentResolver> argumentResolvers =
new LinkedList<HandlerMethodArgumentResolver>();
//存放已經(jīng)解析過的參數(shù)，已經(jīng)對(duì)應(yīng)的HandlerMethodArgumentResolver解析器。加快查找過程
private final Map<MethodParameter, HandlerMethodArgumentResolver> argumentResolverCache =
new ConcurrentHashMap<MethodParameter, HandlerMethodArgumentResolver>(256);
- 介紹了這么多，話不多說。直接來看一個(gè)詳細(xì)解析綁定過程吧
綁定過程
- 先看一個(gè)簡單參數(shù)綁定，有如下Controller和請(qǐng)求,代碼如下。
@Controller
@RequestMapping("/ParameterBind")
public class ParameterBindTestController {
@ResponseBody
@RequestMapping("/test1")
public String test1(int id){
System.out.println(id);
return "test1";
}
}
image
- 請(qǐng)求進(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)建一個(gè)ServletInvocableHandlerMethod。后續(xù)把請(qǐng)求直接交給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);
}
- 然后進(jìn)入invokeAndHanldle方法，然后進(jìn)入invokeForRequest方法，這個(gè)方法的職責(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;
}
- 直接進(jìn)入getMethodArgumentValues方法看看其過程，代碼如下
/**
* 獲取當(dāng)前請(qǐng)求的方法參數(shù)值。
*/
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類型，然后轉(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;
}
- 這個(gè)方法的職責(zé)是，首先獲取paramType。也就是int對(duì)應(yīng)的Class對(duì)象。然后根據(jù)parameter對(duì)象創(chuàng)建一個(gè)NamedValueInfo對(duì)象。這個(gè)對(duì)象存放的就是參數(shù)名、是否必須、參數(shù)默認(rèn)值3個(gè)成員變量。然后進(jìn)入resolverName方法解析參數(shù)，里面的邏輯其實(shí)很簡單，就是根據(jù)方法的參數(shù)名來獲取request中的參數(shù)。關(guān)鍵代碼如下
String[] paramValues = webRequest.getParameterValues(name);
if (paramValues != null) {
arg = paramValues.length == 1 ? paramValues[0] : paramValues;
}
所以這里返回的值就是9999,這里返回的值還是String類型的。而需要的參數(shù)是int類型的。然后通過binder.coverIfNecessary方法把String轉(zhuǎn)換為int類型返回。
對(duì)象綁定
- 新加一個(gè)方法，代碼如下
@ResponseBody
@RequestMapping("/test2")
public String test2(User u){
System.out.println(u.toString());
return "test1";
}
image
- 這個(gè)請(qǐng)求的參數(shù)解析綁定便會(huì)交給ServletModelAttributeMethodProcessor這個(gè)類，在初始化argumentResolvers的時(shí)候。是會(huì)創(chuàng)建兩個(gè)不同的ServletModelAttributeMethodProcessor對(duì)象的。
resolvers.add(new ServletModelAttributeMethodProcessor(false));
resolvers.add(new ServletModelAttributeMethodProcessor(true));
- 這兩個(gè)有什么區(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;
}
}
- 雖然test2(User u)方法沒有ModelAttribute注解，但是User.class不是簡單類型。所以該MethodHandler的參數(shù)u還是會(huì)交給ServletModelAtttributeMethodProcessor處理。
- 看看ServletModelAttributeMethodProcessor的resolveArgument方法。它的resolveArgument是由父類ModelAttributeMethodProcessor具體實(shí)現(xiàn)的，代碼如下。
/**
* 解析model中的參數(shù)，如果從ModelAndViewContainer未找到，直接通過反射實(shí)例化一個(gè)對(duì)象。具體實(shí)例化是通過父類的createAttribute方法，通過調(diào)用BeanUtils.instantiateClass方法來實(shí)例化的。這個(gè)對(duì)象便是后續(xù)傳給test2(User u)方法的對(duì)象，但是此時(shí)創(chuàng)建的對(duì)象里面的值都還為空，注入值是通過bindRequestParameters方法來實(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();
}
-
該方法的職責(zé)是實(shí)例化一個(gè)parameterType的對(duì)象，然后根據(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ì)象。對(duì)應(yīng)的MutablePropertyValues結(jié)構(gòu)如下圖
image 創(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（屬性訪問器）接口。這是spring-bean下的一個(gè)類，在Sping中，對(duì)Bean屬性的存取都是通過BeanWrapperImpl類來實(shí)現(xiàn)的。BeanWarapperImpl在這里作用就是通過PropertyValue中的屬性相關(guān)描述，注入到BeanWarapperImpl對(duì)應(yīng)的java對(duì)象的屬性中去。具體注入的方法是setPropertyValues，這個(gè)方法略復(fù)雜。它的職責(zé)簡單總結(jié)起來就是根據(jù)屬性名調(diào)用對(duì)應(yīng)的set...方法。比如注入U(xiǎn)ser對(duì)象的name屬性時(shí)，通過反射獲取setName方法。如果有該方法便調(diào)用。這也是為什么在定義SpringMVC model 對(duì)象需要set...方法。如果沒有set方法，參數(shù)注入便會(huì)失敗。
參數(shù)解析綁定總結(jié)
- SpringMVC初始化時(shí)，RequestMappingHandlerAdapter類會(huì)把一些默認(rèn)的參數(shù)解析器添加到argumentResolvers中。當(dāng)SpringMVC接收到請(qǐng)求后首先根據(jù)url查找對(duì)應(yīng)的HandlerMethod。
- 遍歷HandlerMethod的MethodParameter數(shù)組
- 根據(jù)MethodParameter的類型來查找確認(rèn)使用哪個(gè)HandlerMethodArgumentResolver，遍歷所有的argumentResolvers的supportsParameter(MethodParameter parameter)方法。。如果返回true，則表示查找成功，當(dāng)前MethodParameter，使用該HandlerMethodArgumentResolver。這里確認(rèn)大多都是根據(jù)參數(shù)的注解已經(jīng)參數(shù)的Type來確認(rèn)。
- 解析參數(shù)，從request中解析出MethodParameter對(duì)應(yīng)的參數(shù)，這里解析出來的結(jié)果都是String類型。
- 轉(zhuǎn)換參數(shù)，把對(duì)應(yīng)String轉(zhuǎn)換成具體方法所需要的類型，這里就包括了基本類型、對(duì)象、List、Set、Map。
總結(jié)
- 解析所使用代碼已上傳至github，https://github.com/wycm/SpringMVC-Demo
- 以上源碼是基于SpringMVC 3.2.2.RELEASE版本。以上便是SpringMVC參數(shù)解析綁定的主要過程，希望對(duì)大家有幫助。本文可能有錯(cuò)誤，希望讀者能夠指出來。
版權(quán)聲明
作者：wycm
出處：http://www.lxweimin.com/p/72f905f2c8e4
您的支持是對(duì)博主最大的鼓勵(lì)，感謝您的認(rèn)真閱讀。
本文版權(quán)歸作者所有，歡迎轉(zhuǎn)載，但未經(jīng)作者同意必須保留此段聲明，且在文章頁面明顯位置給出原文連接，否則保留追究法律責(zé)任的權(quán)利。
歡迎關(guān)注我的個(gè)人公眾號(hào)
