Spring Boot2.0實現靜態資源版本控制詳解

寫在最前面

猶記畢業第一年時，公司每次發布完成后，都會在一個群里通知【版本更新，各部門清理緩存，有問題及時反饋】之類的話。歸根結底就是資源緩存的問題，瀏覽器會將請求到的靜態資源，如JS、CSS等文件緩存到用戶本地，當用戶再次訪問時就不需要再次請求這些資源了，以此也是提升了用戶體驗。但是也正是因為這些資源緩存，導致客戶端的靜態文件往往不是當前最新版本。后來有同事增加了時間戳、隨機數等，確實這也解決了客戶端緩存的問題，但是卻又帶來了新的麻煩，導致每次訪問都要請求服務器，無形中增加了服務器的壓力。

那么有什么辦法可以讓客戶端當需要更新時才去請求，不需更新就不請求嗎？當然有，實現方式很多種，像前端實現，webjars實現等都可以，但是麻煩還是麻煩，太燒腦。介紹一種Spring自身提供的方式，也是我目前所應用的方式，ResourceUrlProvider。

ResourceUrlProvider的實現效果有兩種，大家可以在后文中看到。下面話不多說了，來一起看看詳細的介紹吧

第一種、MD5實現

首先在application.yml或者application.properties中增加配置文件

spring: 
 resources:
 chain:
  strategy:
  content:
   enabled: true
   paths: /**

其次，如果您恰巧和我一樣使用Thymeleaf作為模板引擎，則可以和我一樣使用@bean語法直接從模板訪問ResourceUrlProvider bean。

<script th:src="${@mvcResourceUrlProvider.getForLookupPath('/mods/admin/login.js')}"></script>

如果您使用的模板引擎無法直接訪問Spring bean，則可以將ResourceUrlProvider 添加到Spring中。使用ControllerAdvice，代碼如下：

@ControllerAdvice
public class ControllerConfig {

 @Autowired
 ResourceUrlProvider resourceUrlProvider;

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

}

然后在頁面上通過下述代碼引用：

<script th:src="${urls.getForLookupPath('/mods/admin/login.js')}"></script>

此方法應適用于支持方法調用的所有模板引擎。

下面我們來看看具體的實現效果吧，前臺訪問后html頁面顯示為：

<script src="/mods/admin/login-96d770c87905659930c9786eaa08d710.js"></script>

注意：如果你的js文件沒有修改，或者修改沒重啟，MD5的值可能不會改變，當你重啟服務后你會看到你修改過后的文件MD5也隨之改變了。

簡單看了下源代碼，MD5的計算是通過 ContentVersionStrategy 這個類實現的。此VersionStrategy實現根據資源的內容計算MD5哈希值，并將其附加到文件名后面，也就是你不改變內容MD5值是不會變的哦，一度讓我以為這種方法有BUG(｡•ˇ‸ˇ•｡)。

第二種、版本號實現

同樣在application.yml或者application.properties中增加配置文件

spring: 
 resources:
 chain:
  strategy:
  fixed:
   enabled: true
   paths: /mods/admin/*.js
   version: 20181128

后續操作同上，此時我們看下頁面顯示的效果：

<script src="/20181128/mods/admin/login.js"></script>

在文件路徑的最前面增加了版本號，當我們每次修改只需要更新版本號的設置，客戶端就會自動請求最新的數據了。

同樣的看了下此VersionStrategy的實現是FixedVersionStrategy類，來使固定版本字符串作為資源路徑的前綴。

總結

相比其他方式的靜態資源控制，這種方式是我目前發現最簡便的了，尤其是在SpringBoot項目中的使用。在這兩種方式中，我更傾向于方法一的MD5方式，可以讓我們不必太過于關注靜態資源問題。當然上述講的兩個實現類，在傳統SpringMVC項目中也是有的，所以傳統項目也是可以使用的，具體的使用方法大家可以研究研究。

好了，以上就是這篇文章的全部內容了，希望本文的內容對大家的學習或者工作具有一定的參考學習價值，如果有疑問大家可以留言交流，謝謝大家對億速云的支持。