WSGI及gunicorn指北（一）

作為一個Python Web 開發工程師，pyg0每天都喜滋滋的寫着基於各種web框架的業務代碼。

突然有一天，技術老大過來跟pyg0說，嘿，我們要新上線一個服務，你來幫我部署一下吧。不用太復雜。用gunicorn跑flask， 啟8個進程， 用gevent模式跑就可以。這個很好配，給你一個小時吧。

這時候的pyg0心里充滿的黑人問號， gunicorn, gevent ？？？什么鬼？

趕緊請教萬能的google，發現網上配置的教程滿天飛， pyg0找了一個看着順眼的，照貓畫虎，終於趕在下班前搞定。(說好的一個小時呢？)

但是真的搞定了嗎？pyg0其實發現自己更加迷惑了。再配置的過程中，更多的名詞出現在他的視野之中， wgsi？uwsgi？master? worker? 

為了讓自己不再迷糊下去。pyg0決定開始一場學習python web server的旅程

 

一 WSGI

WSGI（Web Server Gateway Interface），中文是網絡服務器網關接口。它不是web server， 也不是web application，而是架在web server 和web application 之間一道協議和規范。

WSGI規范的目的就是解耦Web Server 和Web Application。 一個完整的WSGI協議包括server 和appliction 兩部分。server的作用是接受客戶端傳來的請求，轉發給application， 然后把application返回的response發給客戶端。 application用來接受server發來的請求，處理請求，然后把response發回給server。這樣一來，我們可以有多個實現了server協議的Web Server和多個實現了application的web framework。

重點來了，上文提到的gunicorn， uwsgi就是實現了WSGI server協議的web server。 而我們常用的Django，Flask等等就是實現了WSGI application協議的 web framework。這樣一來，我們就可以像搭積木一樣隨意組合web server 和 web framework了。

 

其實python自己就帶了一個實現了WSGI協議的server 和 application， 各個web framework也基本上都有自己實現的server， 但這些server基本上只能用來調試，不能用於生產環境。我們先來看python自己實現的WSGI協議: wsgiref。這個名字明確告訴我們，大哥我只是個reference， 你們看看就好，千萬不要用啊，性能沒保障的啊。

#coding:utf-8
from wsgiref.simple_server import make_server, demo_app

app = demo_app
server = make_server("127.0.0.1", 9000, app)
server.serve_forever()

demo_app就是個簡單的web application, 我們看看他都干了什么

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")]

完美的滿足的WSGI的標准，接受兩個參數， environ和start_response, environ是一個包括了客戶端所有請求信息和相關信息的dict, start_response 是一個可以發送響應狀態和響應頭的回調函數。除此之外， 我們的web application 把environ里面所有的信息都打印出來。

現在問題來了。我們應該如何調用這個web application呢？答案就是我們不用調，我們依靠web server 來調。讓我們看看wsgiref里的webserver長什么樣

class WSGIServer(HTTPServer):

    """BaseHTTPServer that implements the Python WSGI protocol"""

    application = None

    def server_bind(self):
        """Override server_bind to store the server name."""
        HTTPServer.server_bind(self)
        self.setup_environ()

    def setup_environ(self):
        # Set up base environment
        env = self.base_environ = {}
        env['SERVER_NAME'] = self.server_name
        env['GATEWAY_INTERFACE'] = 'CGI/1.1'
        env['SERVER_PORT'] = str(self.server_port)
        env['REMOTE_HOST']=''
        env['CONTENT_LENGTH']=''
        env['SCRIPT_NAME'] = ''

    def get_app(self):
        return self.application

    def set_app(self,application):
        self.application = application

這個web server 也同樣很簡單。繼承了HTTPServer， 重寫了server_bind方法,在綁定的同時創建了必要的環境變量。同時提供了綁定和獲取web application的方法。

 

我們再來看看WSGIRequestHandler

class WSGIRequestHandler(BaseHTTPRequestHandler):

    server_version = "WSGIServer/" + __version__

    def get_environ(self):
        env = self.server.base_environ.copy()
        env['SERVER_PROTOCOL'] = self.request_version
        env['SERVER_SOFTWARE'] = self.server_version
        env['REQUEST_METHOD'] = self.command
        if '?' in self.path:
            path,query = self.path.split('?',1)
        else:
            path,query = self.path,''

        env['PATH_INFO'] = urllib.parse.unquote(path, 'iso-8859-1')
        env['QUERY_STRING'] = query

        host = self.address_string()
        if host != self.client_address[0]:
            env['REMOTE_HOST'] = host
        env['REMOTE_ADDR'] = self.client_address[0]

        if self.headers.get('content-type') is None:
            env['CONTENT_TYPE'] = self.headers.get_content_type()
        else:
            env['CONTENT_TYPE'] = self.headers['content-type']

        length = self.headers.get('content-length')
        if length:
            env['CONTENT_LENGTH'] = length

        for k, v in self.headers.items():
            k=k.replace('-','_').upper(); v=v.strip()
            if k in env:
                continue                    # skip content length, type,etc.
            if 'HTTP_'+k in env:
                env['HTTP_'+k] += ','+v     # comma-separate multiple headers
            else:
                env['HTTP_'+k] = v
        return env

    def get_stderr(self):
        return sys.stderr

    def handle(self):
        """Handle a single HTTP request"""

        self.raw_requestline = self.rfile.readline(65537)
        if len(self.raw_requestline) > 65536:
            self.requestline = ''
            self.request_version = ''
            self.command = ''
            self.send_error(414)
            return

        if not self.parse_request(): # An error code has been sent, just exit
            return

        handler = ServerHandler(
            self.rfile, self.wfile, self.get_stderr(), self.get_environ()
        )
        handler.request_handler = self      # backpointer for logging
        handler.run(self.server.get_app())

我們的WSGIRequestHandler會添加更多請求相關的信息放進environ里。同時重寫了handle方法，在這里我們看到了熟悉的get_app(), 沒錯，就是在這里， 我們的web_application出現了。它會接受server 的 environ和回調函數start_response， 處理完成之后，再通過start_response 把HTTP Code 和HEADER發送給handler，通過return把http response返回給handler。

通過這個簡單的示例，pyg0終於明白了WSGI是怎么回事兒。但是他也認同這個wsgiref實在是太low了。所以趕緊開始鑽研老大推薦的gunicorn。

我們下回再見！