NGINX 緩存使用官方指南

我們都知道，應用程序和網站一樣，其性能關乎生存。但如何使你的應用程序或者網站性能更好，並沒有一個明確的答案。代碼質量和架構是其中的一個原因，但是在很多例子中我們看到，你可以通過關注一些十分基礎的應用內容分發技術，來提高終端用戶的體驗。其中一個例子就是實現和調整應用棧（application stack）的緩存。這篇文章，通過幾個例子來講述如何使用NGINX緩存，此外，結尾處還列舉了一些常見問題及解答。

基礎

一個web緩存坐落於客戶端和“原始服務器（origin server）”中間，它保留了所有可見內容的拷貝。如果一個客戶端請求的內容在緩存中存儲，則可以直接在緩存中獲得該內容而不需要與服務器通信。這樣一來，由於web緩存距離客戶端“更近”，就可以提高響應性能，並更有效率的使用應用服務器，因爲服務器不用每次請求都進行頁面生成工作。

在瀏覽器和應用服務器之間，存在多種“潛在”緩存，如：客戶端瀏覽器緩存、中間緩存、內容分發網絡（CDN）和服務器上的負載平衡和反向代理。緩存，僅在反向代理和負載均衡的層面，就對性能提高有很大的幫助。

舉個例子說明，去年，我接手了一項任務，這項任務的內容是對一個加載緩慢的網站進行性能優化。首先引起我注意的事情是，這個網站差不多花費了超過1秒鐘才生成了主頁。經過一系列調試，我發現加載緩慢的原因在於頁面被標記爲不可緩存，即爲了響應每一個請求，頁面都是動態生成的。由於頁面本身並不需要經常性的變更，並且不涉及個性化，那麼這樣做其實並沒有必要。爲了驗證一下我的結論，我將頁面標記爲每5秒緩存一次，僅僅做了這一個調整，就能明顯的感受到性能的提升。第一個字節到達的時間降低到幾毫秒，同時頁面的加載明顯要更快。

並不是只有大規模的內容分發網絡（CDN）可以在使用緩存中受益——緩存還可以提高負載平衡器、反向代理和應用服務器前端web服務的性能。通過上面的例子，我們看到，緩存內容結果，可以更高效的使用應用服務器，因爲不需要每次都去做重複的頁面生成工作。此外，Web緩存還可以用來提高網站可靠性。當服務器宕機或者繁忙時，比起返回錯誤信息給用戶，不如通過配置NGINX將已經緩存下來的內容發送給用戶。這意味着，網站在應用服務器或者數據庫故障的情況下，可以保持部分甚至全部的功能運轉。

下一部分討論如何安裝和配置NGINX的基礎緩存（Basic Caching）。

如何安裝和配置基礎緩存

我們只需要兩個命令就可以啓用基礎緩存： proxy_cache_path和proxy_cache。proxy_cache_path用來設置緩存的路徑和配置，proxy_cache用來啓用緩存。

proxy_cache_path /path/to/cache levels=1:2 keys_zone=my_cache:10m max_size=10g inactive=60m 
                 use_temp_path=off;
server {
...
    location / {
        proxy_cache my_cache;
        proxy_pass http://my_upstream;
    }
}

proxy_cache_path命令中的參數及對應配置說明如下：

1.用於緩存的本地磁盤目錄是/path/to/cache/

2.levels在/path/to/cache/設置了一個兩級層次結構的目錄。將大量的文件放置在單個目錄中會導致文件訪問緩慢，所以針對大多數部署，我們推薦使用兩級目錄層次結構。如果levels參數沒有配置，則NGINX會將所有的文件放到同一個目錄中。

3.keys_zone設置一個共享內存區，該內存區用於存儲緩存鍵和元數據，有些類似計時器的用途。將鍵的拷貝放入內存可以使NGINX在不檢索磁盤的情況下快速決定一個請求是`HIT`還是`MISS`，這樣大大提高了檢索速度。一個1MB的內存空間可以存儲大約8000個key，那麼上面配置的10MB內存空間可以存儲差不多80000個key。

4.max_size設置了緩存的上限（在上面的例子中是10G）。這是一個可選項；如果不指定具體值，那就是允許緩存不斷增長，佔用所有可用的磁盤空間。當緩存達到這個上線，處理器便調用cache manager來移除最近最少被使用的文件，這樣把緩存的空間降低至這個限制之下。

