Python Web——WSGI协议

WSGI协议

介绍

• Python Web开发中，后台服务端程序可以分为两个部分：Web Server 和 Web Application
• Web Server负责通过socket监听client的请求，当出现请求时，调用Web Application，进行具体的逻辑处理。
• WSGI是 Web Server 和 Web Application 之间的一种协议或规范。旨在解决众多 web 框架和web server软件的兼容问题。只要是实现了WSGI协议的Web 框架就可以和实现了WSGI协议的Web Server进行组合使用。

WSGI Application

WSGI规定Web Application:

1. 需要是一个可调用的对象。（即应用程序可以是函数，实现iter方法的Class，实现call方法的Object）
2. 可调用对象需要接收两个参数： environ 和 start_response（environ包含了所有请求有关的信息，包括headers, body等。start_response是一个回调函数，后台服务处理完业务后调用这个函数将response传给wsgi server，server再传给客户端。)
3. 可调用对象要返回一个值,这个值是可迭代的

例如：

# my_wsgi_app.py
HELLO_WORLD = b"Hello world!\n"
 
# callable function
def simple_app(environ, start_response):
    """Simplest possible application object"""
    status = '200 OK'
    response_headers = [('Content-type', 'text/plain')]
    start_response(status, response_headers)
    return [HELLO_WORLD]
 
# callable class
class AppClass:
    """Produce the same output, but using a class
 
    (Note: 'AppClass' is the "application" here, so calling it
    returns an instance of 'AppClass', which is then the iterable
    return value of the "application callable" as required by
    the spec.
 
    If we wanted to use *instances* of 'AppClass' as application
    objects instead, we would have to implement a '__call__'
    method, which would be invoked to execute the application,
    and we would need to create an instance for use by the
    server or gateway.
    """
 
    def __init__(self, environ, start_response):
        self.environ = environ
        self.start = start_response
 
    def __iter__(self):
        status = '200 OK'
        response_headers = [('Content-type', 'text/plain')]
        self.start(status, response_headers)
        yield HELLO_WORLD
 
# callable object
class ApplicationObj(object):
    def __call__(self, environ, start_response):
        return [HELL_WORLD]

WSGI Server

• 一个WSGI Server需要完成的工作是：

1. 监听某端口
2. 当收到用户请求时对应用程序需要的两个参数environ 和 start_response进行设置
3. 调用WSGI Application
4. 迭代访问应用程序的返回结果，并将其传回客户端

一个简易的WSGI Server:

# my_wsgi_server.py
import socket
import sys

class WSGIServer:
    def __init__(self):
        self.listener = socket.socket()
        self.listener.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
        self.listener.bind(('0.0.0.0', 4000))
        self.listener.listen(1)
        print('Serving HTTP on 0.0.0.0 port 4000....')
        self.app = None
        self.headers_set = None

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

    def start_response(self, status, headers):
        self.headers_set = [status, headers]

    def server_forever(self):
        while True:
            listener = self.listener
            client_connnection, client_address = listener.accept()
            print(f'server received connection from:{client_address}')
            request = client_connnection.recv(1024)
            print(f'request we received:{request}')

            method, path, _ = request.split(b' ',2)
            environ = {
                'wsgi.version': (1, 0),
                'wsgi.url_scheme': 'http',
                'wsgi.input': request,
                'wsgi.errors': sys.stderr,
                'wsgi.multithread': False,
                'wsgi.multiprocess': False,
                'wsgi.run_once': False,
                'REQUEST_METHOD': method.decode('utf-8'),
                'PATH_INFO': path.decode('utf-8'),
                'SERVER_NAME': '127.0.0.1',
                'SERVER_PORT': '4000',
            }

            app_result = self.app(environ, self.start_response)

            response_status, response_headers = self.headers_set
            response = f'HTTP/1.1 {response_status}\r\n'
            for header in response_headers:
                response += f'{header[0]}:{header[1]}\r\n'
            response += '\r\n'
            response = response.encode('utf-8')
            for data in app_result:
                response += data
            print(response)
            client_connnection.send(response)
            client_connnection.close()

if __name__ == '__main__':
    if len(sys.argv) < 2:
        sys.exit('Argv Error')
    app_path = sys.argv[1]
    module, app = app_path.split(":")
    module = __import__(module)
    app = getattr(module, app)

    server = WSGIServer()
    server.set_app(app)
    server.server_forever()

• 通过以下命令运行server和application：

python my_wsgi_server.py my_wsgi_application:simple_app

用浏览器访问localhost:4000，屏幕中就会显示 Hello world!

基于WSGI的Web框架

Web Application

一个Web Application框架应具备的最基本功能包括：

• 请求体解析
• 路由
• session管理

如果不采用前后端分离架构，框架需支持：

• 模板引擎
• 静态文件支持

如果支持关系型数据库操作，框架需支持：

• ORM功能

常见的Web applicatioan有Django, Flask。它们都支持上述的基本功能和模板引擎。Flask本身不支持ORM，但可与ORM框架sqlalchemy结合。

Web Server

一个Web Server框架应具备socket监听并调用Web application的功能。

如果希望Web Server有更好的并发性能，需要实现负载均衡。

常见的Web Server有Gunicorn, uwsgi。

相关系列

WSGI协议
Gunicorn 源码解析