細說ASP.NET Core靜態文件的緩存方式


一、前言

  我們在優化Web服務的時候,對於靜態的資源文件,通常都是通過客戶端緩存服務器緩存CDN緩存,這三種方式來緩解客戶端對於Web服務器的連接請求壓力的。

  本文指在這三個方面,在ASP.NET Core中靜態文件的實現過程和使用方法進行闡述。當然也可以考慮使用反向代理的方式(例如IIS或Nginx),這些不是本文討論的內容。

  本文重點展示如何通過StaticFileMiddleware中間件,提高網站的性能。雖然這不是唯一緩存文件的方式,我們還可以通過ResponseCacheAttribute特性為ASP.NET Core Mvc的Controller和Action進行緩存的設置。

二、StaticFileMiddleware

  1.文件服務與默認緩存規則

  當創建一個ASP.NET Core的項目時,查看Startup.Configure方法,就會看到默認模板生成的添加StaticFileMiddleware中間件的方法。

public void Configure(IApplicationBuilder app)  
{
    // looging and exception handler removed for clarity

    app.UseStaticFiles();

    app.UseMvc(routes =>
    {
        routes.MapRoute(
            name: "default",
            template: "{controller=Home}/{action=Index}/{id?}");
    });
}

  這樣就使你的應用程序能夠處理,程序目錄下wwwroot目錄的靜態文件內容。在我們添加文件緩存之前,我們先要看一下StaticFileMiddleware默認的策略是怎么樣的。當第一次加載程序時,瀏覽器將打開頁面並下載所有的資源連接。假如頁面沒有錯誤返回都是正確那么就是返回文件數據和Http Status為200 -OK的狀態。

 

  然后我們看下這個Http請求對應的Response Header,這里會包含ETagLast-Modified兩個值。HTTP內容如下:

HTTP/1.1 200 OK  
Date: Sat, 15 Oct 2016 14:15:52 GMT  
Content-Type: image/svg+xml  
Last-Modified: Sat, 15 Oct 2016 13:43:34 GMT  
Accept-Ranges: bytes  
ETag: "1d226ea1f827703"  
Server: Kestrel  

  如果再次請求這個地址的話,瀏覽器將發送ETagLast-Modified的值到服務端,如果兩個值沒有變化,那么服務端會發送304狀態到瀏覽器,那么瀏覽器將使用之前的資源而不是重新下載一份。

   這樣就提高了,瀏覽器的響應性能,因為文件都緩存到了客戶端,並且通過304狀態,服務端與瀏覽器的請求流量得以減少。

  2.設置文件緩存時間

  當然我們都知道如果要設置某一請求的緩存,只需要設置Header為Cache-Control的值。那么在StaticFileMiddleware中間件中,我們怎么設置這個Header呢?

using Microsoft.Net.Http.Headers;

app.UseStaticFiles(new StaticFileOptions  
{
    OnPrepareResponse = ctx =>
    {
        const int durationInSeconds = 60 * 60 * 24;
        ctx.Context.Response.Headers[HeaderNames.CacheControl] =
            "public,max-age=" + durationInSeconds;
    }
});

 

  設置后每一個靜態文件的請求都會執行這個方法,包括200和304狀態的請求;而且在這個例子里瀏覽器會自動緩存這些文件24小時,但是在此期間並不會返回404狀態

  一旦max-age設置的時間過期,瀏覽器就不會再使用本地緩存,而去直接請求服務器端。這樣已經避免了一些額外的請求到服務器端了。如果我們在瀏覽器與服務器中間使用CDN緩存文件數據的話,這樣就算客戶端瀏覽器的緩存過期了,但是請求也不會到我們的服務器上,而是請求到CDN緩存服務器。

  下面我們看看文件緩存在ASP.NET Core中是如何判斷緩存失效的?.NET Core開源的代碼為我們提供了了解它的入口【代碼 Source Code】。核心代碼如下:

_length = _fileInfo.Length;
DateTimeOffset last = _fileInfo.LastModified;  
// Truncate to the second.
_lastModified = new DateTimeOffset(last.Year, last.Month, last.Day, last.Hour, last.Minute, last.Second, last.Offset).ToUniversalTime();
long etagHash = _lastModified.ToFileTime() ^ _length;  
_etag = new EntityTagHeaderValue('\"' + Convert.ToString(etagHash, 16) + '\"'); 

  服務器端如果檢測到文件改變就會返回200狀態給瀏覽器,如果沒有變化則返回304狀態給瀏覽器端。

  不幸的是,一旦我們添加了緩存,瀏覽器將不再向服務器發出請求。該文件可能已經完全改變或已被完全刪除,但如果瀏覽器不要求,服務器將不能通知瀏覽器重新發起無緩存的請求!

  3.為靜態文件提供版本號

  通常我們都使用形如https://localhost/js/site.js?v=1 這樣的地址來解決緩存的問題。通過給靜態文件生成唯一的版本號,做為QueryString進行請求時,服務器將重新輸出文件內容。

  在ASP.NET Core中Tag Hepers為我們提供了這樣的API:

<script src="~/js/site.js" asp-append-version="true"></script> 

  這段代碼最終在瀏覽器端會被渲染為如下Html代碼:

<script src="/js/site.js?v=Ynfdc1vuMNOWZfqTj4N3SPcebazoGXiIPgtfE-b2TO4"></script> 

  如果靜態文件發生改變,Tag Helper就是重新計算文件的哈希值,它采用 SHA256的哈希值。當然以前服務器緩存的文件版本也隨之失效了。這個asp-append-version Tag Helper可以支持Img、Script和Link元素。

  ASP.NET Core的源代碼我們來看看是怎么計算文件變化的:【源代碼 Source Code】 

 三、ASP.NET Core與CDN?

  我們在使用CDN時,因為還要進行開發任務,一般我們都要有兩套地址,一套是CDN上的文件地址,一套是本地調試開發用的地址。ASP.NET Core中也為我們提供了Tag Helper來解決這樣的問題。直接上代碼實例吧:

<link rel="stylesheet" href="//ajax.aspnetcdn.com/ajax/bootstrap/3.0.0/css/bootstrap.min.css"
      asp-fallback-href="~/lib/bootstrap/css/bootstrap.min.css"
      asp-fallback-test-class="hidden" 
      asp-fallback-test-property="visibility" 
      asp-fallback-test-value="hidden" />

<script src="//ajax.aspnetcdn.com/ajax/bootstrap/3.0.0/bootstrap.min.js"
        asp-fallback-src="~/lib/bootstrap/js/bootstrap.min.js"
        asp-fallback-test="window.jQuery">
</script>

  Tag Helper:asp-fallback-* 解決開發時使用的文件地址問題。 當然它也可以asp-append-version 兩個Tag Helper一起使用,這樣就實現了,在CDN文件緩存的同步問題。

四、寫在最后

  新的ASP.NET Core為我們提供了很多現有互聯網行業的解決方案,也給.NET開發人員引入了先進思想。

 

  GitHub:https://github.com/maxzhang1985/YOYOFx  如果覺還可以請Star下, 歡迎一起交流。

  

  .NET Core 和 YOYOFx 的交流群: 214741894  


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM