Nginx如何根據(jù)前綴路徑轉(zhuǎn)發(fā)到不同的Flask服務(wù)

更新時間：2023年01月06日 09:50:30 作者：Bear_beat

這篇文章主要介紹了Nginx如何根據(jù)前綴路徑轉(zhuǎn)發(fā)到不同的Flask服務(wù)，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

開端

想通過不同的前綴路徑經(jīng)過nginx轉(zhuǎn)發(fā)到不同的服務(wù)上，比如 /user/轉(zhuǎn)發(fā)到用戶服務(wù)，/other/轉(zhuǎn)發(fā)到其他服務(wù)。

首先配置nginx的location根據(jù)前綴匹配。

server {
    listen 80;
    server_name localhost;

    location /user/ {
            proxy_pass http://127.0.0.1:5000; # 用戶服務(wù)
    }

	  location /other/ {
            proxy_pass http://127.0.0.1:5001; # 其他服務(wù)
    }
}

這樣訪問http://127.0.0.1:5000/user/xxx/就會轉(zhuǎn)發(fā)到用戶服務(wù)，訪問http://127.0.0.1:5000/other/xxx/就會轉(zhuǎn)發(fā)到其他服務(wù)。

這樣就會有一個問題，flask application并不知道有前綴，所以使用url_for構(gòu)造url的時候并不會自己添加前綴，要構(gòu)造出正確帶前綴的url就需要把前綴加入到WSGI環(huán)境中的SCRIPT_NAME去。

解決一（設(shè)置SCRIPT_NAME）

gunicorn文檔上：

可以把SCRIPT_NAME設(shè)置到環(huán)境變量中或者HTTP header中。

通過docker部署設(shè)置SCRIPT_NAME在環(huán)境變量中，可以在docker-compose.yml中加入

environment:
  - SCRIPT_NAME=/user/

或者把SCRIPT_NAME設(shè)置在header中可以在nginx配置中加上

proxy_set_header SCRIPT_NAME /user/;

gunicorn.wsgi處理請求的時候是這樣處理PATH_INFO和SCRIPT_NAME的：

解決二（設(shè)置頭部X-Forwarded-Prefix再用ProxyFix調(diào)整WSGI環(huán)境）

同樣的也可以ProxyFix中間件來調(diào)整WSGI環(huán)境，設(shè)置SCRIPT_NAME。

來自werkzeug ProxyFix文檔：

通過nginx設(shè)置頭部信息X-Forwarded-Prefix：

proxy_set_header X-Forwarded-Prefix /user/;

使用ProxyFix：

from werkzeug.middleware.proxy_fix import ProxyFix
app = ProxyFix(app, x_prefix=1)

還需要把nginx的proxy_pass修改下：

server {
    listen 80;
    server_name example.com;

    location /user/ {
            proxy_pass http://127.0.0.1:5000/; # 用戶服務(wù)
    }

	  location /other/ {
            proxy_pass http://127.0.0.1:5001/; # 其他服務(wù)
    }
}

兩種解決的區(qū)別

nginx proxy_pass配置的區(qū)別

區(qū)別在于nginx的proxy_pass中結(jié)尾是否帶/。

如果proxy_pass不帶uri，就是不帶/，則請求會原封不動的轉(zhuǎn)發(fā)給下一個服務(wù)。

如果proxy_pass帶uri，則匹配的uri部分將會被修改為該proxy_pass中的uri。

為什么需要這樣處理

以我的理解是這樣的，請求進(jìn)來通過gunicorn處理請求，gunicorn.wsgi中會根據(jù)SCRIPT_NAME來制定PATH_INFO，所以當(dāng)解決一帶著SCRIPT_NAME=/user/，PATH_INFO=/user/xxx/經(jīng)過處理后PATH_INFO會變成/xxx/。

而解決二中當(dāng)gunicorn.wsgi處理請求時ProxyFix還沒對WSGI環(huán)境進(jìn)行處理，所以SCRIPT_NAME是為空的，PATH_INFO則會一直是帶著SCRIPT_NAME前綴為/user/xxx/，是不能正確匹配到route的，所以把nginx proxy_pass改為uri形式使PATH_INFO能正確匹配。