Response Caching Middleware (Phần mềm trung gian Cache phản hồi) trong ASP.NET Core

Bởi John Luo và Rick Anderson

Bài viết này giải thích cách cấu hình Response Caching Middleware trong ứng dụng ASP.NET Core. Middleware xác định khi nào response (phản hồi) có thể được cache (lưu vào bộ nhớ đệm), lưu trữ response, và phục vụ response từ cache. Để giới thiệu về HTTP caching và attribute [ResponseCache], xem Response Caching.

Response caching middleware (phần mềm trung gian cache phản hồi) cho phép cache response của server dựa trên HTTP Cache-Control headers.

• Hành vi caching thực hiện ngữ nghĩa HTTP caching chuẩn.
• Caching dựa trên HTTP cache headers tương tự phương pháp được dùng bởi proxy.
• Hình thức caching này hữu ích cho các public GET hoặc HEAD API request từ client khi điều kiện để cache được đáp ứng.
• Đối với ứng dụng UI như Razor Pages, response caching thường không có lợi. Các trình duyệt thường đặt request headers ngăn caching.

Output caching (có trong .NET 7 trở lên) là phương pháp tốt hơn cho ứng dụng UI. Trong kịch bản đó, cấu hình xác định những gì cần cache độc lập với HTTP headers.

Để kiểm thử response caching, dùng Fiddler hoặc công cụ khác có thể đặt request headers một cách rõ ràng. Việc đặt headers rõ ràng là ưu tiên cho việc kiểm thử caching.

Cấu hình

Trong Program.cs, thêm Response Caching Middleware services AddResponseCaching vào service collection và cấu hình ứng dụng sử dụng middleware với extension method UseResponseCaching. UseResponseCaching thêm middleware vào request processing pipeline:

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddResponseCaching();

var app = builder.Build();

app.UseHttpsRedirection();

// UseCors phải được gọi trước UseResponseCaching
//app.UseCors();

app.UseResponseCaching();

Ứng dụng mẫu thêm headers để kiểm soát caching trên các request tiếp theo:

• Cache-Control: Cache các response có thể cache trong tối đa 10 giây.
• Vary: Cấu hình middleware phục vụ cached response chỉ khi header Accept-Encoding của các request tiếp theo khớp với request gốc.

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddResponseCaching();

var app = builder.Build();

app.UseHttpsRedirection();

// UseCors phải được gọi trước UseResponseCaching
//app.UseCors();

app.UseResponseCaching();

app.Use(async (context, next) =>
{
    context.Response.GetTypedHeaders().CacheControl =
        new Microsoft.Net.Http.Headers.CacheControlHeaderValue()
        {
            Public = true,
            MaxAge = TimeSpan.FromSeconds(10)
        };
    context.Response.Headers[Microsoft.Net.Http.Headers.HeaderNames.Vary] =
        new string[] { "Accept-Encoding" };

    await next();
});

app.MapGet("/", () => DateTime.Now.Millisecond);

app.Run();

Các headers trên không được ghi vào response và bị ghi đè khi controller, action, hoặc Razor Page:

• Có attribute [ResponseCache]. Điều này áp dụng ngay cả khi property không được đặt. Ví dụ, bỏ qua property VaryByHeader sẽ khiến header tương ứng bị xóa khỏi response.

Response Caching Middleware chỉ cache response của server với status code 200 (OK). Các response khác, bao gồm error pages (trang lỗi), đều bị middleware bỏ qua.

Tùy chọn

Các tùy chọn response caching được hiển thị trong bảng sau.

Ví dụ sau cấu hình middleware để:

• Cache các response với body size nhỏ hơn hoặc bằng 1.024 bytes.
• Lưu trữ các response theo path phân biệt chữ hoa/thường. Ví dụ, /page1 và /Page1 được lưu riêng biệt.

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddResponseCaching(options =>
{
    options.MaximumBodySize = 1024;
    options.UseCaseSensitivePaths = true;
});

var app = builder.Build();

app.UseHttpsRedirection();

// UseCors phải được gọi trước UseResponseCaching
//app.UseCors();

app.UseResponseCaching();

app.Use(async (context, next) =>
{
    context.Response.GetTypedHeaders().CacheControl =
        new Microsoft.Net.Http.Headers.CacheControlHeaderValue()
        {
            Public = true,
            MaxAge = TimeSpan.FromSeconds(10)
        };
    context.Response.Headers[Microsoft.Net.Http.Headers.HeaderNames.Vary] =
        new string[] { "Accept-Encoding" };

    await next(context);
});