5.inactive指定了項目在不被訪問的情況下能夠在內存中保持的時間。在上面的例子中，如果一個文件在60分鐘之內沒有被請求，則緩存管理將會自動將其在內存中刪除，不管該文件是否過期。該參數默認值爲10分鐘（10m）。注意，非活動內容有別於過期內容。NGINX不會自動刪除由緩存控制頭部指定的過期內容（本例中Cache-Control:max-age=120）。過期內容只有在inactive指定時間內沒有被訪問的情況下才會被刪除。如果過期內容被訪問了，那麼NGINX就會將其從原服務器上刷新，並更新對應的inactive計時器。

6.NGINX最初會將註定寫入緩存的文件先放入一個臨時存儲區域， use_temp_path=off命令指示NGINX將在緩存這些文件時將它們寫入同一個目錄下。我們強烈建議你將參數設置爲off來避免在文件系統中不必要的數據拷貝。use_temp_path在NGINX1.7版本和NGINX Plus R6中有所介紹。

最終， proxy_cache命令啓動緩存那些URL與location部分匹配的內容（本例中，爲`/`）。你同樣可以將proxy_cache命令添加到server部分，這將會將緩存應用到所有的那些location中未指定自己的proxy_cache命令的服務中。

陳舊總比沒有強

NGINX內容緩存的一個非常強大的特性是：當無法從原始服務器獲取最新的內容時，NGINX可以分發緩存中的陳舊（stale，編者注：即過期內容）內容。這種情況一般發生在關聯緩存內容的原始服務器宕機或者繁忙時。比起對客戶端傳達錯誤信息，NGINX可發送在其內存中的陳舊的文件。NGINX的這種代理方式，爲服務器提供額外級別的容錯能力，並確保了在服務器故障或流量峯值的情況下的正常運行。爲了開啓該功能，只需要添加proxy_cache_use_stale命令即可：

location / {
    ...
    proxy_cache_use_stale error timeout http_500 http_502 http_503 http_504;
}

按照上面例子中的配置，當NGINX收到服務器返回的error，timeout或者其他指定的5xx錯誤，並且在其緩存中有請求文件的陳舊版本，則會將這些陳舊版本的文件而不是錯誤信息發送給客戶端。

緩存微調

NGINX提供了豐富的可選項配置用於緩存性能的微調。下面是使用了幾個配置的例子：

proxy_cache_path /path/to/cache levels=1:2 keys_zone=my_cache:10m max_size=10g inactive=60m
                 use_temp_path=off;
server {
    ...
    location / {
        proxy_cache my_cache;
        proxy_cache_revalidate on;
        proxy_cache_min_uses 3;
        proxy_cache_use_stale error timeout updating http_500 http_502 http_503 http_504;
        proxy_cache_lock on;
        proxy_pass http://my_upstream;
    }
}

這些命令配置了下列的行爲：

1.proxy_cache_revalidate指示NGINX在刷新來自服務器的內容時使用GET請求。如果客戶端的請求項已經被緩存過了，但是在緩存控制頭部中定義爲過期，那麼NGINX就會在GET請求中包含If-Modified-Since字段，發送至服務器端。這項配置可以節約帶寬，因爲對於NGINX已經緩存過的文件，服務器只會在該文件請求頭中Last-Modified記錄的時間內被修改時纔將全部文件一起發送。

2.proxy_cache_min_uses設置了在NGINX緩存前，客戶端請求一個條目的最短時間。當緩存不斷被填滿時，這項設置便十分有用，因爲這確保了只有那些被經常訪問的內容纔會被添加到緩存中。該項默認值爲1。

3.proxy_cache_use_stale中的updating參數告知NGINX在客戶端請求的項目的更新正在原服務器中下載時發送舊內容，而不是向服務器轉發重複的請求。第一個請求陳舊文件的用戶不得不等待文件在原服務器中更新完畢。陳舊的文件會返回給隨後的請求直到更新後的文件被全部下載。

4.當proxy_cache_lock被啓用時，當多個客戶端請求一個緩存中不存在的文件（或稱之爲一個MISS），只有這些請求中的第一個被允許發送至服務器。其他請求在第一個請求得到滿意結果之後在緩存中得到文件。如果不啓用proxy_cache_lock，則所有在緩存中找不到文件的請求都會直接與服務器通信。

