一篇文章讀懂nginx的gzip功能

2022-05-13 21:51:05

前言

HTTP中包體【body】壓縮協商對應的頭欄位為Accept-Encoding/Content-Encoding。對於HTTP包體壓縮，Nginx的ngx_http_gzip_module模組提供了動態gzip壓縮功能，並且有很精細的控制。

包括：

開啟關閉gzip壓縮： gzip on|off
對指定型別的檔案進行壓縮： gzip_types
檔案最小壓縮閾值： gzip_min_length
設定壓縮率： gzip_comp_level
檢視壓縮率： $gzip_ratio
是否插入Vary: Accept-Encoding頭欄位： gzip_vary
禁止指定瀏覽器使用壓縮：gzip_disable
是否對代理請求響應壓縮：gzip_proxied

關於Nginx gzip基本功能，其語意，邏輯，設定和使用都相當簡單，網上相關文章也很多，本文不再贅述，具體細節可以參看下文的設定範例及說明。本文將重點討論其中的gzip_proxied指令的語意和使用，其涉及若干個引數，特定的應用場景，最為複雜，且網上文章涉及不多。

語意：

gzip_proxied的基本邏輯是對於代理請求，根據請求及迴應的頭欄位決定是否壓縮響應包體。判斷的依據是請求頭中是否攜帶Via頭欄位。

如：

拓撲：

對應的典型網路拓撲如下：

client — proxy1 — proxy2 — … proxyn — reverse proxy — origin web

我們的設定點在reverse proxy上, 也就是企業提供對外WEB服務的邊緣的反向代理伺服器。通常，proxyx會通過Via頭欄位標記訊息自己的版本號和名稱，從而形成了一條有序的訊息路徑，方便排錯。

這是一個取自京東首頁的Via欄位的值，表示博主存取京東首頁中間經過了2臺代理伺服器。

Via: http/1.1 ORI-CLOUD-HEN-MIX-109 (jcs [cSsSfU]), http/1.1 HENzhengzhou-CT-1-MIX-34 (jcs [cRs f ])

模擬：

我們可以通過在curl中新增頭欄位Via,模擬該場景。

curl -H 'Via: 1.1 aaa' test/200_accept_encoding.css --compressed -I

驗證：

響應包體是否壓縮，可以curl -I檢視響應頭中是否有Content-Encoding: gzip

如：

HTTP/1.1 200 OK
Server: nginx/1.20.1
Date: Fri, 18 Feb 2022 03:25:26 GMT
Content-Type: text/css
Last-Modified: Tue, 08 Feb 2022 15:48:26 GMT
Connection: keep-alive
Vary: Accept-Encoding
ETag: W/"620290ca-3523"
Content-Encoding: gzip

壓縮率可以檢視log

tail -f ../logs/200_accept_encoding_access.log

47151 192.168.31.133 - - [18/Feb/2022:10:08:07 +0800] "GET /200_accept_encoding.css HTTP/1.1" 200 2646 "-" "curl/7.61.1" "-" 5.16

其中5.16就是壓縮率

本文使用的是nginx 1.20.1, 使用者端工具是curl 7.61.1, 測試檔案為200_accept_encoding.css，可自行選擇任意檔案測試。

[root@test01 conf]# nginx -v
nginx version: nginx/1.20.1

[root@test01 conf]# curl -V
curl 7.61.1 (x86_64-redhat-linux-gnu) libcurl/7.61.1 OpenSSL/1.1.1k zlib/1.2.11 brotli/1.0.6 libidn2/2.2.0 libpsl/0.20.2 (+libidn2/2.2.0) libssh/0.9.4/openssl/zlib nghttp2/1.33.0

gzip_proxied的引數解析：

off gzip_proxied的預設引數是off，語意是不對代理請求的迴應進行壓縮。
any 對任意代理請求迴應壓縮，語意正好和off相反。
expired 如果迴應中包含頭欄位Expires，並且其值響應導致不會快取，則壓縮。因此可以構造快取不過期，快取過期2種場景，分別驗證。迴應中新增Expires頭欄位可以用expires指令。

