nginx中的正则表达式，location路径匹配规则和优先级

前言，我这里验证的nginx-v1.23.2单机环境下的nginx中的正则表达式、location路径匹配规则和优先级。

先准备好环境，基础配置是这样 nginx/conf/conf.d/host.conf ：

server {
    listen 8081;
    server_name  10.90.5.70;

    proxy_connect_timeout 60;
    proxy_read_timeout 600;
    proxy_send_timeout 600;
    proxy_set_header    X-Real-IP           $remote_addr;
    proxy_set_header    X-Forwarded-For     $proxy_add_x_forwarded_for;
    proxy_set_header    X-Forwarded-Proto   "http";
    proxy_set_header    Host                $host;
    proxy_http_version  1.1;
    proxy_set_header    Connection  "";
    proxy_next_upstream error non_idempotent;

    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection "upgrade";

    location / {
        root   /usr/share/nginx/html;
        index  index.html index.htm;
    }
}

下面的案例都是基于以上配置验证的。

---

一，nginx中的正则表达式

nginx中的正则表达式基本遵循了Regular Expression格式和规则。不同的是，一般以特殊字符代表正则表达式的开始，即标识要用Regular Expression处理其后的字符。

nginx里面可以使用正则表达式的部分可以是 server里，或者location 路径上。

常见的正则表达式的含义

^ ：匹配输入字符串的起始位置
$ ：匹配输入字符串的结束位置
. ：匹配除“\n”之外的任何单个字符，若要匹配包括“\n”在内的任意字符，请使用诸如“[.\n]”之类的模式
\d ：匹配纯数字
\w ：匹配字母或数字或下划线或汉字
\s ：匹配任意的空白符
\b ：匹配单词的开始或结束

【下面这部分是标注匹配长度(字符数量、重复数量)的】
* ：匹配前面的字符零次或多次。如“ol*”能匹配“o”及“ol”、“oll”
+ ：匹配前面的字符一次或多次。如“ol+”能匹配“ol”及“oll”、“olll”，但不能匹配“o”
? ：匹配前面的字符零次或一次，例如“do(es)?”能匹配“do”或者“does”，”?”等效于”{0,1}”
{n} ：重复 n 次
{n,} ：重复 n 次或更多次
{n,m} ：重复 n 到 m 次

[] ：定义匹配的字符范围
[c] ：匹配单个字符 c
注意：在括号里面用-表示范围：
[a-z] ：匹配 a-z 小写字母的任意一个
[a-zA-Z0-9] ：匹配所有大小写字母或数字
() ：表达式的开始和结束位置 例如：(jpg|gif|swf|)

| ：或运算符
! ：非运算符（与其后面的表达式去反运算）
正则表达式里面没有“与运算符”。

\ ：转义字符，将后面接着的字符标记为一个特殊字符或一个原义字符或一个向后引用。如“\n”匹配一个换行符，而“\$”则匹配“$”

参考链接：https://www.jb51.net/article/149053.htm

二，location路径匹配规则和优先级

location:用来设置请求的URI。nginx中location配置项是最基础的配置，而且它的配置也稍显复杂。

location匹配规则 与 优先级

默认值 /

语法 location [ = | ~ | ~* | ^~ ] uri { ... }

位置 server,location

uri变量是待匹配的请求字符串，可以不包含正则表达式，也可以包含正则表达式。那么：

nginx服务器在搜索匹配location的时候，是先使用不包含正则表达式进行匹配，找到一个匹配度最高的一个，然后在通过包含正则表达式的进行匹配，如果能匹配到直接访问，匹配不到，就使用刚才匹配度最高的那个location来处理请求。

另一种描述，意思是一样的：

location 匹配的优先级(与location在配置文件中的顺序无关)
= 精确匹配会第一个被处理。如果发现精确匹配，nginx停止搜索其他匹配。
普通字符匹配，正则表达式规则和长的块规则将被优先和查询匹配，也就是说如果该项匹配还需去看有没有正则表达式匹配和更长的匹配。
^~ 则只匹配该规则，nginx停止搜索其他匹配，否则nginx会继续处理其他location指令。
最后匹配理带有"~"和"~*"的指令，如果找到相应的匹配，则nginx停止搜索其他匹配；
当没有正则表达式或者没有正则表达式被匹配的情况下，那么匹配程度最高的逐字匹配指令会被使用。

