Nginx配置Location指令块

Nginx 配置文件，自下到上分为三种层次分明的结构：

| http block the protocol level

| ----- server block the server level

| ------------ location block the requested URI

Nginx 允许用户定义 Location block ，并指定一个匹配模式（pattern）匹配特定的 URI。

除了简单的字符串（比如文件系统路径），还允许使用更为复杂的匹配模式（pattern）。

Location block 的基本语法形式是：

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

[ = | ~ | ~* | ^~ | @ ] 被称作 location modifier ，定义 Nginx 如何去匹配其后的 pattern ，以及该 pattern 的最基本的属性，例如简单字符串或正则表达式。

location 匹配命令

1) = # 进行普通字符精确完全匹配
2) ~ # 表示执行一个正则匹配，区分大小写
3) ~* # 表示执行一个正则匹配，不区分大小写
4) ^~ # ^~表示普通字符匹配，如果该选项匹配则只匹配该选项，不匹配别的选项，一般用来匹配目录
5) @ # "@" 定义一个命名的 location，使用在内部定向时，例如 error_page, try_files

更多详细的匹配规则，请见米扑博客：Nginx location 正则匹配规则

文件及目录匹配

1) -f和!-f用来判断是否存在文件

2) -d和!-d用来判断是否存在目录

3) -e和!-e用来判断是否存在文件或目录

4) -x和!-x用来判断文件是否可执行

rewrite 指令的最后一项参数为flag标记，flag标记有：

1) last 相当于apache里面的[L]标记，表示 rewrite

2) break本条规则匹配完成后，终止匹配，不再匹配后面的规则。

3) redirect 返回302临时重定向，浏览器地址会显示跳转后的URL地址。

4) permanent 返回301永久重定向，浏览器地址会显示跳转后的URL地址。

location modifier

1. =

普通字符串完全匹配，即完全匹配（不是正则表达式）指定的 pattern ，且 pattern 被限制成简单的字符串，也就是说这里不能使用正则表达式。

Example:

server {
server_name website.com;
location = /abcd {
[…]
}
}

匹配情况：

http://website.com/abcd # 正好完全匹配
http://website.com/ABCD           # 如果运行Nginx server的系统本身对大小写不敏感，比如Windows ，那么也匹配；Linux不匹配，操作系统区分大小写
http://website.com/abcd?param1&param2       # 匹配，忽略查询串参数（query string arguments），这里就是 /abcd 后面的 ?param1&param2
http://website.com/abcd/       # 不匹配，因为末尾存在反斜杠（trailing slash），Nginx 不认为这种情况是完全匹配
http://website.com/abcde       # 不匹配，因为不是完全匹配 /abcd 与 /abcde 不同

2. (None)

普通字符串匹配，可以不写 location modifier (为空)，Nginx 仍然能去匹配 pattern 。

这种情况下，匹配那些以指定的 patern 开头的 URI，注意这里的 URI 只能是普通字符串，不能使用正则表达式。

Example:

server {
server_name website.com;
location /abcd {
[…]
}
}

匹配情况：

http://website.com/abcd # 正好完全匹配
http://website.com/ABCD # 如果运行 Nginx server 的系统本身对大小写不敏感，比如 Windows ，那么也匹配；Linux不匹配，操作系统区分大小写
http://website.com/abcd?param1&param2 # 匹配，忽略查询串参数（query string arguments），这里就是 /abcd 后面的 ?param1&param2
http://website.com/abcd/ # 匹配，末尾存在反斜杠（trailing slash）也属于匹配范围内
http://website.com/abcde # 仍然匹配，因为 URI 是以 pattern 开头的

3. ~

正则匹配，这个 location modifier 对大小写敏感，且 pattern 须是正则表达式

Example:

server {
server_name website.com;
location ~ ^/abcd$ {
[…]
}
}

匹配情况：