#expires 1h; #快取有效期1小時 --->不壓縮
#expires epoch;#快取有效期設為1970年1月1日0時，即必然過期，不快取 --->壓縮

no-cache no-store private 此3個引數有類似的行為和語意，放在一起說，語意是如果響應頭欄位包含Cache-Control: xxx，xxx是上述引數中的一個，則壓縮。

注：響應中需要顯示地攜帶Cache-Control頭欄位，如果不包含則壓縮。

#gzip_proxied no-cache;
#gzip_proxied no-store;
#gzip_proxied private;

響應中新增Cache-Control頭欄位用add_header指令

#add_header Cache-Control no-store;
#add_header Cache-Control no-cache;
#add_header Cache-Control private;

可以同時設定多個gzip_proxied條件：

#gzip_proxied no-cache no-store private;

add_header也可以為Cache-Control設定多個值，對於這種有衝突的Cache-Control設定，以最嚴格的限制為準，如本例是no-store生效。

#add_header Cache-Control no-store,no-cache,private;

no_etag 語意是如果迴應中不包含頭欄位ETag，則壓縮。

ETag預設開啟，用etag off可以關閉。

#etag off;

no_last_modified 語意是如果迴應中不包含頭欄位Last_modified，則壓縮。

#未找到關閉last_modified的方法，abort。

auth 語意是請求中包含Authorization時壓縮

設定下面2條指令可以模擬基本網頁認證：

#auth_basic "test for auth_basic";
#auth_basic_user_file ../src/usr;

小結：

gzip_min_length的優先順序高於gzip_proxied，如果由於gzip_min_length的設定導致不壓縮，則gzip_proxied即使滿足壓縮條件也不會壓縮。
上述gzip_proxied的引數，除auth是看請求頭欄位，其它都是看響應頭欄位。
off, any是一對互斥引數，表達了對代理請求是全部不壓縮，或全部壓縮兩種相反的語意。
no-cache,no-restore,priviate,no_etag,no_last_modified，都和快取相關，表達的語意可以歸納為如果響應不快取，則壓縮，其區別只在於判斷的條件的差異，當然，也可以一次性都設定上。那麼為何響應不快取就壓縮呢？官方檔案沒有描述，博主推測和使用場景有關。
a. 不快取意味著不會在代理伺服器上保留響應副本，那麼應該儘早在訊息源頭壓縮，減少鏈路上的頻寬消耗。
b. gzip是CPU密集型的使用，如果響應快取，則可以選擇在下游代理伺服器上啟用壓縮，從而分擔上游伺服器的壓力。

下面是具體的設定，實踐實踐再實踐才是理解和領會相關指令和引數最有效的方法。

組態檔：

log_format  gzip  '$remote_addr - $remote_user [$time_local] "$request" '
                      '$status $body_bytes_sent "$http_referer" '
                      '"$http_user_agent" "$http_x_forwarded_for" $gzip_ratio';
