SpringBoot静态资源的访问方法详细介绍

更新时间：2022年09月30日 15:27:48 作者：刘婉晴

最近在做SpringBoot项目的时候遇到了“白页”问题，通过查资料对SpringBoot访问静态资源做了总结，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习吧

一. 静态资源

在web场景中的静态图片、html网页等

二. 静态资源访问目标

在SpringBoot中，静态资源访问目标有 resources文件下的 public、resources、static 以及 META-INF 文件夹下的 recources

如下图所示：

（注意文件夹要自己创建，不要写错名字！！！名字是固定的，就这几个）

三. 静态资源访问前缀

1. 默认访问路径为 /

放于上述文件夹下的静态资源可以直接在根目录下访问

如下：以访问qqVeiw.jpg为例

2. 配置访问前缀

为什么需要：在Request访问以及静态资源访问同名时，SpringBoot会访问优先访问Request请求

因此，需要给静态资配置访问前缀，配置方法非常简单，只需在yaml配置文件中加入如下：

spring:
mvc:
static-path-pattern: /res/** #静态资源访问前缀为res

如下图：

3. 配置静态资源默认访问位置

我们可以设置一个或多个自定义文件夹为静态资源默认访问位置（数组形式），只需在yaml配置文件中加入如下：

spring:
resources:
static-locations: [classpath:/haha/, classpath/static/] #在类路径的haha文件夹下的静态资源才能被访问到

四. 欢迎页及网页图标设置

1. 欢迎页的设置

只需将 index.html 网页加入配置的static-locations中，再去访问根目录，就可以看到SpringBoot为我们配置好的欢迎页

（1）yaml文件配置

（2）index.html加入静态资源访问目标

spring:
resources:
static-locations: [classpath:/haha/] #在类路径的haha文件夹下的静态资源才能被访问到

2. 网页图标的设置

将命名为favicon.ico的图标加入静态资源访问目录

注意：若设置了访问前缀，则上述两功能不生效使用设置网页图标功能，要开启禁用浏览器缓存功能

分析源码

WelcomePageHandlerMapping类

1. 实现欢迎页

		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;
		}

2.实现静态资源访问

		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));
			}
		}

继续往下走——

WelcomePageHandlerMapping类

实现欢迎页

	WelcomePageHandlerMapping(TemplateAvailabilityProviders templateAvailabilityProviders,
			ApplicationContext applicationContext, Optional<Resource> welcomePage, String staticPathPattern) {
			// 从这里我们也可以看出来为什么欢迎页不能加静态资源访问前缀
		if (welcomePage.isPresent() && "/**".equals(staticPathPattern)) {
			logger.info("Adding welcome page: " + welcomePage.get());
			setRootViewName("forward:index.html");
		}
		else if (welcomeTemplateExists(templateAvailabilityProviders, applicationContext)) {
			logger.info("Adding welcome page template: index");
			setRootViewName("index");
		}
	}

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

您可能感兴趣的文章:

Java隐藏特性之双括号初始化详解
Java 语言拥有许多隐藏而强大的特性,其中之一是双括号初始化,这篇文章将详细介绍双括号初始化的概念、用法和示例代码,希望对大家有所帮助
2023-12-12
一文详解Springboot中filter的原理与注册
这篇文章主要为大家详细介绍了Springboot中filter的原理与注册的相关知识，文中的示例代码讲解详细，对我们掌握SpringBoot有一定的帮助，需要的可以参考一下
2023-02-02
java基础之接口组成更新的实现
本文主要介绍了java基础之接口组成更新的实现，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-04-04
Java获得元素属性的注解信息的步骤
在Java编程中,注解是一种为代码添加元数据的方式,通过反射机制,我们可以获取元素属性上的注解信息,这个过程对于框架开发和元数据处理非常有用,能够实现更灵活的功能,对java获得元素属性的注解信息相关知识感兴趣的朋友一起看看吧
2024-09-09
Spring中的DeferredImportSelector实现详解
这篇文章主要介绍了Spring中的DeferredImportSelector实现详解,两个官方的实现类AutoConfigurationImportSelector和ImportAutoConfigurationImportSelector都是Spring Boot后新增的实现,需要的朋友可以参考下
2024-01-01
Java之Maven工程打包jar
Maven打包一般可以生成两种包一种是可以直接运行的包，一种是依赖包（只是编译包）。Maven默认打包时jar，如果需要修改其他类型，可以修改pom.xml。感兴趣的同学可以参考阅读
2023-04-04
入门到精通Java SSO单点登录原理详解
这篇文章主要介绍了入门到精通Java SSO单点登录原理详解，本文主要对SSO单点登录与CAS、OAuth2.0两种授权协议的关系和原理进行详细说明
2022-09-09
Java异常 Exception类及其子类(实例讲解)
下面小编就为大家带来一篇Java异常 Exception类及其子类(实例讲解)。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-11-11
Mybatis的mapper标签 namespace属性用法说明
这篇文章主要介绍了Mybatis的mapper标签 namespace属性用法说明，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-09-09
SpringMVC中的DispatcherServlet请求分析
这篇文章主要介绍了SpringMVC中的DispatcherServlet请求分析, DispatcherServlet作为一个Servlet,那么当有请求到Tomcat等Servlet服务器时,会调用其service方法,再调用到其父类GenericServlet的service方法,需要的朋友可以参考下
2024-01-01