一文弄懂Nginx的location匹配的實(shí)現(xiàn)

由于團(tuán)隊(duì)在進(jìn)行前后端分離，前端接管了 Nginx 和 node 層，在日常的工作中，跟 Nginx 打交道的時(shí)候挺多的。其中 location 是使用最多和改動(dòng)最多的地方。之前對(duì) location 的匹配規(guī)則是一知半解的。為了搞明白 location 是如何匹配的，特意花了點(diǎn)時(shí)間查了些資料，總結(jié)此文。希望能給大家?guī)韼椭?/p>

語法規(guī)則

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

語法規(guī)則很簡(jiǎn)單，一個(gè)location關(guān)鍵字，后面跟著可選的修飾符，后面是要匹配的字符，花括號(hào)中是要執(zhí)行的操作。

修飾符

• = 表示精確匹配。只有請(qǐng)求的 url 路徑與后面的字符串完全相等時(shí)，才會(huì)命中。
• ~ 表示該規(guī)則是使用正則定義的，區(qū)分大小寫。
• ~* 表示該規(guī)則是使用正則定義的，不區(qū)分大小寫。
• ^~ 表示如果該符號(hào)后面的字符是最佳匹配，采用該規(guī)則，不再進(jìn)行后續(xù)的查找。

匹配過程

對(duì)請(qǐng)求的 url 序列化。例如，對(duì)%xx等字符進(jìn)行解碼，去除 url 中多個(gè)相連的/，解析 url 中的.，..等。這一步是匹配的前置工作。

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

具體的匹配過程如下：

首先先檢查使用前綴字符定義的 location，選擇最長(zhǎng)匹配的項(xiàng)并記錄下來。

如果找到了精確匹配的 location，也就是使用了=修飾符的 location，結(jié)束查找，使用它的配置。

然后按順序查找使用正則定義的 location，如果匹配則停止查找，使用它定義的配置。

如果沒有匹配的正則 location，則使用前面記錄的最長(zhǎng)匹配前綴字符 location。

基于以上的匹配過程，我們可以得到以下兩點(diǎn)啟示：

1. 使用正則定義的 location 在配置文件中出現(xiàn)的順序很重要。因?yàn)檎业降谝粋€(gè)匹配的正則后，查找就停止了，后面定義的正則就是再匹配也沒有機(jī)會(huì)了。
2. 使用精確匹配可以提高查找的速度。例如經(jīng)常請(qǐng)求/的話，可以使用=來定義 location。

示例
接下來我們以一個(gè)例子來具體說明一下匹配過程。

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

location = / {
  [ configuration A ]
}

location / {
  [ configuration B ]
}

location /user/ {
  [ configuration C ]
}

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

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

請(qǐng)求/精準(zhǔn)匹配 A，不再往下查找。

請(qǐng)求/index.html匹配 B。首先查找匹配的前綴字符，找到最長(zhǎng)匹配是配置 B，接著又按照順序查找匹配的正則。結(jié)果沒有找到，因此使用先前標(biāo)記的最長(zhǎng)匹配，即配置 B。

請(qǐng)求/user/index.html匹配 C。首先找到最長(zhǎng)匹配 C，由于后面沒有匹配的正則，所以使用最長(zhǎng)匹配 C。

請(qǐng)求/user/1.jpg匹配 E。首先進(jìn)行前綴字符的查找，找到最長(zhǎng)匹配項(xiàng) C，繼續(xù)進(jìn)行正則查找，找到匹配項(xiàng) E。因此使用 E。

請(qǐng)求/images/1.jpg匹配 D。首先進(jìn)行前綴字符的查找，找到最長(zhǎng)匹配 D。但是，特殊的是它使用了^~修飾符，不再進(jìn)行接下來的正則的匹配查找，因此使用 D。這里，如果沒有前面的修飾符，其實(shí)最終的匹配是 E。大家可以想一想為什么。

請(qǐng)求/documents/about.html匹配 B。因?yàn)?B 表示任何以/開頭的 URL 都匹配。在上面的配置中，只有 B 能滿足，所以匹配 B。

location @name 的用法

@用來定義一個(gè)命名 location。主要用于內(nèi)部重定向，不能用來處理正常的請(qǐng)求。其用法如下：

location / {
  try_files $uri $uri/ @custom
}
location @custom {
  # ...do something
}

上例中，當(dāng)嘗試訪問 url 找不到對(duì)應(yīng)的文件就重定向到我們自定義的命名 location（此處為 custom）。

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

URL 尾部的/需不需要

關(guān)于 URL 尾部的/有三點(diǎn)也需要說明一下。第一點(diǎn)與 location 配置有關(guān)，其他兩點(diǎn)無關(guān)。

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

如果 URL 結(jié)構(gòu)是https://domain.com/的形式，尾部有沒有/都不會(huì)造成重定向。因?yàn)闉g覽器在發(fā)起請(qǐng)求的時(shí)候，默認(rèn)加上了/。雖然很多瀏覽器在地址欄里也不會(huì)顯示/。這一點(diǎn)，可以訪問baidu驗(yàn)證一下。

如果 URL 的結(jié)構(gòu)是https://domain.com/some-dir/。尾部如果缺少/將導(dǎo)致重定向。因?yàn)楦鶕?jù)約定，URL 尾部的/表示目錄，沒有/表示文件。所以訪問/some-dir/時(shí)，服務(wù)器會(huì)自動(dòng)去該目錄下找對(duì)應(yīng)的默認(rèn)文件。如果訪問/some-dir的話，服務(wù)器會(huì)先去找some-dir文件，找不到的話會(huì)將some-dir當(dāng)成目錄，重定向到/some-dir/，去該目錄下找默認(rèn)文件?？梢匀y(cè)試一下你的網(wǎng)站是不是這樣的。

總結(jié)

location 的配置有兩種形式，前綴字符和正則。查找匹配的時(shí)候，先查找前綴字符，選擇最長(zhǎng)匹配項(xiàng)，再查找正則。正則的優(yōu)先級(jí)高于前綴字符。

正則等查找是按照在配置文件中的順序進(jìn)行的。因此正則等順序很重要，建議越精細(xì)的放的越靠前。

使用=精準(zhǔn)匹配可以加快查找的順序，如果根域名經(jīng)常被訪問等話建議使用=。

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持億速云。