前言

在 Spring Boot 框架中只需要在項(xiàng)目中引入 spring-boot-starter-web 依賴，SpringMVC 的一整套東西就會(huì)自動(dòng)給我們配置好；但是，真實(shí)的項(xiàng)目環(huán)境比較復(fù)雜，系統(tǒng)自帶的配置不一定滿足我們的需求，往往我們還需要結(jié)合實(shí)際情況自定義配置。
自定義配置就有講究了，由于 Spring Boot 的版本變遷，加上這一塊本身就有幾個(gè)不同寫法，容易搞混。

一、SpringBoot 中 SpringMVC 配置概述

首先我們需要明確，跟自定義 SpringMVC 相關(guān)的類和注解主要有如下四個(gè)：

• WebMvcConfigurerAdapter
• WebMvcConfigurer
• WebMvcConfigurationSupport
• @EnableWebMvc
  

這四個(gè)中，除了 @EnableWebMvc 是注解外，WebMvcConfigurerAdapter 和 WebMvcConfigurationSupport 是兩個(gè)類，WebMvcConfigurer 是一個(gè)接口。里邊的方法看起來(lái)好像都類似，但是實(shí)際使用效果卻大不相同。

二、WebMvcConfigurerAdapter 抽象類

我們先來(lái)看 WebMvcConfigurerAdapter，這個(gè)是在 Spring Boot 1.x 中我們自定義 SpringMVC 時(shí)繼承的一個(gè)抽象類。
這個(gè)抽象類本身是實(shí)現(xiàn)了 WebMvcConfigurer 接口，然后抽象類里邊都是空方法，我們來(lái)看一下這個(gè)類的聲明：

public abstract class WebMvcConfigurerAdapter implements WebMvcConfigurer {
    //各種 SpringMVC 配置的方法
}

再來(lái)看看這個(gè)類的注釋：

/**
 * An implementation of {@link WebMvcConfigurer} with empty methods allowing
 * subclasses to override only the methods they're interested in.
 * @deprecated as of 5.0 {@link WebMvcConfigurer} has default methods (made
 * possible by a Java 8 baseline) and can be implemented directly without the
 * need for this adapter
 */

這段注釋關(guān)于這個(gè)類說(shuō)的很明白了。

同時(shí)我們也看到，從 Spring5 開(kāi)始，由于我們要使用 Java8，而 Java8 中的接口允許存在 default 方法，因此官方建議我們直接實(shí)現(xiàn) WebMvcConfigurer 接口，而不是繼承 WebMvcConfigurerAdapter。

也就是說(shuō)，在 Spring Boot 1.x 的時(shí)代，如果我們需要自定義 SpringMVC 配置，直接繼承 WebMvcConfigurerAdapter 類即可。

三、WebMvcConfigurer 接口

如上所述，WebMvcConfigurer 是在 Spring Boot 2.x 中實(shí)現(xiàn)自定義配置的方案。

WebMvcConfigurer 是一個(gè)接口；接口中的方法和 WebMvcConfigurerAdapter 中定義的空方法其實(shí)一樣，所以用法上來(lái)說(shuō)，基本上沒(méi)有差別。

從 Spring Boot 1.x 切換到 Spring Boot 2.x ，只需要把繼承類改成實(shí)現(xiàn)接口即可。

四、WebMvcConfigurationSupport 類-自定義配置

在 Spring 框架中，可以通過(guò) Spring 和 SpringMVC 的XML 配置文件設(shè)置MVC 框架；在 Spring Boot 中自定義 SpringMVC 配置時(shí)，可以通過(guò)繼承 WebMvcConfigurationSupport 類來(lái)實(shí)現(xiàn)。

在 WebMvcConfigurationSupport 類中，提供了用 Java 配置 SpringMVC 所需要的所有方法。我們來(lái)看一下這個(gè)方法的摘要：

WebMvcConfigurationSupport 類方法列表

有一點(diǎn)眼熟，可能有小伙伴發(fā)現(xiàn)了，這里的方法其實(shí)和前面兩個(gè)類中的方法基本是一樣的。

在這里首先大家需要明確的是，WebMvcConfigurationSupport 類本身是沒(méi)有問(wèn)題的，我們自定義 SpringMVC 的配置是可以通過(guò)繼承 WebMvcConfigurationSupport 來(lái)實(shí)現(xiàn)的。

五、WebMvcAutoConfiguration 配置類 – 自動(dòng)化配置

