Django 源码阅读(6):Django中WSGI协议的具体实现过程

• 上一节提到过 run(self.addr, int(self.port), handler, ipv6=self.use_ipv6, threading=threading, server_cls=self.server_cls) 函数，一个标准的 WGSI 实现，这次就具体分析一下。搜到一幅简单示意图帮助理解。

django WSGI application

• handle()在django\core\management\commands\runserver.py 中，handle()=>run()=>inner_run()=>get_handler()=>get_internal_wsgi_application()=>get_wsgi_application()=>WSGIHandler()
• WSGI application应该实现为一个可调用对象，例如函数、方法、类(包含call方法)。需要接收两个参数：
• 一个字典，该字典可以包含了客户端请求的信息以及其他信息，可以认为是请求上下文，一般叫做environment（编码中多简写为environ、env）
• 一个用于发送HTTP响应状态（HTTP status ）、响应头（HTTP headers）的回调函数，通过回调函数响应状态和响应头返回给server，同时返回响应正文(response body)，响应正文是可迭代的、并包含了多个字符串。

#core\handlers\wsgi.py
class WSGIHandler(base.BaseHandler):
    request_class = WSGIRequest
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
         # 加载中间件
        self.load_middleware()

    def __call__(self, environ, start_response):
        set_script_prefix(get_script_name(environ))
        # 请求处理之前发送信号
        signals.request_started.send(sender=self.__class__, environ=environ)
        request = self.request_class(environ)
        response = self.get_response(request)

        response._handler_class = self.__class__

        status = '%d %s' % (response.status_code, response.reason_phrase)
        response_headers = [
            *response.items(),
            *(('Set-Cookie', c.output(header='')) for c in response.cookies.values()),
        ]
        # server提供的回调方法，将响应的header和status返回给server
        start_response(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的流程包括:

  • 加载所有中间件，以及执行框架相关的操作，设置当前线程脚本前缀，发送请求开始信号；
  • 处理请求，调用get_response()方法处理当前请求，该方法的的主要逻辑是通过urlconf找到对应的view和callback，按顺序执行各种middleware和callback。
  • 调用由server传入的start_response()方法将响应header与status返回给server。
    返回响应正文

django WSGI Server

• 负责获取http请求，将请求传递给WSGI application，由application处理请求后返回response。以Django内建server为例看一下具体实现。
• 通过runserver运行django项目，在启动时都会调用下面的run方法，创建一个WSGIServer的实例，之后再调用其serve_forever()（实现细节：serve_forever()=>_handle_request_noblock()=>process_request()=>finish_request()=>RequestHandlerClass）方法启动服务。

def run(addr, port, wsgi_handler, ipv6=False, threading=False, server_cls=WSGIServer):
    server_address = (addr, port)
    if threading:
        httpd_cls = type('WSGIServer', (socketserver.ThreadingMixIn, server_cls), {})
    else:
        httpd_cls = server_cls
    httpd = httpd_cls(server_address, WSGIRequestHandler, ipv6=ipv6)
    if threading:
        # ThreadingMixIn.daemon_threads indicates how threads will behave on an
        # abrupt shutdown; like quitting the server by the user or restarting
        # by the auto-reloader. True means the server will not wait for thread
        # termination before it quits. This will make auto-reloader faster
        # and will prevent the need to kill the server manually if a thread
        # isn't terminating correctly.
        httpd.daemon_threads = True
    httpd.set_app(wsgi_handler)
    httpd.serve_forever()

• 下面表示WSGI server服务器处理流程中关键的类和方法。

• WSGIServer
  • run()方法会创建WSGIServer实例，主要作用是接收客户端请求，将请求传递给application，然后将application返回的response返回给客户端。
  • 创建实例时会指定HTTP请求的handler：WSGIRequestHandler类
  • 通过set_app和get_app方法设置和获取WSGIApplication实例wsgi_handler（WSGIHandler）
  • 处理http请求时，会创建WSGIRequestHandler类的实例（RequestHandlerClass），并调用handle_request方法（继承自基类BaseServer，内部还是调用_handle_request_noblock()）处理请求。
  • 实现细节：handle_request()=>_handle_request_noblock()=>process_request()=>finish_request()=>RequestHandlerClass
• WSGIRequestHandler
  • WSGIRequestHandler实例化时，传入request, client_address, server三个参数，__init__方法在实例化同时还会调用自身的handle方法（该实现是在基类BaseRequestHandler中可以看到）

class BaseRequestHandler:
    def __init__(self, request, client_address, server):
        self.request = request
        self.client_address = client_address
        self.server = server
        self.setup()
        try:
            self.handle()
        finally:
            self.finish()

- handle方法会创建ServerHandler实例，然后调用其run方法处理请求

    def handle(self):
        self.close_connection = True
        self.handle_one_request()
        while not self.close_connection:
            self.handle_one_request()
        ...

    def handle_one_request(self):
        """Copy of WSGIRequestHandler.handle() but with different ServerHandler"""
        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
		#传入的参数，读，写，错误，环境变量，ServerHandler继承自SimpleHandler
        handler = ServerHandler(
            self.rfile, self.wfile, self.get_stderr(), self.get_environ()
        )
        handler.request_handler = self      # backpointer for logging & connection closing
        handler.run(self.server.get_app())

• ServerHandler

  • WSGIRequestHandler在其handle方法中调用run方法，传入self.server.get_app()参数，获取WSGIApplication，然后调用实例(call)，获取response，其中会传入start_response回调，用来处理返回的header和status。
    通过application获取response以后，通过finish_response返回response

• WSGIHandler

  • WSGI协议中的application，接收两个参数，environ字典包含了客户端请求的信息以及其他信息，可以认为是请求上下文，start_response用于发送返回status和header的回调函数

• 虽然上面一个WSGI server涉及到多个类实现以及相互引用，但其实原理还是调用WSGIHandler，传入请求参数以及回调方法start_response()，并将响应返回给客户端。

参考链接

Python Web开发最难懂的WSGI协议，到底包含哪些内容？