SpingMVC之<mvc:annotation-driven/>標(biāo)簽

對于SpringMVC的探索已經(jīng)接近尾聲，本篇筆記主要記錄下SpringMVC為我們提供的一個神奇標(biāo)簽 <mvc:annotation-driven/>，這個標(biāo)簽會幫我們注入很多關(guān)鍵而實用的bean，但是用它也得小心跟自己手動注入的bean重復(fù)，會造成不必要的麻煩。所以今天來了解下這個標(biāo)簽。
本篇筆記主要分析SpringMVC 5.1.1 這個版本。

為了弄清楚這些問題，我們先找到它的解析類，所有的自定義命名空間（像mvc，context等）下的標(biāo)簽解析都是由BeanDefinitionParser 接口的實現(xiàn)類來完成的。我們今天研究的是<mvc:annotation-driven/>標(biāo)簽，所以我們找到對應(yīng)的實現(xiàn)類是org.springframework.web.servlet.config.AnnotationDrivenBeanDefinitionParser。

1 簡單了解下功能

AnnotationDrivenBeanDefinitionParser，為 <annotation-driven /> MVC名稱空間元素提供配置。

1.1 注冊以下HandlerMappings (映射器們)：

  • RequestMappingHandlerMapping 的排序為0，用于將請求映射到帶@RequestMapping注釋的控制器方法。
  • BeanNameUrlHandlerMapping 在排序為2，以將URL路徑映射到控制器bean名稱。

1.2 注冊以下HandlerAdapters (適配器們)：

  • RequestMappingHandlerAdapter 用于使用帶@RequestMapping注解的控制器方法處理請求。
  • HttpRequestHandlerAdapter 用于使用HttpRequestHandlers處理請求。
  • SimpleControllerHandlerAdapter 用于使用基于接口的控制器處理請求。

1.3 注冊以下HandlerExceptionResolvers (異常處理解析器們)：

  • ExceptionHandlerExceptionResolver，用于通過 org.springframework.web.bind.annotation.ExceptionHandler 方法處理異常。
  • ResponseStatusExceptionResolver 用于使用 org.springframework.web.bind.annotation.ResponseStatus 注釋的異常。
  • DefaultHandlerExceptionResolver 用于解析已知的Spring異常類型

1.4 其他

注冊 org.springframework.util.AntPathMatcher 和 org.springframework.web.util.UrlPathHelper 以供 RequestMappingHandlerMapping、ViewControllers 的 HandlerMapping 和 HandlerMapping 服務(wù)資源是使用。

對于JSR-303實現(xiàn)，會檢測 javax.validation.Validator 路徑是否有效，有效則會幫我們創(chuàng)建對應(yīng)的實現(xiàn)類并注入。

最后幫我們檢測一些列 HttpMessageConverter 的實現(xiàn)類們，這些主要是用作直接對請求體里面解析出來的數(shù)據(jù)進行轉(zhuǎn)換。俗稱 http 消息轉(zhuǎn)換器，與參數(shù)轉(zhuǎn)換器不一樣。
在 SpringMVC 5.1.1 中有以下幾個檢測：

檢測路徑 注入消息轉(zhuǎn)換器 對應(yīng)請求類型
com.rometools.rome.feed.WireFeed RssChannelHttpMessageConverter application/atom+xml
javax.xml.bind.Binder Jaxb2RootElementHttpMessageConverter application/xml
com.fasterxml.jackson.databind.ObjectMapper & com.fasterxml.jackson.core.JsonGenerator MappingJackson2HttpMessageConverter application/json
com.fasterxml.jackson.dataformat.xml.XmlMapper MappingJackson2XmlHttpMessageConverter application/xml
com.fasterxml.jackson.dataformat.smile.SmileFactory MappingJackson2SmileHttpMessageConverter application/x-jackson-smile
com.fasterxml.jackson.dataformat.cbor.CBORFactory MappingJackson2CborHttpMessageConverter application/cbor
com.google.gson.Gson GsonHttpMessageConverter application/json

除了會幫我們注入以上檢測有效的 http 消息轉(zhuǎn)換器外，還會幫我們注入SpringMVC自帶的幾個 http 消息轉(zhuǎn)換器，上面檢測的轉(zhuǎn)換器是由上到下順序加入的，也就是說解析的時候回根據(jù) ContentType 從上到下找合適的。

2 源碼簡介

該標(biāo)簽的解釋是在 org.springframework.web.servlet.config.AnnotationDrivenBeanDefinitionParser 類的 parse(..) 方法中

2.1 HandlerMappings 注冊

2.1.1 RequestMappingHandlerMapping 映射器的注冊
//生成RequestMappingHandlerMapping組件對象
RootBeanDefinition handlerMappingDef = new RootBeanDefinition(RequestMappingHandlerMapping.class);
handlerMappingDef.setSource(source);
handlerMappingDef.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
//優(yōu)先級設(shè)置為最高
handlerMappingDef.getPropertyValues().add("order", 0);
//添加contentNegotiationManager屬性，處理media type
handlerMappingDef.getPropertyValues().add("contentNegotiationManager", contentNegotiationManager);