http://website.com/abcd # 完全匹配
http://website.com/ABCD # 不匹配，~ 对大小写是敏感的
http://website.com/abcd?param1&param2 # 匹配，忽略查询串参数（query string arguments），这里就是 /abcd 后面的 ?param1&param2
http://website.com/abcd/ # 不匹配，因为末尾存在反斜杠（trailing slash），并不匹配正则表达式 ^/abcd$
http://website.com/abcde # 不匹配，正则表达式 ^/abcd$

注意：对于一些对大小写不敏感的系统，比如 Windows ，~ 和 ~* 都是不起作用的，这主要是操作系统的原因。

4. ~*

正则匹配，与 ~ 类似，但这个 location modifier 不区分大小写，pattern 须是正则表达式

Example:

server {
server_name website.com;
location ~* ^/abcd$ {
[…]
}
}

匹配情况：

http://website.com/abcd # 完全匹配
http://website.com/ABCD # 匹配，这就是它不区分大小写的特性
http://website.com/abcd?param1&param2 # 匹配，忽略查询串参数（query string arguments），这里就是 /abcd 后面的 ?param1&param2
http://website.com/abcd/ # 不匹配，因为末尾存在反斜杠（trailing slash），并不匹配正则表达式 ^/abcd$
http://website.com/abcde # 不匹配，正则表达式 ^/abcd$

5. ^~

普通字符串匹配，匹配情况类似 2. (None) 的情况，以指定匹配模式开头的 URI 被匹配。

不同的是贪心匹配，一旦匹配成功，那么 Nginx 就停止去寻找其他的 Location 块进行匹配了，与 Location 匹配顺序有关

6. @

内部匹配，用于定义一个 Location 块，且该块不能被外部 Client 所访问，只能被 Nginx 内部配置指令所访问，比如 try_files 、error_page

示例：

error_page 404 = @fetch;
location @fetch(
    proxy_pass http://fetch_error;
)

Nginx 默认的 error_page 配置如下：

error_page  404              /404.html;
location = /404.html {
    root   html;
}

error_page  400 402 403 405 406  /40x.html;
location = /40x.html {
    root   html;
}

# redirect server error pages to the static page /50x.html
#
error_page   500 502 503 504  /50x.html;
location = /50x.html {
    root   html;
}

匹配顺序和优先级

因为可以定义多个 Location 块，每个 Location 块可以有各自的 pattern 。

因此就需要明白当 Nginx 收到一个请求时，它是如何去匹配 URI 并找到合适的 Location 的，例如匹配后立即返回，匹配后break中断，匹配到最后一条规则等。

要注意的是，写在配置文件中每个 Server 块中的 Location 块的次序是不重要的，Nginx 会按 location modifier 的优先级来依次用 URI 去匹配 pattern（推荐按照优先级顺序写）

顺序如下：

1. = 精确匹配第一个被处理，如果发现精确匹配，nginx停止搜索其他匹配
2. (None) 如果 pattern 完全匹配 URI（不是只匹配 URI 的头部，例如 /abcd 也匹配 /abcdef ）
3. ^~ 普通字符串匹配，只匹配该规则，nginx停止搜索其他匹配，否则nginx会继续处理其他location指令
4. ~ 或 ~* 正则匹配，如果找到相应的匹配，则nginx停止搜索其他匹配；当没有正则表达式或者没有正则表达式被匹配的情况下，那么匹配程度最高的逐字匹配指令会被使用
5. (None) pattern 匹配 URI 的头部

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  = / {
  # 只匹配"/".
  [ configuration A ] 
}
location  / {
  # 匹配任何请求，因为所有请求都是以"/"开始
  # 但是更长字符匹配或者正则表达式匹配会优先匹配
  [ configuration B ] 
}
location ^~ /images/ {
  # 匹配任何以 /images/ 开始的请求，并停止匹配其它location
  [ configuration C ] 
}
location ~* \.(gif|jpg|jpeg)$ {
  # 匹配以 gif, jpg, or jpeg结尾的请求. 
  # 但是所有 /images/ 目录的请求将由 [Configuration C]处理.   
  [ configuration D ] 
}

请求URI例子: