WSGI规范

1.WSGI协议

什么是WSGI
(1)、WSGI(Web 服务器网关接口)是python中所定义的Web Server和Web APP之间或框架之间的接口标准规范
(2)、WSGI接口规范的目的就是规范Web服务器与Web应用之间的交互,在协议之间进行转换
(3)、WSGI将Web组件分成三类:Web服务器(Server)、Web中间件(Middleware)与Web应用程序(APP)。

WSGI APP:指的是可以被调用的一个对象,一般指的是包含一个__call__方法的类的实例或者一个函数。
WSGI Server:指的是实现了调用应用的部分。
WSGI Middleware:处于服务器和应用两侧,起粘合作用,具体包括:请求处理、environ处理。

2.什么是WSGI APP

WSGI APP是一个可调用的对象(callable object),常用的可调用的对象有三种:

1.一个函数或者类的方法
2.一个实现__call__()方法的类的实例
3.一个类:调用类时会运行类的 __new__ 方法创建一个实例,然后运行 __init__ 方法,初始化实例,最后把实例返回给调用方。因为 Python 没有 new 运算符,所以调用类相当于调用函数。(通常,调用类会创建那个类的实例,不过覆盖 __new__ 方法的话,也可能出现其他行为。)

这个对象接收两个参数environ和start_response。
environ是一个字典,里面储存了HTTP request的所有内容。而start_response是一个WSGI Server传递过来的函数,用于将response header,status传递给Server。并且它还需要返回一个可迭代的值,用于将response body传递给Server。
以可调用对象为一个类为例:

