WSGI協(xié)議

首先弄清下面幾個概念：

WSGI：全稱是Web Server Gateway Interface，WSGI不是服務(wù)器，python模塊，框架，API或者任何軟件，只是一種規(guī)范，描述web server如何與web application通信的規(guī)范。server和application的規(guī)范在PEP 3333中有具體描述。要實現(xiàn)WSGI協(xié)議，必須同時實現(xiàn)web server和web application，當(dāng)前運行在WSGI協(xié)議之上的web框架有Bottle, Flask, Django。

uwsgi：與WSGI一樣是一種通信協(xié)議，是uWSGI服務(wù)器的獨占協(xié)議，用于定義傳輸信息的類型(type of information)，每一個uwsgi packet前4byte為傳輸信息類型的描述，與WSGI協(xié)議是兩種東西，據(jù)說該協(xié)議是fcgi協(xié)議的10倍快。

uWSGI：是一個web服務(wù)器，實現(xiàn)了WSGI協(xié)議、uwsgi協(xié)議、http協(xié)議等。

WSGI協(xié)議主要包括server和application兩部分：

• WSGI server負(fù)責(zé)從客戶端接收請求，將request轉(zhuǎn)發(fā)給application，將application返回的response返回給客戶端；
• WSGI application接收由server轉(zhuǎn)發(fā)的request，處理請求，并將處理結(jié)果返回給server。application中可以包括多個棧式的中間件(middlewares)，這些中間件需要同時實現(xiàn)server與application，因此可以在WSGI服務(wù)器與WSGI應(yīng)用之間起調(diào)節(jié)作用：對服務(wù)器來說，中間件扮演應(yīng)用程序，對應(yīng)用程序來說，中間件扮演服務(wù)器。

WSGI協(xié)議其實是定義了一種server與application解耦的規(guī)范，即可以有多個實現(xiàn)WSGI server的服務(wù)器，也可以有多個實現(xiàn)WSGI application的框架，那么就可以選擇任意的server和application組合實現(xiàn)自己的web應(yīng)用。例如uWSGI和Gunicorn都是實現(xiàn)了WSGI server協(xié)議的服務(wù)器，Django，F(xiàn)lask是實現(xiàn)了WSGI application協(xié)議的web框架，可以根據(jù)項目實際情況搭配使用。

像Django，F(xiàn)lask框架都有自己實現(xiàn)的簡單的WSGI server，一般用于服務(wù)器調(diào)試，生產(chǎn)環(huán)境下建議用其他WSGI server。

WSGI協(xié)議的實現(xiàn)

以Django為例，分析一下WSGI協(xié)議的具體實現(xiàn)過程。

django WSGI application

WSGI application應(yīng)該實現(xiàn)為一個可調(diào)用對象，例如函數(shù)、方法、類(包含`call`方法)。需要接收兩個參數(shù)：

• 一個字典，該字典可以包含了客戶端請求的信息以及其他信息，可以認(rèn)為是請求上下文，一般叫做environment（編碼中多簡寫為environ、env）
• 一個用于發(fā)送HTTP響應(yīng)狀態(tài)（HTTP status ）、響應(yīng)頭（HTTP headers）的回調(diào)函數(shù)

通過回調(diào)函數(shù)將響應(yīng)狀態(tài)和響應(yīng)頭返回給server，同時返回響應(yīng)正文(response body)，響應(yīng)正文是可迭代的、并包含了多個字符串。下面是Django中application的具體實現(xiàn)部分：

