2015-09-10
本文内容主要来自以下网址:
What is WSGI?
WSGI Tutorial
An Introduction to the Python Web Server Gateway Interface (WSGI)
可以看成一次简单粗暴的翻译。
什么是WSGI
WSGI的全称是Web Server Gateway Interface,这是一个规范,描述了web server如何与web application交互、web application如何处理请求。该规范的具体描述在PEP 3333。注意,WSGI既要实现web server,也要实现web application。
实现了WSGI的模块/库有wsgiref(python内置)、werkzeug.serving、twisted.web等,具体可见Servers which support WSGI。
当前运行在WSGI之上的web框架有Bottle、Flask、Django等,具体可见Frameworks that run on WSGI。
WSGI server所做的工作仅仅是将从客户端收到的请求传递给WSGI application,然后将WSGI application的返回值作为响应传给客户端。WSGI applications 可以是栈式的,这个栈的中间部分叫做中间件
,两端是必须要实现的application和server。
WSGI教程
这部分内容主要来自WSGI Tutorial。
WSGI application接口
WSGI application接口应该实现为一个可调用对象,例如函数、方法、类、含__call__
方法的实例。这个可调用对象可以接收2个参数:
- 一个字典,该字典可以包含了客户端请求的信息以及其他信息,可以认为是请求上下文,一般叫做environment(编码中多简写为environ、env);
- 一个用于发送HTTP响应状态(HTTP status )、响应头(HTTP headers)的回调函数。
同时,可调用对象的返回值是响应正文(response body),响应正文是可迭代的、并包含了多个字符串。
WSGI application结构如下:
Environment
下面的程序可以将environment字典的内容返回给客户端(environment.py
):
浏览器(或者curl、wget等)访问http://127.0.0.1:8051/
,可以看到environment的内容。
另外,浏览器请求一次后,environment.py
就结束了,程序在终端中输出内容如下:
可迭代的响应
如果把上面的可调用对象application的返回值:
改成:
这会导致WSGI程序的响应变慢。原因是字符串response_body
也是可迭代的,它的每一次迭代只能得到1 byte的数据量,这也意味着每一次只向客户端发送1 byte的数据,直到发送完毕为止。所以,推荐使用return [response_body]
。
如果可迭代响应含有多个字符串,那么Content-Length
应该是这些字符串长度之和:
解析GET请求
运行environment.py
,在浏览器中访问http://localhost:8051/?age=10&hobbies=software&hobbies=tunning
,可以在响应的内容中找到:
cgi.parse_qs()
函数可以很方便的处理QUERY_STRING,同时需要cgi.escape()
处理特殊字符以防止脚本注入,下面是个例子:
输出如下:
然后,我们可以写一个基本的处理GET请求的动态网页了:
启动程序,在浏览器中访问http://localhost:8051/
、http://localhost:8051/?age=10&hobbies=software&hobbies=tunning
感受一下~
这个程序会一直运行,可以使用快捷键Ctrl-C
终止它。
这段代码涉及两个我个人之前没用过的小技巧:
解析POST请求
对于POST请求,查询字符串(query string)是放在HTTP请求正文(request body)中的,而不是放在URL中。请求正文在environment字典变量中键wsgi.input
对应的值中,这是一个类似file的变量,这个值是一个。The PEP 3333 指出,请求头中CONTENT_LENGTH
字段表示正文的大小,但是可能为空、或者不存在,所以读取请求正文时候要用try/except
。
下面是一个可以处理POST请求的动态网站:
Python WSGI入门
这段内容参考自An Introduction to the Python Web Server Gateway Interface (WSGI)。
Web server
WSGI server就是一个web server,其处理一个HTTP请求的逻辑如下:
app即WSGI application,environ即上文中的environment。可调用对象app返回一个可迭代的值,WSGI server获得这个值后将数据发送给客户端。
Web framework/app
即WSGI application
。
中间件(Middleware)
中间件位于WSGI server和WSGI application之间,所以
一个示例
该示例中使用了中间件。
然后
有了这些基础知识,就可以打造一个web框架了。感兴趣的话,可以阅读一下Bottle、Flask等的源码。
在Learn about WSGI还有更多关于WSGI的内容。