<mvc:annotation-driven/>做了什么

转自:http://blog.csdn.net/sjjsh2/article/details/53100728


<mvc:annotation-driven /> 是一种简写形式,完全可以手动配置替代这种简写形式,简写形式可以让初学都快速应用默认配置方案。<mvc:annotation-driven /> 会自动注册DefaultAnnotationHandlerMapping与AnnotationMethodHandlerAdapter 两个bean,是spring MVC为@Controllers分发请求所必须的,即解决了@Controller注解使用的前提配置。

  同时它还提供了:数据绑定支持,@NumberFormatannotation支持,@DateTimeFormat支持,@Valid支持,读写XML的支持(JAXB,读写JSON的支持(Jackson)。我们处理响应ajax请求时,就使用到了对json的支持(配置之后,在加入了jackson的core和mapper包之后,不写配置文件也能自动转换成json)。

  而且,当对action写JUnit单元测试时,要从spring IOC容器中取DefaultAnnotationHandlerMapping与AnnotationMethodHandlerAdapter 两个bean,来完成测试,取的时候要知道正是<mvc:annotation-driven />这一句注册的这两个bean。

  需要注意的是,在spring mvc 3.1以上,DefaultAnnotationHandlerMapping与AnnotationMethodHandlerAdapter对应变更为: 
  DefaultAnnotationHandlerMapping -> RequestMappingHandlerMapping 
  AnnotationMethodHandlerAdapter -> RequestMappingHandlerAdapter 
  AnnotationMethodHandlerExceptionResolver -> ExceptionHandlerExceptionResolver 

  以上都在使用了annotation-driven后自动注册。而且对应分别提供了AbstractHandlerMethodMapping , AbstractHandlerMethodAdapter和 AbstractHandlerMethodExceptionResolver以便于让用户更方便的实现自定义的实现类。 

  通常如果我们希望通过注解的方式来进行Spring MVC开发,我们都会在***-servlet.xml中加入<mvc:annotation-driven/>标签来告诉Spring我们的目的,那么这个标签到底做了什么呢,我们先看看它的解析类,我们知道所有的自定义命名空间(像mvc,context等)下的标签解析都是由BeanDefinitionParser接口的子类来完成的,先看图片:


  我们看到有多个AnnotationDrivenBeanDefinitionParser,他们是用来处理不同命名空间下的<annotation-driven/>标签的,我们今天研究的是<mvc:annotation-driven/>标签,所以我们找到对应的实现类是:org.springframework.web.servlet.config.AnnotationDrivenBeanDefinitionParser。

  一、AnnotationDrivenBeanDefinitionParser

  通过阅读类注释文档,我们发现这个类主要是用来向工厂中注册了:

[java]  view plain  copy
  1. RequestMappingHandlerMapping   
  2.   
  3. BeanNameUrlHandlerMapping  
  4.   
  5. RequestMappingHandlerAdapter  
  6.   
  7. HttpRequestHandlerAdapter  
  8.   
  9. SimpleControllerHandlerAdapter  
  10.   
  11. ExceptionHandlerExceptionResolver   
  12.   
  13. ResponseStatusExceptionResolver   
  14.   
  15. DefaultHandlerExceptionResolver   
  上面几个Bean实例。这几个类都是用来做什么的呢?
  前两个是HandlerMapping接口的实现类,用来处理请求映射的。其中第一个是处理@RequestMapping注解的。第二个会将controller类的名字映射为请求url。中间三个是用来处理请求的。具体点说就是确定调用哪个controller的哪个方法来处理当前请求。第一个处理@Controller注解的处理器,支持自定义方法参数和返回值。第二个是处理继承HttpRequestHandler的处理器。第三个处理继承自Controller接口的处理器。后面三个是用来处理异常的解析器。

  二、实现

[java]  view plain  copy
  1. public BeanDefinition parse(Element element, ParserContext parserContext) {  
  2.         Object source = parserContext.extractSource(element);  
  3.   
  4.         CompositeComponentDefinition compDefinition = new CompositeComponentDefinition(element.getTagName(), source);  
  5.         parserContext.pushContainingComponent(compDefinition);  
  6.   
  7.         RuntimeBeanReference contentNegotiationManager = getContentNegotiationManager(element, source, parserContext);  
  8.         //第一个在这 RequestMappingHandlerMapping  
  9.         RootBeanDefinition handlerMappingDef = new RootBeanDefinition(RequestMappingHandlerMapping.class);  
  10.         handlerMappingDef.setSource(source);  
  11.         handlerMappingDef.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);  
  12.         handlerMappingDef.getPropertyValues().add("order"0);  
  13.         handlerMappingDef.getPropertyValues().add("removeSemicolonContent"false);  
  14.         handlerMappingDef.getPropertyValues().add("contentNegotiationManager", contentNegotiationManager);  
  15.         String methodMappingName = parserContext.getReaderContext().registerWithGeneratedName(handlerMappingDef);  
  16.         //第二个在这 RequestMappingHandlerAdapter  
  17.         RootBeanDefinition handlerAdapterDef = new RootBeanDefinition(RequestMappingHandlerAdapter.class);  
  18.         handlerAdapterDef.setSource(source);  
  19.         handlerAdapterDef.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);  
  20.         handlerAdapterDef.getPropertyValues().add("contentNegotiationManager", contentNegotiationManager);  
  21.         handlerAdapterDef.getPropertyValues().add("webBindingInitializer", bindingDef);  
  22.         handlerAdapterDef.getPropertyValues().add("messageConverters", messageConverters);  
  23.         if (element.hasAttribute("ignoreDefaultModelOnRedirect")) {  
  24.             Boolean ignoreDefaultModel = Boolean.valueOf(element.getAttribute("ignoreDefaultModelOnRedirect"));  
  25.             handlerAdapterDef.getPropertyValues().add("ignoreDefaultModelOnRedirect", ignoreDefaultModel);  
  26.         }  
  27.         if (argumentResolvers != null) {  
  28.             handlerAdapterDef.getPropertyValues().add("customArgumentResolvers", argumentResolvers);  
  29.         }  
  30.         if (returnValueHandlers != null) {  
  31.             handlerAdapterDef.getPropertyValues().add("customReturnValueHandlers", returnValueHandlers);  
  32.         }  
  33.         if (asyncTimeout != null) {  
  34.             handlerAdapterDef.getPropertyValues().add("asyncRequestTimeout", asyncTimeout);  
  35.         }  
  36.         if (asyncExecutor != null) {  
  37.             handlerAdapterDef.getPropertyValues().add("taskExecutor", asyncExecutor);  
  38.         }  
  39.         handlerAdapterDef.getPropertyValues().add("callableInterceptors", callableInterceptors);  
  40.         handlerAdapterDef.getPropertyValues().add("deferredResultInterceptors", deferredResultInterceptors);  
  41.         String handlerAdapterName = parserContext.getReaderContext().registerWithGeneratedName(handlerAdapterDef);  
  42.         //异常处理解析器  
  43.         RootBeanDefinition exceptionHandlerExceptionResolver = new RootBeanDefinition(ExceptionHandlerExceptionResolver.class);  
  44.         exceptionHandlerExceptionResolver.setSource(source);  
  45.         exceptionHandlerExceptionResolver.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);  
  46.         exceptionHandlerExceptionResolver.getPropertyValues().add("contentNegotiationManager", contentNegotiationManager);  
  47.         exceptionHandlerExceptionResolver.getPropertyValues().add("messageConverters", messageConverters);  
  48.         exceptionHandlerExceptionResolver.getPropertyValues().add("order"0);  
  49.         String methodExceptionResolverName =  
  50.                 parserContext.getReaderContext().registerWithGeneratedName(exceptionHandlerExceptionResolver);  
  51.         //异常处理解析器  
  52.         RootBeanDefinition responseStatusExceptionResolver = new RootBeanDefinition(ResponseStatusExceptionResolver.class);  
  53.         responseStatusExceptionResolver.setSource(source);  
  54.         responseStatusExceptionResolver.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);  
  55.         responseStatusExceptionResolver.getPropertyValues().add("order"1);  
  56.         String responseStatusExceptionResolverName =  
  57.                 parserContext.getReaderContext().registerWithGeneratedName(responseStatusExceptionResolver);  
  58.         //异常处理解析器  
  59.         RootBeanDefinition defaultExceptionResolver = new RootBeanDefinition(DefaultHandlerExceptionResolver.class);  
  60.         defaultExceptionResolver.setSource(source);  
  61.         defaultExceptionResolver.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);  
  62.         defaultExceptionResolver.getPropertyValues().add("order"2);  
  63.         String defaultExceptionResolverName =  
  64.                 parserContext.getReaderContext().registerWithGeneratedName(defaultExceptionResolver);  
  65.   
  66.         parserContext.registerComponent(new BeanComponentDefinition(handlerMappingDef, methodMappingName));  
  67.         parserContext.registerComponent(new BeanComponentDefinition(handlerAdapterDef, handlerAdapterName));  
  68.         parserContext.registerComponent(new BeanComponentDefinition(exceptionHandlerExceptionResolver, methodExceptionResolverName));  
  69.         parserContext.registerComponent(new BeanComponentDefinition(responseStatusExceptionResolver, responseStatusExceptionResolverName));  
  70.         parserContext.registerComponent(new BeanComponentDefinition(defaultExceptionResolver, defaultExceptionResolverName));  
  71.         parserContext.registerComponent(new BeanComponentDefinition(mappedCsInterceptorDef, mappedInterceptorName));  
  72.         //这里注册了BeanNameUrlHandlerMapping,SimpleControllerHandlerAdapter等  
  73.         // Ensure BeanNameUrlHandlerMapping (SPR-8289) and default HandlerAdapters are not "turned off"  
  74.         MvcNamespaceUtils.registerDefaultComponents(parserContext, source);  
  75.   
  76.         parserContext.popAndRegisterContainingComponent();  
  77.   
  78.         return null;  
  79.     }  
  80. //在这啊。  
  81. public static void registerDefaultComponents(ParserContext parserContext, Object source) {  
  82.         registerBeanNameUrlHandlerMapping(parserContext, source);  
  83.         registerHttpRequestHandlerAdapter(parserContext, source);  
  84.         registerSimpleControllerHandlerAdapter(parserContext, source);  
  85.     }  

  我们知道了它们自动为我们注册了这么多的Bean,那这些Bean是做什么的呢?
  最重要的就是RequestMappingHandlerMapping和RequestMappingHandlerAdapter。
  第一个是HandlerMapping的实现类,它会处理@RequestMapping 注解,并将其注册到请求映射表中。
  第二个是HandlerAdapter的实现类,它是处理请求的适配器,说白了,就是确定调用哪个类的哪个方法,并且构造方法参数,返回值。

  这两个Bean在前面的文章都有介绍,可以返回去看。

  三、小结

  看了上面那些,我们再来归纳一下:

  1、Spring是怎么解析<mvc:annotation-driven/>标签的?

  首先,必须要有一个继承自“org.springframework.beans.factory.xml.NamespaceHandlerSupport”的类,在其init方法中,注册自己的解析器,注册mvc解析器的类为MvcNamespaceHandler。一般针对每个元素,都有一个解析器,比如:针对annotation-driven,就有一个解析器:就是前面提到的AnnotationDrivenBeanDefinitionParser。
  解析器必须实现org.springframework.beans.factory.xml.BeanDefinitionParser接口,这个接口只有一个parse方法,它有两个参数,第一个参数org.w3c.dom.Element就是我们在xml文件中声明的<mvc:annotation-driven/>结点,拿到这个结点信息,就可以开始具体的业务了。

  2、Spring怎么知道处理mvc开头的标签就调用MvcNamespaceHandler中注册的解析器的呢?

  这需要有一个"mvc”<–>MvcNamespaceHandler这样一个映射关系,那么这个映射关系在哪里呢?就在META-INF目录下的spring.handlers:源文件中的内容:

