springmvc源码笔记-HandlerMapping注入

2022年6月16日 445点热度 0人点赞 0条评论

在springmvc中，如何根据url找到controller以及对应方法，依赖的是HandlerMapping接口的getHandler方法

在spring容器中默认注册的HandlerMapping有以下五种：

RequestMappingHandlerMapping
BeanNameUrlHandlerMapping
SimpleUrlHandlerMapping
RouterFunctionMapping
WelcomePageHandlerMapping

本文主要探索spring和springboot启动过程中RequestMappingHandlerMapping的注入

Spring中RequestMappingHandlerMapping的注入

环境

springmvc版本：5.1.9.RELEASE

过程

在springmvc中，使用注解需要在xml了加入注解声明

<!-- 注解扫描 -->
<context:component-scan base-package="com.xiaofan"/>
<!--使用mvc注解声明  -->
<mvc:annotation-driven/>

启动web服务器，我用的是tomcat8

spring启动，注册BeanDefinition，

spring会扫描xml文件，将配置文件中的bean信息注册成BeanDefinition，当发现springmvc的xml配置文件中有annotation-driven标签时，会调用AnnotationDrivenBeanDefinitionParser来解析该标签

@Override
    @Nullable
    public BeanDefinition parse(Element element, ParserContext context) {
        ...
        // 前面省略代码
        RootBeanDefinition handlerMappingDef = new RootBeanDefinition(RequestMappingHandlerMapping.class);
        handlerMappingDef.setSource(source);
        handlerMappingDef.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
        handlerMappingDef.getPropertyValues().add("order", 0);
        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);
        // String HANDLER_MAPPING_BEAN_NAME = RequestMappingHandlerMapping.class.getName()
        readerContext.getRegistry().registerBeanDefinition(HANDLER_MAPPING_BEAN_NAME, handlerMappingDef);
        // 后面省略代码
        ...
        return null;
    }

spring将BeanDefinition通过反射实例化成bean注入到容器中

那么问题来了，如果没有mvc:annotation-driven标签，RequestMappingHandlerMapping还会被注入到spring容器中吗？

答：会的，前提是xml中没有配置任何一个HandlerMapping。

过程如下：

在启动过程中，会调用DispatcherServlet的init()方法（我也不知道是在哪个步骤调用的，希望知道的大佬告知，不胜感激）

DispatcherServlet#onRefresh → DispatcherServlet#initStrategies → DispatcherServlet#initHandlerMappings

private void initHandlerMappings(ApplicationContext context) {
        ...
        // 前面省略代码
        // 当没有配置任何handlerMapping时，则使用默认的handlerMapping
        if (this.handlerMappings == null) {
            // 从DispatcherServlet.properties拿org.springframework.web.servlet.HandlerMapping
            // 所以默认的有BeanNameUrlHandlerMapping和RequestMappingHandlerMapping
            // 最终还是调用BeanFactory#createBean()生成实例
            this.handlerMappings = getDefaultStrategies(context, HandlerMapping.class);
            if (logger.isTraceEnabled()) {
                logger.trace("No HandlerMappings declared for servlet '" + getServletName() +
                        "': using default strategies from DispatcherServlet.properties");
            }
        }
    }

SpringBoot中RequestMappingHandlerMapping的注入

在springboot中的注入，依赖的是springboot的自动装配

环境

Springboot版本：2.4.3

过程

spring-boot-autoconfigure包下的spring.factories中有WebMvcAutoConfiguration

WebMvcAutoConfiguration的内部类EnableWebMvcConfiguration#requestMappingHandlerMapping()

@Bean
@Primary
@Override
public RequestMappingHandlerMapping requestMappingHandlerMapping(
        @Qualifier("mvcContentNegotiationManager") ContentNegotiationManager contentNegotiationManager,
        @Qualifier("mvcConversionService") FormattingConversionService conversionService,
        @Qualifier("mvcResourceUrlProvider") ResourceUrlProvider resourceUrlProvider) {
    // Must be @Primary for MvcUriComponentsBuilder to work
    return super.requestMappingHandlerMapping(contentNegotiationManager, conversionService,
            resourceUrlProvider);
}