ASP.NET Core快取靜態資源
背景
快取樣式表,JavaScript或影象檔案等靜態資源可以提高您網站的效能。在客戶端,總是從快取中載入一個靜態檔案,這樣可以減少對伺服器的請求數量,從而減少獲取頁面及其資源的時間。在伺服器端,由於它們的請求較少,伺服器可以處理更多的客戶端而無需升級硬體。
雖然快取是一件好事,但您必須確保客戶端始終執行最新版本的應用程式。當您部署下一個版本的網站時,您不希望客戶端使用過時的快取版本的檔案。
方案:
為確保使用者始終使用最新版本的檔案,我們必須為每個檔案版本提供一個唯一的URL。有很多策略:
- 使用查詢字串:
http://sample.com/file.js?v=123
- 重新命名檔案:
http://sample.com/file.123.js
- 建立一個目錄:
http://sample.com/123/file.js
ASP.NET Core提供了一種使用 TagHelper
來追加版本與查詢字串的機制。它支援以靜態資源為目標的最常見的HTML標籤:script
,link
和img
。所有你需要做的是在對應Html標籤中追加asp-append-version="true"
:
<link rel="stylesheet" href="~/css/site.css" asp-append-version="true" /><script src="~/js/site.js" asp-append-version="true"></script> <img src="~/images/banner1.svg" asp-append-version="true" />
在瀏覽器中的展現:
<link rel="stylesheet" href="/css/site.css?v=1wp5zz4e-mOPFx4X2O8seW_DmUtePn5xFJk1vB7JKRc" /> <script src="/js/site.js?v=EWaMeWsJBYWmL2g_KkgXZQ5nPe-a3Ichp0LEgzXczKo"></script> <img src="/images/banner1.svg?v=GaE_EmkeBf-yBbrJ26lpkGd4jkOSh1eVKJaNOw9I4uk" />
每個檔案都會有對應的V值,並存儲在一個IMemoryCache
檔案的URL現在是唯一的,並且會在檔案更改時更改,所以我們可以將快取頭新增到響應中,以指示客戶端檔案可以永久儲存在快取中
實踐
為了指示瀏覽器將檔案儲存在快取中,我們必須傳送Cache-control
標頭檔案和Expires
標頭檔案以實現HTTP/1.0
相容性。為了新增這些標頭檔案,我們使用了OnPrepareResponse
回撥函式StaticFilesOptions
。我們來修改這個Startup.cs
檔案:
public void Configure(IApplicationBuilder app, IHostingEnvironment env) { app.UseStaticFiles(new StaticFileOptions { OnPrepareResponse = context => { //快取一年 if (!string.IsNullOrEmpty(context.Context.Request.Query["v"])) { context.Context.Response.Headers.Add("cache-control", new[] { "public,max-age=31536000" }); context.Context.Response.Headers.Add("Expires", new[] { DateTime.UtcNow.AddYears(1).ToString("R") }); // Format RFC1123 } } }); app.UseMvc(routes => { routes.MapRoute( name: "default", template: "{controller=Home}/{action=Index}/{id?}"); }); }
可以檢視開發者控制檯,發現靜態資源都被快取:
如果不想快取某個靜態檔案,修改Startup.cs
檔案:
app.UseStaticFiles(new StaticFileOptions { OnPrepareResponse = context => { //快取一年 //以下操作是UseStaticFiles內部預設實現 if (!string.IsNullOrEmpty(context.Context.Request.Query["v"]))//資源新增asp-append-version="true"後v是查詢引數 { //context.Context.Response.Headers.Add("cache-control", new[] { "public,max-age=31536000" }); context.Context.Response.Headers.Add("cache-control", new[] { "public,no-cache" }); context.Context.Response.Headers.Add("Expires", new[] { DateTime.UtcNow.AddYears(1).ToString("R") }); // Format RFC1123 } } });
會發現無論怎麼重新整理,site.js?v=7mkNbU1tgQL1bUeZe3j2R151hKLhLDKO4BBaR-iqCy0檔案永遠都是重新請求,並沒有使用快取機制
結論
使用HTTP快取對於效能方面的原因(客戶端和伺服器端)非常重要。使用ASP.NET Core,您可以利用提供的功能TagHelpers
來生成版本控制的URL,並更改預設配置StaticFilesMiddleware為資源Urls
新增header的Cache-control屬性
。