if (element.hasAttribute("enable-matrix-variables")) {
    Boolean enableMatrixVariables = Boolean.valueOf(element.getAttribute("enable-matrix-variables"));
    handlerMappingDef.getPropertyValues().add("removeSemicolonContent", !enableMatrixVariables);
}

//配置路徑匹配解析器等屬性
configurePathMatchingProperties(handlerMappingDef, element, context);
readerContext.getRegistry().registerBeanDefinition(HANDLER_MAPPING_BEAN_NAME , handlerMappingDef);

//將RequestMappingHandlerMapping注冊為bean對象放置bean工廠中
RuntimeBeanReference corsRef = MvcNamespaceUtils.registerCorsConfigurations(null, context, source);
handlerMappingDef.getPropertyValues().add("corsConfigurations", corsRef);
2.1.1 BeanNameUrlHandlerMapping 映射器注冊就比較隨意
// Ensure BeanNameUrlHandlerMapping (SPR-8289) and default HandlerAdapters are not "turned off"
MvcNamespaceUtils.registerDefaultComponents(context, source);

放在這里跟 HttpRequestHandlerAdapter、SimpleControllerHandlerAdapter、HandlerMappingIntrospector 一起注冊的。

2.2 HandlerAdapters 注冊

2.2.1 RequestMappingHandlerAdapter 適配器的注冊
//從該標(biāo)簽的 "conversion-service" 屬性中獲取注入到容器里面的參數(shù)轉(zhuǎn)換服務(wù)器, 沒有則重新創(chuàng)建
RuntimeBeanReference conversionService = getConversionService(element, source, context);
//從該標(biāo)簽的 "validator" 屬性中獲取注入到容器里面的參數(shù)驗證服務(wù), 沒有則創(chuàng)建
RuntimeBeanReference validator = getValidator(element, source, context);
//從該標(biāo)簽的 "message-codes-resolver" 屬性中獲取錯誤碼解析器, 沒有則不創(chuàng)建
RuntimeBeanReference messageCodesResolver = getMessageCodesResolver(element);

//創(chuàng)建 `WebDataBinder` 初始化使用到的記錄器, 并將上面的參數(shù)轉(zhuǎn)換和驗證相關(guān)綁定在其上面
RootBeanDefinition bindingDef = new RootBeanDefinition(ConfigurableWebBindingInitializer.class);
bindingDef.setSource(source);
bindingDef.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
bindingDef.getPropertyValues().add("conversionService", conversionService);
bindingDef.getPropertyValues().add("validator", validator);
bindingDef.getPropertyValues().add("messageCodesResolver", messageCodesResolver);

//從該標(biāo)簽的 `message-converters` 屬性上獲取記錄請求體轉(zhuǎn)換器的集合，沒有則創(chuàng)建默認(rèn)的
ManagedList<?> messageConverters = getMessageConverters(element, source, context);
//從該標(biāo)簽的 `argument-resolvers` 屬性上獲取記錄自定義參數(shù)轉(zhuǎn)換器的集合
ManagedList<?> argumentResolvers = getArgumentResolvers(element, context);
//從該標(biāo)簽的 `return-value-handlers` 屬性上獲取記錄自定義返回值轉(zhuǎn)換器的集合
ManagedList<?> returnValueHandlers = getReturnValueHandlers(element, context);
//從該標(biāo)簽的 "async-support" 子節(jié)點解析，獲取其中的 "default-timeout" 屬性，作為異步處理超時時間，默認(rèn)null
String asyncTimeout = getAsyncTimeout(element);
//從該標(biāo)簽的 "async-support" 子節(jié)點解析，獲取其中的 "task-executor" 屬性，異步任務(wù)線程池
RuntimeBeanReference asyncExecutor = getAsyncExecutor(element);
//從該標(biāo)簽的 "async-support" 子節(jié)點解析，獲取其中的 "callable-interceptors"節(jié)點，異步處理callable類型攔截器
ManagedList<?> callableInterceptors = getCallableInterceptors(element, source, context);
ManagedList<?> deferredResultInterceptors = getDeferredResultInterceptors(element, source, context);

//生成RequestMappingHandlerAdapter組件對象，并將上面獲取的相關(guān)綁定在該映射器上
RootBeanDefinition handlerAdapterDef = new RootBeanDefinition(RequestMappingHandlerAdapter.class);
handlerAdapterDef.setSource(source);
handlerAdapterDef.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
handlerAdapterDef.getPropertyValues().add("contentNegotiationManager", contentNegotiationManager);
handlerAdapterDef.getPropertyValues().add("webBindingInitializer", bindingDef);
handlerAdapterDef.getPropertyValues().add("messageConverters", messageConverters);
addRequestBodyAdvice(handlerAdapterDef);
addResponseBodyAdvice(handlerAdapterDef);