跨多硬盤分割緩存

使用NGINX，不需要建立一個RAID（磁盤陣列）。如果有多個硬盤，NGINX可以用來在多個硬盤之間分割緩存。下面是一個基於請求URI跨越兩個硬盤之間均分緩存的例子：

proxy_cache_path /path/to/hdd1 levels=1:2 keys_zone=my_cache_hdd1:10m max_size=10g 
                 inactive=60m use_temp_path=off;
proxy_cache_path /path/to/hdd2 levels=1:2 keys_zone=my_cache_hdd2:10m max_size=10g 
                 inactive=60m use_temp_path=off;
split_clients $request_uri $my_cache {
              50%          “my_cache_hdd1”;
              50%          “my_cache_hdd2”;
}
server {
    ...
    location / {
        proxy_cache $my_cache;
        proxy_pass http://my_upstream;
    }
}

上例中的兩個proxy_cache_path定義了兩個緩存（my_cache_hdd1和my_cache_hd22）分屬兩個不同的硬盤。split_clients配置部分指定了請求結果的一半在my_cache_hdd1中緩存，另一半在my_cache_hdd2中緩存。基於$request_uri（請求URI）變量的哈希值決定了每一個請求使用哪一個緩存，對於指定URI的請求結果通常會被緩存在同一個緩存中。

常見問題解答

這部分內容回答了一些關於NGINX內容緩存的常見問題。

可以檢測NGINX緩存狀態嗎？

可以，使用add_header指令：

add_header X-Cache-Status $upstream_cache_status;

上面的例子中，在對客戶端的響應中添加了一個`X-Cache-Status`HTTP響應頭，下面是$upstream_cache_status的可能值：

MISS——響應在緩存中找不到，所以需要在服務器中取得。這個響應之後可能會被緩存起來。
BYPASS——響應來自原始服務器而不是緩存，因爲請求匹配了一個proxy_cache_bypass（見下面我可以在緩存中打個洞嗎？）。這個響應之後可能會被緩存起來。
EXPIRED——緩存中的某一項過期了，來自原始服務器的響應包含最新的內容。
STALE——內容陳舊是因爲原始服務器不能正確響應。需要配置proxy_cache_use_stale。
UPDATING——內容過期了，因爲相對於之前的請求，響應的入口（entry）已經更新，並且proxy_cache_use_stale的updating已被設置。
REVALIDATED——proxy_cache_revalidate命令被啓用，NGINX檢測得知當前的緩存內容依然有效（If-Modified-Since或者If-None-Match）。
HIT——響應包含來自緩存的最新有效的內容。

NGINX 如何決定是否緩存？

默認情況下，NGINX需要考慮從原始服務器得到的Cache-Control標頭。當在響應頭部中Cache-Control被配置爲Private，No-Cache，No-Store或者Set-Cookie，NGINX不進行緩存。NGINX僅僅緩存GET和HEAD客戶端請求。你也可以參照下面的解答覆蓋這些默認值。

Cache-Control頭部可否被忽略？

可以，使用proxy_ignore_headers命令。如下列配置：

location /images/ {
proxy_cache my_cache;
proxy_ignore_headers Cache-Control;
proxy_cache_valid any 30m;
...
}

NGINX會忽略所有/images/下的Cache-Control頭。proxy_cache_valid命令強制規定緩存數據的過期時間，如果忽略Cache-Control頭，則該命令是十分必要的。NGINX不會緩存沒有過期時間的文件。

當在頭部設置了Set-Cookie之後NGINX還能緩存內容嗎？

可以，使用proxy_ignore_headers命令，參見之前的解答。

NGINX能否緩存POST 請求？

可以，使用proxy_cache_methods命令：

proxy_cache_methods GET HEAD POST;

這個例子中可以緩存POST請求。其他附加的方法可以依次列出來的，如PUT。

NGINX 可以緩存動態內容嗎？

可以，提供的Cache-Control頭部可以做到。緩存動態內容，甚至短時間內的內容可以減少在原始數據庫和服務器中加載，可以提高第一個字節的到達時間，因爲頁面不需要對每個請求都生成一次。

