SpringBoot中SpringMvc自动配置原理及流程

╰+攻爆jí腚メ 2021-09-02 07:37 370阅读 0赞

@EnableWebMvc和WebMvcConfigurer 相关资料可查看，本文只用来记录整个自动加载流程

[https://blog.csdn.net/z69183787/article/details/108587150][https_blog.csdn.net_z69183787_article_details_108587150]

[https://blog.csdn.net/z69183787/article/details/108587048][https_blog.csdn.net_z69183787_article_details_108587048]

简单来说，

WebMvcAutoConfiguration自动装配类内置了 EnableWebMvcConfiguration 及 WebMvcAutoConfigurationAdapter

![20200914211806723.png][]

![20200914211910524.png][]

1、DelgatingWebMvcConfiguration：在初始化时会注入所有WebMvcConfigurer（用于自定义配置一些mvc的CORS规则、拦截器、路径、静态资源访问规则等）的实现Bean。

2、WebMvcAutoConfigurationAdapter：实现了WebMvcConfigurer，增加了一些默认的视图配置及Mvc属性类（上下文路径、静态页面前缀等配置）

3、EnableWebMvcConfiguration与父类WebMvcConfigurationSupport作为配置类，内部集成了许多带有@Bean标签的SpringMvc核心Bean处理器（RequestMappingHandlerAdapter、RequestMappingHandlerMapping、HandlerExceptionResolver、HandlerMapping），在初始化这些Bean的过程中分别调用了各自需要的拦截器、解析器等，对应于WebMvcConfigurer中可实现的接口

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3o2OTE4Mzc4Nw_size_16_color_FFFFFF_t_70][]

4、最终这些类会调用DelgatingWebMvcConfiguration中的addxxx与configurexxx方法，将用户自定义的载入。

5、需要注意的是，有些默认配置在 自定义配置后会失效，或者用带有extend的方法，比如extendMessageConverters

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3o2OTE4Mzc4Nw_size_16_color_FFFFFF_t_70 1][]

configureMessageConverters方法中，如果你没有覆盖并且没有添加其他converter, 则converters为empty，则WebMvcConfigurationSupport会调用addDefaultHttpMessageConverters，配置默认的converter,其中包含了默认的MappingJackson2HttpMessageConverter
    。
    所以在extendMessageConverters中添加MappingJackson2HttpMessageConverter不会起到效果。
    
    解决办法有两个：
    1。就是在configureMessageConverters方法本身中添加所需要的converter
    2。就是在extendMessageConverters中判断converter的类型，设置所需要的属性

前文提要：springboot中的自动配置原理就不再赘述了，入口是spring.factories中的自动配置类

# Auto Configure
    org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
    org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration,\

自动配置类WebMvcAutoConfiguration，

@Configuration(proxyBeanMethods = false)
    @ConditionalOnWebApplication(type = Type.SERVLET)
    @ConditionalOnClass({ Servlet.class, DispatcherServlet.class, WebMvcConfigurer.class })
    //这就是为什么@EnableWebMvc注解后，该自动装配类会失效，
    //因为整个上下文中有了DelegatingWebMvcConfiguration
    //（实现WebMvcConfigurationSupport）这个bean
    @ConditionalOnMissingBean(WebMvcConfigurationSupport.class)
    @AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE + 10)
    @AutoConfigureAfter({ DispatcherServletAutoConfiguration.class, TaskExecutionAutoConfiguration.class,
    		ValidationAutoConfiguration.class })
    public class WebMvcAutoConfiguration 
    
    
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.TYPE)
    @Documented
    @Import(DelegatingWebMvcConfiguration.class)
    public @interface EnableWebMvc {
    }

往下看，首先内置了一个实现WebMvcConfigurer接口的实现类，import了另一个内置类EnableWebMvcConfiguration

