实现满足WSGI协议的Web服务

简介

面试 Python web 相关岗位时，最容易被问到的问题，WSGI 协议是什么？

这篇文章就简单解释一下 WSGI 并实现一个满足 WSGI 协议的服务。

WSGI 协议

WSGI (Python Web Server Gateway Interface, Python Web 服务器网关接口) 由 PEP333 提出，它是一种指定 Web 服务器与 Python Web 应用程序之间通信的一种标准，目的就是将 Web 服务器与 Python Web 应用解耦。

我们熟悉的 Django、Flask、Trondao 等 Python web 框架其实都是满足 WSGI 协议的 Web 应用，而 uWSGI、Gunicorn 等都是满足 WSGI 协议的 Web 服务。

以部署 Flask 为例，常见的部署方法为 Nginx+uWSGI+Flask，其中 Nginx 接受客户端的请求后，会将数据传递给 uWSGI，uWSGI 服务接受到数据后，会依据 WSGI 协议，将数据解析成相应的格式传递给 Flask，Flask 调用相应的逻辑后，同样依据 WSGI 协议将要方法的数据组织成相应的格式返回给 uWSGI，uWSGI 再次组织后，将其回传给 Nginx。

WSGI 工作原理

从 PEP333 中可以看出，WSGI 协议的主要目的就是规范数据解析格式，如果一个 Web 服务满足 WSGI 协议，那么它的作用就是将原始的 socket 数据解析为 environ 对象 (使用时，就是一个字典对象)，environ 数据包含 Web 服务自身的信息和请求的 header 与 body 等信息。当 Web 应用处理完后，可以通过 start_response () 方法进行回调，形象如下图：

整个过程比较清晰，不多赘述。

实现一个满足 WSGI 协议的 Web 服务

要纯手撸一个 WSGI 其实还要注意很多细节与规则，繁杂却没有特别大的技术难度，这里直接使用 wsgiref 内置库来实现满足 WSGI 协议的 Web 服务，wsgiref 帮我们实现了 socket 数据解析的过程，从而可以直接获得 envireon 与 start_response 回调方法。

from wsgiref.simple_server import make_server
# web应用
def web_app(environ, start_response):
    start_response('200 OK', [('Content-Type', 'text/html')])
    return [b'<h1>Hello, HackPython!</h1>']
if __name__ == '__main__':
    # web服务
    server = make_server('127.0.0.1', 8888, web_app)
    print("Serving HTTP on port 8888...")
    server.serve_forever()

利用 make_server () 方法轻松构建了满足 WSGI 协议的 web 服务，运行后，通过浏览器访问则可。

make_server () 背后究竟做了什么？简单阅读一下它的源码.

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

发现关键是 WSGIServer，而 WSGIServer 继承自 HTTPServer，而 HTTPServer 继承自 socketserver.TCPServer，TCPServer 类主要就是处理 TCP 网络连接的逻辑，比如它**服务的逻辑其实就是监听 socket。

# Lib/socketserver/TCPServer
    def server_activate(self):
        """Called by constructor to activate the server.
        May be overridden.
        """
        self.socket.listen(self.request_queue_size)

通过层层继承，到 WSGIServer 这一层，就完成了 Socket 数据 --> HTTP 数据 --> 符合 WSGI 协议数据格式 这样的过程，运行的本质就是启动 socket 监听进程，监听相应端口的网络请求。

除了通过方法形式，以类的方式也可以，通过 __call__的形式去实现。

class Web:
    def __init__(self):
        # init params
        pass
    def __call__(self, environ, start_response):
        start_response('200 OK', [('Content-Type', 'text/html')])
        return [b'<h1>Hello, HackPython!</h1>']
    def listen(self,host='127.0.0.1',port=8888):
        from wsgiref.simple_server import make_server
        server = make_server(host, port, self)
        print(f'serve on {host}:{port}')
        server.serve_forever()
if __name__ == '__main__':
    web = Web()
    web.listen()

如果想深究 WSGI 协议的细节，可以阅读 wsgiref 的实现，这里不再深究。

uWSGI 与 WSGI 的关系

uWSGI 是一个 Web 服务，它实现了 WSGI 协议，此外还实现了 uwsgi 协议与 http 协议。

需要区分一下 WSGI、uWSGI 与 uwsgi 三者的差别。

• WSGI 是一种协议

• uwsgi 同样也是一种协议，与 WSGI 没有什么关系

• uWSGI 是 Web 服务，它实现了 WSGI 协议与 uwsgi 协议

uwsgi 协议是 uWSGI 特有的，它用于定义传输信息的类型，每个 uwsgi 包的前 4 字节都用于记录传输信息类型的描述。

那有了 uWSGI 这个 web 服务后，为什么还需要 Nginx？

因为 Nginx 有优秀的静态内容处理能力，当客户端请求静态内容时，Nginx 层直接返回，如果请求动态内容，Nginx 才会转发给 uWSGI，uWSGI 才更加 WSGI 协议解析信息传递给 Flask、Django 这类 Python Web 应用。

尾

感谢大家阅读，后面将会写点自然语言处理方面的入门内容，来看一下 Python 究竟是怎么玩转语言的。

最后如果文字对你有帮助，麻烦点击「在看」，叩谢豪恩。