nginx配置location總結及rewrite規則寫法

Fish發表於2019-01-19

1. location正則寫法

一個示例：

location  = / {
  # 精確匹配 / ，主機名後面不能帶任何字串
  [ configuration A ]
}

location  / {
  # 因為所有的地址都以 / 開頭，所以這條規則將匹配到所有請求
  # 但是正則和最長字串會優先匹配
  [ configuration B ]
}

location /documents/ {
  # 匹配任何以 /documents/ 開頭的地址，匹配符合以後，還要繼續往下搜尋
  # 只有後面的正規表示式沒有匹配到時，這一條才會採用這一條
  [ configuration C ]
}

location ~ /documents/Abc {
  # 匹配任何以 /documents/Abc 開頭的地址，匹配符合以後，還要繼續往下搜尋
  # 只有後面的正規表示式沒有匹配到時，這一條才會採用這一條
  [ configuration CC ]
}

location ^~ /images/ {
  # 匹配任何以 /images/ 開頭的地址，匹配符合以後，停止往下搜尋正則，採用這一條。
  [ configuration D ]
}

location ~* .(gif|jpg|jpeg)$ {
  # 匹配所有以 gif,jpg或jpeg 結尾的請求
  # 然而，所有請求 /images/ 下的圖片會被 config D 處理，因為 ^~ 到達不了這一條正則
  [ configuration E ]
}

location /images/ {
  # 字元匹配到 /images/，繼續往下，會發現 ^~ 存在
  [ configuration F ]
}

location /images/abc {
  # 最長字元匹配到 /images/abc，繼續往下，會發現 ^~ 存在
  # F與G的放置順序是沒有關係的
  [ configuration G ]
}

location ~ /images/abc/ {
  # 只有去掉 config D 才有效：先最長匹配 config G 開頭的地址，繼續往下搜尋，匹配到這一條正則，採用
    [ configuration H ]
}

location ~* /js/.*/.js

已=開頭表示精確匹配
如 A 中只匹配根目錄結尾的請求，後面不能帶任何字串。
^~ 開頭表示uri以某個常規字串開頭，不是正則匹配
~ 開頭表示區分大小寫的正則匹配;
~* 開頭表示不區分大小寫的正則匹配
/ 通用匹配, 如果沒有其它匹配,任何請求都會匹配到

順序 no優先順序：
(location =) > (location 完整路徑) > (location ^~ 路徑) > (location ~,~* 正則順序) > (location 部分起始路徑) > (/)

上面的匹配結果
按照上面的location寫法，以下的匹配示例成立：

/ -> config A
精確完全匹配，即使/index.html也匹配不了
/downloads/download.html -> config B
匹配B以後，往下沒有任何匹配，採用B
/images/1.gif -> configuration D
匹配到F，往下匹配到D，停止往下
/images/abc/def -> config D
最長匹配到G，往下匹配D，停止往下
你可以看到任何以/images/開頭的都會匹配到D並停止，FG寫在這裡是沒有任何意義的，H是永遠輪不到的，這裡只是為了說明匹配順序
/documents/document.html -> config C
匹配到C，往下沒有任何匹配，採用C
/documents/1.jpg -> configuration E
匹配到C，往下正則匹配到E
/documents/Abc.jpg -> config CC
最長匹配到C，往下正則順序匹配到CC，不會往下到E

實際使用建議

所以實際使用中，個人覺得至少有三個匹配規則定義，如下：
#直接匹配網站根，通過域名訪問網站首頁比較頻繁，使用這個會加速處理，官網如是說。
#這裡是直接轉發給後端應用伺服器了，也可以是一個靜態首頁
# 第一個必選規則
location = / {
    proxy_pass http://tomcat:8080/index
}
# 第二個必選規則是處理靜態檔案請求，這是nginx作為http伺服器的強項
# 有兩種配置模式，目錄匹配或字尾匹配,任選其一或搭配使用
location ^~ /static/ {
    root /webroot/static/;
}
location ~* .(gif|jpg|jpeg|png|css|js|ico)$ {
    root /webroot/res/;
}
#第三個規則就是通用規則，用來轉發動態請求到後端應用伺服器
#非靜態檔案請求就預設是動態請求，自己根據實際把握
#畢竟目前的一些框架的流行，帶.php,.jsp字尾的情況很少了
location / {
    proxy_pass http://tomcat:8080/
}

http://tengine.taobao.org/boo…
http://nginx.org/en/docs/http…

2. Rewrite規則

