django基础之中间件

django基础之中间件

一.简单介绍

介于请求和响应之间的一道处理程序,相对比较轻量级,并在全局上改变django的输入与输出

如果想对请求和响应进行统一处理,不用一个个去加,只用在中间键完成处理逻辑,所有的请求与响应都会走这个逻辑

 

 

Django项目的Settings.py文件，看到下面的MIDDLEWARE配置项，django默认自带的一些中间件：
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配置项是一个列表，列表中是一个个字符串，这些字符串其实是一个个类，也就是一个个中间件。

 

应用案例
1、做IP访问频率限制
某些IP访问服务器的频率过高，进行拦截，比如限制每分钟不能超过20次。
2、URL访问过滤
如果用户访问的是login视图（放过）
如果访问其他视图，需要检测是不是有session认证，已经有了放行，没有返回login，这样就无需在多个视图函数上写装饰器
 

二.自定义中间件

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

 

  • process_request(self,request)

  • process_response(self, request, response)

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

  • process_template_response(self,request,response)

  • process_exception(self, request, exception)

     

 

request和response使用过程中的注意事项:

  1. return HttpResponse('ok') #在request中return操作之后,后面的其他类中的request就不会执行,会直接执行自己的response函数返回.

2.return  HttpResponse('你的响应有异常!')
    #一般情况下走完request,就会走url和视图函数,
    # 但是如果有response函数内有 'return字符串内容',那么url和views视图函数就不会走了
3.#白名单,对指定的内容放行
url=[reverse('login'),]   #白名单
if request.path in url:pass   #判断,如果反向获得的地址为列表url的内容,就放行
else:
    cookie_obj=request.session.get('is_login')
                      #否则就获取sessionid,无则跳会login页面,有则获取页面内容
    if cookie_obj !=True:
        return  redirect('login')
4.# print(response.__dict__.get('_container')[0].decode('utf-8'))   #通过此方法可以获取响应页面的内容





以上方法的返回值可以是None或一个HttpResponse对象，如果是None，则继续按照django定义的规则向后继续执行；如果是HttpResponse对象，则直接将该对象返回给用户。
　　当用户发起请求时会依次经过所有的的中间件，这个时候的请求是process_request，最后到达views的函数中，views函数处理后，再依次穿过中间件，这个时候是process_response，最后返回给请求者。
 
自定义中间件示例：
在项目中创建一个包，随便起名字，一般都放在一个叫做utils的包里面，表示一个公用的组件，创建一个py文件，随便起名字，例如叫做：middlewares.py，内容如下
from django.utils.deprecation import MiddlewareMixin
 
class MD1(MiddlewareMixin):
    # 自定义中间件，不是必须要有下面两个方法，有request方法说明请求来了要处理，
    # 有response方法说明响应出去时需要处理，如果没写process_response方法，
    # 那就一层层往上找，哪个中间件有process_response方法就将返回对象给哪个中间件
    def process_request(self, request):
        print("MD1里面的 process_request")
 
    def process_response(self, request, response):
        print("MD1里面的 process_response")
        return response

 

 
2.1 process_request
process_request有一个参数，就是request，这个request和视图函数中的request是一样的。
它的返回值可以是None也可以是HttpResponse对象。返回值是None的话，按正常流程继续走，交给下一个中间件处理，如果是HttpResponse对象，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',
    'utils.middlewares.MD1',
    'utils.middlewares.MD2'
]

 

middlewares.py
from django.utils.deprecation import MiddlewareMixin
 
class MD1(MiddlewareMixin):
    def process_request(self, request):
        print("MD1里面的 process_request")
 
class MD2(MiddlewareMixin):
    def process_request(self, request):
        print("MD2里面的 process_request")
访问一个视图后，终端打印
MD1里面的 process_request
MD2里面的 process_request
views中的index

 

总结：
  • 中间件的process_request方法是在执行视图函数之前执行的。
  • 当配置多个中间件时，会按照MIDDLEWARE中的注册顺序，从前到后依次执行。
  • 不同中间件之间传递的request都是同一个对象
 
 
2.2 process_response
它有两个参数，一个是request，一个是response，request就是上述例子中一样的对象，response是视图函数返回的HttpResponse对象。该方法的返回值也必须是HttpResponse对象。
from django.utils.deprecation import MiddlewareMixin
 
class MD1(MiddlewareMixin):
    def process_request(self, request):
        print("MD1里面的 process_request")
        # 不必须写return值
 
    def process_response(self, request, response):
    # request和response两个参数必须有，名字随便取
        print("MD1里面的 process_response")
        return response  # 必须有返回值，写return response，这个response就像
                         # 接力棒一样一层一层往上层的中间件传递
        # return HttpResponse('1') # 如果写了这个，那么视图返回内容就被它替代
 
 
