如果想在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()都執行一遍,因為我們自己寫的配置類也注入到了容器里,所以我們的配置也會被呼叫,并且也被SpringBoot自動配置上,所以SpringMVC的自動配置和我們的擴展配置都會起作用;
class WebMvcConfigurerComposite implements WebMvcConfigurer {
...
@Override
public void addViewControllers(ViewControllerRegistry registry) {
for (WebMvcConfigurer delegate : this.delegates) {
delegate.addViewControllers(registry);
}
}
}
還有上面在寫自定義配置類時為什么不能標注@EnableWebMvc
因為一但標注了@EnableWebMvc,所有都是我們自己配置;所有的SpringMVC的自動配置都失效了,原理又是怎么樣的?
給自己的配置類加上@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中還有其他很多配置,只要了解其中的原理,其他配置也就一通百通了,
轉載請註明出處,本文鏈接:https://www.uj5u.com/qita/203075.html
標籤:其他
