Nginx基础

• location
  • 基础使用
  • URL-match
  • modifier
• proxy_pass
  • 简述
  • URI
  • 斜杠（/）问题
  • \$uri \$request_uri
• BMW WARNING

location

基础使用

location 位于 server 下或位于另一个 location 中，基本使用如下

location [modifier] [URL-match] {
  ...
}

URL-match

匹配所有路径

location / {
}

优先级最低，所有都不匹配时，才会命中

modifier

URI 这里指 URL 除了 server:port 的部分。

命中优先级
优先级由上依次降低。

modifier	desc	example
=	exact (精确匹配)	location = /site
^~	priority prefix (优先字符)	location ^~ /site
~	case sensitive regex (大小写敏感正则)	location ~ /site
~*	case insensitive regex(忽略大小写)	location ~* /site
(none)	prefix(字符匹配，无修饰符，由 URI 头字符开始匹配)	location /site

在如下网址可进行匹配测试 https://nginx.viraptor.info/

^~ 与(none)都 进行字符匹配（非正则），^~ 相对于(none) ，提高了命中优先级。

典型示例

示例 1

location ^~ /file/* {
    proxy_pass http://bbb.com/;
}

^~ 进行字符匹配
http://domain2.com/file/* 可以命中
http://domain2.com/file/1 不能命中

示例 2

location ~ /file/* {
    proxy_pass http://bbb.com/;
}
location ^~ /file/ {
    proxy_pass http://bbb.com/;
}

http://domain2.com/file/1 根据优先级命中^~ /file/

proxy_pass

简述

proxy_pass 通常位于 location 下，用于接口转发。

URI

一般把 server:port 后的部分叫做 URI，proxy_pass 在其后加不加 URI 表现完全不同。
location 非正则匹配时，对于 proxy_pass 有如下规则：
proxy_pass 有 URI
替换请求中匹配的 URI 并替换成 proxy_pass 中的 URI 并向上游服务转发。

location /file {
    proxy_pass http://bbb.com/src;
}

http://aaa.com/file/search 真实访问地址为http://bbb.com/src/search

location /file {
    proxy_pass http://bbb.com/;
}

http://aaa.com/file/search 真实访问地址为http://bbb.com//search

proxy_pass 无 URI
保留请求 URI 并将其转发到上游服务

location /file {
    proxy_pass http://bbb.com;
}

http://aaa.com/file/search 真实访问地址为http://bbb.com/file/search

location 为正则匹配时，由于 nginx 不知道替换哪些字符，
proxy_pass 的 URI 不起作用，保留原 URI，转发到上上游服务

location ~ /file {
    proxy_pass http://bbb.com/src;
}

http://aaa.com/file/search 真实访问地址为http://bbb.com/file/search

斜杠（/）问题

location 正则匹配时，不需要考虑 proxy_pass 的 URI
location 非正则匹配时，当 proxy_pass 有 URI 时，需要注意 URI 的尾斜杠，具体表现为如下

location	proxy_pass	Request	Received by upstream
/file/	http://bbb.com/src/	/file/search?name=baz	/src/search?name=baz
/file/	http://bbb.com/src	/file/search?name=baz	/srcsearch?name=baz
/file	http://bbb.com/src/	/file/search?name=baz	/src//search?name=baz
/file	http://bbb.com/src	/file/search?name=baz	/src/search?name=baz
/file	http://bbb.com/src	/filesearch?name=baz	/srcsearch?name=baz
~ /file/	http://bbb.com/src/[^1]	/file/search?name=baz	/file/search?name=baz
~ /file/search/(.*)$	http://bbb.com/src?name=$1[^1]	/file/search/baz	/src?name=baz
~ /file/	http://bbb.com	/file/search?name=baz	/file/search?name=baz

location 正则匹配保留 Request 原始 URI
非正则（前缀）匹配时，proxy_pass 有 URI 直接用 该 URI 替换 Request 中 URI 与 location 对应的字符，无 URI 则保留 Request 原始 URI

总之一句话
location 采用字符前缀匹配时 proxy_pass 中的 URI 替换原始 URI

[^1]: 较新版的 nginx 不支持正则中的 proxy_pass 有 URI(指纯字符 URI，经过测试，包含变量如$1等时可以)，会报错。"proxy_pass" cannot have URI part in location given by regular expression, or inside named location, or inside "if" statement, or inside "limit_except" block

\$uri \$request_uri

要同时保留 location 与 proxy_pass 的 URI 需要使用前缀匹配的同时用到 $uri 或$request_uri
两者区别是$uri 不会保留请求中的路由参数
具体如下

location	proxy_pass	Request	Received by upstream
/file/	http://bbb.com/src$uri	/file/search?name=baz	/src/file/search
/file/	http://bbb.com/src$request_uri	/file/search?name=baz	/src/file/search?name=baz

注意$uri与$request_uri 自带头斜杠

BMW WARNING

• Bulletin

本文首发于 skyline.show 欢迎访问。

I am a bucolic migrant worker but I never walk backwards.

• Material

参考资料如下列出，部分引用可能遗漏或不可考，侵删。

https://nginx.viraptor.info/ https://www.digitalocean.com/community/tutorials/understanding-nginx-http-proxying-load-balancing-buffering-and-caching

• Warrant

本文作者： Skyline(lty)
授权声明： 本博客所有文章除特别声明外， 均采用 CC BY - NC - SA 3.0 协议。 转载请注明出处！

CC BY - NC - SA 3.0