class MD2(MiddlewareMixin):
    def process_request(self, request):
        print("MD2里面的 process_request")
 
    def process_response(self, request, response):
    # request和response两个参数必须要有，名字随便取
        print("MD2里面的 process_response")
        return response  # 上层的中间件拿不到httpresponse对象报错

 

访问视图后终端输出
MD1里面的 process_request
MD2里面的 process_request
views中的index
MD2里面的 process_response
MD1里面的 process_response
 
多个中间件中的process_response方法是按照MIDDLEWARE中的注册顺序倒序执行的，也就是说第一个中间件的process_request方法首先执行，而它的process_response方法最后执行，最后一个中间件的process_request方法最后一个执行，它的process_response方法是最先执行。
 
注意：如果当请求到达请求2的时候直接不符合条件返回，即return HttpResponse("MD2中断")，程序将把请求直接发给中间件2返回，然后依次返回到请求者，结果如下：
返回Md2中断的页面，后台打印如下：
MD1里面的 process_request
MD2里面的 process_request
MD2里面的 process_response
MD1里面的 process_response
页面显示：
MD2中断
流程图如下：
2.3 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):
        print("MD1里面的 process_request")
 
    def process_response(self, request, response):
        print("MD1里面的 process_response")
        return response
 
    def process_view(self, request, view_func, view_args, view_kwargs):
        print("MD1 中的process_view")
        print(view_func, view_func.__name__)
        # view_func就是url映射的那个视图函数，也就是每个中间件的process_view
        # 已经提前拿到了要执行的那个视图函数
        # ret = view_func(request) #提前执行视图函数，如果视图函数有参数的话，
                      # 写成ret = view_func(request,view_args,view_kwargs)
        # return ret  # 直接就在MD1中间件这个类的process_response给返回了，
                      # 不会去执行视图函数里面的这个函数了。
 
class MD2(MiddlewareMixin):
    def process_request(self, request):
        print("MD2里面的 process_request")
        pass
 
    def process_response(self, request, response):
        print("MD2里面的 process_response")
        return response
 
    def process_view(self, request, view_func, view_args, view_kwargs):
        print("MD2 中的process_view")
        print(view_func, view_func.__name__)

 

输出结果：
MD1里面的 process_request
MD2里面的 process_request
MD1 中的process_view
<function index at 0x0000001532407AE8> index
MD2 中的process_view
<function index at 0x0000001532407AE8> index
views中的index
MD2里面的 process_response
MD1里面的 process_response
 
 
2.4 process_exception
process_exception(self, request, exception)
该方法两个参数:
  • 一个HttpRequest对象
  • 一个exception是视图函数异常产生的Exception对象。
这个方法只有在视图函数中出现异常了才执行，它返回的值可以是一个None也可以是一个HttpResponse对象。如果是HttpResponse对象，Django将调用模板和中间件中的process_response方法，并返回给浏览器，否则将默认处理异常。如果返回一个None，则交给下一个中间件的process_exception方法来处理异常。它的执行顺序也是按照中间件注册顺序的倒序执行。
 
from django.utils.deprecation import MiddlewareMixin
from django.shortcuts import HttpResponse
 
class MD1(MiddlewareMixin):
    def process_request(self, request):
        print("MD1里面的 process_request")
 
    def process_response(self, request, response):
        print("MD1里面的 process_response")
        return response
 
    def process_view(self, request, view_func, view_args, view_kwargs):
        print("MD1 中的process_view")
        print(view_func, view_func.__name__)
 
    def process_exception(self, request, exception):
        print(exception)
        print("MD1 中的process_exception")
        return HttpResponse(str(exception))  # 返回一个响应对象
 
 
class MD2(MiddlewareMixin):
    def process_request(self, request):
        print("MD2里面的 process_request")
        pass
    def process_response(self, request, response):
        print("MD2里面的 process_response")
        return response
 
    def process_view(self, request, view_func, view_args, view_kwargs):
        print("MD2 中的process_view")
        print(view_func, view_func.__name__)
 
    def process_exception(self, request, exception):
        print(exception)
        print("MD2 中的process_exception")

 

 
如果视图函数中无异常，process_exception方法不执行。在视图函数中主动抛出一个异常：
def index(request):
    print('views中的index')
    raise ValueError('error')
    return render(request,'index.html')
