本頁使用了標題或全文手工轉換

Web伺服器閘道器介面

維基百科,自由的百科全書
跳至導覽 跳至搜尋

Web伺服器閘道介面Python Web Server Gateway Interface,縮寫為WSGI)是為Python語言定義的Web伺服器Web應用程式框架之間的一種簡單而通用的介面。自從WSGI被開發出來以後,許多其它語言中也出現了類似介面。

發展背景[編輯]

以前,如何選擇合適的Web應用程式框架成為困擾Python初學者的一個問題,這是因為,一般而言,Web應用框架的選擇將限制可用的Web伺服器的選擇,反之亦然。那時的Python應用程式通常是為CGIFastCGImod_python中的一個而設計,甚至是為特定Web伺服器的自訂的API介面而設計的。

WSGI[1] (有時發音作'wiz-gee')是作為Web伺服器與Web應用程式或應用框架之間的一種低階別的介面,以提升可移植Web應用開發的共同點。WSGI是基於現存的CGI標準而設計的。

規範概覽[編輯]

WSGI區分為兩個部份:一為「伺服器」或「閘道」,另一為「應用程式」或「應用框架」。在處理一個WSGI請求時,伺服器會為應用程式提供環境資訊及一個回呼函數(Callback Function)。當應用程式完成處理請求後,透過前述的回呼函數,將結果回傳給伺服器。

所謂的 WSGI 中介軟體同時實現了API的兩方,因此可以在WSGI伺服器和WSGI應用之間起調解作用:從Web伺服器的角度來說,中介軟體扮演應用程式,而從應用程式的角度來說,中介軟體扮演伺服器。「中介軟體」元件可以執行以下功能:

  • 重寫環境變數後,根據目標URL,將請求訊息路由到不同的應用物件。
  • 允許在一個行程中同時執行多個應用程式或應用框架。
  • 負載均衡和遠端處理,通過在網絡上轉發請求和響應訊息。
  • 進行內容後處理,例如應用XSLT樣式表。

範例程式[編輯]

Python語言寫的一個符合WSGI的「Hello World」應用程式如下所示:

def app(environ, start_response):
    start_response('200 OK', [('Content-Type', 'text/plain')])
    yield "Hello world!\n"

其中

  • 第一行定義了一個名為app的callable[註 1],接受兩個參數,environ和start_response,environ是一個字典包含了CGI中的環境變數,start_response也是一個callable,接受兩個必須的參數,status(HTTP狀態)和response_headers(響應訊息的頭)。
  • 第二行呼叫了start_response,狀態指定為「200 OK」,訊息頭指定為內容類型是「text/plain」。
  • 第三行將響應訊息的訊息體返回。

呼叫一個應用程式的範例[編輯]

呼叫一個程式並取得它的應答訊息的例子如下所示:

def call_application(app, environ):
    body = []
    status_headers = [None, None]
    def start_response(status, headers):
        status_headers[:] = [status, headers]
        return body.append
    app_iter = app(environ, start_response)
    try:
        for item in app_iter:
            body.append(item)
    finally:
        if hasattr(app_iter, 'close'):
            app_iter.close()
    return status_headers[0], status_headers[1], ''.join(body)

status, headers, body = call_application(app, {...environ...})

WSGI相容的應用和框架[編輯]

支援WSGI的Web應用框架有很多:

影響[編輯]

注釋[編輯]

  1. ^ 在規範中,使用術語「callable」表示一個函數,方法,類或帶有__call__ method例項。

參考文獻[編輯]

外部連結[編輯]