.NetCore之接口緩存的實現(xiàn)示例
1、問題:我們平時做開發(fā)的時候肯定都有用到緩存這個功能,一般寫法是在需要的業(yè)務(wù)代碼里讀取緩存、判斷是否存在、不存在則讀取數(shù)據(jù)庫再設(shè)置緩存這樣一個步驟。但是如果我們有很多地方業(yè)務(wù)都有用到緩存,我們就需要在每個地方都寫關(guān)于緩存的代碼,這樣會造成很多重復(fù)代碼,同時對業(yè)務(wù)侵入不利于后續(xù)的開發(fā)維護。
2、一般的解決辦法是將緩存的功能提取出來,然后在需要用到緩存的地方調(diào)用即可。這樣確實減少了很多重復(fù)代碼,但這樣還是會存在整個項目通用的緩存功能侵入業(yè)務(wù)代碼,那我們有什么辦法將緩存功能完全提取出來,達到業(yè)務(wù)代碼零侵入呢?
3、既然我們緩存存的是接口的業(yè)務(wù)數(shù)據(jù),那么為何我們不能直接把整個接口緩存起來呢,即將整個接口返回的數(shù)據(jù)緩存?同時要達到業(yè)務(wù)零侵入,那我們是不是想到了反射、特性呢?沒錯,我們使用的就是ActionFilterAttribute,關(guān)于ActionFilterAttribute無非就是OnActionExecuting(執(zhí)行動作方法前觸發(fā))、OnActionExecuted(執(zhí)行動作方法后觸發(fā))、OnResultExecuting(在執(zhí)行操作結(jié)果之前觸發(fā))、OnResultExecuted(在執(zhí)行操作結(jié)果之后觸發(fā))這四個方法,相信很多小伙伴都用到過,這里就不細說了。那我們現(xiàn)在的解決方案是:在OnActionExecuting(執(zhí)行動作方法前觸發(fā))里判斷是否存在緩存,如果存在則不去執(zhí)行接口業(yè)務(wù),直接返回數(shù)據(jù)。還有一個問題,一般接口都會有入?yún)?,入?yún)⒉煌敵龅臄?shù)據(jù)也不同(比如我有一個分頁的接口,傳的page參數(shù)不同,得到的結(jié)果也不同),這個怎么解決呢?我們只需要把接口所有參數(shù)拼湊起來,然后MD5加密成一個字符串,將其作為緩存的key,那么即使同一個接口、參數(shù)不同也會得到不同的key。
4、廢話不多說,直接上代碼。
public class ApiCache : ActionFilterAttribute
{
/// <summary>
/// Header是否參與緩存驗證
/// </summary>
public bool SignHeader = false;
/// <summary>
/// 緩存有效時間(分鐘)
/// </summary>
public int CacheMinutes = 5;/// <summary>
///
/// </summary>
/// <param name="SignHeader">Header是否參與請求體簽名</param>
/// <param name="CacheMinutes">緩存有效時間(分鐘)</param>
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);
//根據(jù)簽名查詢緩存
string data = CsRedisHepler.Get(cacheKey);
if (!string.IsNullOrWhiteSpace(data))
{
//有緩存則設(shè)置返回信息
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,則設(shè)置較短過期時間(此處是防止緩存穿透)
var disData = JsonSerializer.Deserialize<Dictionary<string, object>>(data);
if(disData.ContainsKey("data") && disData["data"]==null)
{
CacheMinutes = 1;
}
CsRedisHepler.Set(cacheKey, data, TimeSpan.FromMinutes(CacheMinutes));
}
/// <summary>
/// 請求體MDH簽名
/// </summary>
/// <param name="request"></param>
/// <returns></returns>
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);
}
這里使用的是redis,也可以選擇其他的,代碼簡單沒有做適配,這樣我們只需要在用到緩存的接口上加上[ApiCache(CacheMinutes =1)]特性就行啦,關(guān)于參數(shù)的話也可以根據(jù)自己的業(yè)務(wù)需求來定制。
5、關(guān)于緩存的三座大山:緩存穿透、緩存擊穿、緩存雪崩,這塊網(wǎng)上有很多的資料可以看,這里只做一個簡單的介紹跟解決思路。
緩存穿透:訪問一個不存在的key時,請求會穿過緩存直接請求數(shù)據(jù)庫。比如現(xiàn)在有個接口是分頁的,然后客戶端請求接口的時候?qū)ageindex參數(shù)給的很大,大到該接口不可能有這么多頁的數(shù)據(jù)時,每次請求都會穿過緩存去查數(shù)據(jù)庫。如果有人故意攻擊接口就會給數(shù)據(jù)庫造成巨大壓力甚至掛掉。當然,這里我們肯定也要做一些業(yè)務(wù)參數(shù)的校驗,比如每頁條數(shù)不能超過多少之類的,總之不能輕信客戶端傳過來的參數(shù)。
解決方案:最簡單有效的解決方案是當在數(shù)據(jù)庫也查不到數(shù)據(jù)的時候,設(shè)置一個value為null的緩存值(該值的過期時間要盡量短),這樣就可以避免惡意攻擊。另外就是使用布隆過濾器。
我們這里使用的解決方案是第一種設(shè)置null值,在上述的代碼中有注釋。不過這里最好接口有一個返回規(guī)范,比如每個接口返回固定值:message、code、data這幾個字段, 那么我們只需判斷data是否為空來設(shè)置過期時間。
緩存擊穿:某一個訪問量極高的key過期,導(dǎo)致所有請求打在數(shù)據(jù)庫上。
解決方案:將訪問量高德key設(shè)置永不過期、使用互斥鎖。我們這里使用設(shè)置key永不過期就行,具體實現(xiàn)就是加一個是否過期的字段從外部傳入,再根據(jù)該字段判斷是否設(shè)置過期時間。同時可以寫一個定時任務(wù)去更新設(shè)置為永不過期的key值。
緩存雪崩:某一時刻多個高訪問量的key同時過期。
解決方案:在設(shè)置過期時間的時候?qū)⒚總€key的過期時間設(shè)置分布開來,在上述代碼中CacheMinutes字段改成過期時間范圍從。。。到。。。,然后key的過期時間從范圍中取一個隨機值。
當然這里講到的解決方案也只是個人常用的,也可以使用其他解決方案。
到此這篇關(guān)于.NetCore之接口緩存的文章就介紹到這了,更多相關(guān).NetCore之接口緩存內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
asp.net gridview中用checkbox全選的幾種實現(xiàn)的區(qū)別
這幾天為了改變客戶端grid的全選效率問題,詳細研究了ext中g(shù)rid的全選和gridview中通過腳本實現(xiàn)的全選效率,總結(jié)一下,供大家參考,有錯誤的地方,希望大俠指正,小弟獻丑了。2009-06-06
在GridView中LinkButton的屬性的應(yīng)用(如何不用選中就刪除這一行)
GridView中LinkButton的屬性的應(yīng)用,實現(xiàn)不用選中就刪除這一行2009-04-04
Linux上使用Docker部署ASP.NET?Core應(yīng)用程序
這篇文章介紹了使用Docker部署ASP.NET?Core應(yīng)用程序的方法,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2022-03-03
ASP.NET MVC 3仿Server.Transfer效果的實現(xiàn)方法
這篇文章主要介紹了ASP.NET MVC 3仿Server.Transfer效果的實現(xiàn)方法,需要的朋友可以參考下2015-10-10

