靜態(tài)資源處理

Spring Boot 默認(rèn)的處理方式就已經(jīng)足夠了，默認(rèn)情況下Spring Boot 使用WebMvcAutoConfiguration中配置的各種屬性。

建議使用Spring Boot 默認(rèn)處理方式，需要自己配置的地方可以通過配置文件修改。

但是如果你想完全控制Spring MVC，你可以在@Configuration注解的配置類上增加@EnableWebMvc，增加該注解以后WebMvcAutoConfiguration中配置就不會(huì)生效，你需要自己來配置需要的每一項(xiàng)。這種情況下的配置方法建議參考WebMvcAutoConfiguration類。

本文以下內(nèi)容針對(duì)Spring Boot 默認(rèn)的處理方式，部分配置通過在application.yml配置文件中設(shè)置。

配置資源映射

Spring Boot 默認(rèn)配置的/**映射到/static（或/public ，/resources，/META-INF/resources），/webjars/**會(huì)映射到classpath:/META-INF/resources/webjars/。

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

如果你想增加如/mystatic/**映射到classpath:/mystatic/，你可以讓你的配置類繼承WebMvcConfigurerAdapter，然后重寫如下方法：

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

這種方式會(huì)在默認(rèn)的基礎(chǔ)上增加/mystatic/**映射到classpath:/mystatic/，不會(huì)影響默認(rèn)的方式，可以同時(shí)使用。

靜態(tài)資源映射還有一個(gè)配置選項(xiàng)，為了簡單這里用.properties方式書寫：

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

這個(gè)配置會(huì)影響默認(rèn)的/**，例如修改為/static/**后，只能映射如/static/js/sample.js這樣的請(qǐng)求（修改前是/js/sample.js）。這個(gè)配置只能寫一個(gè)值，不像大多數(shù)可以配置多個(gè)用逗號(hào)隔開的。

使用注意

例如有如下目錄結(jié)構(gòu)：

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

在index.ftl中該如何引用上面的靜態(tài)資源呢？

如下寫法：

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

注意：默認(rèn)配置的/**映射到/static（或/public ，/resources，/META-INF/resources）

當(dāng)請(qǐng)求/css/index.css的時(shí)候，Spring MVC 會(huì)在/static/目錄下面找到。

如果配置為/static/css/index.css，那么上面配置的幾個(gè)目錄下面都沒有/static目錄，因此會(huì)找不到資源文件！

所以寫靜態(tài)資源位置的時(shí)候，不要帶上映射的目錄名（如/static/，/public/ ，/resources/，/META-INF/resources/）！

使用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版本號(hào)了，如果僅僅這么使用，那么當(dāng)我們切換版本號(hào)的時(shí)候還要手動(dòng)修改href，怪麻煩的，我們可以用如下方式解決。

先在pom.xml中添加依賴：

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

增加一個(gè)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);
  }
 }
}

然后使用的時(shí)候按照如下方式：

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

注意：這里不需要在寫版本號(hào)了，但是注意寫url的時(shí)候，只是在原來url基礎(chǔ)上去掉了版本號(hào)，其他的都不能少！

靜態(tài)資源版本管理

Spring MVC 提供了靜態(tài)資源版本映射的功能。

用途：當(dāng)我們資源內(nèi)容發(fā)生變化時(shí)，由于瀏覽器緩存，用戶本地的靜態(tài)資源還是舊的資源，為了防止這種情況導(dǎo)致的問題，我們可能會(huì)手動(dòng)在請(qǐng)求url的時(shí)候加個(gè)版本號(hào)或者其他方式。

版本號(hào)如：

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

Spring MVC 提供的功能可以很容易的幫助我們解決類似問題。

Spring MVC 有兩種解決方式。

注意：下面的配置方式針對(duì)freemarker模板方式，其他的配置方式可以參考。

資源名-md5 方式

例如：

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

Spring 會(huì)自動(dòng)讀取資源md5，然后添加到index.css的名字后面，因此當(dāng)資源內(nèi)容發(fā)生變化的時(shí)候，文件名發(fā)生變化，就會(huì)更新本地資源。

配置方式：

在application.properties中做如下配置：

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

這樣配置后，所有/**請(qǐng)求的靜態(tài)資源都會(huì)被處理為上面例子的樣子。

到這兒還沒完，我們?cè)趯戀Y源url的時(shí)候還要特殊處理。

首先增加如下配置：

@ControllerAdvice
public class ControllerConfig {
 @Autowired
 ResourceUrlProvider resourceUrlProvider;
 @ModelAttribute("urls")
 public ResourceUrlProvider urls() {
  return this.resourceUrlProvider;
 }
}

然后在頁面寫的時(shí)候用下面的寫法：

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

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

版本號(hào) 方式

在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中。原因我們?cè)谥vSpring MVC 處理邏輯的時(shí)候說。

在頁面寫的時(shí)候，寫法如下：

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

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

在請(qǐng)求的實(shí)際頁面中，會(huì)顯示為：

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

可以看到這里的地址是/v1.0.0/js/index.js。

靜態(tài)資源版本管理 處理過程

在Freemarker模板首先會(huì)調(diào)用urls.getForLookupPath方法，返回一個(gè)/v1.0.0/js/index.js或/css/index-2b371326aa93ce4b611853a309b69b29.css。

這時(shí)頁面上的內(nèi)容就是處理后的資源地址。

這之后瀏覽器發(fā)起請(qǐng)求。

這里分開說。

第一種md5方式

請(qǐng)求/css/index-2b371326aa93ce4b611853a309b69b29.css，我們md5配置的paths=/**，所以Spring MVC 會(huì)嘗試url中是否包含-，如果包含會(huì)去掉后面這部分，然后去映射的目錄（如/static/）查找/css/index.css文件，如果能找到就返回。

第二種版本方式

請(qǐng)求/v1.0.0/js/index.js。

如果我們paths中沒有配置/v1.0.0，那么上面這個(gè)請(qǐng)求地址就不會(huì)按版本方式來處理，因此會(huì)找不到上面的資源。

如果配置了/v1.0.0，Spring 就會(huì)將/v1.0.0去掉再去找/js/index.js，最終會(huì)在/static/下面找到。

最后

以上是Spring Boot 靜態(tài)資源處理的內(nèi)容，有些不全面的地方或者讀者有更多疑問，可以查看Spring Boot完整文檔或本文參考的內(nèi)容。

總結(jié)

以上就是這篇文章的全部內(nèi)容了，希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，謝謝大家對(duì)腳本之家的支持。如果你想了解更多相關(guān)內(nèi)容請(qǐng)查看下面相關(guān)鏈接

最新評(píng)論