spring boot（10）靜態資源

時間 2019-11-06

原文原文鏈接

1 靜態文件

默認狀況下，spring boot會從classpath下一個叫 /static (或 /public 或 /resources 或 /META-INF/resources) 的目錄或者從ServletContext根目錄提供靜態內容。這使用了Spring MVC的ResourceHttpRequestHandler，因此你能夠經過添加本身的WebMvcConfigurerAdapter並覆寫addResourceHandlers方法來改變這個行爲（加載靜態文件）。javascript

在獨立的web應用程序中，容器的servlet是默認開啓的，若是Spring決定不處理某些請求，默認的servlet做爲一個回退（降級）將從ServletContext根目錄加載內容。大多數狀況下，這不會發生(除非您修改默認的MVC配置)，由於Spring老是可以經過DispatcherServlet處理請求。css

默認狀況下，靜態資源映射到/**上，但你能夠經過spring.mvc.static-path-pattern 調整它。例如把全部資源遷移到/resource/**，能夠用下面實現：html

spring.mvc.static-path-pattern=/resources/**

你也能定製靜態資源位置使用 spring.resources.static-locations （使用目錄位置列表替換默認值）。若是你這樣作，默認的歡迎頁面檢測將切換到您的自定義位置。java

# 默認值爲 /**
spring.mvc.static-path-pattern=
# 默認值爲 classpath:/META-INF/resources/,classpath:/resources/,classpath:/static/,classpath:/public/
spring.resources.static-locations=這裏設置要指向的路徑，多個使用英文逗號隔開

除了上面的「標準」靜態資源位置以外，還爲webjar內容製做了一個特殊的例子。任何帶有路徑/webjar/**路徑的資源都將從jar文件中提供，若是它們被打包成webjar格式。jquery

注：若是您的應用程序將打包爲jar，請不要使用src/main/webapp目錄。儘管這個目錄是一個通用的標準，可是它只適用於war包，若是您生成一個jar，它將被大多數構建工具悄悄地忽略。web

2 配置資源映射

Spring Boot 默認配置的/**映射到/static（或/public ，/resources，/META-INF/resources），/webjars/**會映射到classpath:/META-INF/resources/webjars/。spring

注意：上面的/static等目錄都是在classpath:下面。瀏覽器

若是你想增長如/mystatic/**映射到classpath:/mystatic/，你可讓你的配置類繼承WebMvcConfigurerAdapter，而後重寫以下方法：spring-mvc

@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
		
    registry.addResourceHandler("/mystatic/**")
            .addResourceLocations("classpath:/mystatic/");
	
}

這種方式會在默認的基礎上增長/mystatic/**映射到classpath:/mystatic/，不會影響默認的方式，能夠同時使用。緩存

靜態資源映射配置選項：

spring.mvc.static-path-pattern=/** # Path pattern used for static resources.

這個配置會影響默認的/**，例如修改成/static/**後，只能映射如/static/js/sample.js這樣的請求（修改前是/js/sample.js）。這個配置只能寫一個值，不像大多數能夠配置多個用逗號隔開的。

3 使用注意

例若有以下目錄結構：

└─resources
    │  application.yml
    │
    ├─static
    │  ├─css
    │  │      index.css
    │  │
    │  └─js
    │          index.js
    │
    └─templates
            index.ftl

在index.ftl中該如何引用上面的靜態資源呢？
以下寫法：

<link rel="stylesheet" type="text/css" href="/css/index.css">
<script type="text/javascript" src="/js/index.js"></script>

注意：默認配置的/**映射到/static（或/public ，/resources，/META-INF/resources）當請求/css/index.css的時候，Spring MVC 會在/static/目錄下面找到。若是配置爲/static/css/index.css，那麼上面配置的幾個目錄下面都沒有/static目錄，所以會找不到資源文件！

因此寫靜態資源位置的時候，不要帶上映射的目錄名（如/static/，/public/ ，/resources/，/META-INF/resources/）！

4 使用WebJars

WebJars：http://www.webjars.org/

例如使用jquery，添加依賴：

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

而後能夠以下使用：

<script type="text/javascript" src="/webjars/jquery/1.11.3/jquery.js"></script>

你可能注意到href中的1.11.3版本號了，若是僅僅這麼使用，那麼當咱們切換版本號的時候還要手動修改href，怪麻煩的，咱們能夠用以下方式解決。

先在pom.xml中添加依賴：

<dependency>
    <groupId>org.webjars</groupId>
    <artifactId>webjars-locator</artifactId>
</dependency>

增長一個WebJarController：

@Controller
public class WebJarController {
    private final WebJarAssetLocator assetLocator = new WebJarAssetLocator();

    @ResponseBody
    @RequestMapping("/webjarslocator/{webjar}/**")
    public ResponseEntity locateWebjarAsset(@PathVariable String webjar, HttpServletRequest request) {
        try {
            String mvcPrefix = "/webjarslocator/" + webjar + "/";
            String mvcPath = (String) request.getAttribute(HandlerMapping.PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE);
            String fullPath = assetLocator.getFullPath(webjar, mvcPath.substring(mvcPrefix.length()));
            return new ResponseEntity(new ClassPathResource(fullPath), HttpStatus.OK);
        } catch (Exception e) {
            return new ResponseEntity<>(HttpStatus.NOT_FOUND);
        }
    }
}

而後使用的時候按照以下方式：

<script type="text/javascript" src="/webjarslocator/jquery/jquery.js"></script>

注意：這裏不須要在寫版本號了，可是注意寫url的時候，只是在原來url基礎上去掉了版本號，其餘的都不能少！

5 靜態資源版本管理

Spring MVC 提供了靜態資源版本映射的功能。

用途：當咱們資源內容發生變化時，因爲瀏覽器緩存，用戶本地的靜態資源仍是舊的資源，爲了防止這種狀況致使的問題，咱們可能會手動在請求url的時候加個版本號或者其餘方式。

版本號如：

<script type="text/javascript" src="/js/sample.js?v=1.0.1"></script>

Spring MVC 提供的功能能夠很容易的幫助咱們解決相似問題。

Spring MVC 有兩種解決方式。

注意：下面的配置方式針對freemarker模板方式，其餘的配置方式能夠參考。

5.1 資源名-md5 方式

例如：

<link rel="stylesheet" type="text/css" href="/css/index-2b371326aa93ce4b611853a309b69b29.css">

Spring 會自動讀取資源md5，而後添加到index.css的名字後面，所以當資源內容發生變化的時候，文件名發生變化，就會更新本地資源。

配置方式：

在application.properties中作以下配置：

spring.resources.chain.strategy.content.enabled=true
spring.resources.chain.strategy.content.paths=/**

這樣配置後，全部/**請求的靜態資源都會被處理爲上面例子的樣子。

到這兒還沒完，咱們在寫資源url的時候還要特殊處理。

首先增長以下配置：

@ControllerAdvice
public class ControllerConfig {

    @Autowired
    ResourceUrlProvider resourceUrlProvider;

    @ModelAttribute("urls")
    public ResourceUrlProvider urls() {
        return this.resourceUrlProvider;
    }

}

而後在頁面寫的時候用下面的寫法：

<link rel="stylesheet" type="text/css" href="${urls.getForLookupPath('/css/index.css')}">

使用urls.getForLookupPath('/css/index.css')來獲得處理後的資源名。

5.2 版本號-方式

在application.properties中作以下配置：

spring.resources.chain.strategy.fixed.enabled=true
 spring.resources.chain.strategy.fixed.paths=/js/**,/v1.0.0/**
 spring.resources.chain.strategy.fixed.version=v1.0.0

這裏配置須要特別注意，將version的值配置在paths中。緣由咱們在講Spring MVC 處理邏輯的時候說。

在頁面寫的時候，寫法以下：

<script type="text/javascript" src="${urls.getForLookupPath('/js/index.js')}"></script>

注意，這裏仍然使用了urls.getForLookupPath，urls配置方式見上一種方式。

在請求的實際頁面中，會顯示爲：

<script type="text/javascript" src="/v1.0.0/js/index.js"></script>

能夠看到這裏的地址是/v1.0.0/js/index.js。

5.3 靜態資源版本管理-處理過程

在Freemarker模板首先會調用urls.getForLookupPath方法，返回一個/v1.0.0/js/index.js或/css/index-2b371326aa93ce4b611853a309b69b29.css。

這時頁面上的內容就是處理後的資源地址。

這以後瀏覽器發起請求。

這裏分開說。

第一種md5方式

請求/css/index-2b371326aa93ce4b611853a309b69b29.css，咱們md5配置的paths=/**，因此Spring MVC 會嘗試url中是否包含-，若是包含會去掉後面這部分，而後去映射的目錄（如/static/）查找/css/index.css文件，若是能找到就返回。

第二種版本方式

請求/v1.0.0/js/index.js。若是咱們paths中沒有配置/v1.0.0，那麼上面這個請求地址就不會按版本方式來處理，所以會找不到上面的資源。若是配置了/v1.0.0，Spring 就會將/v1.0.0去掉再去找/js/index.js，最終會在/static/下面找到。