本节了解一下 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
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/" };
...
}
classpath:/META-INF/resources/
即上面的 WebJars 路径classpath:/resources/
即resources/resources/
路径classpath:/static/
为resources/static/
路径classpath:/public/
为resources/public
路径
即所有通过 /**
(未配置情况下)的访问请求,都会在这四个路径中寻找静态资源!
默认的 resource 中只有 static 一个目录,这里把上面的目录都创建一下,且放入一个测试用的 js 文件
此时运行项目,访问 http://localhost:8080/public.js
、http://localhost:8080/resources.js
、http://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
就是上面的三个目录 resources
、static
、public
,默认的首页是 index.html
。也就是说,如果这三个目录下存在 index.html
文件,那么它就是默认的首页!演示就省略了,反正也不是什么难点!
3. 总结
本节主要是从源码的角度,研究了一下静态资源导入和首页设置的问题。其实学习结论很简单,但从源码出发思考问题的思想,是不容易学习的。
到此这篇关于SpringBoot 静态资源导入及首页设置的文章就介绍到这了,更多相关SpringBoot 静态资源导入内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网!