SpringBoot-靜態資源載入-原始碼

ML李嘉圖發表於2021-08-17
Spring Boot原始碼

目錄

靜態資源對映規則

SpringBoot中，SpringMVC的web配置都在 WebMvcAutoConfiguration 這個配置類裡面；

我們可以去看看 WebMvcAutoConfigurationAdapter 中有很多配置方法；

有一個方法：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();
    // webjars 配置
    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));
    }
}

讀一下原始碼：比如所有的 /webjars/** ， 都需要去 classpath:/META-INF/resources/webjars/ 找對應的資源；

什麼是webjars 呢？

Webjars本質就是以jar包的方式引入我們的靜態資源 ， 我們以前要匯入一個靜態資原始檔，直接匯入即可。

使用SpringBoot需要使用Webjars，我們可以去搜尋一下：

網站：https://www.webjars.org

要使用jQuery，我們只要要引入jQuery對應版本的pom依賴即可！

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

匯入完畢，檢視webjars目錄結構，並訪問Jquery.js檔案！

訪問：只要是靜態資源，SpringBoot就會去對應的路徑尋找資源，我們這裡訪問：http://localhost:8080/webjars/jquery/3.4.1/jquery.js

第二種靜態資源對映規則

那我們專案中要是使用自己的靜態資源該怎麼匯入呢？我們看下一行程式碼；

我們去找staticPathPattern發現第二種對映規則 ：/** , 訪問當前的專案任意資源，它會去找 resourceProperties 這個類，我們可以點進去看一下分析：

// 進入方法
public String[] getStaticLocations() {
    return this.staticLocations;
}
// 找到對應的值
private String[] staticLocations = CLASSPATH_RESOURCE_LOCATIONS;
// 找到路徑
private static final String[] CLASSPATH_RESOURCE_LOCATIONS = { 
    "classpath:/META-INF/resources/",
  "classpath:/resources/", 
    "classpath:/static/", 
    "classpath:/public/" 
};

ResourceProperties 可以設定和我們靜態資源有關的引數；這裡面指向了它會去尋找資源的資料夾，即上面陣列的內容。

所以得出結論，以下四個目錄存放的靜態資源可以被我們識別：


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

我們可以在resources根目錄下新建對應的資料夾，都可以存放我們的靜態檔案；

比如我們訪問 http://localhost:8080/1.js , 他就會去這些資料夾中尋找對應的靜態資原始檔；

我們也可以自己通過配置檔案來指定一下，哪些資料夾是需要我們放靜態資原始檔的，在application.properties中配置；

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

一旦自己定義了靜態資料夾的路徑，原來的自動配置就都會失效了！

首頁處理

靜態資原始檔夾說完後，我們繼續向下看原始碼！可以看到一個歡迎頁的對映，就是我們的首頁！

@Bean
public WelcomePageHandlerMapping welcomePageHandlerMapping(ApplicationContext applicationContext,
                                                           FormattingConversionService mvcConversionService,
                                                           ResourceUrlProvider mvcResourceUrlProvider) {
    WelcomePageHandlerMapping welcomePageHandlerMapping = new WelcomePageHandlerMapping(
        new TemplateAvailabilityProviders(applicationContext), applicationContext, getWelcomePage(), // getWelcomePage 獲得歡迎頁
        this.mvcProperties.getStaticPathPattern());
    welcomePageHandlerMapping.setInterceptors(getInterceptors(mvcConversionService, mvcResourceUrlProvider));
    return welcomePageHandlerMapping;
}

點進去繼續看

private Optional<Resource> getWelcomePage() {
    String[] locations = getResourceLocations(this.resourceProperties.getStaticLocations());
    // ::是java8 中新引入的運算子
    // Class::function的時候function是屬於Class的，應該是靜態方法。
    // this::function的funtion是屬於這個物件的。
    // 簡而言之，就是一種語法糖而已，是一種簡寫
    return Arrays.stream(locations).map(this::getIndexHtml).filter(this::isReadable).findFirst();
}
// 歡迎頁就是一個location下的的 index.html 而已
private Resource getIndexHtml(String location) {
    return this.resourceLoader.getResource(location + "index.html");
}

歡迎頁，靜態資原始檔夾下的所有 index.html 頁面；被 /** 對映。

比如我訪問 http://localhost:8080/ ，就會找靜態資原始檔夾下的 index.html

新建一個 index.html ，在我們上面的3個目錄中任意一個；然後訪問測試 http://localhost:8080/ 看結果！

與其他靜態資源一樣，Spring Boot在配置的靜態內容位置中查詢 favicon.ico。如果存在這樣的檔案，它將自動用作應用程式的favicon。

1、關閉SpringBoot預設圖示

#關閉預設圖示
spring.mvc.favicon.enabled=false

2、自己放一個圖示在靜態資源目錄下，我放在 public 目錄下

3、清除瀏覽器快取！重新整理網頁，發現圖示已經變成自己的了！

參考連結

狂神說SpringBoot10：Web開發靜態資源處理 (qq.com)

相關文章