SpringBoot对静态资源的映射规则(上) webjars与任何静态资源文件

最新推荐文章于 2023-07-05 19:58:03 发布

原创最新推荐文章于 2023-07-05 19:58:03 发布 · 897 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#springboot静态资源的映射规则

SpringBoot 专栏收录该内容

19 篇文章

订阅专栏

本文详细解析了SpringBoot框架中静态资源的映射规则，包括webjars的使用和项目内静态资源的访问路径。介绍了如何通过pom.xml引入webjars，并在项目中正确访问这些资源。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

SpringBoot对静态资源的映射规则

1.查看相关自动配置类webMvcAutoConfiguration

按两次shift呼出全局搜索，查看webMvcAutoConfiguration 查看webMvc自动配置类
在这里插入图片描述

搜索并查看addResourceHandlers方法 即添加资源映射方法，源码如下：

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

由webmvc自动配置类源代码可知：

规则一:webjars

这就是addResourceHandlers中第一部分

所有/webjars/**，都去classpath:/META-INF/resources/webjars/下找资源

webjars：以jar包方式引入静态资源

举个栗子:

在pom.xml中添加bootstrap依赖

<dependency>  
            <groupId>org.webjars</groupId>  
            <artifactId>bootstrap</artifactId>  
            <version>3.3.5</version>  
</dependency>

可在左侧External Libraries中找到bootstrap3.3.5
在这里插入图片描述

在html中引入bootstrap中的文件使用/webjars/bootstarp即可，会有路径文件提示

在这里插入图片描述

这个多用于访问jQuery ,Bootstrap,将其打成jar包文件。借助版本管理工具(Maven、gradle等)进行版本管理，保证这些Web资源版本唯一。

规则二: /** 访问当前项目的任何静态资源

即addResourceHandlers中第二部分：
在这里插入图片描述

鼠标中键点击getStaticLocation查看源码：

在这里插入图片描述

如图所示，getStaticLocation方法返回的就是以下四个路径：

"classpath:/META-INF/resources/", 
"classpath:/resources/",
"classpath:/static/",
"classpath:/public/"

四个路径这四个路径就是项目中自己的静态资源可存放的位置。

需要注意的是：java文件下是类路径，resources文件也是类路径。所以要使用第二种的话需要在resources下再建一个resources文件夹。