app.MapGet("/", () => DateTime.Now.Millisecond);

app.Run();

VaryByQueryKeys

Khi dùng MVC, web API controllers, hoặc Razor Pages page models, attribute [ResponseCache] chỉ định các tham số cần thiết để đặt headers thích hợp cho response caching. Tham số duy nhất của attribute [ResponseCache] thực sự yêu cầu middleware là VaryByQueryKeys, không tương ứng với HTTP header thực tế.

Khi không dùng attribute [ResponseCache], response caching có thể biến đổi với VaryByQueryKeys. Dùng ResponseCachingFeature trực tiếp từ HttpContext.Features:

var responseCachingFeature = context.HttpContext.Features.Get<IResponseCachingFeature>();

if (responseCachingFeature != null)
{
    responseCachingFeature.VaryByQueryKeys = new[] { "MyKey" };
}

Dùng giá trị duy nhất * trong VaryByQueryKeys sẽ biến đổi cache theo tất cả các query parameter (tham số truy vấn) của request.

HTTP headers được dùng bởi Response Caching Middleware

Bảng sau cung cấp thông tin về HTTP headers ảnh hưởng đến response caching.

Caching tuân theo Cache-Control directives của request

Middleware tuân theo các quy tắc của RFC 9111: HTTP Caching (Section 5.2. Cache-Control). Các quy tắc yêu cầu cache phải tôn trọng header Cache-Control hợp lệ được gửi bởi client. Theo specification (đặc tả), client có thể thực hiện request với giá trị header no-cache và buộc server tạo response mới cho mỗi request. Hiện tại, không có developer control (kiểm soát của nhà phát triển) nào đối với hành vi caching này khi sử dụng middleware vì middleware tuân theo specification caching chính thức.

Để kiểm soát hành vi caching nhiều hơn, hãy khám phá các tính năng caching khác của ASP.NET Core:

• Cache in-memory trong ASP.NET Core
• Distributed caching trong ASP.NET Core
• Cache Tag Helper trong ASP.NET Core MVC
• Distributed Cache Tag Helper trong ASP.NET Core

Xử lý sự cố

Response Caching Middleware dùng IMemoryCache, có dung lượng giới hạn. Khi dung lượng bị vượt quá, memory cache sẽ được compact (nén).

Nếu hành vi caching không như mong đợi, hãy xác nhận rằng các response có thể được cache và có khả năng được phục vụ từ cache. Kiểm tra các incoming headers của request và outgoing headers của response. Bật logging (ghi nhật ký) để hỗ trợ debug.

Khi kiểm thử và xử lý sự cố hành vi caching, trình duyệt thường đặt request headers ngăn caching. Ví dụ, trình duyệt có thể đặt header Cache-Control thành no-cache hoặc max-age=0 khi làm mới trang. Fiddler và các công cụ khác có thể đặt request headers một cách rõ ràng và được ưu tiên để kiểm thử caching.

Điều kiện để cache

• Request phải dẫn đến response của server với status code 200 (OK).
• Request method phải là GET hoặc HEAD.
• Response Caching Middleware phải được đặt trước middleware yêu cầu caching. Xem thêm ASP.NET Core Middleware.
• Header Authorization không được có.
• Tham số header Cache-Control phải hợp lệ, và response phải được đánh dấu public và không đánh dấu private.
• Header Pragma: no-cache không được có nếu header Cache-Control không có, vì header Cache-Control ghi đè header Pragma khi có.
• Header Set-Cookie không được có.
• Tham số header Vary phải hợp lệ và không bằng *.
• Giá trị header Content-Length (nếu được đặt) phải khớp với kích thước của response body.
• IHttpSendFileFeature không được sử dụng.
• Response không được cũ theo quy định của header Expires và các cache directive max-age và s-maxage.
• Response buffering phải thành công. Kích thước của response phải nhỏ hơn SizeLimit đã cấu hình hoặc mặc định. Body size của response phải nhỏ hơn MaximumBodySize đã cấu hình hoặc mặc định.
• Response phải có thể cache theo RFC 9111: HTTP Caching. Ví dụ, directive no-store không được có trong request hoặc response header fields.