location 优先级官方文档：

1.  Directives with the = prefix that match the query exactly. If found, searching stops.
2.  All remaining directives with conventional strings, longest match first. If this match used the ^~ prefix, searching stops.
3.  Regular expressions, in order of definition in the configuration file.
4.  If #3 yielded a match, that result is used. Else the match from #2 is used.

1.  =前缀的指令严格匹配这个查询。如果找到，停止搜索。
2.  所有剩下的常规字符串，最长的匹配。如果这个匹配使用^〜前缀，搜索停止。
3.  正则表达式，在配置文件中定义的顺序。
4.  如果第3条规则产生匹配的话，结果被使用。否则，如同从第2条规则被使用。

它包含了路径的匹配规则和针对该规则的配置。

location规则按照前导符主要分五类：

代号	前导符	说明
①	= uri	全字匹配，只有当请求路径和uri完全匹配时，对应的规则才会生效
②	~ regular	区分大小写的正则匹配
③	~* regular	不区分大小写的正则匹配
④	^~ uri	否定正则的路径匹配
⑤	url	没有任何前导符的路径匹配

这五类规则，同时存在配置文件中时，按照一定的优先级规则生效。

优先级：( location = ) > ( location 完整路径 ) > ( location ^~ 否定正则 ) > ( location ~* 正则顺序 ) > ( location ~ 区分大小写正则顺序 ) > ( location 部分起始路径 ) > ( / )

优先级：① > ④ > ③ > ② > ⑤

nginx规则决定流程如下图：



文字说明：

以下说明非常关键

一、检查请求uri是否与某个=规则匹配，如果有，直接应用规则，终止后续匹配。

二、nginx首先检查所有路径匹配规则配置项，包括"^~"规则和没有前导符号的规则，选择并记住和当前请求uri匹配度最长的配置项。但这个时候，并不会启用相关的配置，而仅仅是记住。

三、判断上一步中选择下来的路径规则是否包含 ^~ ，如果包含，则使用该条规则，终止后续匹配。

四、按配置顺序进行正则表达式检查，匹配到第一条合适的正则表达式时，使用该条规则，终止后续匹配。

五、使用步骤三选择出来的路径匹配规则。

下面以实例属性介绍：

1，不带符号，要求必须以指定模式开始

location指令实例：

server {
    listen 8081;
    server_name 127.0.0.1;

   # 不带符号，要求必须以指定模式开始（区分大小写，并且后面带/是有区别的）
   location /aaa {
        default_type text/plain;
        return 200 "access success aaa \n\r";
   }
}

# 能匹配到：
http://127.0.0.1:8081/aaa
http://127.0.0.1:8081/aaa/
http://127.0.0.1:8081/aaadef
http://127.0.0.1:8081/aaa/def/
http://127.0.0.1:8081/aaa?p1=TOM

# 不能匹配到（大小写区分）：
http://127.0.0.1:8081/Aaa

# 如果规则（后面跟/目录符号） location /aaa/ { 则只能匹配到下面两行：
http://127.0.0.1:8081/aaa/
http://127.0.0.1:8081/aaa/def/

如图：

2，= 用于不包含正则表达式的uri前，必须与指定的模式精确匹配

实测，等于号后面有或没有空格不影响效果。location指令实例：

server {
    listen 8081;
    server_name 127.0.0.1;

   # = : 用于不包含正则表达式的uri前，必须与指定的模式精确匹配（区分大小写，并且后面带/是有区别的）
   location = /bbb {
        default_type text/plain;
        return 200 "access success bbb \n\r";
   }

}

# 能匹配到：
http://127.0.0.1:8081/bbb
http://127.0.0.1:8081/bbb?p1=TOM

