【SpringBoot】SpringBoot与SpringMVC自动配置及静态资源（五）

　　本文介绍SpringBoot对Spring MVC自动配置，SpringBoot自动配置原理可以参考：【SpringBoot】SpringBoot配置与单元测试（二）

　　首先新建一个SpringBoot的web项目，参考：【SpringBoot】SpringBoot快速入门（一）

　　本例pom文件如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.test</groupId>
    <artifactId>test-springboot-web</artifactId>
    <version>1.0-SNAPSHOT</version>


    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.8.RELEASE</version>
    </parent>

    <properties>

        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!--引入jquery-webjar-->
        <dependency>
            <groupId>org.webjars</groupId>
            <artifactId>jquery</artifactId>
            <version>3.3.1</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

    </dependencies>


    <!-- SpringBoot打包插件，可以将代码打包成一个可执行的jar包 -->
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

SpringMVC自动配置

　　自动配置在Spring的默认值之上添加了以下功能：

• 包含ContentNegotiatingViewResolver和BeanNameViewResolver。
• 支持服务静态资源，包括对WebJars的支持。
• 自动注册Converter，GenericConverter和Formatter豆类。
• 支持HttpMessageConverters。
• 自动注册MessageCodesResolver。
• 静态index.html支持。
• 定制Favicon支持。
• 自动使用ConfigurableWebBindingInitializerbean。

　　如果想保留Spring Boot MVC功能，并且想要添加其他MVC配置（拦截器，格式化程序，视图控制器和其他功能），则可以编写一个配置类(@Configuration)，并实现WebMvcConfigurer接口的类，但不能加 @EnableWebMvc。如果您希望提供，或的自定义实例RequestMappingHandlerMapping，则可以声明一个实例来提供此类组件。RequestMappingHandlerAdapter、ExceptionHandlerExceptionResolver、WebMvcRegistrationsAdapter

　　如果想完全控制Spring MVC，可以在配置类(@Configuration)添加上注释@EnableWebMvc。

　　添加MVC配置类

　　1、原理:

　　　　1)、WebMvcAutoConfiguration是SpringMVC的自动配置类 

　　　　2)、在做其他自动配置时会导入;@Import(EnableWebMvcConfiguration.class)

　　　　3)、容器中所有的WebMvcConfigurer都会一起起作用; 

　　　　4)、我们的配置类也会被调用;

　　2、编写一个配置类(@Configuration)，实现WebMvcConfigurer接口；不能标注@EnableWebMvc; 

　　这样既保留了所有的自动配置（WebMvcAutoConfiguration），也能用我们扩展的配置;

// @EnableWebMvc // 全面接管SpringMVC，所有的WebMvc自动配置都失效，如静态资源的访问都失效
@Configuration
public class MyMvcConfig implements WebMvcConfigurer {

    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        // 浏览器访问 "/success2" 重定向到 "/success"
        registry.addRedirectViewController("/success2", "/success");
        // 浏览器访问 "/success2" 转发 "/success"
        registry.addViewController("/success3").setViewName("/success");
    }
}

　　3、验证：效果SpringMVC的自动配置和我们的扩展配置都会起作用

　　重定向请求验证地址：http://localhost:8080/success

　　转发请求验证地址：http://localhost:8080/success

　　全面接管SpringMVC

　　1、原理

　　　　1)、查看源码WebMvcAutoConfiguration类，有条件注解，在没有WebMvcConfigurationSupport类的情况下才注入

@Configuration
@ConditionalOnWebApplication(type = Type.SERVLET)
@ConditionalOnClass({ Servlet.class, DispatcherServlet.class, WebMvcConfigurer.class })
// 条件判断：在没有WebMvcConfigurationSupport类的情况下才注入
@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE + 10)
@AutoConfigureAfter({ DispatcherServletAutoConfiguration.class, TaskExecutionAutoConfiguration.class,
        ValidationAutoConfiguration.class })
public class WebMvcAutoConfiguration {

　　　　2)、查看@EnableWebMvc注解源码，发现它导入DelegatingWebMvcConfiguration类

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

　　　　　　DelegatingWebMvcConfiguration类继承了WebMvcConfigurationSupport类

@Configuration
public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport {

　　　　3)、@EnableWebMvc将WebMvcConfigurationSupport组件导入进来，导入的WebMvcConfigurationSupport只是SpringMVC最基本的功能，WebMvcAutoConfiguration类又是在没有WebMvcConfigurationSupport组件情况下生效，所以@EnableWebMvc能使WebMvcAutoConfiguration失效，并全面接管SpringMVC

静态资源的映射规则

　　SpringBoot对静态文件映射都在类中WebMvcAutoConfiguration，自动配置好了，打开WebMvcAutoConfiguration类，并分析

