2. 程式人生 > >Spring Boot 靜態資源處理

Spring Boot 靜態資源處理

阿新 • • 發佈：2019-02-19

Spring Boot 預設為我們提供了靜態資源處理，使用 WebMvcAutoConfiguration 中的配置各種屬性。

建議大家使用Spring Boot的預設配置方式，如果需要特殊處理的再通過配置進行修改。

如果想要自己完全控制WebMVC，就需要在@Configuration註解的配置類上增加@EnableWebMvc（@SpringBootApplication 註解的程式入口類已經包含@Configuration），增加該註解以後WebMvcAutoConfiguration中配置就不會生效，你需要自己來配置需要的每一項。這種情況下的配置還是要多看一下WebMvcAutoConfiguration類。

我們既然是快速使用Spring Boot，並不想過多的自己再重新配置。本文還是主要針對Spring Boot的預設處理方式，部分配置在application 配置檔案中（.properties 或 .yml）

預設資源對映

我們在啟動應用的時候，可以在控制檯中看到如下資訊：

2016-01-08 09:29:30.362  INFO 24932 --- [           main] o.s.w.s.handler.SimpleUrlHandlerMapping  : Mapped URL path [/webjars/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]
 

2016-01-08 09:29:30.362  INFO 24932 --- [           main] o.s.w.s.handler.SimpleUrlHandlerMapping  : Mapped URL path [/**] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]
2016-01-08 09:29:30.437  INFO 24932 --- [           main] o.s.w.s.handler.SimpleUrlHandlerMapping
 
  : Mapped URL path [/**/favicon.ico] onto handler of type [class org.springframework.web.servlet.resource.ResourceHttpRequestHandler]

