Nginx rewrite模塊深刻淺出詳解

rewrite模塊（ngx_http_rewrite_module）

nginx經過ngx_http_rewrite_module模塊支持url重寫、支持if條件判斷，但不支持else。另外該模塊須要PCRE支持，應在編譯nginx時指定PCRE支持。根據相關變量重定向和選擇不一樣的配置，從一個location跳轉到另外一個location，不過這樣的循環最多能夠執行10次，超事後nginx將返回500錯誤。同時，重寫模塊包含set指令，來建立新的變量並設其值，這在有些情景下很是有用的，如記錄條件標識、傳遞參數到其餘location、記錄作了什麼等等。學習rewrite以前要對正則表達式要很熟悉，下面先給出一些經常使用的正則表達式元字符。

 

1 2 3 4 5 6 7 8 9 10 11

.     :匹配除換行符之外的任意字符 ?     :重複0次或1次 +     :重複1次或更屢次 *     :重複0次或更屢次 \d    :匹配數字 ^     :匹配字符串的開始字符 $     :匹配字符串的結束字符 {n}   :重複n次 {n,}  :重複n次或更屢次 [c]   :匹配單個字符c [a-z] :匹配a-z小寫字母的任意一個

在rewrite中，若是使用小括號()，那麼在小括號之間匹配的內容，能夠在後面經過$1來引用，$2表示的是前面第二個()裏的內容，後面會說到。

Rewrite模塊指令

1）break

 

1 2 3

Syntax: break; Default:— Context:server, location, if

此指令的意思是中止執行當前虛擬主機的後續rewrite指令集。使用示例以下：

 

1 2 3 4

if ($slow) {      limit_rate 10k;      break; }

2）if

 

1 2 3

Syntax: if (condition) { ... } Default:— Context:server, location

對給定的條件（condition）進行判斷，若是條件爲真，大括號內的rewrite指令將被執行。

條件(conditon)能夠是以下任何操做：

1. 當表達式只是一個變量時，若是值爲空或任何以0開頭的字符串都會當作false；

2. 使用「=」和「!=」比較一個變量和字符串；

3. 使用「~」作正則表達式匹配，「~*」作不區分大小寫的正則匹配，「!~」作區分大小寫的正則不匹配；

4. 使用「-f」和「!-f」 檢查一個文件是否存在；

5. 使用「-d」和「!-d」檢查一個目錄是否存在；

6. 使用「-e」和「!-e」檢查一個文件、目錄、符號連接是否存在；

7. 使用「-x」和「 !-x」檢查一個文件是否可執行；

以下示例：

 

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43

//若是UA包含"MSIE"，rewrite請求到/msid/目錄下 if ($http_user_agent ~ MSIE) {     rewrite ^(.*)$ /msie/$1 break; }   //若是cookie匹配正則，設置變量$id等於正則引用部分 if ($http_cookie ~* "id=([^;]+)(?:;|$)") {     set $id $1; }   //給某個訪問IP返回403 if ( $remote_addr = "202\.38\.78\.85" ){     return 403; }   //若是提交方法爲POST，則返回狀態405（Method not allowed）。return不能返回301,302 if ($request_method = POST) {     return 405; }   //若是$slow能夠經過set指令設置，則進行限速處理 if ($slow) {     limit_rate 10k; }   //若是請求的文件名不存在，則反向代理到localhost 。這裏的break也是中止rewrite檢查 if (!-f $request_filename){     break;     proxy_pass http://127.0.0.1; }   //若是query string中包含"post=140"，則永久重定向到example.com if ($args ~ post=140){     rewrite ^ http://example.com/ permanent; }   //防盜鏈 location ~* \.(gif|jpg|png|swf|flv)$ {     valid_referers none blocked www.baidu.com www.ywnds.com;     if ($invalid_referer) {         return 404;     } }

3）return

 

1 2 3 4 5

Syntax: return code [text];         return code URL;         return URL; Default:— Context:server, location, if

中止處理併爲客戶端返回狀態碼，非標準的444狀態碼將關閉鏈接，不發送任何響應頭。可使用的狀態碼有：204，400，402-406，408，410, 411, 413, 416與500-504。若是狀態碼附帶文字段落，該文本將被放置在響應主體。相反，若是狀態碼後面是一個URL，該URL將成爲location頭部值。沒有狀態碼的URL將被視爲一個302狀態碼。

4）rewrite

 

1 2 3

Syntax: rewrite regex replacement [flag]; Default:— Context:server, location, if

rewrite指令的功能就是，使用nginx提供的全局變量或本身設置的變量，而後結合正則表達式和標誌位實現url重寫以及重定向。rewrite指令只能放在server、location或if中，而且只能對域名後邊的除去傳遞的參數外的字符串起做用，例如 http://ywnds.com/a/we/index.php?id=1&u=str，只對/a/we/index.php重寫，語法如上面所示。

