ASP.NET Core ResponseCache进行缓存操作

待我称王封你为后i 2021-07-04 14:14 385阅读 0赞

## 前言 ##

本章将介绍客户端缓存将介绍浏览器缓存和服务端缓存，使用浏览器缓存将减少对web服务器的请求次数，同时可以提升性能，避免重复的运算浪费。

ASP.NET Core对于HTTP缓存分为两种：

*  客户端(浏览器缓存)
 *  服务端缓存

## 客户端缓存 ##

通过设置HTTP的响应头 `Cache-Control` 来完成页面存储到浏览器缓存中如下所示：  
![客户端缓存示意图][20200801233339702.png]  
其实客户端缓存的话只需要进行设置 `ResponseCache` 特性就可以请看如下代码片段

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

![在这里插入图片描述][2020080315273455.png]

`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();
    }

**服务端缓存配置如下**

<table> 
 <thead> 
  <tr> 
   <th>属性</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>MaximumBodySize</code></td> 
   <td>响应正文的最大可缓存大小（以字节为单位）。 默认值为 64 * 1024 * 1024 （64 MB）。</td> 
  </tr> 
  <tr> 
   <td><code>SizeLimit</code></td> 
   <td>响应缓存中间件的大小限制（以字节为单位）。 默认值为 100 * 1024 * 1024 （100 MB）。</td> 
  </tr> 
  <tr> 
   <td><code>UseCaseSensitivePaths</code></td> 
   <td>确定是否将响应缓存在区分大小写的路径上。 默认值是 false。</td> 
  </tr> 
 </tbody> 
</table>

[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`不同。  
我们再看看如上代码效果  
![在这里插入图片描述][2020080317430056.gif]

## `ResponseCache`中间件使用的 `HTTP` 标头 ##

<table> 
 <thead> 
  <tr> 
   <th>响应头</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><code>Authorization</code></td> 
   <td>如果标头存在，则不会缓存。</td> 
  </tr> 
  <tr> 
   <td><code>Cache-Control</code></td> 
   <td>中间件仅考虑用 <code>public</code> 缓存指令标记的缓存响应。</td> 
  </tr> 
  <tr> 
   <td><code>Pragma</code></td> 
   <td>请求中的 <code>Pragma: no-cache</code> 标头将产生与 <code>Cache-Control: no-cache</code>相同的效果。 如果存在此标头，则由 <code>Cache-Control</code> 标头中的相关指令重写。 考虑向后兼容 <code>HTTP/1.0</code>。</td> 
  </tr> 
  <tr> 
   <td><code>Set-Cookie</code></td> 
   <td>如果标头存在，则不会缓存响应。 请求处理管道中设置一个或多个 <code>cookie</code> 的任何中间件会阻止响应缓存中间件缓存响应（例如，基于 <code>cookie</code> 的 <code>TempData</code> 提供程序）。</td> 
  </tr> 
  <tr> 
   <td><code>Vary</code></td> 
   <td><code>Vary</code> 标头用于根据另一个标头改变缓存的响应。 例如，通过编码来缓存响应，包括 <code>Vary: Accept-Encoding</code> 响应头，该响应头将缓存标头为 <code>Accept-Encoding: gzip</code> 和 <code>Accept-Encoding: text/plain</code> 的请求的响应。 永远不会存储响应头值为 <code>*</code> 的响应。</td> 
  </tr> 
  <tr> 
   <td><code>Expires</code></td> 
   <td>除非被其他 <code>Cache-Control</code> 标头重写，否则不会存储或检索此响应头过时的响应。</td> 
  </tr> 
  <tr> 
   <td><code>If-None-Match</code></td> 
   <td>如果值不为 <code>*</code>，响应的 <code>ETag</code> 与提供的任何值都不匹配，则将从缓存中提供完整响应。 否则，将提供304（未修改）响应。</td> 
  </tr> 
  <tr> 
   <td><code>If-Modified-Since</code></td> 
   <td>如果 <code>If-None-Match</code> 标头不存在，则在缓存的响应日期比提供的值更新时，将从缓存中提供完整响应。 否则，将提供304-未修改响应</td> 
  </tr> 
  <tr> 
   <td><code>Date</code></td> 
   <td>从缓存提供时，如果未在原始响应中提供，则中间件会设置 <code>Date</code> 标头。</td> 
  </tr> 
  <tr> 
   <td><code>Content-Length</code></td> 
   <td>从缓存提供时，如果未在原始响应中提供，则中间件会设置 <code>Content-Length</code> 标头。</td> 
  </tr> 
  <tr> 
   <td><code>Age</code></td> 
   <td>忽略原始响应中发送的 Age 标头。 中间件在为缓存的响应提供服务时计算一个新值。</td> 
  </tr> 
 </tbody> 
</table>

## 缓存条件 ##

*  请求必须导致服务器响应，状态代码为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`” 指令。

[20200801233339702.png]: /images/20210704/a57d2d81538941049fb8c60e438c2765.png
[2020080315273455.png]: /images/20210704/c758432653ea4a75a166387d5935a00f.png
[2020080317430056.gif]: /images/20210704/2667c8c09e7e4f06909f70fdd4fa56c1.png