zoukankan      html  css  js  c++  java
  • 中间件

    什么是中间件?

    官方说法 :中间件就是一个出来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配置项是一个列表,列表中是一个个字符串,这些字符串其实是一个个类,也就是一个个中间件。

    我们之前已经接触过一个csrf相关的中间件了?我们一开始让大家把他注释掉,再提交post请求的时候,就不会被forbidden了,后来学会使用{%csrf_token%}之后就不再注释这个中间件了。

    那接下来就学习中间件中的方法以及这些方法什么时候被执行。

    自定义中间件:

    中间件可以定义五个方法,分别是(pricess_request、process_views、process_template、process_exception、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)

    以上的方法的返回值可以是None或者一个HttpResponse对象,如果是None,则按照Django定义的规则向后继续执行,如果是HttpResponse对象,则直接将对象返回给用户

    首先你要在你的Django种开辟的app种建立一个存放中间件的py文件,然后导入中间件需要的模块

    from django.utils.deprecation import MiddlewareMixin

    自定义一个中间件示例

    from django.shortcuts import render,redirect ,HttpResponse
    
    from django.utils.deprecation import  MiddlewareMixin
    
    
    
    class MD1(MiddlewareMixin):
    
        def process_request(self,request):   #request的执行是在视图函数之前先执行这个 
            print('我是MD1的process_request')
    
    
    
        def process_response(self,request,response):   # 这个时候你的response是接收过来的是可能另外一个中间件传递过来的  那么你就要把它接收过来
    
            print('我是MD1的process_response')
    
            return response  #然后把你接收的response传递出去 给下一个中间件或者视图函数

    中间件你要自定一个类然后在你的 类中根据你的需求对你的类设计这个五个方法, 然后把这个类导入你的settings种 

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

    定义中间件的方法:

    process_request :

    process_request有一个参数,就是reqeust,这个request和视图函数中的request是一样的,

    它的返回值可以是None也可以是HttpResponse对象。返回值是None的话 按照正常流程继续往下走,交给下一个中间件处理,如果是HttpResponse对象,Django将不执行视图函数  而将响应对象返回给浏览器

     我们来看看多个中间件时,Django是如何执行其中的process_request方法的。

     中间件  

    from django.shortcuts import render,redirect ,HttpResponse
    
    from django.utils.deprecation import  MiddlewareMixin
    
    class MD1(MiddlewareMixin):
    
        def process_request(self,request):   #request的执行是在视图函数之前先执行这个
            print('我是MD1的process_request')
    
        def process_response(self,request,response):   # 这个时候你的response是接收过来的是可能另外一个中间件传递过来的  那么你就要把它接收过来
            print('我是MD1的process_response')
            return response  #然后把你接收的response传递出去 给下一个中间件或者视图函数
    
    class MD2(MiddlewareMixin):
        def process_request(self,reqeust):
            print('是MD2的process_request')

     通过执行可以看到

     

    通过以上两幅图就可以得到 request是在视图函数执行之前执行的

    由此总结一下:

    1. 中间件的process_request方法是在执行视图函数之前执行的。
    2. 当配置多个中间件时,会按照MIDDLEWARE中的注册顺序,也就是列表的索引值,从前到后依次执行的。
    3. 不同中间件之间传递的request都是同一个对象

    process_response:

    它有两个参数,一个是request,一个是response,request就是上述例子中一样的对象,response就是视图函数返回的HttpRsponse对象。该方法返回的必须是HttpResponse对象

     def process_response(self,request,response):
            print('我是MD2的process_response')
            return response

    必须要有两个参数 self是必须要默认存在的另外的两个是request是你接收的,response是你返回的对象

    from django.utils.deprecation import  MiddlewareMixin
    class MD1(MiddlewareMixin):
        def process_request(self,request):   #request的执行是在视图函数之前先执行这个
            print('我是MD1的process_request')
        def process_response(self,request,response):   # 这个时候你的response是接收过来的是可能另外一个中间件传递过来的  那么你就要把它接收过来
            print('我是MD1的process_response')
            return response  #然后把你接收的response传递出去 给下一个中间件或者视图函数
        
    class MD2(MiddlewareMixin):
        def process_request(self,request):
            print('是MD2的process_request')
        def process_response(self,request,response):
            print('我是MD2的process_response')
            return response

    它的流程是:

    (此时settings.py中 MD1比MD2先注册)

     按照正常流程中间件的从上到下的  然后指向 request 然后再按照中间件的倒叙执行response

    并且 response再视图函数之后执行

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

     

    process_view

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

    该方法有四个参数

    request是HttpRequest对象。

    view_func是Django即将使用的视图函数。 (它是实际的函数对象,而不是函数的名称作为字符串。)

    view_args是将传递给视图的位置参数的列表.

    view_kwargs是将传递给视图的关键字参数的字典。 view_args和view_kwargs都不包含第一个视图参数(request)。

    Django会在调用视图函数之前调用process_view方法。

    它应该返回None或一个HttpResponse对象。 如果返回None,Django将继续处理这个请求,执行任何其他中间件的process_view方法,然后在执行相应的视图。 如果它返回一个HttpResponse对象,Django不会调用适当的视图函数。 它将执行中间件的process_response方法并将应用到该HttpResponse并返回结果。

    from django.utils.deprecation import  MiddlewareMixin
    class MD1(MiddlewareMixin):
        def process_request(self,request):   #request的执行是在视图函数之前先执行这个
            print('我是MD1的process_request')
        def process_response(self,request,response):   # 这个时候你的response是接收过来的是可能另外一个中间件传递过来的  那么你就要把它接收过来
            print('我是MD1的process_response')
            return response  #然后把你接收的response传递出去 给下一个中间件或者视图函数
        def process_view(self,request,view_func,view_args,view_kwargs):
            print('-'*10)
            print('我是MD1的process_view')
            print(view_func,view_func.__name__)
    
    class MD2(MiddlewareMixin):
        def process_request(self,request):
            print('是MD2的process_request')
        def process_response(self,request,response):
            print('我是MD2的process_response')
            return response
        def process_view(self,reqeust,view_func,view_args,view_kwargs):
            print('我是MD2的process_views')
            print(view_func,view_func.__name__)
            print('-' * 10)

    结果:

    process_view方法是在process_request之后,视图函数之前执行的,执行顺序按照MIDDLEWARE中的注册顺序从前到后顺序执行的

    视图函数之后执行 然后按照中间件注册的顺序来执行的

    process_exception:

    process_exception(self,request,exception)

    该方法两个参数:

    一个HttpResponse对象

    一个exception是视图函数异常产生的Exception对象

    这个方法只有在视图函数中出现异常了才执行,它返回的值可以是一个None也可以是一个HttpResponse对象。如果是HttpResponse对象,Django将调用模板和中间件中的process_response方法,并返回给浏览器,否则将默认处理异常。如果返回一个None,则交给下一个中间件的process_exception方法来处理异常。它的执行顺序也是按照中间件注册顺序的倒序执行。

    如果视图函数中无异常,process_exception方法不执行。

     给视图函数设置一个错误

    def login(request):
        print('这个是视图函数执行')
        raise ValueError('login视图函数')      #  主动让它抛出一个异常
    from django.shortcuts import render,redirect ,HttpResponse
    from django.utils.deprecation import  MiddlewareMixin
    class MD1(MiddlewareMixin):
        def process_request(self,request):   #request的执行是在视图函数之前先执行这个
            print('我是MD1的process_request')
        def process_response(self,request,response):   # 这个时候你的response是接收过来的是可能另外一个中间件传递过来的  那么你就要把它接收过来
            print('我是MD1的process_response')
            return response  #然后把你接收的response传递出去 给下一个中间件或者视图函数
        def process_view(self,request,view_func,view_args,view_kwargs):
            print('-'*10)
            print('我是MD1的process_view')
            print(view_func,view_func.__name__)
        def process_exception(self,request,exception):
            print('我是MD1的process_exception')
            return HttpResponse(str(exception))  #这个时候你返回的必须是一个字符串类型的错误信息  如果没有错误返回的就是空
    
    class MD2(MiddlewareMixin):
        def process_request(self,request):
            print('是MD2的process_request')
        def process_response(self,request,response):
            print('我是MD2的process_response')
            return response
        def process_view(self,reqeust,view_func,view_args,view_kwargs):
            print('我是MD2的process_views')
            print(view_func,view_func.__name__)
            print('-' * 10)
    
        def process_exception(self,request,exception):
            print('我是MD2的process_exception')
            return HttpResponse(str(exception))

     异常是倒着执行的  所以 我们先执行了最下面的md2的中间件的exxception  然后抛出了异常之后就不执行其他的了中间件的异常了

     

    process_template_response(用的比较少)

    process_template_iresponse(self,request,response)

    它的参数,一个HttpRequest对象,response是TemplateResponse对象(由视图函数或者中间件产生)。

    process_template_response是在视图函数执行完成后立即执行,但是它有一个前提条件,那就是视图函数返回的对象有一个render()方法(或者表明该对象是一个TemplateResponse对象或等价方法)。

    也就是说templace_process和前端的render是相互依存的

    def index(request):
        ret = HttpResponse('这是一个index页面')
        def func():
            print('This is a render界面')
            return HttpResponse('This is a render界面')
        ret.render = func
        return ret

    中间件:

    from django.shortcuts import render,redirect ,HttpResponse
    from django.utils.deprecation import  MiddlewareMixin
    class MD1(MiddlewareMixin):
        def process_request(self,request):   #request的执行是在视图函数之前先执行这个
            print('我是MD1的process_request')
        def process_response(self,request,response):   # 这个时候你的response是接收过来的是可能另外一个中间件传递过来的  那么你就要把它接收过来
            print('我是MD1的process_response')
            return response  #然后把你接收的response传递出去 给下一个中间件或者视图函数
        def process_view(self,request,view_func,view_args,view_kwargs):
            print('-'*10)
            print('我是MD1的process_view')
            print(view_func,view_func.__name__)
        def process_exception(self,request,exception):
            print('我是MD1的process_exception')
            return HttpResponse(str(exception))  #这个时候你返回的必须是一个字符串类型的错误信息  如果没有错误返回的就是空
    
        def process_templace_response(self,request,response):
            print('我是MD1的process_templace_response')
            return response
    
    class MD2(MiddlewareMixin):
        def process_request(self,request):
            print('是MD2的process_request')
        def process_response(self,request,response):
            print('我是MD2的process_response')
            return response
        def process_view(self,reqeust,view_func,view_args,view_kwargs):
            print('我是MD2的process_views')
            print(view_func,view_func.__name__)
            print('-' * 10)
    
        def process_exception(self,request,exception):
            print('我是MD2的process_exception')
            return HttpResponse(str(exception))
    
        def process_templace_response(self,request,response):
            print('我是MD2的process_templace_response')
            return response

    执行结果:

     当你的视图函数中有render的时候就会触发你的最后一个中间件的process_templace_response方法 然后返回的是你的render后的内容

    process_template_response:
    1. 视图返回的对象有render方法 才执行
    2. 在视图函数之后,process_response之前
    3. 它的顺序是从下往上
    4. 返回值是HttpResponse的对象。
    5. 执行完所有的中间件的process_template_response之后,
    才执行对象.render()得到一个新的HttpResponse的对象,执行往交给process_response继续

                    中间件的执行流程                           

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

     

     总结:

    总结:
        process_request:
            1. 是在视图执行前执行的
            2. 它的顺序是从上往下
            3. 返回值是None,继续往后执行
            4. 返回值是HttpResponse的对象,执行对应中间件的process_response方法
            ,接着往上,返回给浏览器
    
            
        process_response:
            1. 是在视图执行后执行的
            2. 它的顺序是从下往上
            3. 返回必须是HttpResponse的对象,继续往上执行
            
        process_view:
            1. 是在视图执行前执行的,process_request之后
            2. 它的顺序是从上往下
            3. 返回值是None,继续往后执行
            4. 返回值是HttpResponse的对象,执行最后一个中间件的process_response方法
            ,接着往上,返回给浏览器,视图不走了
            
        process_exception:
            1. 报错了才执行
            2. 在视图函数之后,process_response之前
            3. 它的顺序是从下往上
            4. 返回值是HttpResponse的对象,执行最后一个中间件的process_response方法
            ,接着往上,返回给浏览器
        
    
        process_template_response:
            1. 视图返回的对象有render方法 才执行
            2. 在视图函数之后,process_response之前
            3. 它的顺序是从下往上
            4. 返回值是HttpResponse的对象。
            5. 执行完所有的中间件的process_template_response之后,
            才执行对象.render()得到一个新的HttpResponse的对象,执行往交给process_response继续
            
            
            
            
            
    总结

    中间件版登录验证 

    中间件版的登录验证需要依靠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 == "alex" and pwd == "alex3714":
                # 设置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

    复制代码
    <!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>
    复制代码

    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
            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中间的下方。 

  • 相关阅读:
    Linux配置SSH公钥认证与Jenkins远程登录进行自动发布
    在阳台上种花生
    已知传递函数,求幅频响应?
    win8快速锁屏
    word2016怎么让目录索引显示在左边?
    Matlab 瑞利信道仿真
    rayleighchan实现瑞利多径衰落信
    2017电商趋势
    【连载7】二手电商平台的账号与信用体系
    【连载6】二手电商APP的导购功能与关系链机制分析
  • 原文地址:https://www.cnblogs.com/zhaoyunlong/p/9348367.html
Copyright © 2011-2022 走看看