SpringBoot中的静态资源访问的实现

更新时间：2020年09月14日 14:48:15 作者：java-gubin

这篇文章主要介绍了SpringBoot中的静态资源访问的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

一、说在前面的话

我们之间介绍过SpringBoot自动配置的原理，基本上是如下：

xxxxAutoConfiguration：帮我们给容器中自动配置组件；
xxxxProperties:配置类来封装配置文件的内容；

二、静态资源映射规则

1、对哪些目录映射？

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

2、什么意思？

就我们在上面五个目录下放静态资源（比如：a.js等），可以直接访问（http://localhost:8080/a.js），类似于以前web项目的webapp下；放到其他目录下无法被访问。

3、为什么是那几个目录？

3.1、看源码

我们一起来读下源码，这个是SpringBoot自动配置的WebMvcAutoConfiguration.java类来帮我们干的。

@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
  if (!this.resourceProperties.isAddMappings()) {
    logger.debug("Default resource handling disabled");
    return;
  }
  Integer cachePeriod = this.resourceProperties.getCachePeriod();
  if (!registry.hasMappingForPattern("/webjars/**")) {
    customizeResourceHandlerRegistration(
        registry.addResourceHandler("/webjars/**")
            .addResourceLocations(
                "classpath:/META-INF/resources/webjars/")
        .setCachePeriod(cachePeriod));
  }
  String staticPathPattern = this.mvcProperties.getStaticPathPattern();
  if (!registry.hasMappingForPattern(staticPathPattern)) {
    customizeResourceHandlerRegistration(
        registry.addResourceHandler(staticPathPattern)
            .addResourceLocations(
                this.resourceProperties.getStaticLocations())
        .setCachePeriod(cachePeriod));
  }
}

3.2、分析源码

我们重点分析后半截，前半截后面会介绍。

// staticPathPattern是/**
String staticPathPattern = this.mvcProperties.getStaticPathPattern();
if (!registry.hasMappingForPattern(staticPathPattern)) {
  customizeResourceHandlerRegistration(
      registry.addResourceHandler(staticPathPattern)
          .addResourceLocations(
              this.resourceProperties.getStaticLocations())
      .setCachePeriod(cachePeriod));
}
this.resourceProperties.getStaticLocations()
========>
ResourceProperties
public String[] getStaticLocations() {
  return this.staticLocations;
}
========>
private String[] staticLocations = RESOURCE_LOCATIONS;
========>
private static final String[] RESOURCE_LOCATIONS;
private static final String[] SERVLET_RESOURCE_LOCATIONS = { "/" };
private static final String[] CLASSPATH_RESOURCE_LOCATIONS = {
      "classpath:/META-INF/resources/", "classpath:/resources/",
      "classpath:/static/", "classpath:/public/" };
========>
static {
  // 可以看到如下是对上面两个数组进行复制操作到一个新数组上，也就是合并。
  RESOURCE_LOCATIONS = new String[CLASSPATH_RESOURCE_LOCATIONS.length
      + SERVLET_RESOURCE_LOCATIONS.length];
  System.arraycopy(SERVLET_RESOURCE_LOCATIONS, 0, RESOURCE_LOCATIONS, 0,
      SERVLET_RESOURCE_LOCATIONS.length);
  System.arraycopy(CLASSPATH_RESOURCE_LOCATIONS, 0, RESOURCE_LOCATIONS,
      SERVLET_RESOURCE_LOCATIONS.length, CLASSPATH_RESOURCE_LOCATIONS.length);
}
所以上述代码经过我的翻译后成为了如下样子：

registry.addResourceHandler("/**").addResourceLocations(
  "classpath:/META-INF/resources/", "classpath:/resources/",
      "classpath:/static/", "classpath:/public/", "/")
  // 设置缓存时间
  .setCachePeriod(cachePeriod));

3.3、一句话概括

WebMvcAutoConfiguration类自动为我们注册了如下目录为静态资源目录，也就是说直接可访问到资源的目录。

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

优先级从上到下。

所以，如果static里面有个index.html，public下面也有个index.html，则优先会加载static下面的index.html，因为优先级！