若是想對域名或參數字符串起做用，可使用全局變量匹配，也可使用proxy_pass反向代理。

或許看rewrite和location功能有點像，都能實現跳轉，主要區別在於rewrite是在同一域名內更改獲取資源的路徑，而location是對一類路徑作控制訪問或反向代理，能夠proxy_pass到其餘機器。不少狀況下rewrite也會寫在location裏，它們的執行順序是：

1）處理在server級別中定義的模塊指令；

2）爲請求查找location；

3）處理在選中的location中定義的模塊指令，若是指令改變了URI，按新的URI查找location。這個循環至多重複10次，以後nginx返回錯誤500 (Internal Server Error)；

若是一個URI匹配了rewrite指令指定的正則表達式（regex），則URI就按照replacement進行重寫，而rewrite按配置文件中出現的順序執行。其中flag標誌能夠中止繼續處理。若是replacement以」http://」或」https://」開始，將再也不繼續處理，那麼這個重定向將直接返回給客戶端。

flag能夠是以下參數：

• last，完成該rewrite規則的執行後，中止處理後續rewrite指令集；而後查找匹配改變後URI的新location；
• break，完成該rewrite規則的執行後，中止處理後續rewrite指令集，並再也不從新查找；可是當前location內剩餘非rewrite語句和location外的的非rewrite語句能夠執行；
• redirect，返回302臨時重定向，地址欄會顯示跳轉後的地址；
• permanent，返回301永久重定向，地址欄會顯示跳轉後的地址；即表示若是客戶端不清理瀏覽器緩存，那麼返回的結果將永久保存在客戶端瀏覽器中了。

由於301和302不能簡單的只返回狀態碼，還必須有重定向的URL，這就是return指令沒法返回301,302的緣由了。這裏last和break區別有點難以理解：

1）last通常寫在server和if中，而break通常使用在location中；

2）last不終止重寫後的url匹配，即新的url會再從server走一遍匹配流程，而break終止重寫後的匹配；

3）break和last都能組織繼續執行後面的rewrite指令。

示例：

 

1 2 3 4 5 6 7

server {      ...      rewrite ^(/download/.*)/media/(.*)..*$ $1/mp3/$2.mp3 last;      rewrite ^(/download/.*)/audio/(.*)..*$ $1/mp3/$2.ra last;      return 403;      ... }

若是這些rewrite放到「/download/」路徑，那麼location以下所示，這時應使用break而不是last，使用last將循環10次匹配，而後返回500錯誤:

 

1 2 3 4 5

location /download/ {      rewrite ^(/download/.*)/media/(.*)..*$ $1/mp3/$2.mp3 break;      rewrite ^(/download/.*)/audio/(.*)..*$ $1/mp3/$2.ra break;      return 403; }

對於重寫後的URL（replacement）包含原請求的請求參數，原URL的?後的內容。若是不想帶原請求的參數，能夠在replacement後加一個問號。以下，咱們加了一個自定義的參數user=$1,而後在結尾處放了一個問號?，把原請求的參數去掉。

 

1	rewrite ^/users/(.*)$ /show?user=$1? last;

注: 對花括號「}」或「;」來講，使用時須要用雙引號或單引號包圍。由於他們既能用在重定向的正則表達式裏，也是用在配置文件裏分割代碼塊, 爲了不衝突, 正則表達式裏帶花括號的話，應該用雙引號（或者單引號）包圍。好比，要將相似如下的URI：」/photos/123456″重定向到」/path/to/photos/12/1234/123456.png」能夠用如下方法 (注意雙引號):

 

1	rewrite "/photos/([0-9] {2})([0-9] {2})([0-9] {2})" /path/to/photos"

5）set

 

1 2 3

Syntax: set $variable value; Default:— Context:server, location, if

定義一個變量並賦值，值能夠是文本，變量或者文本變量混合體。

6）rewrite_log

 

1 2 3

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

開啓或關閉以notice級別打印rewrite處理日誌到error log文件。nginx打開rewrite log的例子以下：

 

1 2	rewrite_log on;                        //打開rewrite log error_log logs/xxx.error.log notice;   //把error log的級別調整爲notice

7）uninitialized_variable_warn

 

1 2 3

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

控制是否輸出爲初始化的變量到日誌。

重寫規則組成部分

第一部分：任何重寫規則的第一部分都是一個正則表達式

正則表達式可使用括號來捕獲，後續能夠根據位置來將其引用，位置變量值取決於捕獲正則表達式中的順序，$1引用第一個括號中的值，$2引用第二個括號中的值，以此類推。如：

 

1	^/images/([a-z]{2})/([a-z0-9]{5})/(.*)\.(png|jpg|gif)$

