一文弄懂Nginx最核心的配置

背景

在日常的工作中,跟Nginx打交道的時候挺多的。之前對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/,去該目錄下找默認文件。可以去測試一下你的網站是不是這樣的。

總結

  1. location的配置有兩種形式,前綴字符和正則。查找匹配的時候,先查找前綴字符,選擇最長匹配項,再查找正則。正則的優先級高於前綴字符。
  2. 正則的查找是按照在配置文件中的順序進行的。因此正則的順序很重要,建議越精細的放的越靠前。
  3. 使用=精準匹配可以加快查找的順序,如果根域名經常被訪問的話建議使用=。
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章