springboot 添加mvc功能

先放出來幾個類(包含注解或接口)來觀摩一下

• WebMvcConfigurer
• @EnableWebMvc
• WebMvcConfigurerAdapter（已過時，不再詳述，可以理解為繼承該類有和實現(xiàn)WebMvcConfigurer一樣的效果）
• WebMvcConfigurationSupport
• WebApplicationInitializer

這里只聊springboot或者無web.xml環(huán)境的情況，無論如何得看一下這個祖宗，以下代碼來源于spring官網(wǎng)

public class MyWebApplicationInitializer implements WebApplicationInitializer {
    @Override
    public void onStartup(ServletContext servletCxt) {
        // Load Spring web application configuration
        AnnotationConfigWebApplicationContext ac = new AnnotationConfigWebApplicationContext();
        ac.register(AppConfig.class);
        ac.refresh();

        // Create and register the DispatcherServlet
        DispatcherServlet servlet = new DispatcherServlet(ac);
        ServletRegistration.Dynamic registration = servletCxt.addServlet("app", servlet);
        registration.setLoadOnStartup(1);
        registration.addMapping("/app/*");
    }
}

這個是一切無配置文件spring和springmvc整合的基礎(chǔ)，用來替代原始的web.xml中的ContextLoadListener和DispatcherServlet，兩者效果等同；

現(xiàn)在我們先基于上述代碼的情況來說，請注意以下結(jié)論的前提是基于上述示例代碼，很重要，其實就像是很久之前我們從零開始搭建整合方案一樣，現(xiàn)在只是配置了整合的類，還沒有功能，如果我們想要再配置一個json的消息轉(zhuǎn)換器

那么我們就會有如下幾種方案

• 繼承WebMvcConfigurationSupport
• 實現(xiàn)WebMvcConfigurer
• 繼承WebMvcConfigurerAdapter（已過時不再詳述）

繼承WebMvcConfigurationSupport和實現(xiàn)WebMvcConfigurer的區(qū)別如下

• WebMvcConfigurationSupport直接繼承并使用@Configuration標(biāo)識即可，而實現(xiàn)WebMvcConfigurer則需要標(biāo)識為注解@Configuration以外還需要使用注解@EnableWebMvc標(biāo)識才可，所以一個項目中可以有多個地方去實現(xiàn)這個接口，只要標(biāo)識為配置類。然后在一處地方開啟@EnableWebMvc就可。這里提前說一下如果是springboot環(huán)境這里還大有說頭,這里還有個大坑，留在后面說
• WebMvcConfigurationSupport更偏向底層，可以定制化的功能更多，而WebMvcConfigurer是一個接口，是針對WebMvcConfigurationSupport功能將一些常用的功能選擇性的暴露出來，實際上WebMvcConfigurer是依賴于WebMvcConfigurationSupport來實現(xiàn)功能添加的

為什么說WebMvcConfigurer是依賴于WebMvcConfigurationSupport來實現(xiàn)功能添加的？我們來看一下配合該接口的注解@EnableWebMvc源碼

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(DelegatingWebMvcConfiguration.class)
public @interface EnableWebMvc {
}

來看一下這個注解導(dǎo)入的配置類DelegatingWebMvcConfiguration為何物？以下摘取該類部分源碼

@Configuration
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);
  }
 }
}

首先這個配置類其實就是我們上面最開始說的用繼承來擴展功能的WebMvcConfigurationSupport,那么為什么實現(xiàn)WebMvcConfigurer接口也行？注意看上圖中的代碼，提供了一個configurers屬性， 然后通過setConfigurers方法注入將ioc容器中的所有實現(xiàn)了WebMvcConfigurer接口的配置類都添加到configurers中；后續(xù)實現(xiàn)代碼不是本章討論范圍，我也沒有往下看，單看這里其實就已經(jīng)明白了。

**上述是整合的基礎(chǔ)，那么當(dāng)我們在springboot中要添加功能的時候要注意一些什么事情呢？**這個也是寫這篇文章的目的，因為最近在項目中有人在擴展功能的時候去繼承了WebMvcConfigurationSupport這個類，然后聯(lián)想到之前的項目也有人在springboot項目中使用了注解@EnableWebMvc，這兩種情況都不會導(dǎo)致項目啟動報錯，但卻在不該使用的時候使用了這些功能，導(dǎo)致了項目其實是不能正常使用的?，F(xiàn)在來看一下為什么？