其中預設配置的 /** 對映到 /static （或/public、/resources、/META-INF/resources）
其中預設配置的 /webjars/** 對映到 classpath:/META-INF/resources/webjars/
PS：上面的 static、public、resources 等目錄都在 classpath: 下面（如 src/main/resources/static）。

如果我按如下結構存放相同名稱的圖片，那麼Spring Boot 讀取圖片的優先順序是怎樣的呢？
如下圖：
這裡寫圖片描述

自定義資源對映

上面我們介紹了Spring Boot 的預設資源對映，一般夠用了，那我們如何自定義目錄？
這些資源都是打包在jar包中的，然後實際應用中，我們還有很多資源是在管理系統中動態維護的，並不可能在程式包中，對於這種隨意指定目錄的資源，如何訪問？

自定義目錄

以增加 /myres/* 對映到 classpath:/myres/* 為例的程式碼處理為：
實現類繼承 WebMvcConfigurerAdapter 並重寫方法 addResourceHandlers （對於 WebMvcConfigurerAdapter 上篇介紹攔截器的文章中已經有提到）

package org.springboot.sample.config;

import org.springboot.sample.interceptor.MyInterceptor1;
import org.springboot.sample.interceptor.MyInterceptor2;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

@Configuration
public class MyWebAppConfigurer 
        extends WebMvcConfigurerAdapter {

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

}

訪問myres 資料夾中的fengjing.jpg 圖片的地址為 http://localhost:8080/myres/fengjing.jpg
這樣使用程式碼的方式自定義目錄對映，並不影響Spring Boot的預設對映，可以同時使用。

如果我們將/myres/* 修改為 /* 與預設的相同時，則會覆蓋系統的配置，可以多次使用 addResourceLocations 新增目錄，優先順序先新增的高於後新增的。

// 訪問myres根目錄下的fengjing.jpg 的URL為 http://localhost:8080/fengjing.jpg （/** 會覆蓋系統預設的配置）
// registry.addResourceHandler("/**").addResourceLocations("classpath:/myres/").addResourceLocations("classpath:/static/");

其中 addResourceLocations 的引數是動參，可以這樣寫 addResourceLocations(“classpath:/img1/”, “classpath:/img2/”, “classpath:/img3/”);

使用外部目錄

如果我們要指定一個絕對路徑的資料夾（如 H:/myimgs/ ），則只需要使用 addResourceLocations 指定即可。

// 可以直接使用addResourceLocations 指定磁碟絕對路徑，同樣可以配置多個位置，注意路徑寫法需要加上file:
registry.addResourceHandler("/myimgs/**").addResourceLocations("file:H:/myimgs/");

通過配置檔案配置

上面是使用程式碼來定義靜態資源的對映，其實Spring Boot也為我們提供了可以直接在 application.properties（或.yml）中配置的方法。
配置方法如下：

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

使用 spring.mvc.static-path-pattern 可以重新定義pattern，如修改為 /myres/** ，則訪問static 等目錄下的fengjing.jpg檔案應該為 http://localhost:8080/myres/fengjing.jpg ，修改之前為 http://localhost:8080/fengjing.jpg
使用 spring.resources.static-locations 可以重新定義 pattern 所指向的路徑，支援 classpath: 和 file: （上面已經做過說明）
注意 spring.mvc.static-path-pattern 只可以定義一個，目前不支援多個逗號分割的方式。

頁面中使用

上面幾個例子中也已經說明了怎麼訪問靜態資源，其實在頁面中使用不管是jsp還是freemarker，並沒有什麼特殊之處，也我們平時開發web專案一樣即可。
下面是我的index.jsp：

<body>
    <img alt="讀取預設配置中的圖片" src="${pageContext.request.contextPath }/pic.jpg">
    <br/>
    <img alt="讀取自定義配置myres中的圖片" src="${pageContext.request.contextPath }/myres/fengjing.jpg">
</body>

使用webjars

先說一下什麼是webjars？我們在Web開發中，前端頁面中用了越來越多的JS或CSS，如jQuery等等，平時我們是將這些Web資源拷貝到Java的目錄下，這種通過人工方式拷貝可能會產生版本誤差，拷貝版本錯誤，前端頁面就無法正確展示。
WebJars 就是為了解決這種問題衍生的，將這些Web前端資源打包成Java的Jar包，然後藉助Maven這些依賴庫的管理，保證這些Web資源版本唯一性。

WebJars 就是將js, css 等資原始檔放到 classpath:/META-INF/resources/webjars/ 中，然後打包成jar 釋出到maven倉庫中。

簡單應用

以jQuery為例，檔案存放結構為：

META-INF/resources/webjars/jquery/2.1.4/jquery.js
META-INF/resources/webjars/jquery/2.1.4/jquery.min.js
META-INF/resources/webjars/jquery/2.1.4/jquery.min.map
META-INF/resources/webjars/jquery/2.1.4/webjars-requirejs.js

Spring Boot 預設將 /webjars/** 對映到 classpath:/META-INF/resources/webjars/ ，結合我們上面講到的訪問資源的規則，便可以得知我們在JSP頁面中引入jquery.js的方法為：

<script type="text/javascript" src="${pageContext.request.contextPath }/webjars/jquery/2.1.4/jquery.js"></script>

想實現這樣，我們只需要在pom.xml 檔案中新增jquery的webjars 依賴即可，如下：

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

版本號統一管理

但是我們實際開發中，可能會遇到升級版本號的情況，如果我們有100多個頁面，幾乎每個頁面上都有按上面引入jquery.js 那麼我們要把版本號更換為3.0.0，一個一個替換顯然不是最好的辦法。
如何來解決？按如下方法處理即可。

首先在pom.xml 中新增依賴：

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

然後增加一個WebJarsController：

package org.springboot.sample.controller;

import javax.servlet.http.HttpServletRequest;

import org.springframework.core.io.ClassPathResource;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.servlet.HandlerMapping;
import org.webjars.WebJarAssetLocator;

/**
 * 處理WebJars，自動讀取版本號
 *
 * @author   單紅宇(365384722)
 * @myblog  http://blog.csdn.net/catoop/
 * @create    2016年1月8日
 */
@Controller
public class WebJarsController {

     private final WebJarAssetLocator assetLocator = new WebJarAssetLocator();

