Django之中间件

中间件

中间件介绍

什么是中间件?

官方的说法：中间件是一个用来处理Django的请求和响应的框架级别的挂钩。它是一个轻量、低级别的插件系统，用于在全局范围内改变Django的输入和输出。每个中间件组件都负责做一些特定的功能。

但是由于其影响的是全局，所以需要谨慎使用，使用不当会影响性能。

说的直白一点中间件是帮助我们在视图函数执行之前和执行之后都可以做一些额外的操作，它本质上就是一个自定义类，类中定义了几个方法，Django框架会在处理请求的特定的时间去执行这些方法。

打开Django项目的Settings.py文件，看到下图的MIDDLEWARE配置项。

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',
]

MIDDLEWARE配置项是一个列表，列表中是一个个字符串，这些字符串其实是一个个类，也就是一个个中间件。

自定义中间件

中间件可以定义五个方法，分别是：（主要的是process_request和process_response）

• process_request(self,request)
• process_view(self, request, view_func, view_args, view_kwargs)
• process_template_response(self,request,response)
• process_exception(self, request, exception)
• process_response(self, request, response)

from django.utils.deprecation import MiddlewareMixin

class MD1(MiddlewareMixin):

    def process_request(self, request):
        # 执行时间: 在路由匹配和视图函数之前
        # 参数: request对象,就是视图函数的request对象,这个对象贯穿整个过程
        # 执行顺序: 按照注册顺序  顺序执行
        # 返回值:
        # None: 正常流程
        # HttpResponse: 不再执行后面的process_request方法,直接执行从对应的process_response方法开始,向上执行
        print('MD1 process_request', id(request))
        # return HttpResponse('MD1 process_request')

    def process_response(self, request, response):
        # 执行时间: 在视图函数之后
        # 参数: request对象,response对象(视图函数返回的对象)
        # 执行顺序: 按照注册顺序  倒序执行
        # 返回值: 不能为None
        # HttpResponse: 视图函数的response对象,必须是response对象
        print('MD1 process_response', id(request), id(response))
        return response

    def process_view(self, request, view_func, args, kwargs):
        # 执行时间: 在视图函数之前,路由匹配之后
        # 参数: request对象,视图函数对象,视图函数的参数
        # 执行顺序: 按照注册顺序  倒序执行
        # 返回值:
        # None: 正常流程
        # HttpResponse: 不再执行后面的process_view和视图函数,直接从最下面的process_response开始向上执行
        print('MD1 process_view', view_func, args, kwargs)
        # return HttpResponse('MD1 process_view')

    def process_exception(self, request, exception):
        # 执行时间: 视图函数中引发异常时,在视图函数之后运行
        # 参数: request对象, exception异常对象
        # 执行顺序: 按照注册顺序  倒序执行
        # 返回值:
        # None: 将exception交给下一个process_exception处理,如果都不处理就会交给django处理
        # HttpResponse: 处理异常,不再执行后面的process_exception,直接从最下面的process_response开始向上执行
        print('MD1 process_exception', exception, type(exception))

    def process_template_response(self, request, response):
        # 执行时间: 当视图函数返回的是TemplateResponse对象时执行
        # 参数: request对象, response: TemplateResponse对象
        # 执行顺序: 按照注册顺序  倒序执行
        # 返回值:
        # 必须是一个TemplateResponse对象
        print('MD1 process_template_response', request, response, id(response))
        # 可以更改TemplateResponse的属性
        response.template_name = 'index_new.html'
        response.context_data = {'name': '猪八戒'}
        return response

class MD2(MiddlewareMixin):
    
    def process_request(self, request):
        print('MD2 process_request', id(request))

    def process_response(self, request, response):
        print('MD2 process_response', id(request), id(response))
        return response

    def process_view(self, request, view_func, args, kwargs):
        print('MD2 process_view', view_func, args, kwargs)

    def process_exception(self, request, exception):
        print('MD2 process_exception', exception, type(exception))
        return HttpResponse('我MD2 给你处理了!')

    def process_template_response(self, request, response):
        print('MD2 process_template_response', id(response))
        return response

在settings.py的MIDDLEWARE配置项中注册上述两个自定义中间件：

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',
    'middlewares.MD1',  # 自定义中间件MD1
    'middlewares.MD2'  # 自定义中间件MD2
]

中间件的执行流程

请求到达中间件之后，先按照正序执行每个注册中间件的process_reques方法，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方法。

process_request方法都执行完后，匹配路由，找到要执行的视图函数，先不执行视图函数，先执行中间件中的process_view方法，process_view方法返回None，继续按顺序执行，所有process_view方法执行完后执行视图函数。假如中间件3 的process_view方法返回了HttpResponse对象，则4,5,6的process_view以及视图函数都不执行，直接从最后一个中间件，也就是中间件6的process_response方法开始倒序执行。

process_template_response和process_exception两个方法的触发是有条件的，执行顺序也是倒序。总结所有的执行流程如下：

中间件版登录验证

中间件版的登录验证需要依靠session，所以数据库中要有django_session表。

urls.py

from django.conf.urls import url
from django.contrib import admin
from app01 import views

urlpatterns = [
    url(r'^admin/', admin.site.urls),
    url(r'^login/$', views.login, name='login'),
    url(r'^index/$', views.index, name='index'),
    url(r'^home/$', views.home, name='home'),
]

views.py

from django.shortcuts import render, HttpResponse, redirect


def index(request):
    return HttpResponse('this is index')


def home(request):
    return HttpResponse('this is home')


def login(request):
    if request.method == "POST":
        user = request.POST.get("user")
        pwd = request.POST.get("pwd")

        if user == "xxx" and pwd == "123":
            # 设置session
            request.session["user"] = user
            # 获取跳到登陆页面之前的URL
            next_url = request.GET.get("next")
            # 如果有，就跳转回登陆之前的URL
            if next_url:
                return redirect(next_url)
            # 否则默认跳转到index页面
            else:
                return redirect("/index/")
    return render(request, "login.html")

login.html

<body>
<form action="{% url 'login' %}" method="post">
    {% csrf_token %}
    <p>
        <label for="user">用户名：</label>
        <input type="text" name="user" id="user">
    </p>
    <p>
        <label for="pwd">密 码：</label>
        <input type="text" name="pwd" id="pwd">
    </p>
    <input type="submit" value="登录">
</form>
</body>

middlewares.py

from django.utils.deprecation import MiddlewareMixin


class AuthMD(MiddlewareMixin):
    white_list = ['/login/', ]  # 白名单
    black_list = ['/black/', ]  # 黑名单

    def process_request(self, request):
        from django.shortcuts import redirect, HttpResponse

        next_url = request.path_info
        print(request.path_info, request.get_full_path())
        # 黑名单的网址限制访问
        if next_url in self.black_list:
            return HttpResponse('This is an illegal URL')
        # 白名单的网址或者登陆用户不做限制
        elif next_url in self.white_list or request.session.get("user"):
            return None
        else:
            return redirect("/login/?next={}".format(next_url))

在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',
    'middlewares.AuthMD'
]

AuthMD中间件注册后，所有的请求都要走AuthMD的process_request方法。

如果URL在黑名单中，则返回This is an illegal URL的字符串；

访问的URL在白名单内或者session中有user用户名，则不做阻拦走正常流程；

正常的URL但是需要登录后访问，让浏览器跳转到登录页面。

注：AuthMD中间件中需要session，所以AuthMD注册的位置要在session中间的下方。

附：Django请求流程图