首先看一下springboot給我們提供的自動整合類，請參考類

org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration

我來截取部分代碼

@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 {    
    
    @Configuration
 @Import(EnableWebMvcConfiguration.class)
 @EnableConfigurationProperties({ WebMvcProperties.class, ResourceProperties.class })
 @Order(0)
 public static class WebMvcAutoConfigurationAdapter implements WebMvcConfigurer, ResourceLoaderAware {
    }    
     /**
  * Configuration equivalent to {@code @EnableWebMvc}.
  */
 @Configuration
 public static class EnableWebMvcConfiguration extends DelegatingWebMvcConfiguration {
    }
}

現(xiàn)在說一下結(jié)論，springboot為我們提供的整合功能，已經(jīng)默認(rèn)的幫我們添加了很多功能，如消息轉(zhuǎn)換器，靜態(tài)資源映射，視圖解析器，看下WebMvcAutoConfiguration的內(nèi)部類WebMvcAutoConfigurationAdapter，其實就是實現(xiàn)了接口WebMvcConfigurer，然后再通過注解@Import(EnableWebMvcConfiguration.class)又將EnableWebMvcConfiguration這個配置類導(dǎo)入了進來，而我們點進去發(fā)現(xiàn)這個類的作用其實就是等同于之前我們說過的@EnableWebMvc。因此我們說的消息轉(zhuǎn)換器啊，靜態(tài)資源映射，視圖解析器等這些默認(rèn)實現(xiàn)就在WebMvcAutoConfiguration的內(nèi)部類WebMvcAutoConfigurationAdapter又通過@Bean注入進來的

也就是說springboot其實幫我們整合好之后又默認(rèn)幫我們做了一切常用的實現(xiàn)，這樣我們開箱即用的不僅是整合好的框架，還有一些約定大于配置的功能，如靜態(tài)資源要放在static下，其實就是默認(rèn)幫我們做了資源映射，詳細(xì)可以看下

org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration.WebMvcAutoConfigurationAdapter#addResourceHandlers

默認(rèn)整合的功能基本滿足于我們?nèi)粘５拈_發(fā)，而如果我們還需要添加功能要怎么辦呢？其實就是直接實現(xiàn)接口WebMvcConfigurer然后將當(dāng)前類使用注解@Configuration標(biāo)識為配置類即可。

那么為什么不能再繼續(xù)繼承接口WebMvcConfigurationSupport了呢？還是來看一下我們的自動配置類WebMvcAutoConfiguration吧,仔細(xì)看一下上面的配置類上的條件表達(dá)式中有這么一句非常非常重要的@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)，

上面我們所屬的所有整合功能的前提是當(dāng)前ioc容器中沒有WebMvcConfigurationSupport這個bean，我們看到了springboot自己的實現(xiàn)是在當(dāng)前自動配置類生效的時候才通過實現(xiàn)接口WebMvcConfigurer的，所以容器中在當(dāng)前配置類未執(zhí)行之前也是沒有這個WebMvcConfigurationSupport的，現(xiàn)在我們突然在項目中添加功能的時候去繼承了這個類，然后標(biāo)識為配置類之后，立馬在容器中就出現(xiàn)了這個bean，然后springboot就會以為我們要全面接管整合springmvc，我們要拋棄它的默認(rèn)實現(xiàn)，然后自己玩。然后就悲劇了。現(xiàn)在整個mvc中反而只有我們自己新加的這個擴展空間了。這在絕大多數(shù)情況下根本不是我們想要的。

還有一個問題，為什么加注解@EnableWebMvc也不行？

其實通過上面的講解我們已經(jīng)能夠看出來，這個注解其實就是導(dǎo)入了DelegatingWebMvcConfiguration這個配置類，而這個類就是繼承WebMvcConfigurationSupport的，這兩個效果是相同的，所以也不行。

總而言之一句話，在WebMvcAutoConfiguration這個配置類執(zhí)行之前，無論是繼承WebMvcConfigurationSupport還是在某個配置類上添加了注解@EnableWebMvc，都會導(dǎo)致容器中會被注入類型為WebMvcConfigurationSupport的bean，而springboot在實現(xiàn)自動配置時將這種行為定義成了你要自己去實現(xiàn)``

以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。

最新評論