Django中间件的使用方法

2019-01-25 本文已影响0人吾星喵

Django中间件

概念

中间件是一个钩子框架，它们可以介入Django 的请求和响应处理过程。它是一个轻量级、底层的“插件”系统，用于在全局修改Django 的输入或输出。

每个中间件组件负责完成某个特定的功能。

创建一个新django项目时，默认自带的中间件有：(在settings.py内)

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
]

SecurityMiddleware：为请求/相应提供了几种安全改进
SessionMiddleware：开启会话支持
CommonMiddleware：基于APPEND_SLASH和PREPEND_WWW的设置来重写URL，如果APPEND_SLASH设为True，并且初始URL 没有以斜线结尾以及在URLconf 中没找到对应定义，这时形成一个斜线结尾的新URL；如果PREPEND_WWW设为True，前面缺少 www.的url将会被重定向到相同但是以一个www.开头的url
CsrfViewMiddleware：添加跨站点请求伪造的保护，通过向POST表单添加一个隐藏的表单字段，并检查请求中是否有正确的值
AuthenticationMiddleware：向每个接收到的user对象添加HttpRequest属性，表示当前登录的用户
MessageMiddleware：开启基于Cookie和会话的消息支持
XFrameOptionsMiddleware：对点击劫持的保护

中间件执行流程

从浏览器发出一个请求 Request，得到一个响应后的内容 HttpResponse ，这个请求传递到 Django的过程如下：

请求到达中间件之后，先按照正序执行每个注册中间件的process_request方法，如果process_request方法返回的值是None，就依次执行；如果返回的值是HttpResponse对象，则不再执行后面的process_request方法，而是执行当前对象中间件的process_response方法，并将HttpResponse对象返回给浏览器。

也就是说，如果MIDDLEWARE注册了6个中间件，执行过程中，第3个中间件返回了一个HttpResponse对象，那么第4, 5, 6中间件的process_request和process_response方法都不执行，而是顺序执行3, 2, 1中间件的process_response方法。

image.png

中间件的五种方法

中间件中可以定义5个方法，分别是:

process_request(self,request) 发送请求
process_view(self, request, callback, callback_args, callback_kwargs) 执行完 request 预处理函数并确定待执行的 view 之后，但在 view 函数实际执行之前。
process_template_response(self,request,response) response参数应该是一个由view或者中间件返回的TemplateResponse对像（或等价的对象）。如果响应的实例有render()方法，process_template_response()会在view刚好执行完毕之后被调用。这个方法必须返回一个实现了render方法的响应对象。
process_exception(self, request, exception) 收集错误信息，当一个view引发异常时，Django会调用process_exception()来处理。返回一个None或一个HttpResponse对象。如果返回HttpResponse对象，会将响应交给处理响应的中间件处理。由于处理响应时是从下到上的，此层以上的process_exception()是不会被调用的。
process_response(self, request, response) 必须返回 HttpResponse 对象。这个 response 对象可以是传入函数的那一个原始对象（通常已被修改），也可以是全新生成的。

执行顺序也是按照以上顺序执行的。

process_request

执行时间：
在视图函数之前，在路由匹配之前

参数：
request：请求对象，与视图中用到的request参数是同一个对象

返回值：
None：按照正常的流程走
HttpResponse：接着倒序执行当前中间件的以及之前执行过的中间件的process_response方法，不再执行其它的所有方法

执行顺序：
按照MIDDLEWARE中的注册的顺序执行，也就是此列表的索引值

process_response

执行时间：
最后执行

参数：
request：请求对象，与视图中用到的request参数是同一个对象
response：响应对象，与视图中返回的response是同一个对象

返回值：
response：必须返回此对象，按照正常的流程走

执行顺序：
按照注册的顺序倒序执行

process_view

执行时间：
在process_request方法及路由匹配之后，视图之前

参数：
request：请求对象，与视图中用到的request参数是同一个对象
view_func：将要执行的视图函数（它是实际的函数对象，而不是函数的名称作为字符串）
view_args：url路径中将传递给视图的位置参数的元组
view_kwargs：url路径中将传递给视图的关键值参数的字典

返回值：
None：按照正常的流程走
HttpResponse：它之后的中间件的process_view，及视图不执行，执行所有中间件的process_response方法

执行顺序：
按照注册的顺序执行

process_exception

此方法只在视图中触发异常时才被执行.

执行时间：
视图之后，process_response之前

参数：
request：请求对象，与视图中用到的request参数是同一个对象
exception：视图函数异常产生的Exception对象

返回值：
None：按照正常的流程走
HttpResponse对象：不再执行后面的process_exception方法

执行顺序：
按照注册的顺序倒序执行

process_template_response

此方法必须在视图函数返回的对象有一个render()方法（或者表明该对象是一个TemplateResponse对象或等价方法）时，才被执行.

render()方法用于返回一个HTML页面.

执行时间：
视图之后，process_exception之前

参数：
request：请求对象，与视图中用到的request参数是同一个对象
response：是TemplateResponse对象（由视图函数或者中间件产生）

返回值：
response：必须返回此对象，按照正常的流程走

执行顺序：
按照注册的顺序倒序执行

自定义中间件

from django.utils.deprecation import MiddlewareMixin
# from django.http import HttpResponse
from django.shortcuts import HttpResponse, redirect


# 方式一：
class MyMiddleware(MiddlewareMixin):
    def process_request(self, request):
        next_url = request.path_info
        if not request.path_info.startswith("/login/"):
            # 做登录验证
            login_flag = request.session.get("login", "")
            if not login_flag:
                return redirect("/login/?next={}".format(next_url))

    def process_view(self, request, view_func, view_args, view_kwargs):
        pass

    def process_exception(self, request, exception):
        if isinstance(exception, ValueError):
            return HttpResponse("404")

    def process_response(self, request, response):
        return response


# 方式二：
class SimpleMiddleware(object):
    def __init__(self, get_response):
        self.get_response = get_response
        # 一次性配置和初始化。

    def __call__(self, request):
        # Code to be executed for each request before
        # the view (and later middleware) are called.
        # 这里写的代码会在视图被调用前执行来处理请求
        response = self.get_response(request)
        # 这里写的代码会在视图调用后执行来处理响应
        # Code to be executed for each request/response after
        # the view is called.

        return response

    def process_view(self, request, view_func, view_args, view_kwargs):
        pass

    def process_exception(self, request, exception):
        pass

    def process_template_response(self, request, response):
        pass

中间件注册

# 在settings.py里的下面列表中添加自定义的中间件来激活该中间件
MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
    'mymiddlewares.middlewares.MyMiddleware',
    'mymiddlewares.middlewares.SimpleMiddleware',
]