Response Caching Middleware in ASP.NET Core

通过在ASP.NET Core应用中配置 Response Caching Middleware ，决定什么时候 response 是可以缓存，存储response,和从缓存中提供response 服务。

一.Package

需要引用的 Microsoft.AspNetCore.App，或者添加Microsoft.AspNetCore.ResponseCaching包

二.Configuration

在Startup.ConfigureServices中，添加中间件到service collection.

public void ConfigureServices(IServiceCollection services){    services.Configure
     
      (options =>    {        options.CheckConsentNeeded = context => true;        options.MinimumSameSitePolicy = SameSiteMode.None;    });    services.AddResponseCaching();    services.AddMvc()        .SetCompatibilityVersion(CompatibilityVersion.Version_2_1);}

配置应用通过UseResponseCaching扩展方法使用中间件，它增加中间件到请求处理管道。

这个示例应用增加了一个Cache-Control头到response,应用缓存可缓存的responses长达10秒。

示例发送一个Vary头来配置中间件，提供一个缓存的response,只有当随后请求的Accept-Encoding头匹配原始请求的Accept-Encoding.

在随后的代码例子中，CacheControlHeaderValue和HeaderNames要求一个有用状态，对于MIcrosoft.Net.Http.Headers命名空间。

public void Configure(IApplicationBuilder app, IHostingEnvironment env){    if (env.IsDevelopment())    {        app.UseDeveloperExceptionPage();    }    else    {        app.UseExceptionHandler("/Error");        app.UseHsts();    }    app.UseHttpsRedirection();    app.UseStaticFiles();    app.UseCookiePolicy();    app.UseResponseCaching();    app.Use(async (context, next) =>    {        // For GetTypedHeaders, add: using Microsoft.AspNetCore.Http;        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.UseMvc();}

Response Caching Middleware仅仅缓存返回的状态码为200的server responses。

任何其他的responses,包括error pages(错误页),都会被中间件忽视。

警告：包含认证客户端的Responses必须被标记为不可缓存来防止中间件存储和提供那些响应。

三.Options

中间件提供了三个options（选项）来控制resonse caching.

下面例子中配置中间件为：

缓存响应小于等于1024字节

存储响应时区分路径大小写(例如, /page1和/Page1被分开存储)

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

四.VaryByQueryKeys

当使用MVC/Web API控制器或者Razor Pages page models,这些ResponseCache属性会指定必要的参数,来为response caching设置合适的头.

唯一要求中间件的ResponseCache属性是VaryByQueryKeys, VaryByQueryKeys不会回应一个真实的HTTP头。

当不使用ResponseCache属性时，response caching 可以随着VaryByQueryKeys的功能变化。

直接使用来自HttpContext的IFeatureCollection的ResponseCachingFeature :

var responseCachingFeature = context.HttpContext.Features.Get
     
      ();if (responseCachingFeature != null){    responseCachingFeature.VaryByQueryKeys = new[] { "MyKey" };}

在VaryByQueryKeys中，使用一个等于 * 的单独的值，会随着所有request query parameters 而改变cache的值。