Springboot MVC 自動配置

Komorebi_WH發表於2021-12-21
Spring BootMVC

Springboot MVC 自動配置

官方文件閱讀

https://docs.spring.io/spring-boot/docs/current/reference/html/web.html#web.servlet.spring-mvc.auto-configuration

Spring Boot provides auto-configuration for Spring MVC that works well with most applications.

The auto-configuration adds the following features on top of Spring’s defaults:

  • Inclusion of ContentNegotiatingViewResolver and BeanNameViewResolver beans.
  • Support for serving static resources, including support for WebJars (covered later in this document).
  • Automatic registration of Converter, GenericConverter, and Formatter beans.
  • Support for HttpMessageConverters (covered later in this document).
  • Automatic registration of MessageCodesResolver (covered later in this document).
  • Static index.html support.
  • Automatic use of a ConfigurableWebBindingInitializer bean (covered later in this document).

If you want to keep those Spring Boot MVC customizations and make more MVC customizations (interceptors, formatters, view controllers, and other features), you can add your own @Configuration class of type WebMvcConfigurer but without @EnableWebMvc.

如果您希望保留 Spring Boot MVC 定製並進行更多的 MVC 定製(攔截器、格式化程式、檢視控制器和其他特性) ，可以新增您自己的 webmvcrer 型別的@Configuration 類，但不要新增@EnableWebMvc。

If you want to provide custom instances of RequestMappingHandlerMapping, RequestMappingHandlerAdapter, or ExceptionHandlerExceptionResolver, and still keep the Spring Boot MVC customizations, you can declare a bean of type WebMvcRegistrations and use it to provide custom instances of those components.

如果你想提供自定義的 requestmappinghandler mapping、 requestmappinghandler adapter 或 exceptionhandlerexceptionmvc 定製，你可以宣告一個型別為 WebMvcRegistrations 的 bean，並使用它來提供這些元件的自定義例項

If you want to take complete control of Spring MVC, you can add your own @Configuration annotated with @EnableWebMvc, or alternatively add your own @Configuration-annotated DelegatingWebMvcConfiguration as described in the Javadoc of @EnableWebMvc.

如果你想完全控制 Spring MVC，你可以新增你自己的@Configuration 註釋@EnableWebMvc，或者像在@EnableWebMvc 的 Javadoc 中描述的那樣新增你自己的@Configuration 註釋 delegatingwebmvcvc 配置。

個人解讀

​ SpringBoot本身是為Spring MVC提供了自動配置，一般情況下是滿足使用需求的。最近在學習的時候，需要使用矩陣變數，需要對springmvc的配置需要進行更改，遇到了一些疑問，通過原始碼探索了一下，今天在此總結，方便以後自己來看。

​ 上面的官方文件中，最重要的兩段話：

If you want to keep those Spring Boot MVC customizations and make more MVC customizations (interceptors, formatters, view controllers, and other features), you can add your own @Configuration class of type WebMvcConfigurer but without @EnableWebMvc.(在自動配置的基礎上，進行使用者自定義配置)

如果您希望保留 Spring Boot MVC 定製並進行更多的 MVC 定製(攔截器、格式化程式、檢視控制器和其他特性) ，可以新增您自己的 WebMvcConfigurer型別的@Configuration 類，但不要新增@EnableWebMvc。

If you want to take complete control of Spring MVC, you can add your own @Configuration annotated with @EnableWebMvc, or alternatively add your own @Configuration-annotated DelegatingWebMvcConfiguration as described in the Javadoc of @EnableWebMvc.

如果你想完全控制 Spring MVC，你可以新增你自己的@Configuration 註釋@EnableWebMvc，或者新增自己的@Configuration-annotated DelegatingWebMvcConfiguration中的Javadoc中所述@EnableWebMvc。

總結一下：如果我們需要定製適合當前開發需求的springmvc，那麼有兩種方法：

  • （推薦）在使用@Configuration註解的配置類中，實現WebMvcConfigurer介面並重寫對應方法或者新增一個使用者自定義的WebMvcConfigurer元件，但不能使用@EnableWebMvc
  • 使用@Configuration註解的同時，使用@EnableWebMvc

