.NetCore实现接口缓存的方法-创新互联

这篇文章将为大家详细讲解有关.NetCore实现接口缓存的方法，文章内容质量较高，因此小编分享给大家做个参考，希望大家阅读完这篇文章后对相关知识有一定的了解。

1、问题：我们平时做开发的时候肯定都有用到缓存这个功能，一般写法是在需要的业务代码里读取缓存、判断是否存在、不存在则读取数据库再设置缓存这样一个步骤。但是如果我们有很多地方业务都有用到缓存，我们就需要在每个地方都写关于缓存的代码，这样会造成很多重复代码，同时对业务侵入不利于后续的开发维护。

2、一般的解决办法是将缓存的功能提取出来，然后在需要用到缓存的地方调用即可。这样确实减少了很多重复代码，但这样还是会存在整个项目通用的缓存功能侵入业务代码，那我们有什么办法将缓存功能完全提取出来，达到业务代码零侵入呢？

3、既然我们缓存存的是接口的业务数据，那么为何我们不能直接把整个接口缓存起来呢，即将整个接口返回的数据缓存？同时要达到业务零侵入，那我们是不是想到了反射、特性呢？没错，我们使用的就是ActionFilterAttribute，关于ActionFilterAttribute无非就是OnActionExecuting（执行动作方法前触发）、OnActionExecuted（执行动作方法后触发）、OnResultExecuting（在执行操作结果之前触发）、OnResultExecuted（在执行操作结果之后触发）这四个方法，相信很多小伙伴都用到过，这里就不细说了。那我们现在的解决方案是：在OnActionExecuting（执行动作方法前触发）里判断是否存在缓存，如果存在则不去执行接口业务，直接返回数据。还有一个问题，一般接口都会有入参，入参不同输出的数据也不同（比如我有一个分页的接口，传的page参数不同，得到的结果也不同），这个怎么解决呢？我们只需要把接口所有参数拼凑起来，然后MD5加密成一个字符串，将其作为缓存的key，那么即使同一个接口、参数不同也会得到不同的key。

4、废话不多说，直接上代码。

public class ApiCache : ActionFilterAttribute
 {
  /// 

  /// Header是否参与缓存验证
  /// 
  public bool SignHeader = false;
  /// 

  /// 缓存有效时间（分钟）
  /// 
  public int CacheMinutes = 5;/// 

  /// 
  /// 
  /// Header是否参与请求体签名
  /// 缓存有效时间（分钟）
  public ApiCache(bool SignHeader = false, int CacheMinutes = 5)
  {
   this.SignHeader = SignHeader;
   this.CacheMinutes = CacheMinutes;
  }


  public override void OnActionExecuting(ActionExecutingContext filterContext)
  {
   //请求体签名
   string cacheKey = getKey(filterContext.HttpContext.Request);
   //根据签名查询缓存
   string data = CsRedisHepler.Get(cacheKey);
   if (!string.IsNullOrWhiteSpace(data))
   {
    //有缓存则设置返回信息
    var content = new Microsoft.AspNetCore.Mvc.ContentResult();
    content.Content = data;
    content.ContentType = "application/json; charset=utf-8";
    content.StatusCode = 200;
    filterContext.HttpContext.Response.Headers.Add("ContentType", "application/json; charset=utf-8");
    filterContext.HttpContext.Response.Headers.Add("CacheData", "Redis");
    filterContext.Result = content;
   }
  }

  public override void OnActionExecuted(ActionExecutedContext filterContext)
  {
   base.OnActionExecuted(filterContext);
  }

  public override void OnResultExecuting(ResultExecutingContext filterContext)
  {
   base.OnResultExecuting(filterContext);
  }

  public override void OnResultExecuted(ResultExecutedContext filterContext)
  {
   if (filterContext.HttpContext.Response.Headers.ContainsKey("CacheData")) return;
   //获取缓存key
   string cacheKey = getKey(filterContext.HttpContext.Request);
   var data = JsonSerializer.Serialize((filterContext.Result as Microsoft.AspNetCore.Mvc.ObjectResult).Value);
   //如果缓存null，则设置较短过期时间（此处是防止缓存穿透）
   var disData = JsonSerializer.Deserialize>(data);
   if(disData.ContainsKey("data") && disData["data"]==null)
   {
    CacheMinutes = 1;
   }
   CsRedisHepler.Set(cacheKey, data, TimeSpan.FromMinutes(CacheMinutes));
  }
  /// 

  /// 请求体MDH签名
  /// 
  /// 
  /// 
  private string getKey(HttpRequest request)
  {
   var keyContent = request.Host.Value + request.Path.Value + request.QueryString.Value + request.Method + request.ContentType + request.ContentLength;
   try
   {
    if (request.Method.ToUpper() != "DELETE" && request.Method.ToUpper() != "GET" && request.Form.Count > 0)
    {
     foreach (var item in request.Form)
     {
      keyContent += $"{item.Key}={item.Value.ToString()}";
     }
    }
   }
   catch (Exception e)
   {

   }
   if (SignHeader)
   {
    var hs = request.Headers.Where(a => !(new string[] { "Postman-Token", "User-Agent" }).Contains(a.Key)).ToDictionary(a => a);
    foreach (var item in hs)
    {
     keyContent += $"{item.Key}={item.Value.ToString()}";
    }
   }
　　　　　　　//md5加密
   return CryptographyHelper.MD5Hash(keyContent);
  }