Django：中间件

　　中间件是介于request和response处理之间的一道处理过程，相对比较轻量级，并且在全局上改变django的输入与输出，因为改变的是全局，所以需要谨慎使用，用不好会影响性能。

　　如果想修改请求，例如被传送到view中的HttpRequest对象，或者想修改view返回的HttpResponse对象，这些都可以通过中间件来实现。如果还想在view执行之前做一些操作，也可以通过middleware来实现。

　　中间件就是帮助我们在视图函数执行之前和执行之后都可以做一些额外的操作，它本质上就是一个自定义类，类中定义了几个方法，Django框架会在请求的特定的时间去执行这些方法。Django项目的Settings.py文件中，MIDDLEWARE 列表就是用来配置中间件的，它包含了django默认的中间件，MIDDLEWARE中是一个个的字符串，这些字符串其实是一个个类，即各个中间件。当把其中一行字符串注释掉，那么相应的中间件就会失效。

自定义中,间件

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

process_request(self,request)
process_view(self,request,view_func,views_args,view_kwargs)
process_template_response(self,request,response)
process_exception(self,request,response)
process_response(self,request,response)

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

当用户发起请求的时候会一次经过所有的中间件，这个时候的请求先到process_request，最后到达views的函数中，views函数处理后，再依次穿过中间件，这个时候是process_response，最后返回给请求者

自定义中间件一般在项目下创建一个目录，名字一般叫utils，表示一个公用的组件，创建一个py文件，名字随便起。

 1 #自定义中间件需要在 settings.py文件中的 MIDDLEWARE列表中进行配置
 2 
 3 from django.utils.deprecation import MiddlewareMixin
 4 class MD1(MiddlewareMixin):
 5     # 自定义中间件，不是必须要有下面这两个方法，有request方法说明请求来的会在这里先处理，再继续往后走。有response方法说明响应出去时，会在这里做一次处理。如果自定义中间件没有写process_response方法，那么会一层一层向上找，哪个中间件有process_response方法就将返回对象给哪个中间件
 6     def process_request(self,request):
 7         print('MD1---process_request')
 8     def process_response(self,request,response):
 9         print('MD1---process_response')
10         return response

process_request

process_request有一个参数，就是request，这个request和视图函数中的request是一样的。它的返回值可以是None也可以是HttpResponse对象。返回值是None就按正常流程走，交给下一个中间件处理。如果是HttpResponse对象，Django将不执行views函数，而是将相应的对象返回给浏览器

 1 #在项目下创建目录utils，用来存放中间件。在utils下创建 mymiddleware.py
 2 from django.utils.deprecation import MiddlewareMixin
 3 
 4 class MD1(MiddlewareMixin):    # 自定义中间件必须要继承 MiddlewareMixin
 5     def process_request(self,request):
 6         print('MD1---REQUEST')
 7 
 8 
 9 class MD2(MiddlewareMixin):
10     def process_request(self,request):
11         print('MD2----request')
12 
13 # 在项目settings.py中配置中间件
14 MIDDLEWARE = [
15     'django.middleware.security.SecurityMiddleware',
16     'django.contrib.sessions.middleware.SessionMiddleware',
17     'django.middleware.common.CommonMiddleware',
18     'django.middleware.csrf.CsrfViewMiddleware',
19     'django.contrib.auth.middleware.AuthenticationMiddleware',
20     'django.contrib.messages.middleware.MessageMiddleware',
21     'django.middleware.clickjacking.XFrameOptionsMiddleware',
22     'utils.mymiddleware.MD1',    # 需要加上路径utils
23     'utils.mymiddleware.MD2',
24 ]
25 
26 # 中间件的执行顺序就是按照列表 MIDDLEWARE的索引顺序 来执行的。同时中间件的process_request方法是在视图函数之前执行的。不同的中间件之间传递的request都是同一个对象
27 # 所以这里就会先输出 MD1---REQUEST  ，再输出 'MD2----request。如果将两个中间件在MIDDLEWARE中的顺序换一下那么执行顺序也会对调

process_response