Spring Boot 中，SpringMVC 相關(guān)的自動(dòng)化配置是在 WebMvcAutoConfiguration 配置類中實(shí)現(xiàn)的。
那么我們來(lái)看看這個(gè)配置類的生效條件：

@Configuration
@ConditionalOnWebApplication(type = Type.SERVLET)
@ConditionalOnClass({ Servlet.class, DispatcherServlet.class, WebMvcConfigurer.class })
@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE + 10)
@AutoConfigureAfter({ DispatcherServletAutoConfiguration.class, TaskExecutionAutoConfiguration.class,
        ValidationAutoConfiguration.class })
public class WebMvcAutoConfiguration {
}

我們從這個(gè)類的注解中可以看到，它的生效條件有一條，就是當(dāng)不存在 WebMvcConfigurationSupport 的實(shí)例時(shí)，這個(gè)自動(dòng)化配置才會(huì)生生效。

因此，如果我們?cè)?Spring Boot 中自定義 SpringMVC 配置時(shí)選擇了繼承 WebMvcConfigurationSupport，就會(huì)導(dǎo)致 Spring Boot 中 SpringMVC 的自動(dòng)化配置失效。

Spring Boot 給我們提供了很多自動(dòng)化配置，很多時(shí)候當(dāng)我們修改這些配置的時(shí)候，并不是要全盤否定 Spring Boot 提供的自動(dòng)化配置。

我們可能只是針對(duì)某一個(gè)配置做出修改，其他的配置還是按照 Spring Boot 默認(rèn)的自動(dòng)化配置來(lái)。

而繼承 WebMvcConfigurationSupport 來(lái)實(shí)現(xiàn)對(duì) SpringMVC 的配置會(huì)導(dǎo)致所有的 SpringMVC 自動(dòng)化配置失效，因此，一般情況下我們不選擇這種方案。

六、@EnableWebMvc 注解

最后還有一個(gè) @EnableWebMvc 注解，這個(gè)注解很好理解，它的作用就是啟用 WebMvcConfigurationSupport。
我們來(lái)看看這個(gè)注解的定義：

/**
 * Adding this annotation to an {@code @Configuration} class imports the Spring MVC
 * configuration from {@link WebMvcConfigurationSupport}, e.g.:

可以看到，加了這個(gè)注解，就會(huì)自動(dòng)導(dǎo)入 WebMvcConfigurationSupport。

所以在 Spring Boot 中，我們也不建議使用 @EnableWebMvc 注解，因?yàn)樗粯訒?huì)導(dǎo)致 Spring Boot 中的 SpringMVC 自動(dòng)化配置失效。

七、總結(jié)

不知道上面的解釋小伙伴有沒(méi)有看懂？我再簡(jiǎn)單總結(jié)一下：

1. Spring Boot 1.x 中，自定義 SpringMVC 配置可以通過(guò)繼承 WebMvcConfigurerAdapter 來(lái)實(shí)現(xiàn)。
2. Spring Boot 2.x 中，自定義 SpringMVC 配置可以通過(guò)實(shí)現(xiàn) WebMvcConfigurer 接口來(lái)完成。
   

如果在 Spring Boot 中使用繼承 WebMvcConfigurationSupport 來(lái)實(shí)現(xiàn)自定義 SpringMVC 配置，或者在 Spring Boot 中使用了 @EnableWebMvc 注解，都會(huì)導(dǎo)致 Spring Boot 中默認(rèn)的 SpringMVC 自動(dòng)化配置失效。

在純 Java 配置的 SSM 環(huán)境中，如果我們要自定義 SpringMVC 配置，有兩種辦法:

1. 第一種就是直接繼承自 WebMvcConfigurationSupport 來(lái)完成 SpringMVC 配置
2. 還有一種方案就是實(shí)現(xiàn) WebMvcConfigurer 接口來(lái)完成自定義 SpringMVC 配置
   

果使用第二種方式，則需要給 SpringMVC 的配置類上額外添加 @EnableWebMvc 注解，表示啟用WebMvcConfigurationSupport，這樣配置才會(huì)生效。

換句話說(shuō)，在純 Java 配置的 SSM 中，如果你需要自定義 SpringMVC 配置，你離不開(kāi) WebMvcConfigurationSupport ，所以在這種情況下建議通過(guò)繼承 WebMvcConfigurationSupport 來(lái)實(shí)現(xiàn)自動(dòng)化配置。

最新評(píng)論