.NET Core教程--給API加一個服務端快取啦
摘要：
.NET Core教程--給API加一個服務端快取啦
以前給API介面寫快取基本都是這樣寫程式碼:
// redis key
var bookRedisKey = ConstRedisKey.RecommendationBooks.CopyOne(bookId);
// 獲取快取資料...
.NET Core教程--給API加一個服務端快取啦
以前給API介面寫快取基本都是這樣寫程式碼:
// redis key
var bookRedisKey = ConstRedisKey.RecommendationBooks.CopyOne(bookId);
// 獲取快取資料
var cacheBookIds = _redisService.ReadCache<List<string>>(bookRedisKey);
if (cacheBookIds != null)
{
// return
}
else
{
// 執行另外的邏輯獲取資料, 然後寫入快取
}
然後把這一坨坨程式碼都散落在每個地方。
某一天，突然想起我這邊的快取基本時間都差不多，而且都是給Web API用的，
直接在API層支援快取不就完事了。
所以， 這裡用什麼來做呢。
在.NET Core Web API這裡的話, 兩種思路:Middleware 或者ActionFilter.
不瞭解的同學可以看下面的文件:
ASP.NET Core 中文文件 第四章 MVC（4.3）過濾器
ASP.NET Core 中文文件 第三章 原理（2）中介軟體
基於我這邊只是部分介面支援快取的話, 直接還是用ActionFilter實現就可以.
沒撒說的, 直接上程式碼.
using System;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.Filters;
using Newtonsoft.Json.Linq;
namespace XXXAPI.Filters
{
public class DefaultCacheFilterAttribute : ActionFilterAttribute
{
// 這個時間用於給子類重寫,實現不同時間級別的快取
protected TimeSpan _expireTime;
// redis讀寫的類,沒撒看的
private readonly RedisService _redisService;
public DefaultCacheFilterAttribute(RedisService redisService)
{
_redisService = redisService;
}
public override void OnActionExecuting(ActionExecutingContext context)
{
if (context.HttpContext.Request.Query.ContainsKey("refresh"))
{
return;
}
KeyConfig redisKey = GetRequestRedisKey(context.HttpContext);
var redisCache = _redisService.ReadCache<JToken>(redisKey);
if (redisCache != null)
{
context.Result = new ObjectResult(redisCache);
}
return;
}
public override void OnActionExecuted(ActionExecutedContext context)
{
KeyConfig redisKey = GetRequestRedisKey(context.HttpContext);
var objResult = (ObjectResult)context.Result;
if (objResult == null)
{
return;
}
var jToken = JToken.FromObject(objResult.Value);
_redisService.WriteCache(redisKey, jToken);
}
private KeyConfig GetRequestRedisKey(HttpContext httpContext)
{
var requestPath = httpContext.Request.Path.Value;
if (!string.IsNullOrEmpty(httpContext.Request.QueryString.Value))
{
requestPath = requestPath + httpContext.Request.QueryString.Value;
}
if (httpContext.Request.Query.ContainsKey("refresh"))
{
if (httpContext.Request.Query.Count == 1)
{
requestPath = requestPath.Replace("?refresh=true", "");
}
else
{
requestPath = requestPath.Replace("refresh=true", "");
}
}
// 這裡也就一個redis key的類
var redisKey = ConstRedisKey.HTTPRequest.CopyOne(requestPath);
if (_expireTime != default(TimeSpan))
{
redisKey.ExpireTime = _expireTime;
}
return redisKey;
}
}
public static class ConstRedisKey
{
public readonly static KeyConfig HTTPRequest = new KeyConfig()
{
Key = "lemon_req_",
ExpireTime = new TimeSpan(TimeSpan.TicksPerMinute * 30),
DBName = 5
};
}
public class KeyConfig
{
public string Key { get; set; }
public TimeSpan ExpireTime { get; set; }
public int DBName { get; set; }
public KeyConfig CopyOne(string state)
{
var one = new KeyConfig();
one.DBName = this.DBName;
one.Key = !string.IsNullOrEmpty(this.Key) ? this.Key + state : state;
one.ExpireTime = this.ExpireTime;
return one;
}
}
}
然後使用的地方, 直接給Controller的Action方法加上註解即可.
如:
[HttpGet("v1/xxx/latest")]
[ServiceFilter(typeof(DefaultCacheFilterAttribute))]
public IActionResult GetLatestList([FromQuery] int page = 0, [FromQuery]int pageSize = 30)
{
return Ok(new
{
data = _service.LoadLatest(page, pageSize),
code = 0
});
}
完事...
哦, 記得在Startup.cs注入 DefaultCacheFilterAttribute.
這個注入就不用我來寫的吧.
美中不足的地方在於暫時還不知道怎麼直接在註解上面支援自定義快取時間,
湊合先用了.
完結, 拜.....