Nginx location 和 proxy_pass路徑配置詳解

• 2021 年 9 月 1 日
• 筆記
• Nginx

本文是基於 location 的匹配末尾是否配置 / 和 proxy_pass 末尾是否配置 / ，進行測試，完全還原了整個測試過程。幫助了解具體的情況。

一、Nginx location 基本配置

1.1、Nginx 配置文件

upstream test1{
server 127.0.0.1:8000;
}
upstream test2{
server 127.0.0.1:8000;
}
server{
	server_name  test.com;
	listen 80;
        access_log /usr/local/openresty/nginx/logs/test.com_access.log latest;
        error_log  /usr/local/openresty/nginx/logs/test.com.log error;
        proxy_set_header   Host             $host;
        proxy_set_header   X-Real-IP        $remote_addr;
        proxy_set_header   X-Forwarded-For  $proxy_add_x_forwarded_for;
        proxy_connect_timeout   3s;
        proxy_read_timeout 120s;
        proxy_send_timeout 120s;
        proxy_next_upstream error timeout invalid_header http_404 http_502 http_504 http_500;
	
        location /user/ {
			proxy_set_header Connection "";
        	proxy_http_version 1.1;
			proxy_pass //test1/;
		}
        location / {
                proxy_set_header Connection "";
                proxy_http_version 1.1;
                proxy_pass //test2/;
        }
}

1.2 、Python 腳本

python2 可以運行

該腳本用於獲取請求內容。 這個作為後端，也就是 proxy_pass 代理的後端。

#!/usr/bin/env python

import SimpleHTTPServer
import SocketServer

PORT = 8000

class GetHandler(SimpleHTTPServer.SimpleHTTPRequestHandler):
    def do_GET(self):
        print(self.headers)
        self.send_response(200, "")
    def do_POST(self):
        print(self.headers)
        content_length = self.headers.getheaders('content-length')
        length = int(content_length[0]) if content_length else 0
        print(self.rfile.read(length))
        self.send_response(200, "")

Handler = GetHandler
httpd = SocketServer.TCPServer(("", PORT), Handler)
httpd.serve_forever()

二、測試

2.1、測試 location 末尾存在 / 和 proxy_pass末尾存在 /

nginx配置如下

        location /user/ {
			proxy_set_header Connection "";
        	proxy_http_version 1.1;
			proxy_pass //test1/;
		}

請求url

test.com/user/test.html

後端內容

打印的內容：

Host: test1
Content-Length: 0
User-Agent: PostmanRuntime/7.26.8
Accept: */*
Postman-Token: f2bfe770-4f44-4ee9-91c4-060f59dfb26c
Accept-Encoding: gzip, deflate, br


127.0.0.1 - - [10/Apr/2021 16:54:26] "POST /test.html HTTP/1.1" 200 -

小結論：proxy_pass 地址加了 / 的話， 請求 test.com/user/test.html 實際請求是 //test1/test.html。

2.2、測試 location 末尾存在 / 和 proxy_pass末尾不存在 /

nginx配置如下

        location /user/ {
			proxy_set_header Connection "";
        	proxy_http_version 1.1;
			proxy_pass //test1;
		}

請求url

test.com/user/test.html

後端內容

打印的內容：

Host: test1
Content-Length: 0
User-Agent: PostmanRuntime/7.26.8
Accept: */*
Postman-Token: e33d0a2c-1965-4152-b87c-94fca50f2899
Accept-Encoding: gzip, deflate, br


127.0.0.1 - - [10/Apr/2021 16:57:18] "POST /user/test.html HTTP/1.1" 200 -

小結論： proxy_pass 地址不加了 / 的話， 請求 test.com/user/test.html 實際請求是 //test1/user/test.html

2.3、測試三 location 不加末尾 / 且 proxy_pass 不加 末尾 /

nginx配置如下

        location /user {
			proxy_set_header Connection "";
        	proxy_http_version 1.1;
			proxy_pass //test1;
		}

請求url

test.com/user/test.html

後端內容

打印的內容：

Host: test1
Content-Length: 0
User-Agent: PostmanRuntime/7.26.8
Accept: */*
Postman-Token: 31cd33c6-4c95-41b5-a095-28cdc7113dcd
Accept-Encoding: gzip, deflate, br


127.0.0.1 - - [10/Apr/2021 16:59:34] "POST /user/test.html HTTP/1.1" 200 -

請求 test.com/user/test.html 實際請求是 //test1/user/test.html

2.4、location 不加末尾 / 且 proxy_pass 加 末尾 /

nginx配置如下

        location /user {
			proxy_set_header Connection "";
        	proxy_http_version 1.1;
			proxy_pass //test1/;
		}

請求url

test.com/user/test.html

後端內容

打印的內容：

Host: test1
Content-Length: 0
User-Agent: PostmanRuntime/7.26.8
Accept: */*
Postman-Token: d0f4b83f-6482-41ba-8a01-c059eececc2d
Accept-Encoding: gzip, deflate, br


127.0.0.1 - - [10/Apr/2021 17:00:21] "POST //test.html HTTP/1.1" 200 -

請求 test.com/user/test.html 實際請求是 //test1//test.html

2.5、location 末尾有 / proxy_pass 末尾其他有路徑,且末尾加 /

nginx配置如下

        location /user/ {
			proxy_set_header Connection "";
        	proxy_http_version 1.1;
			proxy_pass //test1/haha/;
		}

請求url

test.com/user/test.html

後端內容

打印的內容：

Host: test1
Content-Length: 0
User-Agent: PostmanRuntime/7.26.8
Accept: */*
Postman-Token: 6447cf0b-5988-4f96-81a4-2b621fe32604
Accept-Encoding: gzip, deflate, br


127.0.0.1 - - [10/Apr/2021 17:03:27] "POST /haha/test.html HTTP/1.1" 200 -

請求 test.com/user/test.html 實際請求是 //test1/haha/test.html

2.6、 location 末尾有 / proxy_pass 末尾其他有路徑,且末尾不加 /

nginx配置如下

        location /user/ {
			proxy_set_header Connection "";
        	proxy_http_version 1.1;
			proxy_pass //test1/haha;
		}

請求url

test.com/user/test.html

後端內容

打印的內容：

Host: test1
Content-Length: 0
User-Agent: PostmanRuntime/7.26.8
Accept: */*
Postman-Token: 32fb2a50-1e7c-4131-9804-1828e21ca841
Accept-Encoding: gzip, deflate, br


127.0.0.1 - - [10/Apr/2021 17:05:03] "POST /hahatest.html HTTP/1.1" 200 -

請求 test.com/user/test.html 實際請求是 //test1/hahatest.html

三、總結

注意上表格中的後端是指 python 腳本對應的web服務。

在日常的web網站部署中，經常會用到 nginx的 proxy_pass 反向代理，有一個配置需要弄清楚：配置 proxy_pass 時，

• 當在後面的 upstram_name 後面出現了 /，相當於是絕對根路徑，則 nginx 不會把 location 中匹配的路徑部分代理走;
• 如果沒有 /，則會把匹配的路徑部分也給代理走。