# 不能匹配到（大小写区分）：
http://127.0.0.1:8081/bbb/
http://127.0.0.1:8081/bbbcd
http://127.0.0.1:8081/Bbb

如图：

3，包含正则表达式的

~ ： 用于表示当前uri中包含了正则表达式，并且区分大小写

~*: 用于表示当前uri中包含了正则表达式，并且不区分大小写

换句话说，如果uri包含了正则表达式，需要用上述两个符合来标识

^~: 用于不包含正则表达式的uri前，功能和不加符号的一致，唯一不同的是，如果模式匹配，那么就停止搜索其他模式了。（可用它提升优先级）

含正则表达式的location指令，实例一：

server {
    listen 8081;
    server_name 127.0.0.1;

   # ~ ： 用于表示当前uri中包含了正则表达式，并且区分大小写
   # 正则表达式：区分大小写，以/abc开头，以1个字母或数字或下划线或汉字结束的
   location ~^/eee\w$ {
        default_type text/plain;
        return 200 "access success. 000 Regular expression matched: eee  \n\r";
   }
}

# 能匹配到：
http://127.0.0.1:8081/eeeb
http://127.0.0.1:8081/eeeB
http://127.0.0.1:8081/eee2

# 不能匹配到（大小写区分）：
http://127.0.0.1:8081/eee
http://127.0.0.1:8081/Eee
http://127.0.0.1:8081/eee/
http://127.0.0.1:8081/eeedef
http://127.0.0.1:8081/eee/def/
http://127.0.0.1:8081/eee?p1=TOM

如图：

含正则表达式的location指令，实例二：

server {
    listen 8081;
    server_name 127.0.0.1;

   # ~*: 用于表示当前uri中包含了正则表达式，并且不区分大小写
   # 正则表达式：不区分大小写，以/abc开头，以字母或数字或下划线或汉字结束的
   location ~*^/ddd\w$ {
        default_type text/plain;
        return 200 "access success. 111 Regular expression matched: ddd  \n\r";
   }
}

# 能匹配到：
http://127.0.0.1:8081/dddb
http://127.0.0.1:8081/dddB
http://127.0.0.1:8081/ddd2
http://127.0.0.1:8081/DddH

# 不能匹配到（大小写区分）：
http://127.0.0.1:8081/ddd
http://127.0.0.1:8081/Ddd
http://127.0.0.1:8081/ddd/
http://127.0.0.1:8081/ddddef
http://127.0.0.1:8081/ddd/def/
http://127.0.0.1:8081/ddd?p1=TOM

如图：

不包含正则表达式的location指令，实例三：

server {
    listen 8081;
    server_name 127.0.0.1;

   # ^~: 用于不包含正则表达式的uri前，功能和不加符号的一致，唯一不同的是，如果模式匹配，那么就停止搜索其他模式了，可用于提升优先级。（区分大小写，并且后面带/是有区别的）
   location ^~ /fff {
        default_type text/plain;
        return 200 "access success. Non Regular expression matched: fff  \n\r";
   }
}

# 能匹配到：
http://127.0.0.1:8081/fff
http://127.0.0.1:8081/fff/
http://127.0.0.1:8081/fffdef
http://127.0.0.1:8081/fff/def/
http://127.0.0.1:8081/fff?p1=TOM

# 不能匹配到（大小写区分）：
http://127.0.0.1:8081/Fff
http://127.0.0.1:8081/pp/fff

# 如果规则（后面跟/目录符号） location /fff/ { 则只能匹配到下面两行：
http://127.0.0.1:8081/fff/
http://127.0.0.1:8081/fff/def/

如图：

定义一个命名的 location

用"@" 定义一个命名的 location，使用在内部定向时，例如：error_page, try_files

@location 例子：

# 示例：404错误页将被内部重定向
    error_page 404 = @fetch;
    location @fetch(
        proxy_pass http://fetch;
    )

# 类似案例：
    error_page  404              /404.html;
    error_page   500 502 503 504  /50x.html;
    location = /50x.html {
        root   /usr/share/nginx/html;
    }