process_response有两个参数，一个是request，一个是response。request就是上述例子中的对象，response是视图函数返回的httpresponse对象，改方法的返回值也必须是httpresponse对象

 1 from django.utils.deprecation import MiddlewareMixin
 2 from django.shortcuts import HttpResponse
 3 class MD1(MiddlewareMixin):
 4     def process_request(self,request):
 5         print('MD1---REQUEST')
 6 
 7     def process_response(self,request,resopnse):    # request和response两个参数必须有，名字随便
 8         print('MD1>>>>RESONSE')
 9         return resopnse # 必须有返回值，写return response，这个response就像是一个接力棒一样，传递给下一个中间件的process_response方法
10 
11 
12 class MD2(MiddlewareMixin):
13     def process_request(self,request):
14         print('MD2----request')
15 
16     def process_response(self,request,response):
17         print('MD2>>>>RESPONSE')
18         print(type(response))   # 是一个HttpResponse对象<class 'django.http.response.HttpResponse'>
19         print(response.content) # 查看响应体的内容，就是views视图函数返回给浏览器的内容对象，打印出来就是字符串
20         return response     # 根据MIDDLEWARE中的索引顺序，这个process_response会先执行，必须返回response,不然后面执行的process_response方法就拿不到HttpResponse对象，会报错
21         # return HttpResponse('MD2d httpresponse') # 如果这么写那么视图函数返回给浏览器的对象就会被替换成这个。
22         
23         
24 # views.py
25 from django.shortcuts import render,HttpResponse,redirect
26 
27 def home(request):
28     return render(request,'home.html')
29 
30 #访问一个视图的打印结果
31 MD1---REQUEST
32 MD2----request
33 MD2>>>>RESPONSE
34 <class 'django.http.response.HttpResponse'>
35 b'<!DOCTYPE html>\n<html lang="en">\n<head>\n    <meta charset="UTF-8">\n    <title>Title</title>\n</head>\n<body>\n<h1> this is home page </h1>\n<a href=""></a>\n</body>\n</html>'
36 MD1>>>>RESONSE

process_response方法是在视图函数之后执行的，并且顺序是MD2比MD1先执行。（settings.py中MD1比MD2先注册）。多个中间件的process_response方法是按照MIDDLEWARE中的注册顺序倒序执行的

 1 # 再一种情况
 2 from django.utils.deprecation import MiddlewareMixin
 3 from django.shortcuts import HttpResponse
 4 class MD1(MiddlewareMixin):
 5     def process_request(self,request):
 6         print('MD1---REQUEST')
 7         return HttpResponse('返回request---')    # 在process_request中不写返回值，默认也是返回None，如果自己写一个return None效果也是一样，不会中断请求，如果return HttpResponse的话，那么就会在这个方法中中断你请求，直接将这个对象返回给浏览器，views函数就不会执行了，直接执行这个类里面的 process_response方法
 8 
 9     def process_response(self,request,response):
10         print('MD1>>>>RESONSE')
11         print(response.content)
12         return response
13     
14     
15 class MD2(MiddlewareMixin):
16     def process_request(self,request):
17         print('MD2----request')
18 
19     def process_response(self,request,response):
20         print('MD2>>>>RESPONSE')
21     
22 # 访问一个视图的返回结果
23 MD1---REQUEST
24 MD1>>>>RESONSE
25 b'\xe8\xbf\x94\xe5\x9b\x9erequest---'

中间件cookie登录认证

 1 # mymiddleware.py
 2 
 3 from django.utils.deprecation import MiddlewareMixin
 4 from django.shortcuts import redirect,HttpResponse
 5 from django.conf import settings
 6 class MD1(MiddlewareMixin):
 7     white_urls = ['/app01/','/app01/login/']
 8     def process_request(self,request):
 9         if request.path in self.white_urls:
10             return None
11         else:
12             if request.COOKIES.get('username') == 'jackma':
13                 return None
14             else:
15                 return redirect('login')
16         print(request.path)
17         
18     def process_response(self,request,response): 
19         print('MD1>>>>RESONSE')
20         return response
21     
22     
23 # views.py
24 from django.shortcuts import render,HttpResponse,redirect
25 from django import forms
26 
27 def home(request):
28     return render(request,'home.html')
29 
30 def login(request):
31     if request.method == 'GET':
32         return render(request,'login.html')
33     elif request.method == 'POST':
34         name = request.POST.get('username')
35         pwd = request.POST.get('password')
36         if name == 'jackma' and pwd == '213':
37             ret = HttpResponse('login successfully')
38             ret.set_cookie('username',name)
39             return ret
40 
41 def user(request):
42     return render(request,'userinfo.html')

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并返回结果。

 1 from django.utils.deprecation import MiddlewareMixin
 2 
 3 class MD1(MiddlewareMixin):
 4     def process_request(self,request):
 5         print(request.path)
 6 
 7     def process_response(self,request,response):
 8         print('MD1>>>>RESONSE')
 9         return response
10 
11     def process_view(self,request,view_func,view_args,view_kwargs):
12         print(view_func,view_func.__name__) # 就是url映射到的那个视图函数，也就是说每个中间件的这个process_view已经提前拿到了要执行的那个视图函数
13         # ret = view_func(request) # 提前执行视图函数，如果视图函数有参数的话可以这么写view_func(request,view_args,view_kwargs)
14         # return ret  #直接在MD1中间件的process_view给返回了，就不会到views.py中去执行视图函数了
15         print('MD1 中的process_view')
16 
17 class MD2(MiddlewareMixin):
18     def process_request(self,request):
19         print('MD2----request')
20 
21     def process_response(self,request,response):
22         print('MD2>>>>RESPONSE')
23         return response
24 
25     def process_view(self,request,view_func,view_args,view_kwargs):
26         print('MD2 中的process_view')
27         
28 # 执行结果
29 /app01/
30 MD2----request
31 <function home at 0x000000000402BD90> home
32 MD1 中的process_view
33 MD2 中的process_view
34 MD2>>>>RESPONSE
35 MD1>>>>RESONSE
36 
37 # 　　process_view方法是在process_request之后，reprocess_response之前，视图函数之前执行的，执行顺序按照MIDDLEWARE中的注册顺序从前到后顺序执行的

process_exception

process_exception(self, request, exception)

该方法两个参数:

一个HttpRequest对象

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

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

 1 # views.py 主动抛异常
 2 def home(request):
 3     raise ValueError('xxxxxxxxxxxxxxx')    # 中间件的process_exception会接受到这个异常，并作出响应
 4     return render(request,'home.html')    # 有异常就不会再返回这个对象了，而是在浏览器页面中显示异常
 5 
 6 
 7 # 中间件 mymiddleware.py
 8 from django.utils.deprecation import MiddlewareMixin
 9 from django.shortcuts import HttpResponse
10 class MD1(MiddlewareMixin):
11     def process_request(self,request):
12         print(request.path)
13 
14     def process_response(self,request,response):
15         print('MD1>>>>RESONSE')
16         return response
17 
18     def process_view(self,request,view_func,view_args,view_kwargs):
19         print('MD1 中的process_view')
20 
21     def process_exception(self,request,exception):    # 只有当视图函数有异常时，才会执行此函数
22         print(exception)    # exception接受的就是视图函数抛出的异常
23         print('MD1 zhongd exception')
24         return HttpResponse(str(exception))    # 当视图函数有异常时，可以在这里返回一个HttpResponse对象，这里会在浏览器页面上显示 xxxxxxxxxxxxxxx
25 
26 
27 class MD2(MiddlewareMixin):
28     def process_request(self,request):
29         print('MD2----request')
30 
31     def process_response(self,request,response):
32         print('MD2>>>>RESPONSE')
33         return response
34 
35     def process_view(self,request,view_func,view_args,view_kwargs):
36         print('MD2 中的process_view')

process_template_response

process_template_response(self, request, response)

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

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

视图函数执行完之后，立即执行了中间件的process_template_response方法，顺序是倒序，先执行MD2的，在执行MD1的，接着执行了视图函数返回的HttpResponse对象的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方法开始倒序执行。

参考博文：https://www.cnblogs.com/clschao/articles/10480419.html#part_3

posted @ 2020-08-17 16:00 muchen 阅读(94) 评论(0) 编辑收藏举报

刷新页面返回顶部

muchen