输出结果为：
MD1里面的 process_request
MD2里面的 process_request
MD1 中的process_view
<function index at 0x0000009BE68D7AE8> index
MD2 中的process_view
<function index at 0x0000009BE68D7AE8> index
views中的index
error
MD2 中的process_exception
error
MD1 中的process_exception
MD2里面的 process_response
MD1里面的 process_response
2.5 process_template_response（用的比较少）
process_template_response(self, request, response)
参数：HttpRequest对象，response是TemplateResponse对象（由视图函数或中间件产生）
process_template_response是在视图函数执行完成后立即执行，但是它有一个前提条件，那就是视图函数返回的对象有一个render()方法（或者表明该对象是一个TemplateResponse对象或等价方法）。
views.py
def index(request):
    print("views中的index")
    def render():
        print("in index/render")
        # raise ValueError('出错啦') 
        # render函数中报错，会先执行process_template_response方法，
        # 然后执行process_exception方法，如果是render方法外报错，
        # 那么就不会执行这个process_template_response方法。
        return HttpResponse("返回") # 返回的将是这个新的对象
    rep = HttpResponse("OK")
    rep.render = render
    return rep
 
from django.utils.deprecation import MiddlewareMixin
from django.shortcuts import HttpResponse
 
class MD1(MiddlewareMixin):
    def process_request(self, request):
        print("MD1里面的 process_request")
 
    def process_response(self, request, response):
        print("MD1里面的 process_response")
        return response
 
    def process_view(self, request, view_func, view_args, view_kwargs):
        print("MD1 中的process_view")
        print(view_func, view_func.__name__)
 
    def process_exception(self, request, exception):
        print(exception)
        print("MD1 中的process_exception")
        return HttpResponse(str(exception))
 
    def process_template_response(self, request, response):
        print("MD1 中的process_template_response")
        return response
 
 
class MD2(MiddlewareMixin):
    def process_request(self, request):
        print("MD2里面的 process_request")
        pass
 
    def process_response(self, request, response):
        print("MD2里面的 process_response")
        return response
 
    def process_view(self, request, view_func, view_args, view_kwargs):
        print("MD2 中的process_view")
        print(view_func, view_func.__name__)
 
    def process_exception(self, request, exception):
        print(exception)
        print("MD2 中的process_exception")
 
    def process_template_response(self, request, response):
        print("MD2 中的process_template_response")
        return response

 

输出结果：
MD1里面的 process_request
MD2里面的 process_request
MD1 中的process_view
<function index at 0x000000AC4ADA7AE8> index
MD2 中的process_view
<function index at 0x000000AC4ADA7AE8> index
views中的index
MD2 中的process_template_response
MD1 中的process_template_response
in index/render
MD2里面的 process_response
MD1里面的 process_response
视图函数执行完之后，立即执行了中间件的process_template_response方法，顺序是倒序，先执行MD2的，在执行MD1的，接着执行了视图函数返回的HttpResponse对象的render方法，返回了一个新的HttpResponse对象，接着执行中间件的process_response方法。页面显示“返回”
 
3. 中间件执行流程
请求到达中间件之后，先按照正序执行每个注册中间件的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两个方法的触发是有条件的，执行顺序也是倒序。总结所有的执行流程如下：
 
 
4. 中间件版登录认证
中间件版的登录验证需要依靠session，所以数据库中要有django_session表。
views.py
def index(request):
    return render(request, 'index.html')
 
 
def login(request):
    if request.method == 'POST':
        user = request.POST.get("user")
        pwd = request.POST.get("pwd")
        if user == '1' and pwd == '1':
            request.session['is_login'] = True
            request.session['user'] = user
 
            return redirect('index')
        else:
            return redirect('login')
    return render(request, 'login.html')


login.html
<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>
 
 
middlewares.py
from django.utils.deprecation import MiddlewareMixin
from django.urls import reverse
from django.shortcuts import redirect
 
class Auth(MiddlewareMixin):
    def process_request(self, request):
        white_list = [reverse('login')] # 白名单
        if request.path in white_list:
            pass
        else:
            is_login = request.session.get('is_login')
            if is_login != True:
                return redirect('login')

 

 
AuthMD中间件注册后，所有的请求都要走AuthMD的process_request方法。访问的URL在白名单内（或者session中有user用户名），则不做阻拦走正常流程；（如果URL在黑名单中，则返回This is an illegal URL的字符串）；正常的URL但是需要登录后访问，让浏览器跳转到登录页面。
 
5. Django流程图

 

 

 

posted @ 2019-08-14 20:25  socoolonly1  阅读(101)  评论(0)  编辑  收藏  举报