nginx rewrite/return用法

來源：https://blog.csdn.net/Powerful_Fy

rewrite在if中的用法

格式：if (條件判斷) { 具體的rewrite規則 }

if條件判斷語句由Nginx內置變量、邏輯判斷符號和目標字符串三部分組成。
其中，內置變量是Nginx固定的非自定義的變量，如，$request_method, $request_uri等。
邏輯判斷符號，有=, !=, ~, ~*, !~, !~*
!表示相反的意思，~爲匹配符號，它右側爲正則表達式，區分大小寫，而~*爲不區分大小寫匹配。
目標字符串能夠是正則表達式，一般不用加引號，但表達式中有特殊符號時，好比空格、花括號、分號等，須要用單引號引發來。

示例1：當http請求方法爲post時，返回403狀態碼

if ($request_method = POST)
{
    return 403; 
}

示例2：經過瀏覽器標識匹配關鍵字，禁止IE瀏覽器訪問

if ($http_user_agent ~* MSIE) 
{
    return 403;
}

限制多個瀏覽器：

if ($http_user_agent ~* "MSIE|firefox|Chrome")
{
    return 403;
}

示例3：當請求的文件不存在時，進行重定向或return狀態碼等處理操做

if(!-f $request_filename)
{
    rewrite 語句;
}

示例4：判斷uri中某個參數的內容

if($request_uri ~* 'gid=\d{6,8}/') 
{
    rewrite 語句;
}

#\d表示數字，{6,8}表示數字出現的次數是6到8次，當uri中gid參數的值包含6-8個數字那麼執行rewrite語句

rewrite中break和last的用法

兩個指令用法相同，但含義不一樣，須要放到rewrite規則的末尾，用來控制重寫後的連接是否繼續被nginx配置執行(主要是rewrite、return指令)。

1.break和last在location{}外部時

測試示例：

server{
    listen 80; 
    server_name test.com;
    root /data/wwwroot/test.com;

    rewrite /1.html /2.html;
    rewrite /2.html /3.html;
}

#請求1.html文件時，會被重定向到2.html，而後被重定向到3.html，最後返回的文件爲3.html

示例1：在rewrite 指令後面添加break

server{
    listen 80; 
    server_name test.com;
    root /data/wwwroot/test.com;

    rewrite /1.html /2.html break;
    rewrite /2.html /3.html;
}

#請求1.html文件時，會被重定向到2.html，而後直接返回2.html，break在此處的做用就是當匹配第一個rewrite指令成功時，不執行後面的rewrite指令

示例2：當break後面還有location{}的狀況

server{
    listen 80; 
    server_name test.com;
    root /data/wwwroot/test.com;

    rewrite /1.html /2.html break;
    rewrite /2.html /3.html;
    location /2.html {
        return 403;
    }
}

#請求1.html文件時，會返回403狀態碼，當1.html被重定向到2.html時，break不會匹配後面的rewrite規則，但條件2.html匹配location{}定義的文件2.html，因此會執行return 403

#以上兩個示例中，將break換成last效果同樣

2.break和last在location{}內部時

測試示例：

server{
    listen 80; 
    server_name test.com;
    root /data/wwwroot/test.com;
    
    location / {
        rewrite /1.html /2.html;
        rewrite /2.html /3.html;
    }
    location /2.html
    {
        rewrite /2.html /a.html;
    }
    location /3.html
    {
        rewrite /3.html /b.html;
    }
}

#請求1.html，會通過兩次重定向到3.html，3.html又恰好匹配location /3.html{}，因此返回b.html，當請求2.html時，會直接返回a.html，由於location /2.html {} 更精準，優先匹配

示例1：在rewrite後面添加break

server{
    listen 80; 
    server_name test.com;
    root /data/wwwroot/test.com;
    
    location / {
        rewrite /1.html /2.html break;
        rewrite /2.html /3.html;
    }
    location /2.html
    {
        rewrite /2.html /a.html;
    }
    location /3.html
    {
        rewrite /3.html /b.html;
    }
}

#請求1.html，會返回2.html，不會返回a.html，當break再location {} 內部時，遇到break後，當前location{} 以及後面的location{} 的指令都再也不執行

示例2：在rewrite後面添加last

server{
    listen 80; 
    server_name test.com;
    root /data/wwwroot/test.com;
    
    location / {
        rewrite /1.html /2.html last;
        rewrite /2.html /3.html;
    }
    location /2.html
    {
        rewrite /2.html /a.html;
    }
    location /3.html
    {
        rewrite /3.html /b.html;
    }
}

