一文弄懂Nginx的location匹配

因爲團隊在進行先後端分離，前端接管了 Nginx 和 node 層，在平常的工做中，跟 Nginx 打交道的時候挺多的。其中 location 是使用最多和改動最多的地方。以前對 location 的匹配規則是隻知其一;不知其二的。爲了搞明白 location 是如何匹配的，特地花了點時間查了些資料，總結此文。但願能給你們帶來幫助。

語法規則

location [ = | ~ | ~* | ^~ ] uri { ... }
location @name { ... }

複製代碼

語法規則很簡單，一個location關鍵字，後面跟着可選的修飾符，後面是要匹配的字符，花括號中是要執行的操做。

修飾符

• = 表示精確匹配。只有請求的 url 路徑與後面的字符串徹底相等時，纔會命中。
• ~ 表示該規則是使用正則定義的，區分大小寫。
• ~* 表示該規則是使用正則定義的，不區分大小寫。
• ^~ 表示若是該符號後面的字符是最佳匹配，採用該規則，再也不進行後續的查找。

匹配過程

對請求的 url 序列化。例如，對%xx等字符進行解碼，去除 url 中多個相連的/，解析 url 中的.，..等。這一步是匹配的前置工做。

location 有兩種表示形式，一種是使用前綴字符，一種是使用正則。若是是正則的話，前面有~或~*修飾符。

具體的匹配過程以下：

首先先檢查使用前綴字符定義的 location，選擇最長匹配的項並記錄下來。

若是找到了精確匹配的 location，也就是使用了=修飾符的 location，結束查找，使用它的配置。

而後按順序查找使用正則定義的 location，若是匹配則中止查找，使用它定義的配置。

若是沒有匹配的正則 location，則使用前面記錄的最長匹配前綴字符 location。

基於以上的匹配過程，咱們能夠獲得如下兩點啓示：

1. 使用正則定義的 location 在配置文件中出現的順序很重要。由於找到第一個匹配的正則後，查找就中止了，後面定義的正則就是再匹配也沒有機會了。
2. 使用精確匹配能夠提升查找的速度。例如常常請求/的話，可使用=來定義 location。

示例

接下來咱們以一個例子來具體說明一下匹配過程。

假如咱們有下面的一段配置文件：

location = / {
    [ configuration A ]
}

location / {
    [ configuration B ]
}

location /user/ {
    [ configuration C ]
}

location ^~ /images/ {
    [ configuration D ]
}

location ~* \.(gif|jpg|jpeg)$ {
    [ configuration E ]
}

複製代碼

請求/精準匹配 A，再也不往下查找。

請求/index.html匹配 B。首先查找匹配的前綴字符，找到最長匹配是配置 B，接着又按照順序查找匹配的正則。結果沒有找到，所以使用先前標記的最長匹配，即配置 B。

請求/user/index.html匹配 C。首先找到最長匹配 C，因爲後面沒有匹配的正則，因此使用最長匹配 C。

請求/user/1.jpg匹配 E。首先進行前綴字符的查找，找到最長匹配項 C，繼續進行正則查找，找到匹配項 E。所以使用 E。

請求/images/1.jpg匹配 D。首先進行前綴字符的查找，找到最長匹配 D。可是，特殊的是它使用了^~修飾符，再也不進行接下來的正則的匹配查找，所以使用 D。這裏，若是沒有前面的修飾符，其實最終的匹配是 E。你們能夠想想爲何。

請求/documents/about.html匹配 B。由於 B 表示任何以/開頭的 URL 都匹配。在上面的配置中，只有 B 能知足，因此匹配 B。

location @name 的用法

@用來定義一個命名 location。主要用於內部重定向，不能用來處理正常的請求。其用法以下：

location / {
    try_files $uri $uri/ @custom
}
location @custom {
    # ...do something
}
複製代碼

上例中，當嘗試訪問 url 找不到對應的文件就重定向到咱們自定義的命名 location（此處爲 custom）。

值得注意的是，命名 location 中不能再嵌套其它的命名 location。

URL 尾部的/需不須要

關於 URL 尾部的/有三點也須要說明一下。第一點與 location 配置有關，其餘兩點無關。

1. location 中的字符有沒有/都沒有影響。也就是說/user/和/user是同樣的。

2. 若是 URL 結構是https://domain.com/的形式，尾部有沒有/都不會形成重定向。由於瀏覽器在發起請求的時候，默認加上了/。雖然不少瀏覽器在地址欄裏也不會顯示/。這一點，能夠訪問baidu驗證一下。

3. 若是 URL 的結構是https://domain.com/some-dir/。尾部若是缺乏/將致使重定向。由於根據約定，URL 尾部的/表示目錄，沒有/表示文件。因此訪問/some-dir/時，服務器會自動去該目錄下找對應的默認文件。若是訪問/some-dir的話，服務器會先去找some-dir文件，找不到的話會將some-dir當成目錄，重定向到/some-dir/，去該目錄下找默認文件。能夠去測試一下你的網站是否是這樣的。

總結

location 的配置有兩種形式，前綴字符和正則。查找匹配的時候，先查找前綴字符，選擇最長匹配項，再查找正則。正則的優先級高於前綴字符。

正則等查找是按照在配置文件中的順序進行的。所以正則等順序很重要，建議越精細的放的越靠前。

使用=精準匹配能夠加快查找的順序，若是根域名常常被訪問等話建議使用=。