　　1、规则：/webjars/**

　　　 规则：所有 /webjars/** ，都去 classpath:/META-INF/resources/webjars/ 找资源;

　　　webjars：以jar包的方式引入静态资源; 官网地址：http://www.webjars.org/

// 添加静态资源映射
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
    if (!this.resourceProperties.isAddMappings()) {
        logger.debug("Default resource handling disabled");
        return;
    }
    Duration cachePeriod = this.resourceProperties.getCache().getPeriod();
    CacheControl cacheControl = this.resourceProperties.getCache().getCachecontrol().toHttpCacheControl();
    if (!registry.hasMappingForPattern("/webjars/**")) {
        // 添加映射
        customizeResourceHandlerRegistration(registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/")
                .setCachePeriod(getSeconds(cachePeriod)).setCacheControl(cacheControl));
    }
    String staticPathPattern = this.mvcProperties.getStaticPathPattern();
    if (!registry.hasMappingForPattern(staticPathPattern)) {
        customizeResourceHandlerRegistration(registry.addResourceHandler(staticPathPattern)
                .addResourceLocations(getResourceLocations(this.resourceProperties.getStaticLocations()))
                .setCachePeriod(getSeconds(cachePeriod)).setCacheControl(cacheControl));
    }
}

　　　　测试：在pom文件中引入依赖

<!--引入jquery-webjar-->
<dependency>
    <groupId>org.webjars</groupId>
    <artifactId>jquery</artifactId>
    <version>3.3.1</version>
</dependency>

　　　　可以看到jar包中有jquery.js文件

　　　　

　　　　验证：重启项目，浏览器上打开地址：http://localhost:8080/webjars/jquery/3.3.1/jquery.js，即可看到能获取到js文件

　　2、规则：/**

　　　　"/**" 访问当前项目的任何资源，都去(静态资源的文件夹)找映射，静态资源的文件夹如下：

"classpath:/META-INF/resources/",
"classpath:/resources/", 
"classpath:/static/", 
"classpath:/public/"

　　　　测试：在类路径中，创建static文件夹，在其中添加一个测试页面test.html

　　　　

　　　　验证：重启项目，浏览器使用地址：http://localhost:8080/test.html，访问，即可看到test页面

　　3、规则：首页

　　　　首页映射规则代码在类中WebMvcAutoConfiguration，如下，也在静态文件夹（即规则2下的文件夹）下查找

// 添加首页映射
@Bean
public WelcomePageHandlerMapping welcomePageHandlerMapping(ApplicationContext applicationContext) {
    WelcomePageHandlerMapping welcomePageHandlerMapping = new WelcomePageHandlerMapping(
            new TemplateAvailabilityProviders(applicationContext), applicationContext, getWelcomePage(),
            this.mvcProperties.getStaticPathPattern());
    welcomePageHandlerMapping.setInterceptors(getInterceptors());
    return welcomePageHandlerMapping;
}

　　　　测试：在类路径中的static文件夹，在其中添加一个欢迎页面index.html

　　　　

　　　　验证：重启项目，浏览器使用地址：http://localhost:8080，访问，即可看到欢迎页面

　　4、规则：**/favicon.ico

　　　　所有的 **/favicon.ico 都是在静态资源文件（即规则2下的文件夹）下找;

　　　　首页映射规则代码在类中WebMvcAutoConfiguration，如下

// 配置站点的图标映射
@Configuration
@ConditionalOnProperty(value = "spring.mvc.favicon.enabled", matchIfMissing = true)
public static class FaviconConfiguration implements ResourceLoaderAware {

    private final ResourceProperties resourceProperties;

    private ResourceLoader resourceLoader;

    public FaviconConfiguration(ResourceProperties resourceProperties) {
        this.resourceProperties = resourceProperties;
    }

    @Override
    public void setResourceLoader(ResourceLoader resourceLoader) {
        this.resourceLoader = resourceLoader;
    }

    @Bean
    public SimpleUrlHandlerMapping faviconHandlerMapping() {
        SimpleUrlHandlerMapping mapping = new SimpleUrlHandlerMapping();
        mapping.setOrder(Ordered.HIGHEST_PRECEDENCE + 1);
        mapping.setUrlMap(Collections.singletonMap("**/favicon.ico", faviconRequestHandler()));
        return mapping;
    }

    @Bean
    public ResourceHttpRequestHandler faviconRequestHandler() {
        ResourceHttpRequestHandler requestHandler = new ResourceHttpRequestHandler();
        requestHandler.setLocations(resolveFaviconLocations());
        return requestHandler;
    }

    private List<Resource> resolveFaviconLocations() {
        String[] staticLocations = getResourceLocations(this.resourceProperties.getStaticLocations());
        List<Resource> locations = new ArrayList<>(staticLocations.length + 1);
        Arrays.stream(staticLocations).map(this.resourceLoader::getResource).forEach(locations::add);
        locations.add(new ClassPathResource("/"));
        return Collections.unmodifiableList(locations);
    }

}

　　　　测试：在类路径中的static文件夹，在其中添加一个favicon.ico图标

　　　　验证：重启项目，浏览器使用地址：http://localhost:8080，访问，即可看到浏览器标题上的站点图标已改变