class WSGIHandler(base.BaseHandler):
 initLock = Lock()
 request_class = WSGIRequest

 def __call__(self, environ, start_response):
 # 加載中間件
 if self._request_middleware is None:
 with self.initLock:
 try:
 # Check that middleware is still uninitialized.
 if self._request_middleware is None:
 self.load_middleware()
 except:
 # Unload whatever middleware we got
 self._request_middleware = None
 raise

 set_script_prefix(get_script_name(environ))
 # 請求處理之前發(fā)送信號
 signals.request_started.send(sender=self.__class__, environ=environ)
 try:
 request = self.request_class(environ)
 except UnicodeDecodeError:
 logger.warning('Bad Request (UnicodeDecodeError)',
 exc_info=sys.exc_info(),
 extra={'status_code': 400,})
 response = http.HttpResponseBadRequest()
 else:
 response = self.get_response(request)

 response._handler_class = self.__class__

 status = '%s %s' % (response.status_code, response.reason_phrase)
 response_headers = [(str(k), str(v)) for k, v in response.items()]
 for c in response.cookies.values():
 response_headers.append((str('Set-Cookie'), str(c.output(header=''))))
 # server提供的回調(diào)方法，將響應(yīng)的header和status返回給server
 start_response(force_str(status), response_headers)
 if getattr(response, 'file_to_stream', None) is not None and environ.get('wsgi.file_wrapper'):
 response = environ['wsgi.file_wrapper'](response.file_to_stream)
 return response

可以看出application的流程包括:

• 加載所有中間件，以及執(zhí)行框架相關(guān)的操作，設(shè)置當(dāng)前線程腳本前綴，發(fā)送請求開始信號；
• 處理請求，調(diào)用get_response()方法處理當(dāng)前請求，該方法的的主要邏輯是通過urlconf找到對應(yīng)的view和callback，按順序執(zhí)行各種middleware和callback。
• 調(diào)用由server傳入的start_response()方法將響應(yīng)header與status返回給server。
• 返回響應(yīng)正文

django WSGI Server

負(fù)責(zé)獲取http請求，將請求傳遞給WSGI application，由application處理請求后返回response。以Django內(nèi)建server為例看一下具體實現(xiàn)。

通過runserver運行django項目，在啟動時都會調(diào)用下面的run方法，創(chuàng)建一個WSGIServer的實例，之后再調(diào)用其serve_forever()方法啟動服務(wù)。

def run(addr, port, wsgi_handler, ipv6=False, threading=False):
 server_address = (addr, port)
 if threading:
 httpd_cls = type(str('WSGIServer'), (socketserver.ThreadingMixIn, WSGIServer), {})
 else:
 httpd_cls = WSGIServer
 # 這里的wsgi_handler就是WSGIApplication
 httpd = httpd_cls(server_address, WSGIRequestHandler, ipv6=ipv6)
 if threading:
 httpd.daemon_threads = True
 httpd.set_app(wsgi_handler)
 httpd.serve_forever()

下面表示W(wǎng)SGI server服務(wù)器處理流程中關(guān)鍵的類和方法。

.WSGIServer

run()方法會創(chuàng)建WSGIServer實例，主要作用是接收客戶端請求，將請求傳遞給application，然后將application返回的response返回給客戶端。

• 創(chuàng)建實例時會指定HTTP請求的handler：WSGIRequestHandler類
• 通過set_app和get_app方法設(shè)置和獲取WSGIApplication實例wsgi_handler
• 處理http請求時，調(diào)用handler_request方法，會創(chuàng)建WSGIRequestHandler實例處理http請求。
• WSGIServer中g(shù)et_request方法通過socket接受請求數(shù)據(jù)

.WSGIRequestHandler

• 由WSGIServer在調(diào)用handle_request時創(chuàng)建實例，傳入request、cient_address、WSGIServer三個參數(shù)，__init__方法在實例化同時還會調(diào)用自身的handle方法
• handle方法會創(chuàng)建ServerHandler實例，然后調(diào)用其run方法處理請求

.ServerHandler

• WSGIRequestHandler在其handle方法中調(diào)用run方法，傳入self.server.get_app()參數(shù)，獲取WSGIApplication，然后調(diào)用實例(__call__)，獲取response，其中會傳入start_response回調(diào)，用來處理返回的header和status。
• 通過application獲取response以后，通過finish_response返回response

