django 中間件 [TOC] 自定義中間件 中間件可以定義五個方法,分別是:(主要的是process_request和process_response) process_request(self,request) process_view(self, request, view_func, vi ...
目錄
django 中間件
自定義中間件
中間件可以定義五個方法,分別是:(主要的是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)
- 以上方法的返回值可以是None或一個HttpResponse對象,如果是None,則繼續按照django定義的規則向後繼續執行,
如果是HttpResponse對象,則直接將該對象返回給用戶。 - 中間件是處理django的請求和響應的框架級別的鉤子,本質上就是一個類。
- 註意他們的4個特征: 執行時間、執行順序、參數、返回值
自定義一個中間件示例
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
process_request有一個參數,就是request,這個request和視圖函數中的request是一樣的。
它的返回值可以是None也可以是HttpResponse對象。返回值是None的話,按正常流程繼續走,交給下一個中間件處理,
如果是HttpResponse對象,Django將不執行視圖函數,而將響應對象返回給瀏覽器。
- 我們來看看多個中間件時,Django是如何執行其中的process_request方法的。
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")
- 在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
]
- 此時,我們訪問一個視圖,會發現終端中列印如下內容:
MD1裡面的 process_request
MD2裡面的 process_request
app01 中的 index視圖
- 把MD1和MD2的位置調換一下,再訪問一個視圖,會發現終端中列印的內容如下:
MD2裡面的 process_request
MD1裡面的 process_request
app01 中的 index視圖
"""
看結果我們知道:視圖函數還是最後執行的,MD2比MD1先執行自己的process_request方法。
在列印一下兩個自定義中間件中process_request方法中的request參數,會發現它們是同一個對象。
由此總結一下:
1. 中間件的process_request方法是在執行視圖函數之前執行的。
2. 當配置多個中間件時,會按照MIDDLEWARE中的註冊順序,也就是列表的索引值,從前到後依次執行的。
3. 不同中間件之間傳遞的request都是同一個對象
"""
### process_request(self,request)
執行時間:視圖函數之前
參數:request —— 》 和視圖函數中是同一個request對象
執行順序:按照註冊的順序 順序執行
返回值:
None : 正常流程
HttpResponse: 後面的中間的process_request、視圖函數都不執行,直接執行當前中間件中的process_response方法,
倒敘執行之前的中間中process_response方法。
process_response
它有兩個參數,一個是request,一個是response,request就是上述例子中一樣的對象,response是視圖函數返回的HttpResponse對象。
該方法的返回值也必須是HttpResponse對象。
- 給上述的M1和M2加上process_response方法:
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
class MD2(MiddlewareMixin):
def process_request(self, request):
print("MD2裡面的 process_request")
def process_response(self, request, response):
print("MD2裡面的 process_response")
return response
- 訪問一個視圖,看一下終端的輸出:
MD2裡面的 process_request
MD1裡面的 process_request
app01 中的 index視圖
MD1裡面的 process_response
MD2裡面的 process_response
"""
看結果可知:
process_response方法是在視圖函數之後執行的,並且順序是MD1比MD2先執行。(此時settings.py中 MD2比MD1先註冊)
多個中間件中的process_response方法是按照MIDDLEWARE中的註冊順序**倒序**執行的,
也就是說第一個中間件的process_request方法首先執行,而它的process_response方法最後執行,
最後一個中間件的process_request方法最後一個執行,它的process_response方法是最先執行。
"""
#### process_response(self, request, response)
執行時間:視圖函數之後
參數:
request —— 》 和視圖函數中是同一個request對象
response ——》 返回給瀏覽器響應對象
執行順序:按照註冊的順序 倒敘執行
返回值:
HttpResponse:必須返回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並返回結果。
- 給MD1和MD2添加process_view方法:
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("-" * 80)
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, request, view_func, view_args, view_kwargs):
print("-" * 80)
print("MD2 中的process_view")
print(view_func, view_func.__name__)
- 訪問index視圖函數,看一下輸出結果:
MD2裡面的 process_request
MD1裡面的 process_request
--------------------------------------------------------------------------------
MD2 中的process_view
<function index at 0x000001DE68317488> index
--------------------------------------------------------------------------------
MD1 中的process_view
<function index at 0x000001DE68317488> index
app01 中的 index視圖
MD1裡面的 process_response
MD2裡面的 process_response
"""
process_view方法是在process_request之後,視圖函數之前執行的,執行順序按照MIDDLEWARE中的註冊順序 從前到後順 序執行的
"""
#### process_view(self, request, view_func, view_args, view_kwargs)
執行時間:視圖函數之前,process_request之後
參數:
request —— 》 和視圖函數中是同一個request對象
view_func ——》 視圖函數
view_args ——》 視圖函數的位置參數
view_kwargs ——》 視圖函數的關鍵字參數
執行順序:按照註冊的順序 順序執行
返回值:
None : 正常流程
HttpResponse: 後面的中間的process_view、視圖函數都不執行,直接執行最後一個中間件中的process_response方法,
倒敘執行之前的中間中process_response方法。
process_exception
process_exception(self, request, exception)
該方法兩個參數:
一個HttpRequest對象
一個exception是視圖函數異常產生的Exception對象。
這個方法只有在視圖函數中出現異常了才執行,它返回的值可以是一個None也可以是一個HttpResponse對象。
如果是HttpResponse對象,Django將調用模板和中間件中的process_response方法,並返回給瀏覽器,否則將預設處理異常。
如果返回一個None,則交給下一個中間件的process_exception方法來處理異常。它的執行順序也是按照中間件註冊順序的倒序執行。
- 給MD1和MD2添加上這個方法:
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("-" * 80)
print("MD1 中的process_view")
print(view_func, view_func.__name__)
def process_exception(self, request, exception):
print(exception)
print("MD1 中的process_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, request, view_func, view_args, view_kwargs):
print("-" * 80)
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("app01 中的 index視圖")
raise ValueError("呵呵")
return HttpResponse("O98K")
- 在MD1的process_exception中返回一個響應對象:
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("-" * 80)
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)) # 返回一個響應對象
- 看輸出結果:
MD2裡面的 process_request
MD1裡面的 process_request
--------------------------------------------------------------------------------
MD2 中的process_view
<function index at 0x0000022C09727488> index
--------------------------------------------------------------------------------
MD1 中的process_view
<function index at 0x0000022C09727488> index
app01 中的 index視圖
呵呵
MD1 中的process_exception
MD1裡面的 process_response
MD2裡面的 process_response
#註意,這裡並沒有執行MD2的process_exception方法,因為MD1中的process_exception方法直接返回了一個響應對象。
#### process_exception(self, request, exception)
執行時間(觸發條件):視圖層面有錯時才執行
參數:
request —— 》 和視圖函數中是同一個request對象
exception ——》 錯誤對象
執行順序:按照註冊的順序 倒敘執行
返回值:
None : 交給下一個中間件取處理異常,都沒有處理交由django處理異常
HttpResponse: 後面的中間的process_exception不執行,直接執行最後一個中間件中的process_response方法,
倒敘執行之前的中間中process_response方法。
process_template_response(用的比較少)
process_template_response(self, request, response)
它的參數,一個HttpRequest對象,response是TemplateResponse對象(由視圖函數或者中間件產生)。
process_template_response是在視圖函數執行完成後立即執行,但是它有一個前提條件,
那就是視圖函數返回的對象有一個render()方法(或者表明該對象是一個TemplateResponse對象或等價方法)。
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("-" * 80)
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")
def process_response(self, request, response):
print("MD2裡面的 process_response")
return response
def process_view(self, request, view_func, view_args, view_kwargs):
print("-" * 80)
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
views.py中:
def index(request):
print("app01 中的 index視圖")
def render():
print("in index/render")
return HttpResponse("O98K")
rep = HttpResponse("OK")
rep.render = render
return rep
- 訪問index視圖,終端輸出的結果:
MD2裡面的 process_request
MD1裡面的 process_request
--------------------------------------------------------------------------------
MD2 中的process_view
<function index at 0x000001C111B97488> index
--------------------------------------------------------------------------------
MD1 中的process_view
<function index at 0x000001C111B97488> index
app01 中的 index視圖
MD1 中的process_template_response
MD2 中的process_template_response
in index/render
MD1裡面的 process_response
MD2裡面的 process_response
"""
從結果看出:
視圖函數執行完之後,立即執行了中間件的process_template_response方法,順序是倒序,先執行MD1的,
在執行MD2的,接著執行了視圖函數返回的HttpResponse對象的render方法,返回了一個新的HttpResponse對象,
接著執行中間件的process_response方法。
"""
#### process_template_response(self,request,response)
執行時間(觸發條件):視圖返回的是一個templateResponse對象
參數:
request —— 》 和視圖函數中是同一個request對象
response ——》 templateResponse對象
執行順序:按照註冊的順序 倒敘執行
返回值:
HttpResponse:必須返回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中間的下方。