本文所需的一些預備知識可以看這里: http://www.cnblogs.com/cgzl/p/9010978.html 和 http://www.cnblogs.com/cgzl/p/9019314.html
建立Richardson成熟度2級的POST、GET、PUT、PATCH、DELETE的RESTful API請看這里:https://www.cnblogs.com/cgzl/p/9047626.html 和 https://www.cnblogs.com/cgzl/p/9080960.html 和 https://www.cnblogs.com/cgzl/p/9117448.html
HATEOAS:https://www.cnblogs.com/cgzl/p/9153749.html。
本文介紹緩存和並發,無需看前邊文章也能明白吧。
本文所需的練習代碼(右鍵另存,后綴改為zip):https://images2018.cnblogs.com/blog/986268/201806/986268-20180611132306164-388387828.jpg
緩存
根據REST約束:“每個響應都應該定義它自己是否可以被緩存”。本文就要介紹如何保證HTTP響應是可被緩存的,這里就要用到HTTP緩存的知識,HTTP緩存是HTTP標准的一部分(RFC 2616, RFC 7234)。
"除非性能可以得到很大的提升,否則用緩存是沒啥用的。HTTP/1.1里緩存的目標就是在很多場景中可以避免發送請求,在其他情況下避免返回完整的響應"。
針對避免發送請求的數量這一點,緩存使用了過期機制。
針對避免返回完整響應這點,緩存采用了驗證機制。
緩存是什么?
緩存是一個獨立的組件,存在於API和API消費者之間。
緩存接收API消費者的請求,並把請求發送給API;
緩存還從API接收響應並且如果響應是可緩存的就會把響應保存起來,並把響應返回給API的消費者。如果同一個請求再次發送,那么緩存就可能會吧保存的響應返回給API消費者。
緩存可以看作是請求--響應通訊機制的中間人。
HTTP里面有三種緩存:
- 客戶端緩存/瀏覽器緩存,它存在於客戶端,並且是私有的(因為它不會與其它客戶端共享)。
- 網關緩存,它是共享的緩存,位於服務器端,所有的API消費者客戶端都會共享這個緩存。它的別名還有反向代理服務器緩存,HTTP加速器等。
- 代理緩存,它位於網絡上,共享的,它既不位於API消費者客戶端,也不在API服務器上,它在網絡的其它地方。這種緩存經常被大型企業或ISP使用,用來服務大規模的用戶。(這個不介紹了,我不會)
過期模型
過期模型讓服務器可以聲明請求的資源也就是響應信息能保持多長時間是“新鮮”的狀態。緩存可以存儲這個響應,所以后續的請求可以由緩存來響應,只要緩存是“新鮮”的。處於這個目的,需要使用兩個Response Headers:
Expires Header,它包含一個HTTP日期,該日期表述了響應會在什么時間過期,例如:Expires: Mon, 11 Jun 2018 13:55:41 GMT。但是它可能會存在一些同步問題,所以要求緩存和服務器的時間是保持一致的。它對響應的類型、時間、地點的控制很有限,因為這些東西都是由cache-control這個Header來控制和限制的。
Cache-Control Header,例如Cache-Control: public, max-age=60,這個Header里包含兩個指令public和max-age。max-age表明了響應可以被緩存60秒,所以時鍾同步就不是問題了;而public則表示它可以被共享和私有的緩存所緩存。所以說服務器可以決定響應是否允許被網關緩存或代理緩存所緩存。對於過期模型,優先考慮使用Cache-Control這個Header。Cache-Control還有很多其它的指令,常見的幾個可以在ASP.NET Core官網上看:https://docs.microsoft.com/en-us/aspnet/core/performance/caching/response?view=aspnetcore-2.1#http-based-response-caching
過期模型的工作原理,看下面的例子:
這里的Cache 緩存可以是私有的也可以是共享的。
客戶端程序發送請求 GET countries,這時還沒有緩存版本的響應,所以緩存會繼續把請求發送到API服務器;然后API返回響應給緩存,響應里面包含了Cache-Control這個Header,Cache-Control聲明了響應會保持“新鮮”(或者叫有效)半個小時,最后緩存把響應返回給客戶端,但同時緩存復制了一份響應保存了起來。
然后比如10分鍾之后,客戶端又發送了一樣的請求:
這時,緩存里的響應還在有效期內,緩存會直接返回這個響應,響應里包含一個age Header,針對這個例子(10分鍾),age的值就是600(秒)。
這種情況下,對API服務器的請求就被避免了,只有在緩存過期(或者叫不新鮮 Stale)的情況下,緩存才會訪問后端的API服務器。
如果緩存是私有的,例如在web應用的localstorage里面,或者手機設備上,請求到此就停止了。
如果緩存是共享的,例如緩存在服務器上,情況就不一樣了。
比如說10分鍾之后另一個客戶端發送了同樣的請求,這個請求肯定首先來到緩存這里,如果緩存還沒有過期,那么緩存會直接把響應返回給客戶端,這次age Header的值就是1200(秒),20分鍾了:
總的來說私有緩存會減少網絡帶寬的需求,同時會減少從緩存到API的請求。
而共享緩存並不會節省緩存到API的網絡帶寬,但是它會大幅減少到API的請求。例如同時10000個客戶端發出了同樣請求到API,第一個到達的請求會來到API程序這里,而其它的同樣請求只會來到緩存,這也意味着代碼的執行量會大大減少,訪問數據庫的次數也會大大減少,等等。
所以組合使用私有緩存和共享緩存(客戶端緩存和公共/網關緩存)還是不錯的。但是這種緩存還是更適用於比較靜態的資源,例如圖片、內容網頁;而對於數據經常變化的API並不太合適。如果API添加了一條數據,那么針對這10000個客戶端,所緩存的數據就不對了,針對這個例子有可能半個小時都會返回不正確的數據,這時就需要用到驗證模型了。
驗證模型
驗證模型用於驗證緩存的響應數據是否是保持最新的。
這種情況下,當被緩存的數據將要成為客戶端請求的響應的時候,它首先會檢查一下源服務器或者擁有最新數據的中間緩存,看看它所緩存的數據是否仍然最新。這里就要用到驗證器。
驗證器
驗證器分為兩種:強驗證器,弱驗證器。
強驗證器:如果響應的body或者header發生了變化,強驗證器就會變化。典型的例子就是ETag(Entity Tag)響應header,例如:ETag: "12345678",ETag是由Web服務器或者API發配的不透明標識,它代表着某個資源的特定版本。強驗證器可以在任意帶有緩存的上下文中使用,在更新資源的時候強驗證器可以用來做並發檢查。
弱驗證器:當響應變化的時候,弱驗證器通常不一定會變化,由服務器來決定什么時候變化,通常的做法有“只有在重要變化發生的時候才變化”。一個典型的例子就是Last-Modified(最后修改時間)這個Header ,例如:Mon, 11 Jun 2018 13:55:41 GMT,它里面包含着資源最后修改的時間,這個就有點弱,因為它精確到秒,因為有可能一秒內對資源進行兩次以上的更新。但即使針對弱驗證器,時鍾也必須同步,所以它和expires header有同樣的問題,所以ETag是更好的選擇。
還有一種弱ETag,它以w/開頭,例如ETag: "w/123456789",它被當作弱驗證器來對待,但是還是由服務器來決定其程度。當ETag是這種格式的時候,如果響應有變化,它不一定就變化。
弱驗證器只有在允許等價(大致相等)的情況下可已使用,而在要求完全相等的需求下是不可以使用的。
HTTP標准建議如果可能的話最好還是同時發送ETag和Last-Modified這兩個Header。
下面看看其工作原理。客戶端第一次請求的時候,請求到達緩存后發現緩存里沒有,然后緩存把請求發送到API;API返回響應,這個響應包含ETag和Last-Modified 這兩個Header,響應被發送到緩存,然后緩存再把它發送給客戶端,與此同時緩存保存了這個響應的一個副本。
10分鍾后,客戶端再次發送了同樣的請求,請求來到緩存,但是無法保證緩存的響應是“新鮮”的,這個例子里並沒有使用Cache-Control Header,所以緩存就必須到服務器的API去做檢查。這時它會添加兩個Headers:If-None-Match,它被設為已緩存響應數據的ETag的值;If-Modified-Since,它被設為已緩存響應數據的Last-Modified的值。現在這個請求就是根據情況而定的了,服務器接收到這個請求並會根據證器來比較這些header或者生成響應。
如果檢查合格,服務器就不需要生成響應了,它會返回304 Not Modified,然后緩存會返回緩存的響應,這個響應還包含了一個最新的Last-Modified Header(如果支持Last-Modifed的話);
而如果響應的資源發生變化了,API就會生成新的響應。
如果是私有緩存,那就請求就會停在這。
但如果是共享緩存的話,假如10分鍾之后另一個客戶端發送了請求,這個請求也會到達緩存,然后跟上面一樣的流程:
總的來說就是,同樣的響應只會被生成一次。
對比一下:
私有緩存:后續的請求會節省網絡帶寬,我們需要與API進行通信,但是API不需要把完整的響應返回來,如果資源沒有變化的話只需要返回304即可。
共享緩存:會節省緩存和API之間的帶寬,如果驗證通過的話,API不需要重新生成響應然后重新發送回來。
過期模型和驗證模型還是經常被組合使用的。
組合使用過期模型和驗證模型
可以這樣做:
如果使用私有緩存,這時只要響應沒有過期,那么響應直接會從私有緩存返回。這樣做的好處就是減少了與API之間的通信,也減少了API生成響應的工作,減輕了帶寬需求。而如果私有緩存過期了,那還是會訪問到API的。如果只有過期(模型)檢查的話,這就意味着如果過期了API就得重新生成響應。但是如果使用驗證(模型)檢查的話,我們可能就會避免這種情況。因為緩存的響應過期了並不代表緩存的響應就不是有效的了,API會檢查驗證器,如果響應依然有效,就會返回304。這樣網絡帶寬和響應的生成動作都有可能被大幅度減少了。
如果是共享緩存,緩存的響應只要沒過期就會一直被返回,這樣雖然不會節省客戶端和緩存之間的網絡帶寬,但是會節省緩存和API之間的網絡帶寬,同時也大幅度減少了到API的請求次數,這個要比私有緩存幅度大,因為共享緩存是共享與可能是所有的客戶端的。如果緩存的響應過期了,緩存就必須與API通信,但這也不一定就意味着響應必須被重新生成。如果驗證成功,就會返回304,沒有響應body,這就有可能減少了緩存和API之間的網絡帶寬需求,響應還是從緩存返回到客戶端的。
所以綜上,客戶端配備私有緩存,服務器級別配備共享緩存就應該是最佳的實踐。
Cache-Control的指令
先看一下響應的Cache-Control常用指令:
- 新鮮度:
- max-age定義了響應的生命期, 超過了這個值, 緩存的響應就過期了, 它的單位是秒.
- s-maxage對於共享緩存來說它會覆蓋max-age的值. 所以在私有緩存和共享緩存里響應的過期時間可能會不同.
- 存儲地點:
- public, 它表示響應可以被任何一個緩存器所緩存, 私有或者共享的都可以.
- private, 它表示整個或部分響應的信息是為某一個用戶所准備的, 並且不可以被共享的緩存器所緩存.
- 驗證:
- no-cache, 它表示在沒有和源服務器重新驗證之前, 響應不可以被后續的請求所使用.
- must-revalidate, 使用它服務器可以聲明響應是否已經不新鮮了(過期了), 那么就需要進行重新驗證. 這就允許服務器強制讓緩存進行重新驗證, 即使客戶端認為過期的響應也是可以的.
- proxy-revalidate, 他和must-revalidate差不多, 但不適用於私有緩存.
- 其它:
- no-store, 它表示緩存不允許存儲消息的任何部分.
- no-transform, 它表示緩存不可以對響應body的媒體類型進行轉換.
上面這些都是由服務器決定的, 但是客戶端可以覆蓋其中的一些設定.
請求的Cache-Control常用指令:
- 新鮮度:
- max-age, 它表示客戶端不想要接收已經超過這個值的有效期的響應
- min-fresh, 它表示客戶端可以接受到這樣的響應, 它的有效期不小於它當前的年齡加上這個設定的值(秒), 也就是說客戶端想要響應還可以在指定的時間內保持新鮮.
- max-stale, 它表示客戶端可以接收過期的響應.
- 驗證:
- no-cache, 它表示緩存不可以用存儲的響應來滿足請求. 源服務器需要重新驗證成功並生成響應.
- 其他:
- no-store, 和響應的一樣.
- no-transform, 和響應的一樣.
- only-if-cached, 它表示客戶端只想要緩存的響應, 並且不要和源服務器進行重新驗證和生成. 這個比較適用於網絡狀態非常差的狀態.
到目前也介紹了幾個指令了, 其實大多數情況下使用max-age和public, private即可...
更多指令請查看: https://tools.ietf.org/html/rfc7234#section-5.2
Cache Headers
根據REST的約束, 為了支持HTTP緩存, 我們需要一個可以生成正確的響應Header的組件, 並且可以檢查發送的請求的Header, 所以我們可以返回304 Not Modified或者412 Preconditioned Failed.
這個組件應該位於緩存的后端, ASP.NET Core里有個自帶的屬性標簽 [ResponseCache] (https://docs.microsoft.com/en-us/aspnet/core/performance/caching/response?view=aspnetcore-2.1#responsecache-attribute), 它可以應用於Controller的Actions. 為設定適當響應緩存Header它可以指定所需的參數. 它只能做這些, 無法在緩存里存儲響應, 它並不是緩存存儲. 而且因為它好像不支持ETag, 所以暫時先不使用這個.
可以考慮CacheCow,它可以生成ETag,也支持.NET Core,但是它並沒有內置中間件來返回304。所以我這里使用的是Marvin.Cache.Headers。
安裝:
Startup的ConfigureServices方法里配置:
這里還可以配置Header的生成選項,但暫時先使用默認的配置。
然后在Configure方法里,把這個中間件添加在app.useMvc()之前:
這里就是處理並返回304的邏輯。
還需要設置一下Postman, 要保證Send no-cache header這一項是off的:
發送請求測試:
這是第一次訪問,會執行Action方法,然后返回響應。響應的Header如上圖所示,里面包含了緩存相關的Header。
默認的Cache-Control是public,max-age是60秒。Expires header也反映了過期的時間,也就是1分鍾之后。
用於驗證的ETag和Last-Modified也被生成和添加了,Last-Modified就是現在的時間。
ETag的生成邏輯並不是標准的一部分,這個可以由我們自己來決定。當讓響應是等價的還是完全相等的也是由我們來決定。
默認情況下,這個中間件會考慮到請求路徑、Accept、Accept-language 這些Header以及響應的body。
再次發送該請求,由於已經超過了1分鍾,所以還是會走Action方法的:
然后在1分鍾之內再次發送請求:
還是走了這個Action方法!!
Header還是有變化的。
這個現象是沒有問題的,因為這個庫只是負責生成Header和驗證,它並不是緩存存儲器。
想要緩存數據,那就需要一個緩存存儲器了,可以是私有、公共的也可以是兩者兼顧的。這個一會再說。
先來看看驗證,如果一個響應是不新鮮的(過期的),我們知道這樣話緩存必須進行重新驗證,最好是用ETag進行驗證,他會把ETag的值賦給If-None-Match這個Header:
這時就會返回304 Not Modified,而Action方法也不會執行。
下面測試一下PUT動作:
更新數據之后,我再發送一次之前的GET請求:
這次Action方法又被執行了,這說明驗證失敗了,因為ETag已經不一致了,當我發送PUT請求的時候,生成了一個新的ETag。
我們也可以對如何生成Header進行配置,打開Startup的ConfigureServices方法:
配置參數還是很多的,這里我分別為過期模型和驗證模型修改了一個參數。
過期模型的max-age設為600秒。驗證模型為Cache-Control添加了must-revalidate指令,也就是說如果緩存的響應過期了,那么必須進行重新驗證。
再次發送那個GET請求:
重新執行了Action方法,也可以看到響應Header的變化。
緩存存儲
之前只是生成了緩存相關的Header,還沒有進行真正的存儲,現在就介紹存儲這部分。
緩存有私有的、共享的等。
私有的不在我們討論的范圍內,因為它在客戶端。
私有和共享緩存,有一些緩存是兩者的混合,根據你在哪使用它來決定給其類型。例如CacheCow。
微軟提供了一個共享緩存,支持.NET Core:ResponseCaching中間件(https://docs.microsoft.com/en-us/aspnet/core/performance/caching/middleware?view=aspnetcore-2.1)。
這個中間件會檢查Marvin.Cache.Headers這個中間件生成的Header,並把響應放到緩存並根據Header把它們服務給客戶端,但是ResponseCaching中間件它自己並不會生成這些Header。
在ConfigureServices里注冊:
然后在Configure方法里,把這個緩存存儲添加到管道:
注意順序,要保證它在UseHttpCacheHeaders()之前。
測試,發送GET請求:
這次會執行Action方法,返回響應。
再次發送GET請求:
這次沒有走進Action方法里,而是從緩存返回的,這里還多了一個Age header,它告訴了我響應的”年齡“,他已經活了123秒了。
再次請求:
年齡變成了243秒,還是小於600秒。很顯然這提高了應用的性能。。。
到目前我們可以生成Cache-Control和Etag的Headers了,但是還沒有用到ETag的另一個功能:
並發控制
看下面這個情況,很常見:
兩個客戶端1和2,客戶1先獲取了id為1的Country資源,隨后客戶2也獲取了這個資源;然后客戶2對資源進行了修改,先進行了PUT動作進行更新,然后客戶1才修改好Country然后PUT到服務器。
這時客戶1就會把客戶2的更改完全覆蓋掉,這是個常見問題。
針對這樣的問題,我們需要使用一些處理並發沖突的策略:悲觀並發控制和樂觀並發控制。
悲觀並發控制意味着資源是為客戶1鎖定的,只要資源處於鎖定的狀態,別人就不能修改它,只有客戶1可以修改它。但是悲觀並發控制是無法在REST下實現的,因為REST有個無狀態約束。
樂觀並發控制,這就意味着客戶1會得到一個Token,並允許他更新資源,只要Token是合理有效的,那么客戶1就一直可以更新該資源。在REST里這是可以實現的,而這個Token就是個驗證器,而且要求是強驗證器,所以我們可以用ETag。
回到例子:
客戶1發送GET請求,返回響應並帶着ETag Header。然后客戶2發送同樣的請求,返回同樣的響應和Etag。
客戶2先進行更新,並把Etag的值賦給了If-Match Header,API檢查這個Header並和它為這個響應所保存的ETag值進行比較,這時針對這個響應會生成新的ETag,響應包含着這個新的ETag。
然后客戶1進行PUT更新操作,它的If-Match Header的值是客戶1之前得到的ETag的值,在到達API之后,API就知道這個和資源最新的ETag的值不一樣,所以API會返回412 Precondition Failed。
所以客戶1的更新沒有成功,因為它使用的是老版本的資源。這就是樂觀並發控制的工作原理。
下面看測試,
客戶1先GET:
客戶2GET:
注意他們兩個的ETag是一樣的。
然后客戶2先更新:
最后客戶1再更新(使用的是老的ETag):
返回412。
本文比較短,一些關於緩存技術的內容並沒有寫,距離REST的主題有點遠。
ASP.NET Core關於緩存部分的文檔在這里:https://docs.microsoft.com/en-us/aspnet/core/performance/caching/?view=aspnetcore-2.1
本系列的源碼在:https://github.com/solenovex/ASP.NET-Core-2.0-RESTful-API-Tutorial