SpringBoot擴充套件SpringMVC原理並實現全面接管
如果想在SpringBoot中擴充套件一些SpringMVC的配置,例如需要配置自定義的檢視解析器或攔截器等,需要怎麼實現呢?
例如,自定義一個檢視解析器:
@Configuration public class MyConfig implements WebMvcConfigurer { @Override public void addViewControllers(ViewControllerRegistry registry) { registry.addViewController("/index").setViewName("index"); } }
我們只需要編寫一個配置類去實現WebMvcConfigurer介面,並選擇實現介面中的方法,不能標註@EnableWebMvc,這些WebMvcConfigurer介面中的方法就是SpringMVC所可以擴充套件的配置
注意:在SpringBoot1.0版本中擴充套件SpringMVC配置是繼承WebMvcConfigurerAdapter類,但在2.0以上的版本中已經過時,官方推薦使用以上實現WebMvcConfigurer介面的方式進行擴充套件,因為在2.0版本中WebMvcConfigurer介面有了預設實現。
WebMvcConfigurer方法介紹:這裡只列舉幾個比較關鍵的方法
public interface WebMvcConfigurer { //定製URL匹配規則 default void configurePathMatch(PathMatchConfigurer configurer) { } //內容協商機制 default void configureContentNegotiation(ContentNegotiationConfigurer configurer) { } //非同步任務執行器。 default void configureAsyncSupport(AsyncSupportConfigurer configurer) { } //使用預設servlet處理靜態資源 default void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) { } //新增格式轉換器 default void addFormatters(FormatterRegistry registry) { } //新增攔截器 default void addInterceptors(InterceptorRegistry registry) { } //新增檢視解析器 default void addViewControllers(ViewControllerRegistry registry) { } }
擴充套件MVC的實現原理:
我們都知道WebMvcAutoConfiguration是SpringMVC的自動配置類,當在做其他配置匯入時,匯入了@Import(EnableWebMvcConfiguration.class)這樣一個註解,這個註解有什麼用?
@Configuration(proxyBeanMethods = false)
@Import(EnableWebMvcConfiguration.class)
@EnableConfigurationProperties({ WebMvcProperties.class,ResourceProperties.class })
@Order(0)public static class WebMvcAutoConfigurationAdapter implements WebMvcConfigurer {
}
點進這個註解,發現他還是WebMvcAutoConfiguration裡的一個靜態內部類,但他繼承了DelegatingWebMvcConfiguration
@Configuration(proxyBeanMethods = false)
public static class EnableWebMvcConfiguration extends DelegatingWebMvcConfiguration implements ResourceLoaderAware {
}
再點進這個DelegatingWebMvcConfiguration類裡,開頭有這樣一段程式碼,有一個configurers屬性,型別是WebMvcConfigurerComposite ,這個WebMvcConfigurerComposite類也實現了WebMvcConfigurer,當@Autowired標註在一個方法上說明,這個方法的引數都從容器中獲取,這裡是從容器中獲取所有的WebMvcConfigurer,並賦值給了configurers屬性
@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); } } }
在這個類往下看,發現這個類的方法跟WebMvcConfigurer接口裡的方法一樣,以這個檢視解析器舉例,方法裡呼叫了這個方法this.configurers.addViewControllers(registry)
@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); } } ... @Override protected void addViewControllers(ViewControllerRegistry registry) { this.configurers.addViewControllers(registry); } }
點進configurers.addViewControllers(registry),這個方法是把容器中所有的addViewControllers()都執行一遍。<mark style="box-sizing: border-box; outline: 0px; background-color: rgb(248,248,64); color: rgb(0,0); overflow-wrap: break-word;">因為我們自己寫的配置類也注入到了容器裡,所以我們的配置也會被呼叫,並且也被SpringBoot自動配置上,所以SpringMVC的自動配置和我們的擴充套件配置都會起作用</mark>;
class WebMvcConfigurerComposite implements WebMvcConfigurer { ... @Override public void addViewControllers(ViewControllerRegistry registry) { for (WebMvcConfigurer delegate : this.delegates) { delegate.addViewControllers(registry); } } }
還有上面在寫自定義配置類時為什麼不能標註@EnableWebMvc
因為一但標註了@EnableWebMvc,所有都是我們自己配置;所有的SpringMVC的自動配置都失效了。<mark style="box-sizing: border-box; outline: 0px; background-color: rgb(248,0); overflow-wrap: break-word;">原理又是怎麼樣的?</mark>
給自己的配置類加上@EnableWebMvc
@Configuration @EnableWebMvc public class myConfig implements WebMvcConfigurer { @Override public void addViewControllers(ViewControllerRegistry registry) { registry.addViewController("/index").setViewName("index"); } }
這個註解匯入了@Import(DelegatingWebMvcConfiguration.class)
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(DelegatingWebMvcConfiguration.class)
public @interface EnableWebMvc {
}
這個類繼承了WebMvcConfigurationSupport
public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport {
}
我們再回頭看一下WebMvcAutoConfiguration,@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)這個註解的意思就是容器中沒有這個元件的時候,這個自動配置類才生效
小結:大概瞭解到SpringBoot擴充套件SpringMVC的原理和全面接管SpringMVC,但SpringBoot中還有其他很多配置,只要瞭解其中的原理,其他配置也就一通百通了。
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支援我們。