跟我学springboot（十八）springboot-web-webjars和静态资源映射规则

朱雀 2022-05-12 12:38 233阅读 0赞

# 一.简介 #

在使用springboot的web应用时，首先需要创建springboot应用，选择我们自己需要的模块，springboot已经默认将这些场景配置好了，只需要在配置文件指定少量的配置就可以运行起来。在使用之前我们需要了解自动配置的原理，可以参考[跟我学springboot（十四）springboot自动配置原理][springboot_springboot]核心的精髓如下：  
1）、SpringBoot启动会加载大量的自动配置类  
2）、我们看我们需要的功能有没有SpringBoot默认写好的自动配置类；  
3）、我们再来看这个自动配置类中到底配置了哪些组件；（只要我们要用的组件有，我们就不需要再来配置了）  
4）、给容器中自动配置类添加组件的时候，会从properties类中获取某些属性。我们就可以在配置文件中指定这些属性的值；  
xxxxAutoConfigurartion：自动配置类； 给容器中添加组件  
xxxxProperties:封装配置文件中相关属性

--------------------

# 二.底层代码 #

我们以webMvc为例说明一下。

## 1、 WebMvcAutoConfiguration ##

首先是ResourceProperties，他可以配置一些和静态资源有关的参数，比如缓存，资源目录等。

@ConfigurationProperties(prefix = "spring.resources", ignoreUnknownFields = false) public class ResourceProperties implements ResourceLoaderAware { //可以设置和静态资源有关的参数，缓存时间等

![参数][70]  
addResourceHandlers方法主要是静态资源文件夹映射，所有 /webjars/\*\* ，都去 classpath:/META-INF/resources/webjars/ 找资源；webjars：以jar包的方式引入静态资源；参考：[http://www.webjars.org/，][http_www.webjars.org] 比如我们引入jquery的包，在pom.xml配置：

<dependency>
        <groupId>org.webjars</groupId>
        <artifactId>jquery</artifactId>
        <version>3.3.1-1</version>
    </dependency>

![jquery][]

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

我们访问localhost:8080/webjars/jquery/3.3.1/jquery.js，就可以寻找到我们需要的静态文件。

“/\*\*” 访问当前项目的任何资源，都去（静态资源的文件夹）找映射

"classpath:/META‐INF/resources/",
    "classpath:/resources/",
    "classpath:/static/",
    "classpath:/public/"
    "/"：当前项目的根路径

访问：localhost:8080/abc === 去静态资源文件夹里面找abc

欢迎页； 静态资源文件夹下的所有index.html页面；被"/\*\*"映射；localhost:8080/ 找index页面

//配置欢迎页映射 @Bean public WelcomePageHandlerMapping welcomePageHandlerMapping(ApplicationContext applicationContext) { return new WelcomePageHandlerMapping(new TemplateAvailabilityProviders(applicationContext), applicationContext, this.getWelcomePage(), this.mvcProperties.getStaticPathPattern()); }

所有的 \*\*/favicon.ico 都是在静态资源文件下找；

//配置喜欢的图标 public static class FaviconConfiguration implements ResourceLoaderAware { private final ResourceProperties resourceProperties; private ResourceLoader resourceLoader; public FaviconConfiguration(ResourceProperties resourceProperties) { this.resourceProperties = resourceProperties; } public void setResourceLoader(ResourceLoader resourceLoader) { this.resourceLoader = resourceLoader; } @Bean public SimpleUrlHandlerMapping faviconHandlerMapping() { SimpleUrlHandlerMapping mapping = new SimpleUrlHandlerMapping(); mapping.setOrder(-2147483647); mapping.setUrlMap(Collections.singletonMap("**/favicon.ico", this.faviconRequestHandler())); return mapping; } @Bean public ResourceHttpRequestHandler faviconRequestHandler() { ResourceHttpRequestHandler requestHandler = new ResourceHttpRequestHandler(); requestHandler.setLocations(this.resolveFaviconLocations()); return requestHandler; } private List<Resource> resolveFaviconLocations() { String[] staticLocations = WebMvcAutoConfiguration.WebMvcAutoConfigurationAdapter.getResourceLocations(this.resourceProperties.getStaticLocations()); List<Resource> locations = new ArrayList(staticLocations.length + 1); Stream var10000 = Arrays.stream(staticLocations); ResourceLoader var10001 = this.resourceLoader; this.resourceLoader.getClass(); var10000.map(var10001::getResource).forEach(locations::add); locations.add(new ClassPathResource("/")); return Collections.unmodifiableList(locations); } }

[springboot_springboot]: https://blog.csdn.net/a303549861/article/details/82635163
[70]: /images/20220512/1ecfa09ebac14c3681c985de76fd4970.png
[http_www.webjars.org]: http://www.webjars.org/%EF%BC%8C
[jquery]: /images/20220512/0626a13e816c410a8dcd5beca77e8d03.png