#請求1.html時，會返回a.html，在location {} 內部遇到last，當前location {}中剩下的指令不會再執行，但被重定向的url會從新匹配一遍location {}

3.break和last用法總結

1.當rewrite規則在location{}外，break和last做用同樣，遇到break或last後，其後續的rewrite/return語句再也不執行。但後續有location{}的話，還會近一步執行location{}裏面的語句,前提是請求能匹配該location 2.當rewrite規則在location{}裏，遇到break後，本location{}與其餘location{}的全部rewrite/return規則都再也不執行 3.當rewrite規則在location{}裏，遇到last後，本location{}裏後續rewrite/return規則不執行，但重寫後的url再次從頭匹配全部location

return的用法

該指令通常用於對請求的客戶端直接返回響應狀態碼。在該做用域內return後面的全部nginx配置都是無效的，可使用在server、location以及if配置中，除了支持跟狀態碼，還能夠跟字符串或者url連接。

示例1：直接返回狀態碼

server{
    listen 80;
    server_name www.test.com;
    return 403;
    rewrite www.test.net;  
}

#訪問時，直接返回403狀態碼，return返回內容後，後面的配置rewrite不會執行

示例2：當return在if 判斷中時

server {
.....

if ($request_uri ~ "\.password|\.bak")
{
    return 404;
    rewrite /(.*) /index.html;  
}
.....
}

#請求的文件包含.password或.bak時，直接返回404，rewrite不會執行，但if {}外的配置會繼續執行，return只在當前做用域中生效

示例3：返回字符串

server{
    listen 80;
    server_name www.test.com;
    return 200 "hello";
}

#返回字符串必須加上狀態碼，不然會報錯

示例4：返回nginx變量

location /1.html {
    return 200 "$host $request_uri";
}

示例5：返回url

server{
    listen 80;
    server_name www.test.com;
    return http://www.test.com/index2.html;
}

#返回url時，必須以http://或https://開頭

示例6：返回html代碼

if ($http_referer ~ 'baidu.com') 
{
    return 200 "<html><script>window.location.href='//$host$request_uri';</script></html>";
}

#當網站被黑了的時候，從百度點進網站是連接都會跳轉到其餘網站，可使用該方法暫時處理 #注意：return http://$host$request_uri; 在瀏覽器中會提示"重定向的次數過多"

rewrite的語法規則

格式：rewrite regex replacement [flag]

rewrite 配置能夠在server、location以及if配置段內生效

regex 是用於匹配URI的正則表達式，其不會匹配到$host（域名）

replacement 是目標跳轉的URI，能夠以http://或者https://開頭，也能夠省略掉$host，直接寫$request_uri部分

flag 用來設置rewrite對URI的處理行爲，其中有break、last、rediect、permanent，其中break和last在前面已經介紹過，rediect和permanent的區別在於，前者爲臨時重定向(302)，然後者是永久重定向(301)，對於用戶經過瀏覽器訪問，這二者的效果是一致的。 可是，對於搜索引擎爬蟲來講就有區別了，使用301更有利於SEO。因此，建議replacemnet是以http://或者https://開頭的，flag使用permanent。

示例1：域名跳轉

location / {
    rewrite /(.*) http://www.test.com/$1 permanent;
}

# .*爲正則表達式，表示uri，用()括起來，在後面的uri中能夠調用它，第一次出現的()用$1調用，第二次出現的()用$2調用，以此類推。

示例2：域名跳轉的第二種寫法

location / {
    rewrite /.* http://www.test.com$request_uri permanent;
}

示例3：文件跳轉

server{
    listen 80;
    server_name www.test.com;
    root /data/wwwroot/test.com;
    index index.html;
    if ($request_uri !~ '^/web/')
    {
        rewrite /(.*) /web/$1 redirect;
    }
}

#將uri請求的文件重定向到web/目錄中去尋找

錯誤寫法1：

server{
    listen 80;
    server_name www.test.com;
    root /data/wwwroot/test.com;
    index index.html;
    rewrite /(.*) /web/$1 redirect;
}

#這樣寫會反覆循環，直到瀏覽器最大循環限制次數，哪怕uri包含web/目錄了，也會繼續重定向/web/web/$1

錯誤寫法2：

server{
    listen 80;
    server_name www.test.com;
    root /data/wwwroot/test.com;
    index index.html;
    rewrite /(.*) /web/$1 break;
}

#添加break後不會致使循環，但若是uri中包含web/目錄的狀況下也會被重定向一次，重定向後的uri就是web/web/$1