WebMvcConfigurationSupport与WebMvcConfigurer

在spring中配置WebMvc时有两种方法，一种是继承WebMvcConfigurationSupport，重写里面相应的方法，还有一种是继承WebMvcConfigurer的子抽象类WebMvcConfigurerAdapter，也是重写里面相应的方法，但是需要在配置类上添加@EnableWebMvc注解。那这两个类直接是什么关系呢？
细心的开发者会发现，WebMvcConfigurationSupport中那些子类可以重写的空方法在WebMvcConfigurer都有，这说明WebMvcConfigurer只是WebMvcConfigurationSupport的一个扩展类，它并没有扩展新功能，只是为让用户更方便安全的添加自定义配置，为什么说是安全呢？因为如果直接继承WebMvcConfigurationSupport，那么用户可以重写默认的配置，如果对原理不是很清楚地开发者不小心重写了默认的配置，springmvc可能相关功能就无法生效，是一种不安全的行为。但如果是继承WebMvcConfigurerAdapter，那么开发者是在默认配置的基础上添加自定义配置，相对来说更安全一些，只不过要多加一个@EnableWebMvc注解。从这个角度来说，最佳实践还是继承WebMvcConfigurerAdapter，如下

@Configuration
@EnableWebMvc
public class WebConfig extends WebMvcConfigurerAdapter {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //添加自定义拦截器
        registry.addInterceptor();
    }
}

为什么WebMvcConfigurer实现要加@EnableWebMvc
@EnableWebMvc注解类上导入了DelegatingWebMvcConfiguration类，该类是WebMvcConfigurationSupport的子类，该类除了实例化WebMvcConfigurationSupport实例以外，另一个作用就是收集BeanFactory中所有WebMvcConfigurer的实现，汇集到WebMvcConfigurerComposite中，在WebMvcConfigurationSupport实例化过程中会分别调用这些实现，将相应的实例传入这些实现中，供开发者在此基础上添加自定义的配置。这也就是在WebMvcConfigurerAdapter子类上要加@EnableWebMvc的原因，因为要先实例化WebMvcConfigurationSupport。
为什么可以存在多个WebMvcConfigurer的实现？
一般来讲一个应用中一个WebMvcConfigurer的已经足够，设计成收集多个是不是有些多余？从springboot的autoconfigure机制来看并不多余，反而更灵活，比如我要写一个mybatis的AutoConfiguration和JPA的AutoConfiguration，我就可以在不同的AutoConfiguration里面定义一个WebMvcConfigurer的实现，里面只配置与mybatis或JPA相关的配置，这样需要那个启用那个，不需要人工通过注释代码来转换mybatis和JPA，注意：在springboot下自定义的WebMvcConfigurer实现配置类上是不需要添加@EnableWebMvc的，因为springboot已经实例化了WebMvcConfigurationSupport，如果添加了该注解，默认的WebMvcConfigurationSupport配置类是不会生效的，也就是以用户定义的为主，一般建议还是不覆盖默认的好。

在Spring Boot 2.0后用自己的的配置类继承WebMvcConfigurerAdapter时，idea会提示这个类已经过时了。

通常情况下我们会采用下面两种代替方案：

实现WebMvcConfigurer
继承WebMvcConfigurationSupport

但是继承WebMvcConfigurationSupport时发现会造成一些问题

在这之前，我们先看一下WebMvc自动配置类WebMvcAutoConfiguration的定义：

注意红框圈起来到这个关键语句：

1	`@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)`

看到这行可以明白，原来SpringBoot做了这个限制，只有当WebMvcConfigurationSupport类不存在的时候才会生效WebMvc自动化配置，WebMvc自动配置类中不仅定义了classpath:/META-INF/resources/，classpath:/resources/，classpath:/static/，classpath:/public/等路径的映射，还定义了配置文件spring.mvc开头的配置信息等。

当 WebMvcAutoConfiguration 不生效时会导致以下几个问题：
1.WebMvcProperties 和 ResourceProperties 失效

因为两个配置类中的属性都在 WebMvcAutoConfiguration 中使用

当WebMvc自动配置失效(WebMvcAutoConfiguration自动化配置)时，会导致无法视图解析器无法解析并返回到对应的视图

2.类路径上的 HttpMessageConverter 失效

如：StringHttpMessageConverterConfiguration、MappingJackson2HttpMessageConverter ,因为 HttpMessageConverters 中持有着所有HttpMessageConverter的实例，在 WebMvcAutoConfigurationAdapter 中会注入 HttpMessageConverters ，因此当 WebMvcAutoConfigurationAdapter 不加载时，则会失效，间接的造成 spring.http.encoding.charset 与 spring.jackson.date-format 假象的失效。

如：StringHttpMessageConverter 会使用 spring.http.encoding.charset 配置，默认编码为：ISO-8859-1

六千江山

发布了21 篇原创文章 · 获赞 0 · 访问量 2268

私信关注

WebMvcConfigurationSupport与WebMvcConfigurer

猜你喜欢