SpringBoot 静态资源导入及首页设置问题

作者:風栖祈鸢 时间:2023-11-26 22:45:07 

本节了解一下 SpringBoot 中 Web 开发的静态资源导入和首页设置,对应 SpringBoot-03-Web 项目。

1. 静态资源导入

在 Web 开发过程中,我们需要接触许多的静态资源,如 CSS、JS、图片等;在之前的开发过程中,这些资源都放在 Web 的目录下,用到的时候按照对应路径访问即可。不过在 SpringBoot 项目中,没有了 Web 的目录,那这些静态资源该放到哪里去,又要如何访问呢?

由于是 Web 应用中的配置,所以查看对应的自动配置类 WebMvcAutoConfiguration,可以看到处理资源的方法 addResourceHandlers


@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
   if (!this.resourceProperties.isAddMappings()) {
       logger.debug("Default resource handling disabled");
       return;
   }
   addResourceHandler(registry, "/webjars/**", "classpath:/META-INF/resources/webjars/");
   addResourceHandler(registry, this.mvcProperties.getStaticPathPattern(), (registration) -> {
       registration.addResourceLocations(this.resourceProperties.getStaticLocations());
       if (this.servletContext != null) {
           ServletContextResource resource = new ServletContextResource(this.servletContext, SERVLET_LOCATION);
           registration.addResourceLocations(resource);
       }
   });
}

其中,this.resourceProperties.isAddMappings() 的作用为判断是否在配置文件中指定了资源的访问路径,若指定了则此方法不用生效,直接返回;若未指定则继续执行方法,去默认的位置查找资源。

1.1 WebJars

WebJars 是前端资源的 Jar 包形式,让我们可以通过 Jar 包的形式使用前端的框架、组件。

WebJars 网站:https://www.webjars.org/。

为什么要使用 WebJars?

我们在开发 Java web 项目的时候会使用像 Maven,Gradle 等构建工具以实现对 jar 包版本依赖管理,以及项目的自动化管理,但是对于 JS,Css 等前端资源包,我们只能采用拷贝到 webapp 目录下的手工方式,这样做就无法对这些资源进行依赖管理,而且容易导致文件混乱、版本不一致等问题。WebJars 就提供给我们这些前端资源的 jar 包形式,我们就可以进行依赖管理

如要使用到 JQuery 时,按照之前的做法,我们要去网上下载 JQuery 的 JS 文件,把它放到 web 目录下的 statics/js 下(之前用 AJAX 的时候就是这么干的);但现在,我们可以采用 WebJars 的方式。

首先在 WebJars 网站中找到 JQuery 的 Maven 坐标,把它放到项目的 pom 文件中


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

引入后,在项目的 External Libaries 中就可以看到 org.webjars:jquery:3.6.0 了!

SpringBoot 静态资源导入及首页设置问题

那么我们要怎么访问到它呢?在上面的源码中其实就已经给出了路径


addResourceHandler(registry, "/webjars/**", "classpath:/META-INF/resources/webjars/");

这行代码将 /webjars/ 下的所有访问都映射为了 classpath:/META-INF/resources/webjars/,即我们只需要通过 /webjars/ 就可以找到类路径下的 /jquery/3.6.0/jquery.js 文件了!

运行项目,在浏览器中输入 http://localhost:8080/webjars/jquery/3.6.0/jquery.js,确实显示出了 jquery.js 文件!

以 WebJars 方式引入的文件,都符合上图中的结构,即能通过 classpath:/META-INF/resources/webjars/ 路径访问到,这样代码中的设置和外部文件就联系起来了!

1.2 staticPathPattern

回到源码中,这个方法的三句话还有最后一句(虽然很长但确实是一句)


addResourceHandler(registry, this.mvcProperties.getStaticPathPattern(), (registration) -> {
   registration.addResourceLocations(this.resourceProperties.getStaticLocations());
   if (this.servletContext != null) {
       ServletContextResource resource = new ServletContextResource(this.servletContext, SERVLET_LOCATION);
       registration.addResourceLocations(resource);
   }
});

这就有点复杂了(之前版本的源码倒还好理解一点),不过可以看到获取静态路径 getStaticPathPattern() 方法,点进去


public String getStaticPathPattern() {
   return this.staticPathPattern;
}

这个方法直接返回了 staticPathPattern,继续点


/**
* Path pattern used for static resources.
*/
private String staticPathPattern = "/**";

