Python WSGI 規(guī)范簡(jiǎn)介

作為 Python Web 開(kāi)發(fā)者來(lái)說(shuō)，在開(kāi)發(fā)程序階段一般是不會(huì)接觸到 WSGI 這個(gè)名詞的，但當(dāng)程序開(kāi)發(fā)完成，考慮上線(xiàn)部署的時(shí)候，WSGI 規(guī)范是一個(gè)繞不開(kāi)的話(huà)題，本文將介紹何為 WSGI。

WSGI 全拼 Web Server Gateway Interface，是為 Python 語(yǔ)言定義的 Web 服務(wù)器和 Web 應(yīng)用程序（或框架）之間的一種通用編程接口。翻譯成白話(huà)就是說(shuō) WSGI 是一個(gè)協(xié)議，就像 HTTP 協(xié)議定義了客戶(hù)端和服務(wù)端數(shù)據(jù)傳輸?shù)囊?guī)范，WSGI 協(xié)議定義了 Web 服務(wù)器和 Web 應(yīng)用程序之間協(xié)同工作的規(guī)范。

Python Web 應(yīng)用部署方案

Flask 或 Django 等 Web 框架都提供了內(nèi)置的 Web Server，本地開(kāi)發(fā)階段可以使用 flask run 或 python manage.py runserver 來(lái)分別啟動(dòng) Flask 或 Django 內(nèi)置的 Server。

在生產(chǎn)環(huán)境部署應(yīng)用時(shí)，通常不會(huì)使用框架內(nèi)置的 Server，而是使用 Gunicorn 或 uWSGI 來(lái)部署，以獲得更好的性能。部署過(guò) Python Web 應(yīng)用的同學(xué)應(yīng)該對(duì)如下部署架構(gòu)有所了解，左側(cè)是瀏覽器，右側(cè)是服務(wù)器。在服務(wù)器內(nèi)部，首先通過(guò) Nginx 來(lái)監(jiān)聽(tīng) 80/443 端口，當(dāng)接收到來(lái)自客戶(hù)端的請(qǐng)求時(shí)，Nginx 會(huì)將請(qǐng)求轉(zhuǎn)發(fā)到監(jiān)聽(tīng) 5000 端口的 Gunicorn/uWSGI Server，接著請(qǐng)求會(huì)通過(guò) WSGI 協(xié)議被傳遞到 Flask/Django 框架，在框架內(nèi)部處理請(qǐng)求邏輯后，會(huì)將響應(yīng)信息按照原路返回。

你可能會(huì)問(wèn)，Nginx 性能很高，為什么不將應(yīng)用直接部署到 Nginx 上，而是中間通過(guò) Gunicorn/uWSGI 做一層轉(zhuǎn)發(fā)呢？因?yàn)?Nginx 沒(méi)有遵循 WSGI 規(guī)范，并不能像 Gunicorn/uWSGI 這樣很容易的與 Flask/Django 框架結(jié)合起來(lái)。

WSGI 規(guī)范

根據(jù) Python Web 應(yīng)用部署架構(gòu)，我們知道了 WSGI 所處的位置，接下來(lái)看下 WSGI 規(guī)范具體定義了哪些內(nèi)容。

如同 HTTP 協(xié)議有一個(gè)客戶(hù)端和一個(gè)服務(wù)端，WSGI 協(xié)議有一個(gè) Application 端和一個(gè) Server 端，其中 Application 就是指 Flask、Django 這些 Web 框架，而 Server 就是指 Gunicorn、uWSGI 等 Web 服務(wù)器。

WSGI 協(xié)議規(guī)定 Application 端需要實(shí)現(xiàn)成一個(gè)可調(diào)用對(duì)象（函數(shù)、類(lèi)等），其接口如下：

def simple_app(environ, start_response):
    status = '200 OK'
    response_headers = [('Content-type', 'text/plain')]
    start_response(status, response_headers)
    return ['Hello world!\n']

simple_app 就是一個(gè)最簡(jiǎn)單的 Application，它需要接收兩個(gè)參數(shù)，environ 是一個(gè) dict，其中保存了所有 HTTP 請(qǐng)求相關(guān)的信息，由 Server 端提供，start_response 是一個(gè)可調(diào)用對(duì)象，同樣由 Server 端提供，simple_app內(nèi)部需要調(diào)用一次 start_response，并將 狀態(tài)碼 和 響應(yīng)頭 當(dāng)作參數(shù)傳遞給它，simple_app 最終會(huì)返回一個(gè)可迭代對(duì)象作為 HTTP Body 內(nèi)容返回給客戶(hù)端。

我們已經(jīng)知道了 Application 端接口，接下來(lái)看下一個(gè)符合 WSGI 協(xié)議的 Server 端實(shí)現(xiàn)：

import os


def wsgi_server(application):
    environ = dict(os.environ.items())

    def start_response(status, response_headers):
        print(f'status: {status}')
        print(f'response_headers: {response_headers}')

    result = application(environ, start_response)
    for data in result:
        print(f'response_body: {data}')

示例中 Server 端同樣使用函數(shù)來(lái)實(shí)現(xiàn)，wsgi_server 接收一個(gè) application 作為參數(shù)，在其內(nèi)部構(gòu)造了 environ 和 start_response 兩個(gè)對(duì)象，這里使用環(huán)境變量信息來(lái)模擬 HTTP 請(qǐng)求信息構(gòu)造 environ 字典，start_response 同樣被定義為一個(gè)函數(shù)，供 application 在內(nèi)部對(duì)其進(jìn)行調(diào)用，wsgi_server 函數(shù)最后會(huì)調(diào)用 application 并對(duì)其進(jìn)行打印。

現(xiàn)在有了 Application 端和 Server 端，我們可以來(lái)測(cè)試一下這個(gè)簡(jiǎn)單的 WSGI 程序示例。只需要將 simple_app 作為參數(shù)傳遞給 wsgi_server 并調(diào)用 wsgi_server 即可：

wsgi_server(simple_app)

執(zhí)行以上代碼，將得到如下打印：

status: 200 OK
response_headers: [('Content-type', 'text/plain')]
response_body: Hello world!

以上，我們分別實(shí)現(xiàn)了符合 WSGI 規(guī)范的 Application 端和 Server 端，雖然程序看起來(lái)比較簡(jiǎn)陋，但不論多么復(fù)雜的 Python Web 框架和 Server 都同樣遵循此規(guī)范。

WSGI 實(shí)際應(yīng)用

學(xué)習(xí)了 WSGI 規(guī)范，我們可以來(lái)驗(yàn)證下平時(shí)使用的 Python Web 框架是否真的遵循此規(guī)范，這里以 Flask 框架源碼為例，可以在 https://github.com/pallets/flask/blob/master/src/flask/app.py 查看 Flask 的定義：

class Flask(Scaffold):
    ...

    def __call__(self, environ, start_response):
        """The WSGI server calls the Flask application object as the
        WSGI application. This calls :meth:`wsgi_app`, which can be
        wrapped to apply middleware.
        """
        return self.wsgi_app(environ, start_response)

Flask 類(lèi)內(nèi)部通過(guò)實(shí)現(xiàn) __call__ 方法，使得 Flask 實(shí)例對(duì)象成為一個(gè)可調(diào)用對(duì)象，其接口實(shí)現(xiàn)同樣符合 WSGI Application 規(guī)范。

以上就是Python WSGI 規(guī)范簡(jiǎn)介的詳細(xì)內(nèi)容，更多關(guān)于Python WSGI 規(guī)范的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！