if (element.hasAttribute("ignore-default-model-on-redirect")) {
    Boolean ignoreDefaultModel = Boolean.valueOf(element.getAttribute("ignore-default-model-on-redirect"));
    handlerAdapterDef.getPropertyValues().add("ignoreDefaultModelOnRedirect", ignoreDefaultModel);
}
if (argumentResolvers != null) {
    handlerAdapterDef.getPropertyValues().add("customArgumentResolvers", argumentResolvers);
}
if (returnValueHandlers != null) {
    handlerAdapterDef.getPropertyValues().add("customReturnValueHandlers", returnValueHandlers);
}
if (asyncTimeout != null) {
    handlerAdapterDef.getPropertyValues().add("asyncRequestTimeout", asyncTimeout);
}
if (asyncExecutor != null) {
    handlerAdapterDef.getPropertyValues().add("taskExecutor", asyncExecutor);
}

handlerAdapterDef.getPropertyValues().add("callableInterceptors", callableInterceptors);
handlerAdapterDef.getPropertyValues().add("deferredResultInterceptors", deferredResultInterceptors);
readerContext.getRegistry().registerBeanDefinition(HANDLER_ADAPTER_BEAN_NAME , handlerAdapterDef);
2.2.2 HttpRequestHandlerAdapter 和 SimpleControllerHandlerAdapter 適配器的注冊就比較隨意
registerHttpRequestHandlerAdapter(parserContext, source);
registerSimpleControllerHandlerAdapter(parserContext, source);

2.3 HandlerExceptionResolvers 組件注冊

默認(rèn)采用 ExceptionHandlerExceptionResolver(處理 @ExceptionHandler 方法注解)、ResponseStatusExceptionResolver(處理 @ResponseStatus 類型、方法注解)、DefaultHandlerExceptionResolver(處理普通的 Spring 異常) 作為異常處理類

RootBeanDefinition methodExceptionResolver = new RootBeanDefinition(ExceptionHandlerExceptionResolver.class);
methodExceptionResolver.setSource(source);
methodExceptionResolver.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
methodExceptionResolver.getPropertyValues().add("contentNegotiationManager", contentNegotiationManager);
methodExceptionResolver.getPropertyValues().add("messageConverters", messageConverters);
methodExceptionResolver.getPropertyValues().add("order", 0);
addResponseBodyAdvice(methodExceptionResolver);
if (argumentResolvers != null) {
    methodExceptionResolver.getPropertyValues().add("customArgumentResolvers", argumentResolvers);
}
if (returnValueHandlers != null) {
    methodExceptionResolver.getPropertyValues().add("customReturnValueHandlers", returnValueHandlers);
}
String methodExResolverName = readerContext.registerWithGeneratedName(methodExceptionResolver);

RootBeanDefinition statusExceptionResolver = new RootBeanDefinition(ResponseStatusExceptionResolver.class);
statusExceptionResolver.setSource(source);
statusExceptionResolver.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
statusExceptionResolver.getPropertyValues().add("order", 1);
String statusExResolverName = readerContext.registerWithGeneratedName(statusExceptionResolver);

RootBeanDefinition defaultExceptionResolver = new RootBeanDefinition(DefaultHandlerExceptionResolver.class);
defaultExceptionResolver.setSource(source);
defaultExceptionResolver.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
defaultExceptionResolver.getPropertyValues().add("order", 2);
String defaultExResolverName = readerContext.registerWithGeneratedName(defaultExceptionResolver);

2.4 其他的根據(jù)檢測有效路徑注冊

static {
    ClassLoader classLoader = AnnotationDrivenBeanDefinitionParser.class.getClassLoader();
    javaxValidationPresent = ClassUtils.isPresent("javax.validation.Validator", classLoader);
    romePresent = ClassUtils.isPresent("com.rometools.rome.feed.WireFeed", classLoader);
    jaxb2Present = ClassUtils.isPresent("javax.xml.bind.Binder", classLoader);
    jackson2Present = ClassUtils.isPresent("com.fasterxml.jackson.databind.ObjectMapper", classLoader) &&
    ClassUtils.isPresent("com.fasterxml.jackson.core.JsonGenerator", classLoader);
    jackson2XmlPresent = ClassUtils.isPresent("com.fasterxml.jackson.dataformat.xml.XmlMapper", classLoader);
    jackson2SmilePresent = ClassUtils.isPresent("com.fasterxml.jackson.dataformat.smile.SmileFactory", classLoader);
    jackson2CborPresent = ClassUtils.isPresent("com.fasterxml.jackson.dataformat.cbor.CBORFactory", classLoader);
    gsonPresent = ClassUtils.isPresent("com.google.gson.Gson", classLoader);
}

后面會根據(jù)上面 Class 路徑的檢測結(jié)果注入相關(guān)的驗證器和轉(zhuǎn)換器。

其他相關(guān)文章

SpringMVC入門筆記
SpringMVC工作原理之處理映射[HandlerMapping]
SpringMVC工作原理之適配器[HandlerAdapter]
SpringMVC工作原理之參數(shù)解析
SpringMVC之自定義參數(shù)解析
SpringMVC工作原理之視圖解析及自定義
SpingMVC之<mvc:annotation-driven/>標(biāo)簽

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容