到这就明白了,其实就是默认的静态资源路径!这个路径也可以通过 spring.mvc 去设置,在未设置的情况在,它就是项目下的所有路径 /**

然后在 Web 属性类 WebProperties 中有一个资源类 Resource,它也设置了4个路径(跳跃的有点大,先看着吧),其中


public static class Resources {

private static final String[] CLASSPATH_RESOURCE_LOCATIONS = { "classpath:/META-INF/resources/",
                                                                 "classpath:/resources/", "classpath:/static/", "classpath:/public/" };
   ...
}
  1. classpath:/META-INF/resources/ 即上面的 WebJars 路径

  2. classpath:/resources/resources/resources/ 路径

  3. classpath:/static/resources/static/路径

  4. classpath:/public/resources/public 路径

即所有通过 /**(未配置情况下)的访问请求,都会在这四个路径中寻找静态资源!

默认的 resource 中只有 static 一个目录,这里把上面的目录都创建一下,且放入一个测试用的 js 文件

SpringBoot 静态资源导入及首页设置问题

此时运行项目,访问 http://localhost:8080/public.jshttp://localhost:8080/resources.jshttp://localhost:8080/static.js,都可以显示出对应的 js 文件内容!

注意:如果三个目录下的文件有重名的情况,则优先级为 CLASSPATH_RESOURCE_LOCATIONS 数组的顺序,可以理解为如果在前面的路径中找到了就不找后面的了!

2. 首页设置

和上面一样,先找到对应的源码


@Bean
public WelcomePageHandlerMapping welcomePageHandlerMapping(ApplicationContext applicationContext,
                                                          FormattingConversionService mvcConversionService, ResourceUrlProvider mvcResourceUrlProvider) {
   WelcomePageHandlerMapping welcomePageHandlerMapping = new WelcomePageHandlerMapping(
       new TemplateAvailabilityProviders(applicationContext), applicationContext, getWelcomePage(),
       this.mvcProperties.getStaticPathPattern());
   welcomePageHandlerMapping.setInterceptors(getInterceptors(mvcConversionService, mvcResourceUrlProvider));
   welcomePageHandlerMapping.setCorsConfigurations(getCorsConfigurations());
   return welcomePageHandlerMapping;
}

很长也很复杂,不过只需要关注里面的 getWelcomePage() 方法,点进去看看


private Resource getWelcomePage() {
   for (String location : this.resourceProperties.getStaticLocations()) {
       Resource indexHtml = getIndexHtml(location);
       if (indexHtml != null) {
           return indexHtml;
       }
   }
   ServletContext servletContext = getServletContext();
   if (servletContext != null) {
       return getIndexHtml(new ServletContextResource(servletContext, SERVLET_LOCATION));
   }
   return null;
}

private Resource getIndexHtml(String location) {
   return getIndexHtml(this.resourceLoader.getResource(location));
}

private Resource getIndexHtml(Resource location) {
   try {
       Resource resource = location.createRelative("index.html");
       if (resource.exists() && (resource.getURL() != null)) {
           return resource;
       }
   }
   catch (Exception ex) {
   }
   return null;
}

这三个方法是逐层调用的关系(虽然我也不知道为什么要这么干),不过可以知道,其中的 location 就是上面的三个目录 resourcesstaticpublic,默认的首页是 index.html。也就是说,如果这三个目录下存在 index.html 文件,那么它就是默认的首页!演示就省略了,反正也不是什么难点!

3. 总结

本节主要是从源码的角度,研究了一下静态资源导入和首页设置的问题。其实学习结论很简单,但从源码出发思考问题的思想,是不容易学习的。

来源:https://blog.csdn.net/qq_43560701/article/details/120452787

标签:SpringBoot,静态资源导入,首页设置
0
投稿

猜你喜欢

  • springboot使用之多个filter的执行顺序以及配置方式

    2023-11-09 09:30:59
  • android实现扑克卡片翻转

    2021-10-19 08:08:35
  • SpringBoot AOP控制Redis自动缓存和更新的示例

    2023-08-31 17:34:37
  • Android滑动组件悬浮固定在顶部效果

    2022-12-13 19:24:32
  • java接口私有方法实现过程解析

    2021-10-28 01:51:23
  • Selenium+Tesseract-OCR智能识别验证码爬取网页数据的实例

    2023-04-11 19:43:01
  • springboot基于docsify 实现随身文档

    2023-04-25 04:52:23
  • 基于Scala和Java方法的相互调用

    2021-07-05 11:53:04
  • Android递归方式删除某文件夹下的所有文件(.mp3文件等等)

    2022-06-05 06:43:46
  • C# TextBox 扩展方法数据验证详细说明

    2022-05-07 14:21:36
  • C# 获取当前总毫秒数的实例讲解

    2023-02-22 12:57:00
  • SpringCloud如何创建一个服务提供者provider

    2023-08-01 01:56:33
  • Android编程开发之RadioGroup用法实例

    2022-11-11 10:26:27
  • JavaFx Tooltip悬浮提示使用及自定义代码详解

    2023-05-11 15:06:05
  • Android Studio实现简易登录界面制作

    2023-08-25 08:49:42
  • java实现简单石头剪刀布小游戏

    2021-09-17 07:25:41
  • java使用FileVisitor遍历文件和目录

    2021-07-17 13:25:21
  • 三道java新手入门面试题,通往自由的道路--多线程

    2023-05-24 23:12:51
  • 详解flutter中常用的container layout实例

    2022-07-25 07:49:53
  • Java 实战练手项目之医院预约挂号系统的实现流程

    2023-11-24 00:42:36
  • asp之家 软件编程 m.aspxhome.com