4、默认首页

PS：就是直接输入ip:port/项目名称默认进入的页面。

4.1、看源码

WebMvcAutoConfiguration.java

@Bean
public WelcomePageHandlerMapping welcomePageHandlerMapping(
   ResourceProperties resourceProperties) {
  return new WelcomePageHandlerMapping(resourceProperties.getWelcomePage(),
     this.mvcProperties.getStaticPathPattern());
}

4.2、分析源码

resourceProperties.getWelcomePage()
========>
public Resource getWelcomePage() {
  // 遍历默认静态资源目录后面拼接个index.html的数组
  // 比如：[/static/index.html, /public/index.html等等]
  for (String location : getStaticWelcomePageLocations()) {
    Resource resource = this.resourceLoader.getResource(location);
    try {
      if (resource.exists()) {
        resource.getURL();
        return resource;
      }
    }
    catch (Exception ex) {
      // Ignore
    }
  }
  return null;
}
========>
// 下面这段代码通俗易懂，就是给默认静态资源目录后面拼接个index.html并返回，比如：/static/index.html
private String[] getStaticWelcomePageLocations() {
  String[] result = new String[this.staticLocations.length];
  for (int i = 0; i < result.length; i++) {
    String location = this.staticLocations[i];
    if (!location.endsWith("/")) {
      location = location + "/";
    }
    result[i] = location + "index.html";
  }
  return result;
}

所以上述代码经过我的翻译后成为了如下样子：

return new WelcomePageHandlerMapping(
  "classpath:/META-INF/resources/index.html",
  "classpath:/resources/index.html",
  "classpath:/static/index.html",
  "classpath:/public/index.html",
  "/index.html"
  , "/**");

4.3、一句话概括

WebMvcAutoConfiguration类自动为我们注册了如下文件为默认首页。

classpath:/META-INF/resources/index.html
classpath:/resources/index.html
classpath:/static/index.html 
classpath:/public/index.html
/index.html

优先级从上到下。

所以，如果static里面有个index.html，public下面也有个index.html，则优先会加载static下面的index.html，因为优先级！

5、favicon.ico

PS：就是这个图标。

5.1、看源码

@Configuration
@ConditionalOnProperty(value = "spring.mvc.favicon.enabled", matchIfMissing = true)
public static class FaviconConfiguration {

  private final ResourceProperties resourceProperties;

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

  @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(this.resourceProperties.getFaviconLocations());
   return requestHandler;
  }

}

5.2、分析源码

// 首先可以看到的是可以设置是否生效，通过参数spring.mvc.favicon.enabled来配置，若无此参数，则默认是生效的。
@ConditionalOnProperty(value = "spring.mvc.favicon.enabled", matchIfMissing = true)
========》
// 可以看到所有的**/favicon.ico都是在faviconRequestHandler()这个方法里找。
mapping.setUrlMap(Collections.singletonMap("**/favicon.ico", faviconRequestHandler()));
========》
faviconRequestHandler().this.resourceProperties.getFaviconLocations()
// 就是之前的五个静态资源文件夹。  
List<Resource> getFaviconLocations() {
  List<Resource> locations = new ArrayList<Resource>(
      this.staticLocations.length + 1);
  if (this.resourceLoader != null) {
    for (String location : this.staticLocations) {
      locations.add(this.resourceLoader.getResource(location));
    }
  }
  locations.add(new ClassPathResource("/"));
  return Collections.unmodifiableList(locations);
}

5.3、一句话概括

只要把favicon.ico放到如下目录下，就会自动生效。

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

6、webjars

6.1、看源码

WebMvcAutoConfiguration

@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
  if (!this.resourceProperties.isAddMappings()) {
    logger.debug("Default resource handling disabled");
    return;
  }
  Integer cachePeriod = this.resourceProperties.getCachePeriod();
  if (!registry.hasMappingForPattern("/webjars/**")) {
    customizeResourceHandlerRegistration(
        registry.addResourceHandler("/webjars/**")
            .addResourceLocations(
                "classpath:/META-INF/resources/webjars/")
        .setCachePeriod(cachePeriod));
  }
  String staticPathPattern = this.mvcProperties.getStaticPathPattern();
  if (!registry.hasMappingForPattern(staticPathPattern)) {
    customizeResourceHandlerRegistration(
        registry.addResourceHandler(staticPathPattern)
            .addResourceLocations(
                this.resourceProperties.getStaticLocations())
        .setCachePeriod(cachePeriod));
  }
}

