Nginx 的過濾模塊是干啥用的？

上一篇文章我寫了 Nginx 的 11 個階段，很多人都說太長了，這是出于文章完整性的考慮的，11 個階段嘛，一次性說完就完事了，今天這篇文章比較短，看完沒問題，

過濾模塊的位置

之前我們介紹了 Nginx 的 11 個階段，在 content 階段時，Nginx 會生成回傳給用戶的回應內容，對用戶的回應內容，實際上還需要做再加工處理，Nginx 的過濾模塊就是對回應內容進行再加工處理的，所以實際上過濾模塊位于 content 階段之后，log 階段之前，

我們先來看一段配置指令：

limit_req zone=req_one
burst=120;
limit_conn c_zone 1;

satisfy any;
allow 192.168.1.0/32;
auth_basic_user_file access.pass;

gzip on;
image_filter resize 80 80;

那么在這一段配置指令之下，會遵循怎樣的請求流程呢？請看一下下面這張圖：

上面這張圖的流程大致說一下，如果對于 Nginx 的 11 個階段不了解的去翻一下之前的文章，

我這里再簡單說一下，首先由 Nginx 框架接收 HTTP 請求，經過 preaccess、access、content 階段的處理，當經過 static 模塊之后生成回應的時候，很多時候需要對回應進行處理，然后才會回傳給客戶端，

這里我們假如回應是一張圖片的話，那么需要做縮略圖的時候，首先就要經過 image_filter 模塊的處理，這里面還有一個 gzip 模塊，這兩個模塊也是需要遵循嚴格的順序的，因為如果先做 gzip 壓縮的話，縮略圖后面就沒辦法做了，

第二個需要關注的地方是，首先對 header 進行過濾，再對 body 進行過濾，因為我們在對用戶發送回應的時候，一定是先發送 header，然后再發送 body，所以所有的過濾模塊都會提供對 header 或 body 的過濾，當然 image_filter 和 gzip 模塊對這兩者都可以過濾，

回傳回應

前面我們說過，Nginx 的 11 個階段是有嚴格的順序的，而這個順序是在 Nginx 的代碼中以一個陣列的形式存在的，這個陣列的順序是從后往前，在給用戶回傳回應的時候，過濾模塊也是有嚴格順序的，這個順序同樣是從后往前，來看一下在代碼中的定義，標紅的是我下面會提到的幾個過濾模塊，

我們需要重點關注四個過濾模塊，它們分別的作用是啥呢？

• copy_filter：復制包體內容

  當我們使用 sendfile 指令的時候，也就是零拷貝技術，不經過用戶態記憶體，這里就是不經過 Nginx 直接發給用戶，同時也用了 gzip 模塊的時候，gzip 是必須在 copy_filter 模塊之后的，因為 gzip 必須對記憶體中的資料做壓縮，這時 copy_filter 就會讓 sendfile 指令失效，有些模塊不需要對記憶體中的資料進行處理，就需要在 copy_filter 模塊之前進行處理，

• postpone_filter：處理子請求

  用來處理子請求，有些過濾模塊需要關心子請求的處理結果，需要放在該模塊之后，

• header_filter：構造回應頭部

  用來構造最終發送給用戶的回應頭部，可能會添加一些 Server，Nginx 版本號等內容，

• write_filter：發送回應

  用來實際呼叫作業系統的 write 或 send 等系統呼叫，來把回應實際發送出去，

介紹完了過濾模塊的功能以及所處的階段，下面來具體看兩個模塊，

sub 模塊

介紹一個可以替換回應中字串內容的模塊：sub 模塊，

• 功能：將回應中指定的字串，替換成新的字串
• 模塊：ngx_http_sub_filter_module 模塊，默認未編譯進 Nginx，通過 --with-http_sub_module 啟用

指令

Syntax: sub_filter string replacement;
Default: —
Context: http, server, location

Syntax: sub_filter_last_modified on | off;
Default: sub_filter_last_modified off; 
Context: http, server, location

Syntax: sub_filter_once on | off;
Default: sub_filter_once on; 
Context: http, server, location

Syntax: sub_filter_types mime-type ...;
Default: sub_filter_types text/html; 
Context: http, server, location

