WSGI的全称是 Web Server Gateway Interface ,翻译过来就是 Web服务器网关接口 。具体的来说, WSGI是一个规范,定义了Web服务器如何与Python应用程序进行交互,使得使用Python写的Web应用程序可以和Web服务器对接起来 。WSGI一开始是在 PEP-0333 中定义的,最新版本是在Python的 PEP-3333 定义的。
对于初学者来说,上面那段就是废话,说了跟没说一样。本文的主要内容就是说清楚,WSGI到底是如何工作的。
在Web部署的方案上,有一个方案是目前应用最广泛的:
那么,要采用这种方案,Web服务器和应用程序之间就要知道如何进行交互。为了定义Web服务器和应用程序之间的交互过程,就形成了很多不同的规范。这种规范里最早的一个是 CGI (Common Gateway Interface),1993年开发的。后来又出现了很多这样的规范。比如改进CGI性能的FasgCGI,Java专用的Servlet规范,还有Python专用的WSGI规范等。提出这些规范的目的就是为了定义统一的标准,提升程序的可移植性。在WSGI规范的最开始的PEP-333中一开始就描述了为什么需要WSGI规范。
从上文可以知道,WSGI相当于是Web服务器和Python应用程序之间的桥梁。那么这个桥梁是如何工作的呢?首先,我们明确桥梁的作用,WSGI存在的目的有两个:
在WSGI中定义了两个角色,Web服务器端称为 server 或者 gateway ,应用程序端称为 application 或者 framework (因为WSGI的应用程序端的规范一般都是由具体的框架来实现的)。我们下面统一使用server和application这两个术语。
server端会先收到用户的请求,然后会根据规范的要求调用application端,如下图所示:
调用的结果会被封装成HTTP响应后再发送给客户端。
首先,每个application的入口只有一个,也就是所有的客户端请求都同一个入口进入到应用程序。
接下来,server端需要知道去哪里找application的入口。这个需要在server端指定一个Python模块,也就是Python应用中的一个文件,并且这个模块中需要包含一个名称为 application 的可调用对象(函数和类都可以),这个 application 对象就是这个应用程序的唯一入口了。WSGI还定义了 application 对象的形式:
def simple_app(environ, start_response): pass
上面代码中的 environ
和 start_response
就是server端调用 application 对象时传递的两个参数。
我们来看具体的例子。假设我们的应用程序的入口文件是 /var/www/index.py
,那么我们就需要在server端配置好这个路径(如何配置取决于server端的实现),然后在 index.py
中的代码如下所示:
使用标准库(这个只是demo)
import wsgiref application = wsgiref.simple_server.demo_app
使用web.py框架
import web urls = ( '/.*', 'hello', ) class hello(object): def GET(self): return "Hello, world." application = web.application(urls, globals()).wsgifunc()
你可以看到,文件中都需要有一个 application 对象,server端会找到这个文件,然后调用这个对象。所以支持WSGI的Python框架最终都会有这么一个application对象,不过框架的使用者不需要关心这个application对象内部是如何工作的,只需要关心路由定义、请求处理等具体的业务逻辑。
因为application对象是唯一的入口,所以不管客户端请求的路径和数据是什么,server都是调用这个application对象,具体的客户端请求的处理有application对象完成。
上面已经提到了,application对象需要是一个可调用对象,而且其定义需要满足如下形式:
def simple_app(environ, start_response): pass
当server按照WSGI的规范调用了application之后,application就可以开始处理客户端的请求了,处理请求之后,application对象需要返回处理结果给server端。处理请求和返回结果这两个事情,都和server调用application对象时传递的两个参数有关。
environ参数是一个Python的字典,里面存放了所有和客户端相关的信息,这样application对象就能知道客户端请求的资源是什么,请求中带了什么数据等。environ字典包含了一些CGI规范要求的数据,以及WSGI规范新增的数据,还可能包含一些操作系统的环境变量以及Web服务器相关的环境变量。我们来看一些environ中常用的成员:
首先是CGI规范中要求的变量:
WSGI规范中还要求environ包含下列成员:
上面列出的这些内容已经包括了客户端请求的所有数据,足够application对象处理客户端请求了。
start_response是一个可调用对象,接收两个必选参数和一个可选参数:
当application对象根据environ参数的内容执行完业务逻辑后,就需要返回结果给server端。我们知道HTTP的响应需要包含status,headers和body,所以在application对象将body作为返回值return之前,需要先调用 start_response()
,将status和headers的内容返回给server,这同时也是告诉server,application对象要开始返回body了。
application对象的返回值用于为HTTP响应提供body,如果没有body,那么可以返回None。如果有body的化,那么需要返回一个可迭代的对象。server端通过遍历这个可迭代对象可以获得body的全部内容。
PEP-3333中有一个application的实现demo,我把它再简化之后如下:
def simple_app(environ, start_response): status = '200 OK' response_headers = [('Content-type', 'text/plain')] start_response(status, response_headers) return ['hello, world']
可以将这段代码和前面的说明对照起来理解。
前面已经知道server如何定位到application的入口了,也知道了application的入口的形式以及application对象内部需要完成的工作。那么,我们还需要再说一下, environ
和 start_response()
是需要在server端的生成和定义的,其中关于 start_response()
的部分在规范中也有明确的要求。这部分内容太长了,不适合放在本文中,有兴趣的读者可以去看下PEP-3333,里面有一段server端的demo实现。
WSGI Middleware(中间件)也是WSGI规范的一部分。上一章我们已经说明了WSGI的两个角色:server和application。那么middleware是一种运行在server和application中间的应用(一般都是Python应用)。middleware同时具备server和application角色,对于server来说,它是一个application;对于application来说,它是一个server。middleware并不修改server端和application端的规范,只是同时实现了这两个角色的功能而已。
我们可以通过下图来说明middleware是如何工作的:
上图中最上面的三个彩色框表示角色,中间的白色框表示操作,操作的发生顺序按照1 ~ 5进行了排序,我们直接对着上图来说明middleware是如何工作的:
environ_s
,并且已经定义了 start_response_s
。 environ_s
和 start_response_s
。 environ
执行业务逻辑,生成 environ_m
,并且已经定义了 start_response_m
。 environ_m
和 start_response_m
。Application的application对象处理完成后,会调用 start_response_m
并且返回结果给Middleware,存放在 result_m
中。 result_m
,然后生成 result_s
,接着调用 start_response_s
,并返回结果 result_s
给Server端。Server端获取到result_s后就可以发送结果给客户端了。 从上面的流程可以看出middleware应用的几个特点:
要使用WSGI,需要分别实现server角色和application角色。
Application端的实现一般是由Python的各种框架来实现的,比如Django, web.py等,一般开发者不需要关心WSGI的实现,框架会会提供接口让开发者获取HTTP请求的内容以及发送HTTP响应。
Server端的实现会比较复杂一点,这个主要是因为软件架构的原因。一般常用的Web服务器,如Apache和nginx,都不会内置WSGI的支持,而是通过扩展来完成。比如Apache服务器,会通过扩展模块mod_wsgi来支持WSGI。Apache和mod_wsgi之间通过程序内部接口传递信息,mod_wsgi会实现WSGI的server端、进程管理以及对application的调用。Nginx上一般是用proxy的方式,用nginx的协议将请求封装好,发送给应用服务器,比如uWSGI,应用服务器会实现WSGI的服务端、进程管理以及对application的调用。