class application:
   def __call__(self, environ, start_response):
   status = '200 OK'
   response_headers = [('Content-type', 'text/plain')]
   start_response(status, response_headers)
   return [u"This is hello wsgi app".encode('utf8')

WSGI APP使用start_response(status, response_headers)这个函数将response header,status传递给Server,使用return(调用返回)将response body传递给Server,即将一个http response通过两个途径返回给了Server。

在OpenStack中,为了简化程序的书写,经常使用WebOb包中的wsgify装饰器将一个函数变为WSGI APP

class webob.dec.wsgify(func=None, RequestClass=None, args=(), kwargs=None, middleware_wraps=None)

如下所示

from webob.dec import wsgify
from webob import Request,Response
@wsgify
def myfunc(req):
    return Response('hey there')

此时APP的输入变成封装了environ字典的一个Request类,并且直接返回一个封装了所有http response信息的Response类即可。
装饰器还可以自定义,一般通过一个继承了webob.Request的子类(比如MyRequest)来实现,如下:

class MyRequest(webob.Request):  #python中的继承,子类继承Request类
    @property                    #只读
    def is_local(self):     
        return self.remote_addr == '127.0.0.1' 

@wsgify(RequestClass=MyRequest)
def myfunc(req):
    if req.is_local:
        return Response('hi!')
    else:
        raise webob.exc.HTTPForbidden

可以看到,经过这种方式,我们在Server和APP之间实现了一层过滤地址的功能(本机地址可以访问,其他地址则拒绝访问),实际上就实现了一个Middleware。

WebOb包的官方英文文档链接:https://docs.pylonsproject.org/projects/webob/en/latest/reference.html
关于environ字典和WebOb包的总结:https://www.jianshu.com/p/c62a4a2f5dd6

3.WSGI Server

WSGI Server需要调用WSGI APP


def run(application):#服务器程序调用应用程序

    environ = {}#设定参数

    defstart_response(xxx):#设定参数

        pass

    result = application(environ, start_response)#调用APP的__call__函数(这里APP是一个类)

    def write(data):

        pass

    def data in result:#迭代访问

        write(data)

服务器程序主要做了以下的事:

  1\. 设定app所需要的参数(environ,start_response)

  2\. 调用app

  3\. 迭代访问app的返回结果(response body),并传给客户端

但实际上已经有很多已经封装好的WSGI Server供我们使用,只需简单的将APP与一些其他的参数绑定来创建一个Server,而这个Server会将它接收到的request传递给绑定的APP。
如最简单,常用于实验环境中启动一个Server的方法,如下所示:

from paste import httpserver
def application(environ, start_response)
    pass

httpserver.serve(application, host = '127.0.0.1', port = 8080)

上面的方法是使用进程启动,一个进程对应一个服务(Server),对服务地启动、关闭、暂停都需要直接对进程进行操作,开销较大,而在OpenStack中,常用eventlet(绿色线程)来启动服务。

class Server(object)
  def __init__(self, app, host = '0.0.0.0', port = 0):
    #线程池,允许并行访问
    self._pool = eventlet.GreePool(10)
    #WSGI server的应用程序,由调用者传入!!!
    self.app = app
    #根据传入的参数创建监听socket
    self._socket = eventlet.listen((host, port), backlog = 10)
    #获取监听的地址和端口放到__dict__字典中,然后打印出来
    (self.host, self.port) = self._socket.getsockname()
    print("Listen on %(host)s:%(port)s" %self.__dict__)

  #start方法,由初始化的参数创建服务线程,注意需要传入app
  def start(self)
    self._server = eventlet.spawn(event.wsgi.server,
                                  self._socket
                                  self.app
                                  protocol = eventlet.wsgi.HttpProtocol,
                                  custom_pool = self._pool

  #stop方法,终止线程
  def stop(self):
    if self._server is not None:
       self._pool.resize(0)
       self._server.kill()

  #wait方法,监听http请求
  def wait(self):
    try:
      self._server.wait()
    except greenlet.GreeletExit:
      print("WSGI server has stopped.")

上面将WSGI Server封装到了一个Server类中,并通过传入WSGI APP参数创建Server实例来启动一个WSGI Server,但需要注意的是Server与APP并非简单的一对一或一对多的关系。

4.WSGI Middleware

WSGI Middleware(中间件)是介于服务器程序和应用程序中间的部分,Middleware对Server和APP是透明的。
从实现上来说,Middleware和APP的输入和返回是一样的,只不过Middleware接收Server传递过来的request,经过自己的逻辑处理后(如路由,过滤),选择是调用下一个APP获取response返回或者直接返回response(如404,403等)。因此,Middleware就是中间APP。
Server获取到了客户端请求的URL,需要把URL交给不同的APP处理,这个功能可以使用Middleware实现:

# URL Routing middleware
def urlrouting(url_app_mapping):   
     def midware_app(environ, start_response):       #函数可调用,包含2个参数,返回可迭代的值
          url = environ['PATH_INFO']       
          app = url_app_mapping(url)       #获得对应url的应用程序
          result = app(environ, start_response)       #调用应用程序
          return result       
     return midware_app

函数midware_app就是Middleware(也是一个APP),调用流程:
1.实现一个url_app_mapping(url)函数,它传入url并返回请求的app
2.调用middleware_app = urlrouting(url_app_mapping)得到中间件app
3.使用middleware_app创建server

def url_app_mapping(url):
  pass

middleware_app = urlrouting(url_app_mapping)
server = make_server('ip',port,middleware_app)
server.serve_forever

Middleware 处于Server和APP之间,每个 Middleware 实现不同的功能,我们通常根据需求选择相应的 Middleware 并组合起来,实现所需的功能。其作用有以下几点:
• 根据 url 把用户请求调度到不同的 application 中。
• 负载均衡,转发用户请求
• 预处理 XSL 等相关数据
• 限制请求速率,设置白名单

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,029评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,238评论 3 388
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,576评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,214评论 1 287
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,324评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,392评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,416评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,196评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,631评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,919评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,090评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,767评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,410评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,090评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,328评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,952评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,979评论 2 351

推荐阅读更多精彩内容

  • Refer to: www.threemeal.com/blog/12/ 中间件 中间件是一个钩子框架,它们可以介...
    兰山小亭阅读 16,478评论 9 165
  • 原文:https://legacy.python.org/dev/peps/pep-3333 PEP:3333标题...
    老周_o_o阅读 2,398评论 0 5
  • 在web服务器运行中,为了防止请求的文件打开有异常,要在判断文件是否以“.py”结尾之后加上异常调试。 搜索到了一...
    菩灵阅读 333评论 0 3
  • WSGI的全称是Web Server Gateway Interface,翻译过来就是Web服务器网关接口。具体的...
    iqunqunqun阅读 20,017评论 1 18
  • 全称为Web Server Gateway Interface,即 Web服务器网关接口。是一种标准接口规范,规定...
    超net阅读 3,154评论 0 2