來解釋一下這四個指令都是啥意思，

• sub_filter string replacement

  sub_filter 指令會把匹配到的 string 字串替換成 replacement 表示的字串，

• sub_filter_last_modified on | off

  sub_filter_last_modified 指令的意思是，是否要回傳原來的 last_modified HTTP 頭部，因為我們已經修改了檔案內容，如果是 on 的話，就會繼續回傳原來的頭部，

• sub_filter_once on | off

  sub_filter_once 的意思是，是否只替換一次，默認打開，如果設定為 off 的話，那就會將回應中的內容全部掃描一遍并替換，

• sub_filter_types mime-type

  這個指令是說針對那些檔案型別進行替換，這里可以設定成 *，但是效率就會比較低了，需要根據實際情況考慮，

實戰

組態檔如下：

server {
	server_name sub.ziyang.com;
	error_log  logs/myerror.log  info;
	
	location / {
    	sub_filter 'Nginx.oRg'  '$host/nginx';
    	sub_filter 'nginX.cOm' '$host/nginx';
    	#sub_filter_once on;
		sub_filter_once off;
		#sub_filter_last_modified off;
		sub_filter_last_modified on;
	}	
}

這里需要重新編譯 Nginx，我這里把下一節需要的模塊也一起編譯進去了：

./configure --prefix=/Users/mtdp/myproject/nginx/test_nginx --with-http_sub_module --with-http_addition_module --with-http_realip_module
make
cp nginx ../../test_nginx/sbin/ # 復制編譯好的 nginx 到之前的目錄

執行熱部署：

熱部署的流程詳見 Nginx 入門及命令列操作

kill -USR2 87693 # 使用新的 Nginx 二進制檔案提供服務
kill -WINCH 87693 # 退出老的 Nginx 的 worker 行程
kill -quit 87693 # 優雅的退出老的 master 行程

在瀏覽器中打開 sub.ziyang.com：

這里面會發現，nginx.org 已經替換成了 sub.ziyang.com/nginx，nginx.com 也替換成了 sub.ziyang.com/nginx，

addition 模塊

下面再來看一個過濾模塊，addition 模塊，它可以在回應的前后添加內容，

• 功能：在相應前或者回應后增加內容，增加內容的方式，是通過新增子請求，根據子請求的回應來完成，

• 模塊：ngx_http_addition_filter_module

  默認未編譯進 Nginx，通過 --with-http_addition_module 啟用

指令

Syntax: add_before_body uri;
Default: —
Context: http, server, location

Syntax: add_after_body uri;
Default: —
Context: http, server, location

Syntax: addition_types mime-type ...;
Default: addition_types text/html; 
Context: http, server, location

這里的三個指令都比較簡單，說一下 add_before_body 和 add_after_body 后面的 uri，這個的意思是說，向指定 uri 發起子請求，根據子請求的回應來添加內容，

addition_types 指令是指定要添加的檔案型別，

實戰

組態檔如下：

server {
	server_name addition.ziyang.com;
	error_log logs/myerror.log info;
	
	location / {
    	#add_before_body /before_action;
    	#add_after_body  /after_action;
		#addition_types *;
	}	
	location /before_action {
		return 200 'new content before\n';
	}
	location /after_action {
		return 200 'new content after\n';
	}
	location /testhost {
		uninitialized_variable_warn on;
		set $foo 'testhost';
		return 200 '$gzip_ratio\n';
	}
}

先看在注釋掉 addition 模塊的指令的情況下，會是什么效果：

?  ~ curl addition.ziyang.com/a.txt
a

然后打開注釋：

?  ~ curl addition.ziyang.com/a.txt
new content before
a
new content after

在原回應前后都增加了內容，

這里面需要注意一點，在實際情況下，add_before_body 和 add_after_body 后面是其他的 uri，我這里為了簡化，直接轉發到對應的 location，

本文涉及到的所有組態檔我已經放在了 Nginx 組態檔，大家可以自取，

本文首發于我的個人博客：iziyang.github.io

標籤：Linux

上一篇：上古神器vim系列之初探

下一篇：Python的contextlib出了差錯