6.2、分析源码

这次我们来分析前半截。

Integer cachePeriod = this.resourceProperties.getCachePeriod();
if (!registry.hasMappingForPattern("/webjars/**")) {
  customizeResourceHandlerRegistration(
      registry.addResourceHandler("/webjars/**")
          .addResourceLocations(
              "classpath:/META-INF/resources/webjars/")
      .setCachePeriod(cachePeriod));
}

6.3、一句话概括

所有/webjars/**都从classpath:/META-INF/resources/webjars/路径下去找对应的静态资源。

6.4、什么是webjars？

就是以jar包的方式引入静态资源。

官网地址：http://www.webjars.org/。类似于maven仓库。

我们可以做个例子，将jquery引入到项目中

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

看项目依赖

会自动为我们引入jquery，要怎么使用呢？我们上面说过：

所有/webjars/*都从classpath:/META-INF/resources/webjars/路径下去找对应的静态资源。

所以我们启动项目，访问：http://localhost:8080/webjars/jquery/3.3.1/jquery.js即可。

必须在这几个路径下SpringBoot才会扫描到！

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

到此这篇关于SpringBoot中的静态资源访问的实现的文章就介绍到这了,更多相关SpringBoot 静态资源访问内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Springboot中实现接口幂等性的4种方案小结
本文主要介绍了Springboot中实现接口幂等性,包含数据库的幂等,数据库的幂等,Redis的幂等性和Token + 时间戳的幂等性,具有一定的参考价值,感兴趣的可以了解一下
2024-03-03
Java SpringBoot项目如何优雅的实现操作日志记录
这篇文章主要介绍了Java SpringBoot项目如何优雅的实现操作日志记录，文章围绕主题展开详细的内容介绍，具有一定的参考价值，需要的朋友可以参考一下
2022-08-08
Java常用排序算法及性能测试集合
周末天气不好，在家无事，把常用排序算法理了一遍，收获不小，特写文章纪念。这些算法在学校的时候学过一遍，很多原理都忘记了
2013-06-06
新浪开源轻量级分布式RPC框架motan简单示例解析
这篇文章主要为大家介绍了新浪开源轻量级分布式RPC框架motan的简单示例解析，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步
2022-03-03
Java的增强for循环修改数组元素的问题小结
增强for循环的元素变量x,就是一个局部变量,它是引用数组当前元素引用的副本（就相当于上文所说的你复刻朋友的钥匙）,或者是基本数据类型的值的副本,这篇文章主要介绍了Java的增强for循环修改数组元素的问题小结,需要的朋友可以参考下
2024-02-02
springboot集成mybatis-plus遇到的问题及解决方法
这篇文章主要介绍了springboot集成mybatis-plus遇到的问题及解决方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2019-11-11
redisson 实现分布式锁的源码解析
这篇文章主要介绍了redisson 实现分布式锁的源码解析,通过模拟一个商品秒杀的场景结合示例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2022-05-05
详解Java并发工具类之CountDownLatch和CyclicBarrier
在JDK的并发包中，有几个非常有用的并发工具类，它们分别是：CountDownLatch、CyclicBarrier、Semaphore和Exchanger,本文主要来讲讲其中CountDownLatch和CyclicBarrier的使用，感兴趣的可以了解一下
2023-06-06
Spring中注解方式的异步请求
今天给大家整理了Spring中注解方式的异步请求的知识点,对正在学习java的小伙伴们很有帮助,需要的朋友可以参考下
2021-06-06
springboot打jar包之后下载文件的路径问题
这篇文章主要介绍了springboot打jar包之后下载文件的路径问题,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-07-07

SpringBoot中的静态资源访问的实现

相关文章

最新评论

大家感兴趣的内容

最近更新的内容

常用在线小工具