WSGI规范笔记

概述

WSGI接口包含两方面：server/gateway 及 application/framework。
server调用由application提供的可调用对象。
另外在server和application之间还可能有一种称作middleware的中间件。
可调用对象是指：函数、方法、类或者带有callable方法的实例。

---

关于application

函数、方法、类及带有callable方法的实例等可调用对象都可以作为the application object。
WSGI协议要求：
the application object接受两个参数且可以被多次调用

这两个参数分别为：
1.CGI式的字典；
2.回调函数：application用来向server传递http状态码/消息/http头

另外协议要求可调用对象必须将响应体封装成一个可迭代的strings返回。

# the application object. 可以使用其他名字,
# 但是在使用mod_wsgi 时必须为  "application"
def application( environ, start_response):
#  函数接受两个参数:
# environ ：包含有CGI 式环境变量的字典，由server负责提供内容
# start_response：由server提供的回调函数，其作用是将状态码和响应头返回给server

# 构造响应体，以可迭代字符串形式封装
    response_body = 'The request method was %s' % environ['REQUEST_METHOD']

# HTTP 响应码及消息
   status = '200 OK'

# 提供给客户端的响应头.
# 封装成list of tuple pairs 的形式:
# 格式要求：[(Header name, Header value)].
   response_headers = [('Content-Type', 'text/plain'),
                       ('Content-Length', str(len(response_body)))]

# 将响应码/消息及响应头通过传入的start_reponse回调函数返回给server
   start_response(status, response_headers)

#  响应体作为返回值返回
# 注意这里被封装到了list中.
   return [response_body]

---

关于server

从概述中可以知道，WSGI server必须要调用application，同时，从application的协议要求可知：
1. WSGI server必须向application提供环境参数，因此，自身也必须能够获取环境参数。
2. WSGI server接收application的返回值作为响应体。
最简单的WSGI server为Python自带的wsgiref.simple_server
示例如下：

from wsgiref.simple_server import make_server
srv = make_server('localhost', 8080, hello_world)
srv.serve_forever()

---

关于middleware

middleware的概念没有appllication和server那么容易理解。
假设一个符合application标准的可调用对象，它接受可调用对象作为参数，返回一个可调用对象的对象。
那么对于server来说，它是一个符合标准的可调用对象，因此是application。
而对于application来说，它可以调用application，因此是server。
这样的可调用对象称为middleware。

middleware的概念非常接近decorator。

以一个路由的例子示例：

import re

# 这是一个标准的application object
def index(environ, start_response):
    start_response('200 OK', [('Content-Type', 'text/html')])
    return ['index page']

# 这是一个标准的application object
def hello(environ, start_response):
    start_response('200 OK', [('Content-Type', 'text/html')])
    return ['hello page']

# 这是一个标准的application object
def not_found(environ, start_response):
    start_response('404 NOT FOUND', [('Content-Type', 'text/plain')])
    return ['Not Found Page']

# map urls to functions
urls = [
    (r'^$', index),
    (r'hello/?$', hello)
]
# 这是一个middleware
# 根据不同的route返回不同的application object
def application(environ, start_response):
    path = environ.get('PATH_INFO', '').lstrip('/')
    for regex, callback in urls:
        match = re.search(regex, path)
        if match is not None:
            return callback(environ, start_response)
    return not_found(environ, start_response）