[html]  view plain  copy
  1. http\://www.springframework.org/schema/mvc=  
  2. org.springframework.web.servlet.config.MvcNamespaceHandler  
  这里定义了只要是http\://www.springframework.org/schema/mvc命名空间的标签,就使用org.springframework.web.servlet.config.MvcNamespaceHandler中的解析器。
  头文件里说的http://www.springframework.org/schema/mvc/spring-mvc-3.1.xsd,并不是真的到网上去下载这个文件,在spring.schemas文件中,定义了它指向org/springframework/web/servlet/config/spring-mvc-3.1.xsd这个文件(在jar包里)。
  所以,在Spring中,想使用自己的命名空间:
  1、首先需要一个xsd文件,来描述自定义元素的命名规则,并在再Spring的配置文件的<benas>头中引用它。
  2、然后需要实现一个BeanDefinitionParser接口,在接口的parse方法中,解析将来在Spring配置文件中出现的元素。(如果xsd声明可以有多个元素,需呀实现多个BeanDefinitionParser接口)
  3、最后需要继承一个NamespaceHandlerSupport类,在它的init方法中,调用registerBeanDefinitionParser方法,将待解析的xml元素与解析器绑定。
  4、在META-INF目录下,创建spring.schemas、spring.handlers文件,建立最高级的映射关系以便Spring进行处理。

  四、与<context:component-scan/>的区别

  <context:component-scan/>标签是告诉Spring 来扫描指定包下的类,并注册被@Component,@Controller,@Service,@Repository等注解标记的组件。