.WSGIHandler

• WSGI協(xié)議中的application，接收兩個參數(shù)，environ字典包含了客戶端請求的信息以及其他信息，可以認(rèn)為是請求上下文，start_response用于發(fā)送返回status和header的回調(diào)函數(shù)

雖然上面一個WSGI server涉及到多個類實現(xiàn)以及相互引用，但其實原理還是調(diào)用WSGIHandler，傳入請求參數(shù)以及回調(diào)方法start_response()，并將響應(yīng)返回給客戶端。

django simple_server

django的simple_server.py模塊實現(xiàn)了一個簡單的HTTP服務(wù)器，并給出了一個簡單的demo，可以直接運行，運行結(jié)果會將請求中涉及到的環(huán)境變量在瀏覽器中展示出來。

其中包括上述描述的整個http請求的所有組件:

ServerHandler, WSGIServer, WSGIRequestHandler，以及demo_app表示的簡易版的WSGIApplication。

可以看一下整個流程：

if __name__ == '__main__':
 # 通過make_server方法創(chuàng)建WSGIServer實例
 # 傳入建議application，demo_app
 httpd = make_server('', 8000, demo_app)
 sa = httpd.socket.getsockname()
 print("Serving HTTP on", sa[0], "port", sa[1], "...")
 import webbrowser
 webbrowser.open('http://localhost:8000/xyz?abc')
 # 調(diào)用WSGIServer的handle_request方法處理http請求
 httpd.handle_request() # serve one request, then exit
 httpd.server_close()
 
def make_server(
 host, port, app, server_class=WSGIServer, handler_class=WSGIRequestHandler
):
 """Create a new WSGI server listening on `host` and `port` for `app`"""
 server = server_class((host, port), handler_class)
 server.set_app(app)
 return server

# demo_app可調(diào)用對象，接受請求輸出結(jié)果
def demo_app(environ,start_response):
 from io import StringIO
 stdout = StringIO()
 print("Hello world!", file=stdout)
 print(file=stdout)
 h = sorted(environ.items())
 for k,v in h:
 print(k,'=',repr(v), file=stdout)
 start_response("200 OK", [('Content-Type','text/plain; charset=utf-8')])
 return [stdout.getvalue().encode("utf-8")]

demo_app()表示一個簡單的WSGI application實現(xiàn)，通過make_server()方法創(chuàng)建一個WSGIServer實例，調(diào)用其handle_request()方法，該方法會調(diào)用demo_app()處理請求，并最終返回響應(yīng)。

uWSGI

uWSGI旨在為部署分布式集群的網(wǎng)絡(luò)應(yīng)用開發(fā)一套完整的解決方案。主要面向web及其標(biāo)準(zhǔn)服務(wù)。由于其可擴展性，能夠被無限制的擴展用來支持更多平臺和語言。uWSGI是一個web服務(wù)器，實現(xiàn)了WSGI協(xié)議，uwsgi協(xié)議，http協(xié)議等。
uWSGI的主要特點是：

• 超快的性能
• 低內(nèi)存占用
• 多app管理
• 詳盡的日志功能（可以用來分析app的性能和瓶頸）
• 高度可定制（內(nèi)存大小限制，服務(wù)一定次數(shù)后重啟等）

uWSGI服務(wù)器自己實現(xiàn)了基于uwsgi協(xié)議的server部分，我們只需要在uwsgi的配置文件中指定application的地址，uWSGI就能直接和應(yīng)用框架中的WSGI application通信。

參考閱讀：

• WSGI & uwsgi
• WSGI Tutorial
• 打造mvc框架之wsgi協(xié)議的優(yōu)缺點及接口實現(xiàn)
• Nginx和uWSGI通信機制
• 理解Python WSGI

總結(jié)

以上就是這篇文章的全部內(nèi)容了，希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，如果有疑問大家可以留言交流，謝謝大家對腳本之家的支持。

最新評論