1. 程式人生 > >Nginx的location匹配

Nginx的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的配置有兩種形式,字首字元和正則。查詢匹配的時候,先查詢字首字元,選擇最長匹配項,再查詢正則。正則的優先順序高於字首字元。

正則的查詢是按照在配置檔案中的順序進行的。因此正則的順序很重要,建議越精細的放的越靠前。

使用=精準匹配可以加快查詢的順序,如果根域名經常被訪問的話建議使用=