Django中间件

中间件

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

# 进入到各自的类中，会发现它们都继承了同一个类MiddlewareMixin
如果要进行自定义中间件的话，要先导入这个模块，如：

from django.utils.deprecation import MiddlewareMixin

class MD1(MiddlewareMixin):

    def process_request(self, request):
        print("MD1里面的 process_request")

    def process_response(self, request, response):
        print("MD1里面的 process_response")
        return response

process_request(self,request):

执行时间：

​ 在路由匹配之前,也在执行视图函数之前

参数：

​ request： 请求对象，和视图是同一个

执行的顺序：

​ 按照中间件的注册顺序，顺序执行

返回值：

​ None ： 正常流程

​ HttpResponse：当前中间件之后的中间件的process_request、路由匹配、process_view、视图函数都不执行，直接执行当前中间件的process_response的方法，倒序执行之前中间件的process_response的方法，最终返回给浏览器

process_response(self, request, response)

执行时间：

​ 正常情况下，在执行视图函数之后；

参数：

​ request： 请求对象 和视图是同一个

​ response: 返回的response对象，response是视图函数返回的HttpResponse对象。该方法的返回值也必须是HttpResponse对象。

执行的顺序：

​ 多个中间件中的process_response方法是按照MIDDLEWARE中的注册顺序倒序执行的，也就是说第一个中间件的process_request方法首先执行，而它的process_response方法最后执行，最后一个中间件的process_request方法最后一个执行，它的process_response方法是最先执行。

返回值：

​ HttpResponse：必须返回response对象

process_view(self, request, view_func, view_args, view_kwargs)

执行时间：

​ 在执行视图函数之前，在路由匹配之后

参数：

​ request： 请求对象 ， 和视图是同一个

​ view_func： 视图函数，它是实际的函数对象，而不是函数的名称作为字符串。

​ view_args： 传递给视图函数的位置参数 ，分组的参数

​ view_kwargs： 传递给视图函数的关键字参数，命名分组的参数

执行的顺序：

​ 按照中间件的注册顺序 顺序执行

返回值：

​ None : 正常流程

​ HttpResponse：当前中间件之后的中间件的process_view、视图函数都不执行，直接执行最后一个中间件的process_response的方法，倒序执行之前的process_response的方法，最终返回给浏览器

process_exception(self, request, exception)

执行时间（触发条件）：

​ 视图层面有异常才执行

参数：

​ request： 请求对象 和视图是同一个

​ exception： 错误对象

执行的顺序：

​ 按照中间件的注册顺序 倒序执行

返回值：

​ None : 交给下一个中间件处理异常，所有的中间件都没有处理，交给django处理

​ HttpResponse：当前中间件之前的中间件的process_exception不执行，直接执行最后一个中间件的process_response的方法，倒序执行之前的process_response的方法，最终返回给浏览器

process_template_response(self,request,response):

执行时间（触发条件）：

​ 视图返回的response 是一个template_response对象，或者是视图函数返回的对象有一个render()方法（或者表明该对象是一个TemplateResponse对象或等价方法）

参数：

​ request： 请求对象 和视图是同一个

​ response： 响应对象

执行的顺序：

​ 按照中间件的注册顺序 倒序执行

返回值：

​ HttpResponse：必须返回

优点：可以通过response.template_data,response.template_name等进行灵活的数据修改

中间件的执行流程

请求到达中间件之后，先按照正序执行每个注册中间件的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两个方法的触发是有条件的，执行顺序也是倒序。总结所有的执行流程如下：

Django请求流程图

中间件实现登录验证

# urls实现
from django.conf.urls import url
from django.contrib import admin
from app01 import views

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

# views设置
def login(request):
    if request.method == "POST":
        user = request.POST.get("user")
        pwd = request.POST.get("pwd")

        if user == "gailun" and pwd == "1234":
            # 设置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")

# middle中间件配置
class AuthMD(MiddlewareMixin):
    while_list = ['/login/',]
    black_list = ['/black/',]

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

        next_url = request.path_info
        print(request.path_info, request.get_full_path())

        if next_url in self.black_list:
            return HttpResponse('this is illegal URL')
        elif next_url in self.while_list or request.session.get('user'):
            return None
        else:
            return redirect("/login/?next={}".format(next_url))

# HTML模板login.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="x-ua-compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>登录页面</title>
</head>
<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>
</html>

【总结】

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

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

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

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

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