WebMvcConfigurer 与 WebMvcConfigurationSupport避坑指南

今天药忘吃喽~ 2021-06-10 20:39 671阅读 0赞

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

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

*  实现WebMvcConfigurer  
 *  继承WebMvcConfigurationSupport

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

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

![a04f2976bc2ce73b7947e3f5997c73fc.png][]

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

<table> 
 <tbody> 
 <tr> 
 <td> 1 </td> 
 <td> <code>@ConditionalOnMissingBean</code><code>(WebMvcConfigurationSupport.</code><code>class</code><code>)</code> </td> 
 </tr> 
 </tbody> 
</table>

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

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

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

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

**解决方案：**

1. 在SpringBoot1.X的版本中，我们可以继承自WebMvcConfigurerAdapter，覆盖想要实现的方法即可。

2. 但是在SpringBoot2.X的定义中，WebMvcConfigurerAdapter已经被定义为@Deprecated，我们来看一下源代码：

![3bdb71b294527906cfceab0ab304b9e2.png][]

SpringBoot其实也已经告诉你WebMvcConfigurerAdapter自从Spring5.0版本开始已经不建议使用了，但是你可以实现WebMvcConfigurer并重写相关方法来达到类似的功能。

*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

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 </td> 
 <td> <code>@Bean</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@ConditionalOnMissingBean</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>StringHttpMessageConverter stringHttpMessageConverter() { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>StringHttpMessageConverter converter =&nbsp;</code><code>new</code>&nbsp;<code>StringHttpMessageConverter(</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>this</code><code>.encodingProperties.getCharset());</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>converter.setWriteAcceptCharset(</code><code>false</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>converter;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

**解决方案**：  
因为已知的配置类都已通过 @Bean 注册在容器中，那么我们可以在使用 WebMvcConfigurationSupport 时，通过 @Autowired 注入到配置类中，然后替换掉 WebMvcConfigurationSupport 默认的配置即可，如：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 </td> 
 <td> <code>@Configuration</code> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>WebConfiguration&nbsp;</code><code>extends</code>&nbsp;<code>WebMvcConfigurationSupport { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Autowired</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code>&nbsp;<code>StringHttpMessageConverter stringHttpMessageConverter;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Autowired</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code>&nbsp;<code>MappingJackson2HttpMessageConverter httpMessageConverter;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>/**</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>* 添加转换器</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>*/</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>void</code>&nbsp;<code>extendMessageConverters(List&lt;HttpMessageConverter&lt;?&gt;&gt; converters) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>for</code>&nbsp;<code>(</code><code>int</code>&nbsp;<code>i =&nbsp;</code><code>0</code><code>; i &lt; converters.size(); i++) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code>&nbsp;<code>(converters.get(i)&nbsp;</code><code>instanceof</code>&nbsp;<code>StringHttpMessageConverter){ </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>converters.set(i, stringHttpMessageConverter);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code>&nbsp;<code>(converters.get(i)&nbsp;</code><code>instanceof</code>&nbsp;<code>MappingJackson2HttpMessageConverter) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>converters.set(i, httpMessageConverter);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

也可以根据需求来重新实现。

*补充\_*

WebMvcConfigurer类代码分析：

从EnableWebMvcConfiguration配置类开始,当它注入时父类会注入Spring容器中所有的WebMvcConfigurer类

![7e8909066e71a23204023a6937784389.png][]

接着注入RequestMappingHandlerAdapter Bean 它会调用父类的requestMappingHandlerAdapter方法

![bdfbac7ee0a2af85ce2ea5b8077154b1.png][]

![ed15aadd8cc75c2b0491f923ca7a8d7d.png][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3o2OTE4Mzc4Nw_size_16_color_FFFFFF_t_70][]

这个时候获取配置,例如自定义了返回结果Handler, WebMvcConfigurerComposite会遍历调用WebMvcConfigurer实现类的

addReturnValueHandlers方法,会把自定义配置加载到默认的配置中

![2a4635bd685b74537fc5b15193f009fe.png][]

![060015e93de6f07df2589b27dc61ef9d.png][]

[a04f2976bc2ce73b7947e3f5997c73fc.png]: /images/20210527/9b5e69e12cfb4b8888e35914282f0f43.png
[3bdb71b294527906cfceab0ab304b9e2.png]: /images/20210527/9946c8c8a5bd4d3489e8a9059ae66b5d.png
[7e8909066e71a23204023a6937784389.png]: /images/20210527/94b4a23902b8430c94b06731cb4abdfe.png
[bdfbac7ee0a2af85ce2ea5b8077154b1.png]: /images/20210527/3b274ea8f6294f459d77578c502dfeb3.png
[ed15aadd8cc75c2b0491f923ca7a8d7d.png]: /images/20210527/2a1202090b11436095b135b3e72b2850.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3o2OTE4Mzc4Nw_size_16_color_FFFFFF_t_70]: /images/20210527/8733bbda206a407ca567cc2f3c1d0ab2.png
[2a4635bd685b74537fc5b15193f009fe.png]: /images/20210527/8eec69dae0214e4dbcbb5badf78efec7.png
[060015e93de6f07df2589b27dc61ef9d.png]: /images/20210527/54b2b50870a04d10bd455e9d88d24e4c.png