深入理解

首先我們得知道：（推薦使用在自動配置的基礎上進行更多定製，即同時使用自動配置以及使用者自定義配置）

​ SpringBoot會預設自動配置元件，在自動配置元件的時候，首先會檢視IOC容器中是否有使用者自定義配置的（即，在@Configuration配置類中，使用者使用@Bean新增進容器中的元件），如果有就用使用者配置的，如果沒有就用自動配置的；如果有些元件可以存在多個，比如我們的檢視解析器，就將使用者配置的和自己預設的組合起來。

示例程式碼

​ 這裡是推薦方法的使用，至於全面接管的使用，後面再更新吧（如果你看到了這句話，那還沒有更新.........）

  • 第一種，實現WebMvcConfigurer介面並重寫對應方法
@Configuration
public class MyConfig implements WebMvcConfigurer {
    @Override
    public void configurePathMatch(PathMatchConfigurer configurer) {
        UrlPathHelper urlPathHelper = new UrlPathHelper();
        // 移除url中分號：設定為false，不移除；這樣，才能從url中取出矩陣變數的值
        urlPathHelper.setRemoveSemicolonContent(false);
        configurer.setUrlPathHelper(urlPathHelper);
    }
}
  • 第二種：在配置類中，使用者使用WebMvcConfigurer定製化SpringMVC的功能，並新增到容器中
@Configuration
public class WebConfig /*implements WebMvcConfigurer*/ {

    // WebMvcConfigurer定製化SpringMVC的功能
    @Bean
    public WebMvcConfigurer webMvcConfigurer(){
            @Override
            public void configurePathMatch(PathMatchConfigurer configurer) {
                UrlPathHelper urlPathHelper = new UrlPathHelper();
                // 不移除；後面的內容。矩陣變數功能就可以生效
                urlPathHelper.setRemoveSemicolonContent(false);
                configurer.setUrlPathHelper(urlPathHelper);
            }
}

自動配置原理(推薦方法)

WebMvcConfigurer

  1. 我們知道springboot是自動配置類是WebMvcAutoConfiguration.class：

    @Configuration(proxyBeanMethods = false)
@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 {
    ......
}

  2. WebMvcAutoConfiguration.class中有一個靜態類WebMvcAutoConfigurationAdapter，實現了WebMvcConfigurer：

    	@Configuration(proxyBeanMethods = false)
	@Import(EnableWebMvcConfiguration.class)
	@EnableConfigurationProperties({ WebMvcProperties.class, WebProperties.class })
	@Order(0)
	public static class WebMvcAutoConfigurationAdapter implements WebMvcConfigurer, ServletContextAware {...}

  3. WebMvcAutoConfigurationAdapter類是實現了WebMvcConfigurer介面，WebMvcConfigurer中提供了許多預設實現的方法，我們正是通過對這些方法的重寫，來達到定製的目的。

    public interface WebMvcConfigurer {
    
	default void configurePathMatch(PathMatchConfigurer configurer) {
	}
    .......
}

  4. 從註解@Import(EnableWebMvcConfiguration.class)看到，WebMvcAutoConfiguration匯入了一個配置等效於@EnableWebMvc的配置類，這個類繼承了DelegatingWebMvcConfiguration，而DelegatingWebMvcConfiguration繼承了WebMvcConfigurationSupport。

    DelegatingWebMvcConfiguration這個類的作用：其實是呼叫WebMvcConfigurerComposite這個類中的方法，目的是同時載入自動配置和使用者自定義的配置

