0%

实现满足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回调方法。

1
2
3
4
5
6
7
8
9
10
11
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()背后究竟做了什么?简单阅读一下它的源码.

1
2
3
4
5
6
7
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。

1
2
3
4
5
6
7
8
9
# 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__的形式去实现。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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究竟是怎么玩转语言的。

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