rewrite功能就是，使用nginx提供的全域性變數或自己設定的變數，結合正規表示式和標誌位實現url重寫以及重定向。rewrite只能放在server{},location{},if{}中，並且只能對域名後邊的除去傳遞的引數外的字串起作用，例如 http://seanlook.com/a/we/index.php?id=1&u=str 只對/a/we/index.php重寫。語法rewrite regex replacement [flag];

如果相對域名或引數字串起作用，可以使用全域性變數匹配，也可以使用proxy_pass反向代理。

表明看rewrite和location功能有點像，都能實現跳轉，主要區別在於rewrite是在同一域名內更改獲取資源的路徑，而location是對一類路徑做控制訪問或反向代理，可以proxy_pass到其他機器。很多情況下rewrite也會寫在location裡，它們的執行順序是：

執行server塊的rewrite指令
執行location匹配
執行選定的location中的rewrite指令

如果其中某步URI被重寫，則重新迴圈執行1-3，直到找到真實存在的檔案；迴圈超過10次，則返回500 Internal Server Error錯誤。

2.1 flag標誌位

last : 相當於Apache的[L]標記，表示完成rewrite
break : 停止執行當前虛擬主機的後續rewrite指令集
redirect : 返回302臨時重定向，位址列會顯示跳轉後的地址
permanent : 返回301永久重定向，位址列會顯示跳轉後的地址

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

last一般寫在server和if中，而break一般使用在location中
last不終止重寫後的url匹配，即新的url會再從server走一遍匹配流程，而break終止重寫後的匹配
break和last都能組織繼續執行後面的rewrite指令

2.2 if指令與全域性變數

if判斷指令
語法為if(condition){...}，對給定的條件condition進行判斷。如果為真，大括號內的rewrite指令將被執行，if條件(conditon)可以是如下任何內容：

當表示式只是一個變數時，如果值為空或任何以0開頭的字串都會當做false
直接比較變數和內容時，使用=或!=
~正規表示式匹配，~*不區分大小寫的匹配，!~區分大小寫的不匹配

-f和!-f用來判斷是否存在檔案
-d和!-d用來判斷是否存在目錄
-e和!-e用來判斷是否存在檔案或目錄
-x和!-x用來判斷檔案是否可執行

例如：

if ($http_user_agent ~ MSIE) {
    rewrite ^(.*)$ /msie/$1 break;
} //如果UA包含"MSIE"，rewrite請求到/msid/目錄下

if ($http_cookie ~* "id=([^;]+)(?:;|$)") {
    set $id $1;
 } //如果cookie匹配正則，設定變數$id等於正則引用部分

if ($request_method = POST) {
    return 405;
} //如果提交方法為POST，則返回狀態405（Method not allowed）。return不能返回301,302

if ($slow) {
    limit_rate 10k;
} //限速，$slow可以通過 set 指令設定

if (!-f $request_filename){
    break;
    proxy_pass  http://127.0.0.1;
} //如果請求的檔名不存在，則反向代理到localhost 。這裡的break也是停止rewrite檢查

if ($args ~ post=140){
    rewrite ^ http://example.com/ permanent;
} //如果query string中包含"post=140"，永久重定向到example.com

location ~* .(gif|jpg|png|swf|flv)$ {
    valid_referers none blocked www.jefflei.com www.leizhenfang.com;
    if ($invalid_referer) {
        return 404;
    } //防盜鏈
}

全域性變數
下面是可以用作if判斷的全域性變數

$args ： #這個變數等於請求行中的引數，同$query_string
$content_length ：請求頭中的Content-length欄位。
$content_type ：請求頭中的Content-Type欄位。
$document_root ：當前請求在root指令中指定的值。
$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
$host：localhost
$server_port：88
$request_uri：http://localhost:88/test1/tes…
$document_uri：/test1/test2/test.php
$document_root：/var/www/html
$request_filename：/var/www/html/test1/test2/test.php

2.3 常用正則

. ：匹配除換行符以外的任意字元
? ：重複0次或1次
+ ：重複1次或更多次
* ：重複0次或更多次
d ：匹配數字
^ ：匹配字串的開始
$ ：匹配字串的介紹
{n} ：重複n次
{n,} ：重複n次或更多次
[c] ：匹配單個字元c
[a-z] ：匹配a-z小寫字母的任意一個

小括號()之間匹配的內容，可以在後面通過$1來引用，$2表示的是前面第二個()裡的內容。正則裡面容易讓人困惑的是轉義特殊字元。

2.4 rewrite例項

