SpringBoot通過原始碼探究靜態資源的對映規則實現
我們開發一個Spring Boot專案,肯定要匯入許多的靜態資源,比如css,js等檔案
如果我們是一個web應用,我們的main下會有一個webapp,我們以前都是將所有的頁面導在這裡面的,對吧!但是我們現在的pom呢,打包方式是為jar的方式,那麼這種方式SpringBoot能不能來給我們寫頁面呢?當然是可以的,但是SpringBoot對於靜態資源放置的位置,是有規定的!
1、靜態資源對映規則
1.1、第一種對映規則
SpringBoot中,SpringMVC的web配置都在 WebMvcAutoConfiguration 這個配置類裡面;
WebMvcAutoConfigurationAdapter 中有很多配置方法;其中就有一個新增資源處理方法: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)); } }); }
通過分析上面原始碼可得,新增的靜態資源對映路徑為/webjars/**
,資源路徑為classpath:/META-INF/resources/webjars/
什麼是webjars
WebJars是將客戶端(瀏覽器)資源(javascript,Css等)打成jar包檔案,以對資源進行統一依賴管理。WebJars的jar包部署在Maven中央倉庫上。
webjars官網
我們可以到webjars官網上找到自己需要的資源,在自己的工程中新增入maven依賴,即可直接使用這些資源了。
比如,我們要匯入jhttp://www.cppcns.comquery資源
&qaSRuzqlt;dependency> <groupId>org.webjars</groupId程式設計客棧> <artifactId>jquery</artifactId> <version>3.6.0</version> </dependency>
匯入後我們可以通過資源路徑找到資源的存放位置並訪問,我們在webjars網站匯入的資源都符合下圖的結構
通過路徑訪問,成功訪問到靜態資源!
1.2、第二種對映規則
下面我們繼續分析原始碼
getStaticPathpattern():獲得靜態路徑模式,點進去看一下原始碼
public String getStaticPathPattern() { return this.staticPathPattern; }
再看一下staticPathPattern的原始碼
/**
就是當前目錄下的所有靜態資源都能識別,但是當前目錄下具體指的又是什麼呢?我們點開resourceProperties的原始碼便可看出來。原始碼如下:
上面原始碼很清楚的給出了我們四個靜態資源路徑,所以只要是這四個目錄下的靜態資源,都可以直接獲取。
我們來測試一下,先補齊上面的目錄,然後再resource目錄放一個js資源
啟動springboot應用測試:成功訪問到靜態資源!
1.3、總結
以下四個目錄存放的靜態資源可以被我們識別:
"classpath:/META-INF/resources/" "classpath:/resources/" "classpath:/static/" "classpath:/public/"
注意:
第一個目錄的訪問路徑為localhost:8080/webjars/資源目錄結構,後面三個訪問路徑為localhost:8080/資源名
第二種對映規則的優先順序為:resources>static(預設)>public
2、自定義靜態資源路徑
我們可以自己通過配置檔案來指定一下,哪些資料夾是需要我們放靜態資原始檔的,在application.properties中配置;
spring.resources.static-locations=classpath:/coding/,classpath:/cheng/
但是通過下面原始碼我們可以看出,如果自定義了資源路徑,那麼上面預設的四個路徑就失效了,所以最好不要自定義路徑,使用springboot幫我們自動配置好的就行。
if (www.cppcns.com!this.rqaSRuzqesourceProperties.isAddMappings()) { logger.debug("Default resource handling disabled"); return; }
到此這篇關於SpringBoot通過原始碼探究靜態資源的對映規則實現的文章就介紹到這了,更多相關SpringBoot 靜態資源對映規則內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們!