server {
		listen 80;
        server_name  test test1;
		
		root html;


        access_log  logs/200_accept_encoding_access.log gzip;
		error_log logs/200_accept_encoding_error.log debug;

		default_type text/plain;
		
		#gzip off;#這是設定為off，原因是我在http級別已經把gzip開啟了。
		gzip_buffers 16 8k;# gzip_buffers number size;
		gzip_comp_level 6;#設定壓縮級別，預設為1，可以不用改,級別6大約和gzip命令列預設壓縮率相當。
		#gzip_disable "(Chrome|curl|Firefox)";#根據User-Agent的返回值，針對特定使用者端禁止壓縮。這裡把3種使用者端都禁了。
		#Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/98.0.4758.102 Safari/537.36
		#curl/7.61.1
		#Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:97.0) Gecko/20100101 Firefox/97.0
		#gzip_http_version 1.1;#指定gzip壓縮針對的HTTP版本
		#gzip_min_length 13603;#設定最小待壓縮的檔案大小,大小的依據是Content-Length,使用的測試檔案為200_accept_encoding.css
		gzip_min_length 620;#index.html檔案大小正好是620
		#gzip *可以表示所有檔案型別
		gzip_types application/javascript application/x-javascript text/css *;
		#mp4有專屬的mime型別,video/mp4,而不是application/octet-stream,可以在conf/mime.types中檢視詳細的mime型別。
		#gzip_types application/javascript application/x-javascript text/css application/octet-stream;
		#gzip_types application/javascript application/x-javascript text/css video/mp4;

		gzip_vary on;#控制是否插入Vary: Accept-Encoding頭欄位。

		#gzip_proxied off;#設定是否壓縮代理請求的迴應，代理請求的依據是請求頭中是否包含Via欄位，off表示只要請求頭中包含Via欄位，則不壓縮。
		#gzip_proxied expired;#如果迴應中包含頭欄位Expires，並且其值導致不會快取，則壓縮。
		#注1：該設定不考慮是否在請求中包含Via
		#注2：注1理解是錯誤的，進入gzip_proxied的先決條件一定是頭欄位中包含Via欄位,以當前的設定,在不考慮gzip_proxied影響的情況下，響應一定是壓縮的，所以給人以誤解，當gzip_proxied條件滿足時無論是否有Via都壓縮。
		#迴應中新增Expires,注:使用expires指令會同時新增Expires和Cache-Control頭欄位
		#expires 1h; #快取有效期1小時
		#expires epoch;#快取有效期設為1970年1月1日0時，即必然過期，不快取

		#gzip_proxied no-cache no-store private有類似的行為，如果響應頭欄位包含Cache-Control: xxx，則壓縮
		#有2點需要注意，1.受Via欄位影響；2.迴應中需要顯示地有Cache-Control頭欄位，如果不包含則壓縮
		#gzip_proxied no-cache;
		#gzip_proxied no-store;
		#gzip_proxied private;
		#迴應新增Cache-Control用add_header
		#add_header Cache-Control no-store;
		#add_header Cache-Control no-cache;
		#add_header Cache-Control private;
		#可以同時設定多個gzip_proxied條件：
		#gzip_proxied no-cache no-store private;
		#add_header也可以為Cache-Control設定多個值，對於這種有衝突的Cache-Control設定，以最嚴格的限制為準。
		#add_header Cache-Control no-store,no-cache,private;

		#gzip_proxied no_etag;#如果迴應中不包含頭欄位ETag，則壓縮。
		#etag off;
		#未找到關閉last_modified的方法，abort
		#gzip_proxied no_last_modified;
		#if_modified_since off;

		#gzip_proxied any;#對任意代理請求迴應壓縮。

		gzip_proxied auth;#請求中包含Authorization時壓縮
		auth_basic "test for auth_basic";
		auth_basic_user_file ../src/usr;
		#curl -H 'Via: 1.1 aaa' test --compressed --basic -u root:root

		#curl可以使用2種命令列方式驗證gzip，一種是新增Accept-Encoding頭欄位，一種使用compressed引數
		#curl -H 'Accept-Encoding: gzip' test/200_accept_encoding.css --output a.css
		#curl test/200_accept_encoding.css --compressed
		#如果使用者端請求不支援的壓縮方式如br，則伺服器將忽略之

		location / {
			#return 200 'okn';#如果使用return，則在gzip模組生效之前就退出，所以不會壓縮。
			#Content-Length和Cotnent-Encoding不會同時出現，因為gzip是實時動態壓縮，無法預先取得Content-Length。
			#Accept-Encoding實驗中curl必須顯示的新增Accept-Encoding頭欄位，否則視為不使用壓縮方式返回響應，而瀏覽器天然會新增Accept-Encoding
			#$gzip_ratio計算的是原始檔和壓縮檔案的大小之比，如原始檔100，壓縮檔案20，則ratio為5
		}

    }

參考：ngx_http_gzip_module

相關文章：一文讀懂nginx gzip_static