Werkzeug 与 WSGI 介绍

mengera88 发布于2019-07-30 17:54 / 2877人阅读

摘要：在介绍之前，先介绍一下，它为语言定义的服务器和应用程序或框架之间的一种简单而通用的接口。这个函数接受两个参数，分别是和。响应对象是一个应用，提供了更好的方法来创建响应。这部分解释来源于官方文档的中文版。

Werkzeug 是一个WSGI工具包，也可以作为一个Web框架的底层库。

WSGI

在介绍Werkzeug之前，先介绍一下 WSGI（Python Web Server Gateway Interface），它为Python语言定义的Web服务器和Web应用程序或框架之间的一种简单而通用的接口。这是一个规范，描述了web server如何与web application交互、web application如何处理请求，该规范的具体描述在PEP3333，强烈推荐先阅读 PEP3333 再回头来阅读本文。

WSGI 分为两个部分：

Server/Gateway: 即是HTTP Server, 负责从客户端(Nginx、apache、IIS）接收请求,将 request 转发给 application, 并将 application（可能是个Flask应用）返回的response 返回给客户端

Application/Framework: 一个python web 应用或 web 框架接收由 server 转发的request，处理请求，并将处理结果返回给 server

可以通过下面两张图片来梳理一下它们之间的调用关系：

先从一份示例代码理解：

def application(environ, start_response):
    start_response("200 OK", [("Content-Type", "text/plain")])
    return ["Hello World!"]

一个最基本的 WSGI 应用就是如上所示，定义了一个 application 函数(callable object），callable object(可调用对象) 包括：一个函数、方法、类或一个实现了__call__的实例都可以用作应用程序对象。这个函数接受两个参数，分别是environ和start_response。

environ是一个字典包含了CGI中的环境变量

start_response也是一个callable，接受两个必须的参数，status（HTTP状态）和response_headers（响应消息的头）

通过回调函数（start_response)将响应状态和响应头返回给 server，同时返回响应正文(response body)，响应正文是可迭代的、并包含了多个字符串。

Werkzeug

werkzeug 提供了 python web WSGI 开发相关的功能：

路由处理：如何根据请求 URL 找到对应的视图函数

request 和 response 封装: 提供更好的方式处理request和生成response对象

自带的 WSGI server: 测试环境运行WSGI应用

下面使用 Werkzeug 来实现一个简单的WSGI应用：

from werkzeug.wrappers import Request, Response

def application(environ, start_response):
    request = Request(environ)
    text = "Hello %s!" % request.args.get("name", "World")
    response = Response(text, mimetype="text/plain")
    return response(environ, start_response)

如上代码所示，请求数据需要环境对象，Werkzeug允许你以一个轻松的方式访问数据。响应对象是一个 WSGI 应用，提供了更好的方法来创建响应。

具体创建一个 WSGI 应用请查看文档，后面会陆续提到Flask框架中使用到Werkzeug的数据结构。这里贴一些官方文档的例子，使用werkzeug创建一个web 应用：

import os
import redis
import urlparse
from werkzeug.wrappers import Request, Response
from werkzeug.routing import Map, Rule
from werkzeug.exceptions import HTTPException, NotFound
from werkzeug.wsgi import SharedDataMiddleware
from werkzeug.utils import redirect
from jinja2 import Environment, FileSystemLoader

class Shortly(object):
    """ 
    Shortly 是一个实际的 WSGI 应用，通过 __call__ 方法直接调 用 wsgi_app，
    同时通过一个可选设置创建一个中间件，将static文件夹暴露给用户：
    """
    def __init__(self, config):
        self.redis = redis.Redis(config["redis_host"], config["redis_port"])

    def dispatch_request(self, request):
        return Response("Hello World!")

    def wsgi_app(self, environ, start_response):
        request = Request(environ)
        response = self.dispatch_request(request)
        return response(environ, start_response)

    def __call__(self, environ, start_response):
        return self. wsgi_app(environ, start_response)


def create_app(redis_host="localhost", redis_port=6379, with_static=True):
    app = Shortly({
        "redis_host":       redis_host,
        "redis_port":       redis_port
    })
    if with_static:
        app.wsgi_app = SharedDataMiddleware(app.wsgi_app, {
            "/static":  os.path.join(os.path.dirname(__file__), "static")
        })
    return app
    
if __name__ == "__main__":
    from werkzeug.serving import run_simple
    app = create_app()
    run_simple("127.0.0.1", 5000, app, use_debugger=True, use_reloader=True)

思路很简单，我们的 Shortly 是一个实际的 WSGI 应用。 __call__ 方法直接调用 wsgi_app 。这样做我们可以装饰 wsgi_app 调用中间件，就像我们在 create_app 函数中做的一样。 wsgi_app 实际上创建了一个 Request 对象,之后通过 dispatch_request 调用 Request 对象然后给 WSGI 应用返回一个 Response 对象。正如你看到的：无论是创建 Shortly 类，还是创建 Werkzeug Request 对象来执行 WSGI 接口。最终结果只是从 dispatch_request 方法返回另一个 WSGI 应用。这部分解释来源于官方文档的中文版。

总结

本文主要解释了WSGI规范和Werkzeug（WSGI 工具集），以及如何实现一个符合WSGI规范的WSGI应用，最后使用Werkzeug 工具集中的相关模块，快速实现了一个基于WSGI的简单应用。

参考

Werkzeug 中文文档
Werkzeug 英文文档
WSGI Servers
WSGI协议的原理和实现

专线服务私有云 Werkzeug 与index介绍 WSGI 数据科学与大数据技术介绍

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/42491.html

一个Flask应用运行过程剖析

摘要：本文就主要针对一个应用的运行过程进行简要分析，后续文章还会对框架的一些具体问题进行分析。所有的请求处理过程，都会在这个上下文对象中进行。和一些全局变量注意当进入这个上下文对象时，会触发。相信很多初学Flask的同学（包括我自己），在阅读官方文档或者Flask的学习资料时，对于它的认识是从以下的一段代码开始的： from flask import Flask app = Flask(...

shmily 2019-07-25 11:47 评论0 收藏0
flask 源码解析：简介

摘要：简介官网上对它的定位是一个微开发框架。另外一个必须理解的概念是，简单来说就是一套和框架应用之间的协议。功能比较丰富，支持解析自动防止攻击继承变量过滤器流程逻辑支持代码逻辑集成等等。那么，从下一篇文章，我们就正式开始源码之旅了文章属于作者原创，原文发布在个人博客。 flask 简介 Flask 官网上对它的定位是一个微 python web 开发框架。 Flask is a micro...

megatron 2019-07-25 11:23 评论0 收藏0
flask源码走读

摘要：另外，如果你对模板渲染部分的内容感兴趣，也可以考虑阅读文档文档文档源码阅读，可以参考下面的函数打断点，再测试一个请求，理清过程。 Flask-Origin 源码版本一直想好好理一下flask的实现,这个项目有Flask 0.1版本源码并加了注解,挺清晰明了的,我在其基础上完成了对Werkzeug的理解部分,大家如果想深入学习的话,可以参考werkzeug_flow.md. 阅读前为...

Coly 2019-07-31 10:16 评论0 收藏0
flask 源码解析：应用启动流程

摘要：中有一个非常重要的概念每个应用都是一个可调用的对象。它规定了的接口，会调用，并传给它两个参数包含了请求的所有信息，是处理完之后需要调用的函数，参数是状态码响应头部还有错误信息。一般来说，嵌套的最后一层是业务应用，中间就是。文章属于作者原创，原文发布在个人博客。 WSGI 所有的 python web 框架都要遵循 WSGI 协议，如果对 WSGI 不清楚，可以查看我之前的介绍文章。 ...

whatsns 2019-07-25 11:23 评论0 收藏0
深入理解Python中的ThreadLocal变量（下）

摘要：具体怎么实现的呢，思想其实特别简单，我们在深入理解中的变量上一文的最后有提起过，就是创建一个全局字典，然后将线程或者协程标识符作为，相应线程或协程的局部数据作为。在上篇我们看到了 ThreadLocal 变量的简单使用，中篇对python中 ThreadLocal 的实现进行了分析，但故事还没有结束。本篇我们一起来看下Werkzeug中ThreadLocal的设计。 Werkzeug...

dadong 2019-07-31 10:51 评论0 收藏0