而<mvc:annotation-scan/>是告知Spring,我们启用注解驱动。然后Spring会自动为我们注册上面说到的几个Bean到工厂中,来处理我们的请求。

  五、与<context:annotation-config/>的区别

  当我们需要使用注解模式时,直接在Spring配置文件中定义这些Bean显得比较笨拙,例如:
使用@Autowired注解,必须事先在Spring容器中声明AutowiredAnnotationBeanPostProcessor的Bean:

[html]  view plain  copy
  1. <bean class="org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor "/>  
  使用 @Required注解,就必须声明RequiredAnnotationBeanPostProcessor的Bean:
[html]  view plain  copy
  1. <bean class="org.springframework.beans.factory.annotation.RequiredAnnotationBeanPostProcessor"/>  
  简单的说,用什么注解,就需要声明对应的BeanPostProcessor。这样的声明未免太不优雅,而Spring为我们提供了一种极为方便注册这些BeanPostProcessor的方式,即使用<context:annotation- config/>隐式地向 Spring容器注册AutowiredAnnotationBeanPostProcessor、RequiredAnnotationBeanPostProcessor、CommonAnnotationBeanPostProcessor以及PersistenceAnnotationBeanPostProcessor这4个BeanPostProcessor。

    另外,在我们使用注解时一般都会配置扫描包路径选项,即<context:component-scan/>。该配置项其实也包含了自动注入上述processor的功能,因此当使用<context:component-scan/>后,即可将<context:annotation-config/>省去,但必须要配置全!以防万一,还是同时声明的好。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值