系列導航及源代碼

需求

有的時候為了减少客戶端請求相同資源的邏輯重複執行,我們會考慮使用一些緩存的方式,在.NET 6中,我們可以借助框架提供的中間件來實現請求資源的緩存。

目標

實現請求結果的緩存。

原理與思路

對於在.NET6中實現緩存,我們可以使用響應緩存中間件ResponseCaching來實現,同時可以使用Marvin.Cache.Headers來為我們提供更多的緩存相關的屬性。

實現

使用原生ResponseCaching實現緩存

既然是中間件,我們便在Program中引入:

  • Program.cs
// 省略其他...
// 配置緩存中間件
builder.Services.AddResponseCaching();
builder.Services.AddControllers();
// ...
// 使用緩存中間件
app.UseResponseCaching();
app.MapControllers();

在使用方法上,有幾種方式可以實現配置:1)進行全局的配置,應用於所有添加了相同ProfileNameResponseCache的Controller響應;2)對單個Controller/Action進行配置,應用於當前作用的Controller/Action;3)全局配置後,由單個Controller/Action覆蓋全局配置。我們會演示1)和3)的場景。

我們准備使用獲取所有TodoLists的接口進行演示。

先看如何進行全局配置:

  • Program.cs
// 省略其他...
builder.Services.AddControllers(options =>
{
options.CacheProfiles.Add("60SecondDuration", new CacheProfile { Duration = 60 });
});

驗證1: 全局配置Caching

首先給我們要進行驗證的Action添加屬性:

  • TodoListController.cs
// 省略其他...
[HttpGet]
[ResponseCache(CacheProfileName = "60SecondDuration")]
public async Task<ApiResponse<List<TodoListBriefDto>>> Get()
{
return ApiResponse<List<TodoListBriefDto>>.Success(await _mediator.Send(new GetTodosQuery()));
}

啟動Api項目,第一次執行獲取TodoLists的請求:

  • 請求

  • 響應



    響應頭中多了一個cache-control字段用於指明緩存的類型(public)以及過期時間為60s:



    如果你是使用Postman或者Insomia發送的請求,那麼在過期前再次發起相同請求的返回頭中會再多出一個Age字段,用於錶明該資源當前緩存了多少秒(Hoppscotch我沒找到可以在哪裏設置,所以下面的截圖是來自Insomia,如果有哪比特老哥知道的可以教一下):



    同時如果觀察日志的話會發現,第二次請求並沒有實際執行SQL語句,這也證明了第二次請求的返回來自緩存:



    如果間隔60s以上我們再去發送相同的請求,會發現日志中是這樣的:



    可以看到緩存已經失效了,此時需要重新向數據庫查詢返回數據,並將這次請求結果緩存起來。

驗證2: 單個Action覆蓋全局配置

我們還是使用這個接口,但是修改一下屬性:

  • TodoListController.cs
[HttpGet]
[ResponseCache(Duration = 120)]
public async Task<ApiResponse<List<TodoListBriefDto>>> Get()
{
return ApiResponse<List<TodoListBriefDto>>.Success(await _mediator.Send(new GetTodosQuery()));
}

重新啟動Api項目,第一次執行獲取TodoLists的請求,請求和驗證1相同,我們來看響應中的變化:

  • 響應



    可以看到失效時間已經變為120s了,其他不再一一驗證。

使用Marvin.Cache.Headers實現更多緩存功能

在緩存中還有一個問題是,如果判斷緩存的數據內容已經變化,就需要去獲取最新的響應而不是直接從緩存中取值。這是借助緩存校驗來完成的,而常使用的方式是通過Etag實現。示意的過程如下:

如果首次請求資源,API會在響應頭中添加EtagLast-Modified字段:

當客戶端再次請求資源時,由於緩存自身是不知道資源有沒有被修改,所以緩存會攜帶If-None-Match字段(和客戶端收到的Etag值相等)和If-Modified-Since字段(和客戶端收到的Last-Modified值相等)到API端,如果校驗發現資源沒有發生修改,那麼API端無需重新獲取資源,直接返回304字段(NotModifed)給緩存,緩存給客戶端返回值。如果校驗發現資源發生了修改,那麼API將會返回新的結果。