    /**
 * A subclass of {@code WebMvcConfigurationSupport} that detects and delegates
 * to all beans of type {@link WebMvcConfigurer} allowing them to customize the
 * configuration provided by {@code WebMvcConfigurationSupport}. This is the
 * class actually imported by {@link EnableWebMvc @EnableWebMvc}.
 *
 * @author Rossen Stoyanchev
 * @since 3.1
 *WebMvcConfigurationSupport的子類，它檢測並委託給WebMvcConfigurer型別的所有bean，允許它們自定義WebMvcConfigurationSupport提供的配置。 這是由@EnableWebMvc實際匯入的@EnableWebMvc
 */
@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);
		}
	}
    
   ........
}

    我們隨機選擇這個類中任意一個方法，並進入到呼叫的對應WebMvcConfigurerComposite類中的方法，可以發現：

    這個類的方法，將實現所有WebMvcConfigurer的相關配置bean，包括我們自己配置的和SpringBoot給我們自動配置的，即這裡完成了在自動配置的基礎上增加我們自定義的配置。下面給出兩個示例方法：

    	@Autowired(required = false)
	public void setConfigurers(List<WebMvcConfigurer> configurers) {
		if (!CollectionUtils.isEmpty(configurers)) {
            // 從容器中獲取所有自定義配置bean
			this.configurers.addWebMvcConfigurers(configurers);
		}
	}

	@Override
	protected void configurePathMatch(PathMatchConfigurer configurer) {
        // 遍歷容器中中相關配置並呼叫
		this.configurers.configurePathMatch(configurer);
	}

    檢視configurePathMatch()方法：

    將各種自定義配置bean（即WebMvcConfigurer物件）新增到delegates中，並將所有的WebMvcConfigurer相關配置使用對應的方法進行遍歷呼叫（包括springboot自動配置的和我們使用者自定義配置的）。

    class WebMvcConfigurerComposite implements WebMvcConfigurer {

	private final List<WebMvcConfigurer> delegates = new ArrayList<>();

	public void addWebMvcConfigurers(List<WebMvcConfigurer> configurers) {
		if (!CollectionUtils.isEmpty(configurers)) {
			this.delegates.addAll(configurers);
		}
	}

	@Override
	public void configurePathMatch(PathMatchConfigurer configurer) {
        // 遍歷呼叫實現，實現預設的配置以及自定義的配置
		for (WebMvcConfigurer delegate : this.delegates) {
			delegate.configurePathMatch(configurer);
		}
	}
    ....
}

總結1

所有的WebMvcConfiguration都會被呼叫，包括springboot自動配置的內容以及我們自己定義的配置。

為什麼不能使用@EnableWebMvc（完全控制Spring MVC）

​ 完全控制Spring MVC：SpringBoot對SpringMVC的自動配置失效，所有配置都需要使用者自己去配置。

前面提到，如果使用第一種方法的話，就不能使用@EnableWebMvc註解，從WebMvcConfigurer的實現類WebMvcAutoConfigurationAdapter所在的springboot自動配置類WebMvcAutoConfiguration可以看到：

@Configuration(proxyBeanMethods = false)
@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 {

@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)

只有當容器裡面沒有WebMvcConfigurationSupport這個元件時，才能使用SpringBoot的自動配置。所以，當我們使用第一種自動配置+自定義配置時，不能使用@EnableWebMvc註解的原因就在此。（從自動配置類WebMvcAutoConfiguration直觀分析）

進一步理解，加入@EnableWebMvc註解後SpringMVC的所有自動配置失效的原理：

  1. 檢視@EnableWebMvc註解的定義：
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(DelegatingWebMvcConfiguration.class)
public @interface EnableWebMvc {
}
  1. 這個要匯入DelegatingWebMvcConfiguration元件：
@Configuration(proxyBeanMethods = false)
public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport {...}

可以看到DelegatingWebMvcConfiguration是繼承WebMvcConfigurationSupport，也就是說如果使用註解@EnableWebMvc，就會向容器新增元件DelegatingWebMvcConfiguration，等同於匯入了WebMvcConfigurationSupport，這與springboot自動配置類使用的條件衝突，導致自動配置失效。

總結2

@EnableWebMvc將WebMvcConfigurationSupport元件匯入進容器中來了，會導致自動配置失效。

相關文章