我可以再緩存中打個洞（Punch a Hole）嗎？

可以，使用proxy_cache_bypass命令：

location / {
proxy_cache_bypass $cookie_nocache $arg_nocache;
...
}

這個命令定義了哪種類型的請求需要向服務器請求而不是嘗試首先在緩存中查找。有些時候又被稱作在內存中“打個洞”。在上面的例子中，NGINX會針對nocache cookie或者參數進行直接請求服務器，如： http://www.example.com/?nocache=true。NGINX依然可以爲將那些沒有避開緩存的請求緩存響應結果。

NGINX 使用哪些緩存鍵？

NGINX生成的鍵的默認格式是類似於下面的NGINX變量的MD5哈希值: $scheme$proxy_host$request_uri，實際的算法有些複雜。

proxy_cache_path /path/to/cache levels=1:2 keys_zone=my_cache:10m max_size=10g inactive=60m
use_temp_path=off;

server {
...
location / {
proxy_cache $my_cache;
proxy_pass http://my_upstream;
}
}

按照上面的配置， http://www.example.org/my_image.jpg的緩存鍵被計算爲md5(“http://my_upstream:80/my_image.jpg”)。

注意，$proxy_host變量用於哈希之後的值而不是實際的主機名（www.example.com）。$proxy_host被定義爲proxy_pass中指定的代理服務器的主機名和端口號。

爲了改變變量（或其他項）作爲基礎鍵，可以使用proxy_cache_key命令（下面的問題會講到）。

可以使用Cookie作爲緩存鍵的一部分嗎？

可以，緩存鍵可以配置爲任意值，如：

proxy_cache_key $proxy_host$request_uri$cookie_jessionid;

NGINX使用Etag頭部嗎？

在NGINX 1.7.3和NGINX Plus R5及之後的版本，配合使用If-None-Match， Etag是完全支持的。

NGINX 如何處理字節範圍請求？

如果緩存中的文件是最新的，NGINX會對客戶端提出的字節範圍請求傳遞指定的字節。如果文件並沒有被提前緩存，或者是陳舊的，那麼NGINX會從服務器上下載完整文件。如果請求了單字節範圍，NGINX會盡快的將該字節發送給客戶端，如果在下載的數據流中剛好有這個字節。如果請求指定了同一個文件中的多個字節範圍，NGINX則會在文件下載完畢時將整個文件發送給客戶端。

一旦文件下載完畢，NGINX將整個數據移動到緩存中，這樣一來，無論將來的字節範圍請求是單字節還是多字節範圍，NGINX都可以在緩存中找到指定的內容立即響應。

NGINX 支持緩存清洗嗎？

NGINX Plus支持有選擇性的清洗緩存。當原始服務器上文件已經被更新，但是NGINX Plus緩存中文件依然有效（Cache-Control:max-age依然有效，proxy_cache_path命令中inactive參數設置的超時時間沒有過期），這個功能便十分有用。使用NGINX Plus的緩存清洗特性，這個文件可以被輕易的刪除。詳細信息，參見Purging Content from the Cache。

NGINX如何處理Pragma 頭部？

當客戶端添加了Pragma:no-cache頭部，則請求會繞過緩存直接訪問服務器請求內容。NGINX默認不考慮Pragma頭部，不過你可以使用下面的proxy_cache_bypass的命令來配置該特性：

location /images/ {
proxy_cache my_cache;
proxy_cache_bypass $http_pragma;
...
}

NGINX支持Vary 頭部嗎？

是的，在NGINX Plus R5、NGINX1.7.7和之後的版本中是支持的。看看這篇不錯的文章： good overview of the Vary header。

NGINX 緩存使用官方指南

基礎

如何安裝和配置基礎緩存

陳舊總比沒有強

緩存微調

跨多硬盤分割緩存

常見問題解答

認知提升的方法

螞蟻面試：Springcloud核心組件的底層原理，你知道多少？

Nginx 清除緩存第三方ngx_cache_purge模塊

NGINX 緩存使用官方指南

Redis 內存回收策略

Vmware提示以獨佔方式鎖定此配置文件失敗。另一個正在運行的VMware進程可能正在使用配置文件以及虛擬機黑屏

Nginx 減輕緩存失效對上游服務壓力 proxy_cahce_lock和proxy_cache_use_stale

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結