我們給Api項目添加Nuget包Marvin.Cache.Headers,來實現此功能。

首先向Program中添加服務以及引入中間件:

  • Program.cs
builder.Services.AddResponseCaching();
builder.Services.AddHttpCacheHeaders(
expirationOptions =>
{
expirationOptions.MaxAge = 180;
expirationOptions.CacheLocation = CacheLocation.Private;
},
validateOptions =>
{
validateOptions.MustRevalidate = true;
});
// 省略其他...
app.UseResponseCaching();
app.UseHttpCacheHeaders();

同時我們需要移除之前添加的ResponseCache屬性,因為新引入的庫已經幫我們完成了,當然我們也可以通過以下方式覆蓋全局配置:

[HttpCacheExpiration(CacheLocation = CacheLocation.Public, MaxAge = 60)]
[HttpCacheValidation(MustRevalidate = false)]

覆蓋規則和框架內置的規則是一致的,我不會繼續演示。

驗證3: 緩存校驗

請求仍然是獲取所有的TodoLists

  • 響應

    我們暫時只關注響應頭:



    如果在緩存失效前我們添加了一個新的TodoList,在請求頭中添加If-None-Match=53154EEFAE230D733827DBDE49B42AF9再執行獲取請求:



    可以看到在失效時間到期之內,Etag值已經發生了變化,校驗錶明資源已經改變,需要重新獲取。

    如果我們再次獲取相同的資源,會得到304返回:

一點擴展

但是如果我們仔細觀察和思考就會發現,框架在實現緩存校驗上存在兩個問題:

  1. If-None-Match頭字段是我們手動添加模擬的,這本應該由緩存中間件來完成;
  2. 在響應304的情况下,實際上是沒有返回響應體的,即緩存中未修改的資源沒有返回;

這兩個問題是由框架內建的ResponseCaching庫導致的,可以認為它沒有正確地實現緩存校驗機制。為此我們有一些替代方案可供參考:

Varnish

Apache Traffic Server

Squid

當然使用專門的CDN來做緩存也是可以的。

總結

在本文中我們主要演示了如何借助框架的緩存機制來實現請求資源的緩存,盡管在緩存校驗的實現上,官方提供的庫目前來看並沒有能很好地完成功能以外,對於我們基本的使用場景來說已經够用了。下一篇文章我們來看怎麼實現接口的限流。

參考資料

  1. Varnish
  2. Apache Traffic Server
  3. Squid