$1是兩個小寫字母組成的字符串，$2是由小寫字母和0到9的數字組成的5個字符的字符串，$3將是個文件名，$4是png、jpg、gif中的其中一個。

第二部分：重寫規則的第二部分是URI

當重寫規則第一部分被匹配到了以後，則請求被改寫，那麼該URI可能包含正則表達式中的捕獲的位置參數或這個級別下的nginx任何配置變量。如：

 

1	/data?file=$3.$4

若是這個URI不匹配nginx配置的任何location，那麼將給客戶端返回301(永久重定向)或302(臨時重定向)的狀態碼來表示重定向類型。該狀態碼能夠經過第三個參數來明確指定。

第三部分：重寫規則的第三部分就是標記（flag）

第三部分也就是尾部的標記（flag）， last標記將致使重寫後的URI搜索匹配nginx的其餘location，最多可循環10次。如：

 

1	rewrite '^/images/([a-z]{2})/([a-z0-9]{5})/(.*)\.(png|jpg|gif)$' /data?file=$3.$4 last;

 

全局變量

下面是能夠用做if判斷的全局變量

 

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21

$args               #這個變量等於請求行中的參數，同$query_string; $content_length     #請求頭中的Content-length字段; $content_type       #請求頭中的Content-Type字段; $document_root      #當前請求在root指令中指定的值，如:root /var/www/html; $host               #請求主機頭字段，不然爲服務器名稱; $http_user_agent    #客戶端agent信息; $http_cookie        #客戶端cookie信息; $limit_rate         #這個變量能夠限制鏈接速率; $request_method     #客戶端請求的動做，一般爲GET或POST; $remote_addr        #客戶端的IP地址; $remote_port        #客戶端的端口; $remote_user        #已經通過Auth Basic Module驗證的用戶名; $request_filename   #當前請求的文件路徑，由root或alias指令與URI請求生成; $scheme             #HTTP方法（如http，https）; $server_protocol    #請求使用的協議，一般是HTTP/1.0或HTTP/1.1; $server_addr        #服務器地址，在完成一次系統調用後能夠肯定這個值; $server_name        #服務器名稱; $server_port        #請求到達服務器的端口號; $request_uri        #包含請求參數的原始URI，不包含主機名，如：」/foo/bar.php?arg=baz」; $uri                #不帶請求參數的當前URI，$uri不包含主機名，如」/foo/bar.html」; $document_uri       #與$uri相同,例：http://localhost:88/test1/test2/test.php;

例如：http://localhost:88/test1/test2/test.php這個URL，其中：

 

1 2 3 4 5 6

$host：localhost $server_port：88 $request_uri：http://localhost:88/test1/test2/test.php $document_uri：/test1/test2/test.php $document_root：/var/www/html $request_filename：/var/www/html/test1/test2/test.php

 

Rewrite模塊使用實例

1）使用rewrite指令把訪問80端口的請求重定向到443

對於HTTPS網站，通常最少須要定義兩個虛擬主機，一個是使用80的虛擬主機，另外一個就是使用443端口的虛擬主機了。好比在瀏覽器輸入www.ywnds.com（http://www.ywnds.com）會自動跳轉到https://www.ywnds.com。

 

1	rewrite ^(.*)$ https://www.ywnds.com$uri redirect;

這種跳轉就是302臨時重定向跳轉，若是把flag變成permanent就成了301永久重定向跳轉了。

2）做爲重寫規則的一部分，傳遞新的查詢字符串參數是使用重寫規則的目標之一

 

1	rewrite ^/images/(.*)_(\d+)x(\d+)\.(png|jpg|gif)$ /resizer/$1.$4?width=$2&height=$3? last;

3）使用rewrite模塊禁止用戶代理

Nginx能夠經過各類方式來限制訪問，例如NGINX基本Http認證、allow/deny等等，這些都是前文提過的，下面來看看nginx如何經過用戶代理來禁止訪問。

user agent是什麼?

簡單來講告訴服務器你當前使用的是什麼瀏覽器、工具等來訪問個人。例如火狐、chrome、wget、curl等瀏覽器或工具。使用$http_user_agent變量就能夠獲取到用戶代理，通常在定義日誌格式時都會使用這個變量，把用戶代理記錄到日誌中去。

如何禁止特定UA？

咱們不但願被使用wget或者curl來下載個人文件，怎麼作呢？這裏就可使用rewrite模塊了，編輯nginx配置文件，如下內容放在http配置段，那麼整個nginx都生效。若是放到server裏，那麼一個域名生效，你放哪，哪就有效！

 

1 2 3

if ($http_user_agent ~* (curl) ) {     return 404; }

禁止多個UA

 

1 2 3

if ($http_user_agent ~* (wget|curl) ) {     return 404; }

nginx重寫規則提及來挺簡單的，作起來就難，重點在於正則表達式，同時，還須要考慮到nginx執行順序。