Spring Boot 中的靜態(tài)資源放置位置

當(dāng)我們使用 SpringMVC 框架時(shí)，靜態(tài)資源會(huì)被攔截，需要添加額外配置，之前老有小伙伴在微信上問(wèn)松哥Spring Boot 中的靜態(tài)資源加載問(wèn)題：“松哥，我的HTML頁(yè)面好像沒(méi)有樣式？”，今天我就通過(guò)一篇文章，來(lái)和大伙仔細(xì)聊一聊這個(gè)問(wèn)題。

SSM 中的配置

要講 Spring Boot 中的問(wèn)題，我們得先回到 SSM 環(huán)境搭建中，一般來(lái)說(shuō)，我們可以通過(guò) <mvc:resources /> 節(jié)點(diǎn)來(lái)配置不攔截靜態(tài)資源，如下：

<mvc:resources mapping="/js/**" location="/js/"/>
<mvc:resources mapping="/css/**" location="/css/"/>
<mvc:resources mapping="/html/**" location="/html/"/>

由于這是一種Ant風(fēng)格的路徑匹配符，/** 表示可以匹配任意層級(jí)的路徑，因此上面的代碼也可以像下面這樣簡(jiǎn)寫(xiě)：
<mvc:resources mapping="/**" location="/"/>

這種配置是在 XML 中的配置，大家知道，SpringMVC 的配置除了在XML中配置，也可以在 Java 代碼中配置，如果在Java代碼中配置的話，我們只需要自定義一個(gè)類，繼承自WebMvcConfigurationSupport即可：

@Configuration
@ComponentScan(basePackages = "org.sang.javassm")
public class SpringMVCConfig extends WebMvcConfigurationSupport {
  @Override
  protected void addResourceHandlers(ResourceHandlerRegistry registry) {
    registry.addResourceHandler("/**").addResourceLocations("/");
  }
}

重寫(xiě) WebMvcConfigurationSupport 類中的addResourceHandlers方法，在該方法中配置靜態(tài)資源位置即可，這里的含義和上面 xml 配置的含義一致，因此無(wú)需多說(shuō)。

 這是我們傳統(tǒng)的解決方案，在Spring Boot 中，其實(shí)配置方式和這個(gè)一脈相承，只是有一些自動(dòng)化的配置了。

Spring Boot 中的配置

在 Spring Boot 中，如果我們是從 https://start.spring.io 這個(gè)網(wǎng)站上創(chuàng)建的項(xiàng)目，或者使用 IntelliJ IDEA 中的 Spring Boot 初始化工具創(chuàng)建的項(xiàng)目，默認(rèn)都會(huì)存在 resources/static 目錄，很多小伙伴也知道靜態(tài)資源只要放到這個(gè)目錄下，就可以直接訪問(wèn)，除了這里還有沒(méi)有其他可以放靜態(tài)資源的位置呢？為什么放在這里就能直接訪問(wèn)了呢？這就是本文要討論的問(wèn)題了。

整體規(guī)劃

首先，在 Spring Boot 中，默認(rèn)情況下，一共有5個(gè)位置可以放靜態(tài)資源，五個(gè)路徑分別是如下5個(gè)：

1.classpath:/META-INF/resources/
2.classpath:/resources/
3.classpath:/static/
4.classpath:/public/
5./

前四個(gè)目錄好理解，分別對(duì)應(yīng)了resources目錄下不同的目錄，第5個(gè) / 是啥意思呢？我們知道，在 Spring Boot 項(xiàng)目中，默認(rèn)是沒(méi)有 webapp 這個(gè)目錄的，當(dāng)然我們也可以自己添加（例如在需要使用JSP的時(shí)候），這里第5個(gè) / 其實(shí)就是表示 webapp 目錄中的靜態(tài)資源也不被攔截。如果同一個(gè)文件分別出現(xiàn)在五個(gè)目錄下，那么優(yōu)先級(jí)也是按照上面列出的順序。

不過(guò)，雖然有5個(gè)存儲(chǔ)目錄，除了第5個(gè)用的比較少之外，其他四個(gè)，系統(tǒng)默認(rèn)創(chuàng)建了 classpath:/static/ ， 正常情況下，我們只需要將我們的靜態(tài)資源放到這個(gè)目錄下即可，也不需要額外去創(chuàng)建其他靜態(tài)資源目錄，例如我在 classpath:/static/ 目錄下放了一張名為1.png 的圖片，那么我的訪問(wèn)路徑是：

http://localhost:8080/1.png 

這里大家注意，請(qǐng)求地址中并不需要 static，如果加上了static反而多此一舉會(huì)報(bào)404錯(cuò)誤。很多人會(huì)覺(jué)得奇怪，為什么不需要添加 static呢？資源明明放在 static 目錄下。其實(shí)這個(gè)效果很好實(shí)現(xiàn)，例如在SSM配置中，我們的靜態(tài)資源攔截配置如果是下面這樣：

<mvc:resources mapping="/**" location="/static/"/>

如果我們是這樣配置的話，請(qǐng)求地址如果是 http://localhost:8080/1.png 實(shí)際上系統(tǒng)會(huì)去 /static/1.png 目錄下查找相關(guān)的文件。

所以我們理所當(dāng)然的猜測(cè)，在 Spring Boot 中可能也是類似的配置。

源碼解讀

胡適之先生說(shuō)：“大膽猜想，小心求證”，我們這里就通過(guò)源碼解讀來(lái)看看 Spring Boot 中的靜態(tài)資源到底是怎么配置的。

首先我們?cè)?WebMvcAutoConfiguration 類中看到了 SpringMVC 自動(dòng)化配置的相關(guān)的內(nèi)容，找到了靜態(tài)資源攔截的配置，如下：

可以看到這里靜態(tài)資源的定義和我們前面提到的Java配置SSM中的配置非常相似，其中，this.mvcProperties.getStaticPathPattern() 方法對(duì)應(yīng)的值是 “/**”，this.resourceProperties.getStaticLocations()方法返回了四個(gè)位置，分別是："classpath:/META-INF/resources/", "classpath:/resources/","classpath:/static/", "classpath:/public/"，然后在getResourceLocations方法中，又添加了“/”，因此這里返回值一共有5個(gè)。其中，/表示webapp目錄，即webapp中的靜態(tài)文件也可以直接訪問(wèn)。靜態(tài)資源的匹配路徑按照定義路徑優(yōu)先級(jí)依次降低。因此這里的配置和我們前面提到的如出一轍。這樣大伙就知道了為什么Spring Boot 中支持5個(gè)靜態(tài)資源位置，同時(shí)也明白了為什么靜態(tài)資源請(qǐng)求路徑中不需要/static，因?yàn)樵诼窂接成渲幸呀?jīng)自動(dòng)的添加上了/static了。

自定義配置

當(dāng)然，這個(gè)是系統(tǒng)默認(rèn)配置，如果我們并不想將資源放在系統(tǒng)默認(rèn)的這五個(gè)位置上，也可以自定義靜態(tài)資源位置和映射，自定義的方式也有兩種，可以通過(guò) application.properties 來(lái)定義，也可以在 Java 代碼中來(lái)定義，下面分別來(lái)看。

application.properties

在配置文件中定義的方式比較簡(jiǎn)單，如下：

spring.resources.static-locations=classpath:/
spring.mvc.static-path-pattern=/**

第一行配置表示定義資源位置，第二行配置表示定義請(qǐng)求 URL 規(guī)則。以上文的配置為例，如果我們這樣定義了，表示可以將靜態(tài)資源放在 resources目錄下的任意地方，我們?cè)L問(wèn)的時(shí)候當(dāng)然也需要寫(xiě)完整的路徑，例如在resources/static目錄下有一張名為1.png 的圖片，那么訪問(wèn)路徑就是 http://localhost:8080/static/1.png ,注意此時(shí)的static不能省略。

Java 代碼定義

當(dāng)然，在Spring Boot中我們也可以通過(guò) Java代碼來(lái)自定義，方式和 Java 配置的 SSM 比較類似，如下：

@Configuration
public class WebMVCConfig implements WebMvcConfigurer {
  @Override
  public void addResourceHandlers(ResourceHandlerRegistry registry) {
    registry.addResourceHandler("/**").addResourceLocations("classpath:/aaa/");
  }
}

這里代碼基本和前面一致，比較簡(jiǎn)單，不再贅述。

總結(jié)

這里需要提醒大家的是，松哥見(jiàn)到有很多人用了 Thymeleaf 之后，會(huì)將靜態(tài)資源也放在 resources/templates 目錄下，注意，templates 目錄并不是靜態(tài)資源目錄，它是一個(gè)放頁(yè)面模板的位置（你看到的 Thymeleaf 模板雖然后綴為 .html，其實(shí)并不是靜態(tài)資源）。好了，通過(guò)上面的講解，相信大家對(duì) Spring Boot 中靜態(tài)資源的位置有一個(gè)深刻了解了，應(yīng)該不會(huì)再在項(xiàng)目中出錯(cuò)了吧！