ASP.NET Core ResponseCache進行快取操作

前言

本章將介紹客戶端快取將介紹瀏覽器快取和服務端快取，使用瀏覽器快取將減少對web服務器的請求次數，同時可以提升性能，避免重復的運算浪費，

ASP.NET Core對于HTTP快取分為兩種：

• 客戶端(瀏覽器快取)
• 服務端快取

客戶端快取

通過設定HTTP的回應頭 Cache-Control 來完成頁面存盤到瀏覽器快取中如下所示：

其實客戶端快取的話只需要進行設定 ResponseCache 特性就可以請看如下代碼片段

[ResponseCache(Duration = 100,Location = ResponseCacheLocation.Client)]
public IActionResult Index()
{
      return View();
}

ResponseCacheAttribute 可應用于：

• Razor 頁面處理程式（類） – 特性不能應用于處理程式方法，
• MVC 控制器（類），
• MVC 操作（方法） – 方法級特性覆寫類級特性中指定的設定，

[ResponseCache] 引數

• Duration 設定快取的存盤時間(以秒為單位)，設定“Cache-control”中的“max-age”，
• Location
  • Any 快取在代理和客戶端，設定“Cache-control”標題為“public”，
  • Client 只快取在客戶端，設定“Cache-control”標題為“private”，
  • None 每次有請求發出時，快取會將請求發到服務器 ，服務器端會驗證請求中所描述的快取是否過期，若未過期（注：實際就是回傳304），則快取才使用本地快取副本， 報頭設定為“no-cache”，
• NoStore 快取中不得存盤任何關于客戶端請求和服務端回應的內容，每次由客戶端發起的請求都會下載完整的回應內容，
• VaryByHeader 使用vary頭有利于內容服務的動態多樣性，例如，使用Vary: User-Agent頭，快取服務器需要通過UA判斷是否使用快取的頁面，
• VaryByQueryKeys 可以按照相同頁面，不同的引數進行相應的存盤
• CacheProfileName 設定快取組態檔的值,可以通過設定不同的快取引數

CacheProfileName使用請看如下代碼片段

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllersWithViews(options =>
            {
                options.CacheProfiles.Add("default", new CacheProfile
                {
                    Duration = 60
                });

                options.CacheProfiles.Add("test", new CacheProfile
                {
                    Duration = 30
                });
            });
        }

上述代碼我們設定好了兩份不一樣的配置，那么我們就可以通過下面代碼片段進行使用了

    [ResponseCache(CacheProfileName = "default")]
    public IActionResult Index()
    {
         return View();
   }

服務端快取

服務端快取可以快取頁面資料和API資料，同時如果我們服務端存在資料，也就是快取命中的情況下，會直接從快取中取，不會再進入我們的方法，

        public void ConfigureServices(IServiceCollection services)
        {
              services.AddResponseCaching(options =>
            {
                options.UseCaseSensitivePaths = false;
                options.MaximumBodySize = 1024;
                options.SizeLimit = 100 * 1024*1024;
            });
        }

        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            app.UseResponseCaching();
        }
        

服務端快取配置如下

        [ResponseCache(Duration = 30, VaryByQueryKeys = new[] { "q" })]
        public IActionResult Index(int q)
        {
            _logger.LogWarning($"我是一個路徑：{HttpContext.Request.Host}");
            return View(model:DateTime.Now.ToString());
        }

VaryByQueryKeys

使用 MVC/web API 控制器或 Razor Pages 頁面模型時， [ResponseCache]屬性指定為回應快取設定適當的標頭所需的引數， 嚴格需要中間件的 [ResponseCache] 屬性的唯一引數 VaryByQueryKeys，這與實際 HTTP 標頭不對應， 有關詳細資訊，請參閱 回應快取在 ASP.NET Core，
如果不使用 [ResponseCache] 屬性，回應快取可能會與 VaryByQueryKeys不同，
我們再看看如上代碼效果

ResponseCache中間件使用的 HTTP 標頭

快取條件

• 請求必須導致服務器回應，狀態代碼為200（正常），
• 請求方法必須為 GET 或 HEAD，
• 在 Startup.Configure中，回應快取中間件必須置于需要快取的中間件之前，
• Authorization 標頭不得存在，
• Cache-Control 標頭引數必須是有效的，并且回應必須標記為 "public" 且未標記為 "private"，
• 如果 Cache-Control 標頭不存在，則 Pragma: no-cache 標頭不得存在，因為 Cache-Control 標頭在存在時將覆寫 Pragma 標頭，
• Set-Cookie 標頭不得存在，
• Vary 標頭引數必須有效且不等于 *，
• Content-Length 標頭值（如果已設定）必須與回應正文的大小匹配，
• 不使用 IHttpSendFileFeature，
• Expires 標頭和 max-age 和 s-maxage 快取指令指定的回應不能過時，
• 回應緩沖必須成功， 回應的大小必須小于配置的或默認 SizeLimit， 回應的正文大小必須小于配置的或默認的 MaximumBodySize，
• "請求" 或 "回應" 標頭欄位中不得存在 "no-store" 指令，

Reference

https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Caching_FAQ

https://docs.microsoft.com/en-us/aspnet/core/performance/caching/middleware?view=aspnetcore-3.1

https://github.com/hueifeng/BlogSample/tree/master/src/ResponseCachingDemo

標籤：.NET Core

上一篇：詳解Net Core Web Api專案與在NginX下發布

下一篇：asp.net core 3.x 授權默認流程