SpringBoot通過(guò)源碼探究靜態(tài)資源的映射規則實(shí)現

我們開(kāi)發(fā)一個(gè)Spring Boot項目，肯定要導入許多的靜態(tài)資源，比如css，js等文件

如果我們是一個(gè)web應用，我們的main下會(huì )有一個(gè)webapp，我們以前都是將所有的頁(yè)面導在這里面的，對吧！但是我們現在的pom呢，打包方式是為jar的方式，那么這種方式SpringBoot能不能來(lái)給我們寫(xiě)頁(yè)面呢？當然是可以的，但是SpringBoot對于靜態(tài)資源放置的位置，是有規定的！

1、靜態(tài)資源映射規則

1.1、第一種映射規則

SpringBoot中，SpringMVC的web配置都在 WebMvcAutoConfiguration 這個(gè)配置類(lèi)里面；

WebMvcAutoConfigurationAdapter 中有很多配置方法；其中就有一個(gè)添加資源處理方法：addResourceHandlers ()，源碼如下。

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

通過(guò)分析上面源碼可得，添加的靜態(tài)資源映射路徑為/webjars/**，資源路徑為classpath:/META-INF/resources/webjars/

什么是webjars

WebJars是將客戶(hù)端（瀏覽器）資源（JavaScript，Css等）打成jar包文件，以對資源進(jìn)行統一依賴(lài)管理。WebJars的jar包部署在Maven中央倉庫上。

我們可以到webjars官網(wǎng)上找到自己需要的資源，在自己的工程中添加入maven依賴(lài)，即可直接使用這些資源了。

比如，我們要導入jquery資源

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

導入后我們可以通過(guò)資源路徑找到資源的存放位置并訪(fǎng)問(wèn)，我們在webjars網(wǎng)站導入的資源都符合下圖的結構

通過(guò)路徑訪(fǎng)問(wèn)，成功訪(fǎng)問(wèn)到靜態(tài)資源！

1.2、第二種映射規則

下面我們繼續分析源碼

getStaticPathpattern()：獲得靜態(tài)路徑模式，點(diǎn)進(jìn)去看一下源碼

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

再看一下staticPathPattern的源碼

/**就是當前目錄下的所有靜態(tài)資源都能識別，但是當前目錄下具體指的又是什么呢？我們點(diǎn)開(kāi)resourceProperties的源碼便可看出來(lái)。源碼如下：

上面源碼很清楚的給出了我們四個(gè)靜態(tài)資源路徑，所以只要是這四個(gè)目錄下的靜態(tài)資源，都可以直接獲取。

我們來(lái)測試一下，先補齊上面的目錄，然后再resource目錄放一個(gè)js資源

啟動(dòng)springboot應用測試：成功訪(fǎng)問(wèn)到靜態(tài)資源！

1.3、總結

以下四個(gè)目錄存放的靜態(tài)資源可以被我們識別：

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

注意：

第一個(gè)目錄的訪(fǎng)問(wèn)路徑為localhost:8080/webjars/資源目錄結構，后面三個(gè)訪(fǎng)問(wèn)路徑為localhost:8080/資源名

第二種映射規則的優(yōu)先級為：resources>static（默認）>public

2、自定義靜態(tài)資源路徑

我們可以自己通過(guò)配置文件來(lái)指定一下，哪些文件夾是需要我們放靜態(tài)資源文件的，在application.properties中配置；

spring.resources.static-locations=classpath:/coding/,classpath:/cheng/

但是通過(guò)下面源碼我們可以看出，如果自定義了資源路徑，那么上面默認的四個(gè)路徑就失效了，所以最好不要自定義路徑，使用springboot幫我們自動(dòng)配置好的就行。

if (!this.resourceProperties.isAddMappings()) {
				logger.debug("Default resource handling disabled");
				return;
			}

到此這篇關(guān)于SpringBoot通過(guò)源碼探究靜態(tài)資源的映射規則實(shí)現的文章就介紹到這了,更多相關(guān)SpringBoot 靜態(tài)資源映射規則內容請搜索腳本之家以前的文章或繼續瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！