使用.NET 6開發TodoList應用(22)——實現緩存的更多相關文章

  1. 使用.NET 6開發TodoList應用(3)——引入第三方日志庫

    需求 在我們項目開發的過程中,使用.NET 6自帶的日志系統有時是不能滿足實際需求的,比如有的時候我們需要將日志輸出到第三方平臺上,最典型的應用就是在各種雲平臺上,為了集中管理日志和查詢日志,通常會選 ...

  2. 使用.NET 6開發TodoList應用(1)——系列背景

    前言 想到要寫這樣一個系列博客,初衷有兩個:一是希望通過一個實踐項目,將.NET 6 WebAPI開發的基礎知識串聯起來,幫助那些想要入門.NET 6服務端開發的朋友們快速上手,對使用.NET 6開發 ...

  3. 使用.NET 6開發TodoList應用(2)——項目結構搭建

    為了不影響閱讀的體驗,我把系列導航放到文章最後了,有需要的小夥伴可以直接通過導航跳轉到對應的文章 : P TodoList需求簡介 首先明確一下我們即將開發的這個TodoList應用都需要完成什麼功能 ...

  4. 使用.NET 6開發TodoList應用(4)——引入數據存儲

    需求 作為後端CRUD程序員(bushi,數據存儲是開發後端服務一個非常重要的組件.對我們的TodoList項目來說,自然也需要配置數據存儲.目前的需求很簡單: 需要能持久化TodoList對象並對其 ...

  5. 使用.NET 6開發TodoList應用(5)——領域實體創建

    需求 上一篇文章中我們完成了數據存儲服務的接入,從這一篇開始將正式進入業務邏輯部分的開發. 首先要定義和解决的問題是,根據TodoList項目的需求,我們應該設計怎樣的數據實體,如何去進行操作? 長文 ...

  6. 使用.NET 6開發TodoList應用(5.1)——實現Repository模式

    需求 經常寫CRUD程序的小夥伴們可能都經曆過定義很多Repository接口,分別做對應的實現,依賴注入並使用的場景.有的時候會發現,很多分散的XXXXRepository的邏輯都是基本一致的,於是 ...

  7. 使用.NET 6開發TodoList應用(6)——使用MediatR實現POST請求

    需求 需求很簡單:如何創建新的TodoList和TodoItem並持久化. 初學者按照教程去實現的話,應該分成以下幾步:創建Controller並實現POST方法:實用傳入的請求參數new一個數據庫實 ...

  8. 使用.NET 6開發TodoList應用文章索引

    系列導航 使用.NET 6開發TodoList應用(1)--系列背景 使用.NET 6開發TodoList應用(2)--項目結構搭建 使用.NET 6開發TodoList應用(3)--引入第三方日志 ...

  9. iOS移動開發周報-第22期

    iOS移動開發周報-第22期 [摘要]:本期iOS移動開發周報帶來如下內容:蘋果股價創新高,iOS8自動調整UITableView布局,Swift學習心得等. 新聞 <蘋果股價創新高 市值全球第 ...

  10. 使用.NET 6開發TodoList應用(7)——使用AutoMapper實現GET請求

    系列導航 使用.NET 6開發TodoList應用文章索引 需求 需求很簡單:實現GET請求獲取業務數據.在這個階段我們經常使用的類庫是AutoMapper. 目標 合理組織並使用AutoMapper ...

隨機推薦

  1. (轉)libcurl應用:如何把下載內容寫入內存

    libcurl應用:如何把下載內容寫入內存 2008-01-13 00:32:52|  分類: 默認分類 |舉報 |字號 訂閱   libcurl的文檔中有 getinmemory.c這個例子,把下載 ...

  2. 詳細解析Java中抽象類和接口的區別

    在Java語言中, abstract class 和interface 是支持抽象類定 義的兩種機制.正是由於這兩種機制的存在,才賦予了Java强大的 面向對象能力.abstract class和in ...

  3. 素數槽csuoj

    超時代碼: #include <iostream> using namespace std;//寫一個函數判斷是否是素數bool isPrime(int num){int i=2;//co ...

  4. Node.js安裝和配置

    今天有時間開始要研究Node.js了,項目的需要,先把環境正好,初次接觸,把安裝和配置過程記錄下來,以備不時之需.言歸正傳. 1.打開NodeJS的官網,下載和自己系統相配的NodeJS的安裝程序,包 ...

  5. lnk後綴名打開方式

    老娘栽了兩次!! 前段時間,設計把設計圖發給我,竟然是個後綴"exe"的文件,選擇打開方式的時候忘記取消下圖勾選: 結果懵逼了... 在網上找了個方法: 1.打開電腦"運 ...

  6. Linux命令的學習

    mkdir -p 創建目錄 (make directorys) p遞歸創建 ls -l(long)d(direcitory)顯示目錄或者文件 cd 切換目錄  從"/"開始目錄,/ ...

  7. Android手機客戶端測試點(全)

    網上看到一個整理比較完善的手機客戶端測試:

  8. websocket的理解及實例應用

    websocket協議是HTML5提出的一個新的規範,主要用於實現服務器及時推送信息給客戶端的功能. websocket實現是基於HTTP協議的部分握手功能,但是websocket僅僅握手一次即可進行 ...

  9. Android必知必會-App 常用圖標尺寸規範匯總

    若移動端訪問不佳,請使用 –> Github版 內容持續更新中,更新日期:2016-08-11 1. 程序啟動圖標(icon launcher) 放在mipmap-*dpi下,文件名為ic_la ...

  10. 期末架構-Centos7

    00--linux運維架構演變過程 01--老男孩教育-CentOS6和7 01-筆記 安裝系統 系統下載地址:http://mirrors.aliyun.com/centos/7/isos/x86_ ...