@Configuration(proxyBeanMethods = false)
    //springmvc核心配置类
    @Import(EnableWebMvcConfiguration.class)
    //加载2个配置类，配置了mvc的上下文，静态文件默认访问路径等
    //详见 spring-configuration-metadata.json
    @EnableConfigurationProperties({ WebMvcProperties.class, ResourceProperties.class })
    @Order(0)
    public static class WebMvcAutoConfigurationAdapter implements WebMvcConfigurer {
    
    
    
    /**
     * Configuration equivalent to {@code @EnableWebMvc}.
     */
    @Configuration(proxyBeanMethods = false)
    public static class EnableWebMvcConfiguration extends DelegatingWebMvcConfiguration implements ResourceLoaderAware {

可以看到EnableWebMvcConfiguration继承了DelegatingWebMvcConfiguration，构造函数中注入了上下文中所有实现了WebMvcConfigurer的Bean，WebMvcConfigurerComposite是一个WebMvcConfigurer的组合类，保存了所有WebMvcConfigurer的代理。

@Configuration(proxyBeanMethods = false)
    public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport {
    
    	private final WebMvcConfigurerComposite configurers = new WebMvcConfigurerComposite();
    
    
    	@Autowired(required = false)
    	public void setConfigurers(List<WebMvcConfigurer> configurers) {
    		if (!CollectionUtils.isEmpty(configurers)) {
    			this.configurers.addWebMvcConfigurers(configurers);
    		}
    	}
    
    
    class WebMvcConfigurerComposite implements WebMvcConfigurer {
    
    	private final List<WebMvcConfigurer> delegates = new ArrayList<>();
    
    
    	public void addWebMvcConfigurers(List<WebMvcConfigurer> configurers) {
    		if (!CollectionUtils.isEmpty(configurers)) {
    			this.delegates.addAll(configurers);
    		}
    	}

接着往下看，EnableWebMvcConfiguration中还申明了很多Bean，拿一个举例子看一下，就知道mvc配置是如何生效，自定义WebMvcConfigurer实现类是如何被加入到mvc的规则中

RequestMappingHandlerAdapter负责处理所有Requestmapping注解的HandlerMethod，完成方法调用

@Bean
    @Override
    public RequestMappingHandlerAdapter requestMappingHandlerAdapter(
    	@Qualifier("mvcContentNegotiationManager") ContentNegotiationManager contentNegotiationManager,
    	@Qualifier("mvcConversionService") FormattingConversionService conversionService,
    	@Qualifier("mvcValidator") Validator validator) {
    	RequestMappingHandlerAdapter adapter = super.requestMappingHandlerAdapter(contentNegotiationManager,conversionService, validator);
    	adapter.setIgnoreDefaultModelOnRedirect(
    	this.mvcProperties == null || this.mvcProperties.isIgnoreDefaultModelOnRedirect());
    	return adapter;
    }

super.requestMappingHandlerAdapter(contentNegotiationManager,conversionService, validator);

调用了二级父类WebMvcConfigurationSupport的方法，可以发现，里面调用了许多getxxx方法，用来获取mvc解析中需要使用的处理器和转换器

//WebMvcConfigurationSupport
    @Bean
    public RequestMappingHandlerAdapter requestMappingHandlerAdapter(
    		@Qualifier("mvcContentNegotiationManager") ContentNegotiationManager contentNegotiationManager,
    		@Qualifier("mvcConversionService") FormattingConversionService conversionService,
    		@Qualifier("mvcValidator") Validator validator) {
    
    	RequestMappingHandlerAdapter adapter = createRequestMappingHandlerAdapter();
    	adapter.setContentNegotiationManager(contentNegotiationManager);
        //消息转换
    	adapter.setMessageConverters(getMessageConverters());
     adapter.setWebBindingInitializer(getConfigurableWebBindingInitializer(conversionService, validator));
        //自定义参数处理
    	adapter.setCustomArgumentResolvers(getArgumentResolvers());
        //自定义返回值处理
    	adapter.setCustomReturnValueHandlers(getReturnValueHandlers());
    
    
    
    protected final List<HttpMessageConverter<?>> getMessageConverters() {
    		if (this.messageConverters == null) {
    			this.messageConverters = new ArrayList<>();
                //子类实现方法，即DelegatingWebMvcConfiguration来实现
    			configureMessageConverters(this.messageConverters);
    			if (this.messageConverters.isEmpty()) {
    				addDefaultHttpMessageConverters(this.messageConverters);
    			}
    			extendMessageConverters(this.messageConverters);
    		}
    		return this.messageConverters;
    	}

回到DelegatingWebMvcConfiguration，即EnableWebMvcConfiguration的父类中的方法

其中调用所有自定义WebMvcConfigurer实现类的configure 重载方法，这样就让所有自定义的配置加入了Mvc配置中，其余的一些配置项都是雷同的操作

//DelegatingWebMvcConfiguration
    @Override
    	protected void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
    		this.configurers.configureMessageConverters(converters);
    	}
    
    
    //WebMvcConfigurerComposite
    @Override
    	public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
    		for (WebMvcConfigurer delegate : this.delegates) {
    			delegate.configureMessageConverters(converters);
    		}
    	}

[https_blog.csdn.net_z69183787_article_details_108587150]: https://blog.csdn.net/z69183787/article/details/108587150
[https_blog.csdn.net_z69183787_article_details_108587048]: https://blog.csdn.net/z69183787/article/details/108587048
[20200914211806723.png]: /images/20210527/76bdee6c866045ffa923bca1e8646d34.png
[20200914211910524.png]: /images/20210527/abd84b200290483fb820f9dae54a822d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3o2OTE4Mzc4Nw_size_16_color_FFFFFF_t_70]: /images/20210527/6fdc990bb0924de4b1a89e54b94df511.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3o2OTE4Mzc4Nw_size_16_color_FFFFFF_t_70 1]: /images/20210527/e2cea420e8e64908b21ac284346048b6.png