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執行順序。