    @ResponseBody
    @RequestMapping("/webjarslocator/{webjar}/**")
    public ResponseEntity<Object> locateWebjarAsset(@PathVariable String webjar, HttpServletRequest request) {
        try {
            String mvcPrefix = "/webjarslocator/" + webjar + "/"; // This prefix must match the mapping path!
            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="${pageContext.request.contextPath }/webjarslocator/jquery/jquery.js"></script>

靜態資源版本管理

Spring 預設提供了靜態資源版本對映的支援。
當我們的資源內容發生改變時，由於瀏覽器快取，使用者本地的資源還是舊資源，為了防止這種情況發生導致的問題。我們可能會選擇在資原始檔後面加上引數“版本號”或其他方式。

使用版本號引數，如：

<script type="text/javascript" src="${pageContext.request.contextPath }/js/common.js?v=1.0.1"></script>

使用這種方式，當我們檔案修改後，手工修改版本號來達到URL檔案不被瀏覽器快取的目的。同樣也存在很多檔案都需要修改的問題。或者有的人會增加時間戳的方式，這樣我認為是最不可取的，每次瀏覽器都要請求為伺服器增加了不必要的壓力。

然而Spring在解決這種問題方面，提供了2種解決方式。
* 資源名稱md5方式 *
1. 修改 application.properties 配置檔案（或.yml）

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

所有 /** 請求的靜態資源都會被處理。

  1. 建立 ResourceUrlProviderController 檔案
package org.springboot.sample.config;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.servlet.resource.ResourceUrlProvider;

/**
 * 處理靜態資源URL
 *
 * @author 單紅宇(365384722)
 * @myblog http://blog.csdn.net/catoop/
 * @create 2016年1月8日
 */
@ControllerAdvice
public class ResourceUrlProviderController {

    @Autowired
    private ResourceUrlProvider resourceUrlProvider;

    @ModelAttribute("urls")
    public ResourceUrlProvider urls() {
        return this.resourceUrlProvider;
    }
}
  1. 在頁面中使用的寫法
<script type="text/javascript" src="${pageContext.request.contextPath }${urls.getForLookupPath('/js/common.js') }"></script>

當我們訪問頁面後，HTML中實際生成的程式碼為：

<script type="text/javascript" src="/myspringboot/js/common-c6b7da8fffc9be141b48c073e39c7340.js"></script>

其中 /myspringboot 為我這個專案的 contextPath

* 資源版本號方式 *
該方式本人覺得並無多大意義，也不做詳細說明，這是對所有資源的統一版本控制，不像上面一個md5是針對檔案的。
除了在 application.properties（或.yml）中的配置有所區別，頁面使用和md5的一樣。

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

這樣配置後，以上面 common.js 為例，實際頁面中生成的HTML程式碼為：

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

* md5與版本號方式的處理原理 *
頁面中首先會呼叫urls.getForLookupPath方法，返回一個/v1.0.0/js/common.js或/css/common-c6b7da8fffc9be141b48c073e39c7340.js
然後瀏覽器發起請求。
當請求的地址為md5方式時，會嘗試url中的檔名中是否包含-，如果包含會去掉後面這部分，然後去對映的目錄（如/static/）查詢/js/common.js檔案，如果能找到就返回。

當請求的地址為版本號方式時，會在url中判斷是否存在/v1.0.0 ，如果存在，則先從URL中把 /v1.0.0 去掉，然後再去對映目錄查詢對應檔案，找到就返回。

總結

有這麼多方式來管理我們的資原始檔，然而在實際應用中雖然也都有可能用到（存在就有存在的道理嘛），但是憑藉個人經驗來說。
1. 我們使用第三方的庫時，建議使用webjars的方式，通過動態版本號（webjars-locator 的方式）來使用（因為第三方庫在專案開發中變動頻率很小，即便是變動也是版本號的修改）。
2. 我們使用自己存放在靜態資源對映目錄中的資源的時候，建議使用md5 資原始檔名的方式來使用（專案開發中一些css、js檔案會經常修改）。
3. 專案素材檔案建議放到 classpath:/static （或其他）目錄中，打包在專案中，通過CMS維護的一些圖片和資源，我們使用配置引用到具體的磁碟絕對路徑來使用。
4. 注意使用md5檔名方式的時候，Spring 是有快取機制的，也就是說，在服務不重啟的情況下，你去變動修改這些資原始檔，其檔名的md5值並不會改變，只有重啟服務再次訪問才會生效。如果需要每次都獲取實際檔案的md5值，需要重寫相關類來實現，我們不建議這樣做，因為一直去計算檔案md5值是需要效能代價的。

相關推薦

Spring Boot靜態資源處理

內容 獲取request adapter 邏輯 keyword control 導致 match creat Spring Boot靜態資源處理 8.8 Spring Bo

Spring boot 靜態資源處理以及攔截器的使用

前言 本章主要圍繞WebMvcConfigurer，簡單介紹spring boot如何處理靜態資源以及使用攔截器的使用 靜態資源 spring boot預設為我們提供預設的配置方式 classpath:/META-INF/resources classpath

Spring Boot 靜態資源處理

Spring Boot 預設為我們提供了靜態資源處理，使用 WebMvcAutoConfiguration 中的配置各種屬性。 建議大家使用Spring Boot的預設配置方式，如果需要特殊處理的再通過配置進行修改。 如果想要自己完全控制WebMVC，就需要

Spring MVC靜態資源處理

sta itl span 接收 expires 客戶端使用 let web應用 request 優雅REST風格的資源URL不希望帶 .html 或 .do 等後綴.由於早期的Spring MVC不能很好地處理靜態資源，所以在web.xml中配置DispatcherServ

spring boot 靜態資源。。

web資源 length fix 入口 cep 等等 comm esp reat spring Boot 默認為我們提供了靜態資源處理，使用 WebMvcAutoConfiguration 中的配置各種屬性。 建議大家使用Spring Boot的默認配置方式，如果需要特殊處

spring boot 靜態資源映射

mp4 hadoop ont reg system ssp test nds handler package com.ehongcn.ccp.ss.dd.common.security; import org.springframework.beans.factory.an

Spring Boot 靜態資源路徑分析

導致 路徑 分享圖片 ota thymeleaf map ppi contex pub 　　最近在接觸一個看公司的java後臺項目(采用的耶魯大學開源的一個cas單點登錄系統)，用的是框架是Spring Boot，用的模板是Thymeleaf,於是我生成一個Spring B

Spring MVC 靜態資源處理 （三）

完整的專案案例： springmvc.zip 目錄 例項 專案結構：   一、配置web.xml <?xml version="1.0" encoding="UTF-8"?> <web-app xmlns="http://xmlns.

spring boot靜態資源訪問配置（訪問專案資料夾外的檔案）

很多類似的博文，但是實際配置後發現是有問題的。下面是完整的yml靜態資源訪問配置,在spring：下新增 mvc: static-path-pattern: /** #這個配置是預設配置 http:

Spring Boot靜態資源

Spring Boot靜態資源 Spring Boot靜態資源的存放位置 1. application.properties配置 2. JavaConfig - WebMvcConfigurationSupport webjars webjars

spring Boot 靜態資源與攔截器

spring Boot 靜態資源與攔截器 優先順序：META-INF/resources > resources > static > public   一、對映資源路徑 1、 spring.resources.static-locatio

Spring Boot 靜態資源訪問原理解析

一、前言 　　springboot配置靜態資源方式是多種多樣，接下來我會介紹其中幾種方式，並解析一下其中的原理。 二、使用properties屬性進行配置 　　應該說 spring.mvc.static-path-pattern 和 spring.resources.static-locations這兩

spring mvc 靜態資源處理遇到的問題

自己專案中遇到的問題，記錄一下，解決方式，至於原理，待大神來解答，哈哈！ 專案中靜態資源的處理是採用下面的方式 <mvc:resources location="/lib/" mapping="/lib/**" /> 專案中有一個攔截器，測試時發現一般的靜態資源

spring boot 靜態資源修改能否立即生效問題

/* 如果將要訪問的靜態資源放在專案的類路徑下面即配置為"classpath:/BookPicture/"那麼當該路徑下的資 源發生變化時是不立即生效的，即只有重啟後才能訪問到變化的資源； 解決辦法將靜態資源放在非專案類路徑下即可 "file:F:

spring boot 靜態資源和攔截器

classpath:/META-INF/resources classpath:/resources classpath:/static classpath:/public 3.配置檔案 #預設值為 /** spring.mvc.static-pa

Spring boot 靜態資源訪問

0. 兩個配置 spring.mvc.static-path-pattern spring.resources.stat

深入 Spring 系列之靜態資源處理

extend ada tst mar 找到 方法 rman 依賴 1-43 1. 背景 前一段時間，WebIDE 開源的過程中，無意間接觸到 webjars，覺得比較有趣，於是研究並整理了一下。 webjars 是將前端的庫（比如 jQuery）打包成 Jar 文件，然

Spring MVC靜態資源實例

startup current -c xml文件 _id param eba ota ring 以下內容引用自http://wiki.jikexueyuan.com/project/spring/mvc-framework/spring-static-pages-examp

spring mvc靜態資源放行

default mar tco add 之前 fis res tomcat ssp 方式一:在springmvc.xml中放行 1,全部資源放行 <!--springmvc.xml中添加--> <!-- 全部資源放行 --

Spring Boot? 統一異常處理

xtend import put itl ava advice efault ges spring 效果區： 代碼區： package com.wls.integrateplugs.exception.dto; public class ErrorI