例1：

http {
    # 定義image日誌格式
    log_format imagelog `[$time_local] ` $image_file ` ` $image_type ` ` $body_bytes_sent ` ` $status;
    # 開啟重寫日誌
    rewrite_log on;

    server {
        root /home/www;

        location / {
                # 重寫規則資訊
                error_log logs/rewrite.log notice;
                # 注意這裡要用‘’單引號引起來，避免{}
                rewrite `^/images/([a-z]{2})/([a-z0-9]{5})/(.*).(png|jpg|gif)$` /data?file=$3.$4;
                # 注意不能在上面這條規則後面加上“last”引數，否則下面的set指令不會執行
                set $image_file $3;
                set $image_type $4;
        }

        location /data {
                # 指定針對圖片的日誌格式，來分析圖片型別和大小
                access_log logs/images.log mian;
                root /data/images;
                # 應用前面定義的變數。判斷首先檔案在不在，不在再判斷目錄在不在，如果還不在就跳轉到最後一個url裡
                try_files /$arg_file /image404.html;
        }
        location = /image404.html {
                # 圖片不存在返回特定的資訊
                return 404 "image not found
";
        }
}

對形如/images/ef/uh7b3/test.png的請求，重寫到/data?file=test.png，於是匹配到location /data，先看/data/images/test.png檔案存不存在，如果存在則正常響應，如果不存在則重寫tryfiles到新的image404 location，直接返回404狀態碼。

例2：

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

對形如/images/bla_500x400.jpg的檔案請求，重寫到/resizer/bla.jpg?width=500&height=400地址，並會繼續嘗試匹配location。

例3：
見 ssl部分頁面加密。

參考

nginx location匹配及rewrite規則
2019-12-27
Nginx
Nginx location匹配及Rewrite重寫
2022-03-09
Nginx
Nginx的location配置規則梳理
2017-05-03
Nginx
Nginx Location配置總結
2015-07-12
Nginx
Nginx Rewrite規則初探
2015-06-16
Nginx
nginx location匹配規則
2020-04-05
Nginx
nginx負載均衡（5種方式）、rewrite重寫規則及多server反代配置梳理
2017-02-14
Nginx負載Server
Nginx常用Rewrite偽靜態規則
2017-04-24
Nginx
Nginx的Rewrite規則與例項
2013-07-01
Nginx
nginx的location 規則匹配練習
2020-10-02
Nginx
Nginx URL重寫規則配置詳解
2019-03-18
Nginx
Nginx rewrite 規則與 proxy_pass 實現
2016-05-31
Nginx
css書寫規則總結
2016-04-12
CSS
nginx location規則優先順序比較
2013-11-21
Nginx
Nginx Location 配置
2019-01-19
Nginx
nginx location配置
2016-11-03
Nginx
Apache之Rewrite和RewriteRule規則梳理以及http強轉https的配置總結
2018-08-31
ApacheHTTP
第七章：nginx的rewrite規則詳解
2018-01-02
Nginx
Nginx 學習總結（4）—— Rewrite 模組
2018-03-27
Nginx
nginx location 的配置
2013-12-26
Nginx
Nginx 重寫規則指南
2015-04-09
Nginx
nginx rewrite語法格式
2018-09-02
Nginx
nginx thinkphp rewrite配置項
2018-05-22
NginxPHP
apache的rewrite規則無法載入問題
2017-11-12
Apache
07 nginx Location之正則匹配
2015-01-26
Nginx
利用apache的mod_rewrite做URL規則重寫
2017-01-19
Apache
Apache 重寫規則的常見應用 (rewrite)(轉)
2007-08-09
Apache
Git忽略提交規則.gitignore配置總結
2018-11-13
Git
Nginx Location 指令語法解析
2019-02-23
Nginx
Nginx的location規則：優先順序和路徑替換
2019-02-01
Nginx
Sendmail relay規則及配置檔案用法彙總 sendmail配置 (轉)
2007-12-08
AI
nginx與location語法詳解
2018-12-07
Nginx
Nginx(六)：配置解析之location解析
2021-01-19
Nginx
Nginx location配置詳細解釋
2017-05-17
Nginx
rewrite規則中引數多於9個的處理方式 apache nginx
2016-12-15
ApacheNginx
android jni程式碼編寫規則--整理總結
2016-04-14
Android
CSS-@規則(At-rules)常用語法使用總結
2023-02-03
CSS
Git忽略提交規則 - .gitignore配置運維總結
2018-12-14
Git運維