Django中間件

django的中間件可以在視圖函數執行前執行，比如登陸驗證、日志記錄等，下面簡單說明一下中間件的基礎用法，主要為筆者學習時的筆記

1. 在django項目文件夾下創建一個用于存放中間件函數的文件夾

文件夾的名字可自定義，本文使用utils作為文件夾名

2. 在utils文件夾中創建中間件py文件

如用于登陸驗證的中間件loginCheck.py

from django.http import HttpResponseRedirect
from django.utils.deprecation import MiddlewareMixin

class UserLoginCheck(MiddlewareMixin):
    '''
    登錄驗證中間件
    '''
    def process_request(self, request):
        # 用戶request請求前
        path = ['/login/', '/logout/'] # 不需要進行登錄檢測的url
        if request.path in path:
            return

        userinfoSession = request.session.get('userinfo')
        if not userinfoSession:
            return HttpResponseRedirect('/login/')
        return

3. 配置使用中間件

在setting.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.loginCheck.UserLoginCheck', # 此處為自定義的中間件
]

擴展

中間件可定義的五種方法
Request預處理函數: process_request(self, request)

• 這個方法的調用時機在Django接收到request之后，但仍未解析URL以確定應當運行的視圖函數。Django向它傳入相應的Request對象，以便在方法中修改。
• 如果返回None，Django將繼續處理這個request，執行后續的中間件， 然后調用相應的 view。
• 如果返回HttpResponse對象，Django將不再執行任何除了process_response以外其它的中間件以及相應的view，Django將立即返回該HttpResponse。

View預處理函數: process_view(self, request, callback, callback_args,callback_kwargs)

• 這個方法的調用時機在 Django 執行完 request 預處理函數并確定待執行的 view （即callback參數）之后，但在 view 函數實際執行之前。
• request：HttpRequest 對象。
• callback：Django將調用的處理request的python函數. 這是實際的函數對象本身, 而不是字符串表述的函數名。
• args：將傳入view的位置參數列表，但不包括request參數(它通常是傳入view的第一個參數)。
• kwargs：將傳入view的關鍵字參數字典。
• process_view() 應當返回None或 HttpResponse 對象。如果返回 None， Django將繼續處理這個request ，執行后續的中間件， 然后調用相應的view。
• 如果返回 HttpResponse 對象，Django 將不再執行任何其它的中間件(不論種類)以及相應的view，Django將立即返回。

Template模版渲染函數：process_template_response()

• 默認不執行，只有在視圖函數的返回結果對象中有render方法才會執行，并把對象的render方法的返回值返回給用戶（注意不返回視圖函數的return的結果了，而是返回視圖函數 return值（對象）中rende方法的結果）

Exception后處理函數:process_exception(self, request, exception)

• 這個方法只有在 request 處理過程中出了問題并且view 函數拋出了一個未捕獲的異常時才會被調用。這個鉤子可以用來發送錯誤通知，將現場相關信息輸出到日志文件，或者甚至嘗試從錯誤中自動恢復。
• 這個函數的參數除了一貫的request對象之外，還包括view函數拋出的實際的異常對象exception 。
• process_exception() 應當返回None或HttpResponse對象。
• 如果返回None，Django將用框架內置的異常處理機制繼續處理相應request。
• 如果返回HttpResponse對象，Django將使用該response對象，而短路框架內置的異常處理機制。

Response后處理函數:process_response(self, request, response)

• 這個方法的調用時機在 Django 執行 view 函數并生成 response 之后。
• 該處理器能修改response 的內容；一個常見的用途是內容壓縮，如gzip所請求的HTML頁面。
• 這個方法的參數相當直觀：request是request對象，而response則是從view中返回的response對象。
• process_response() 必須返回 HttpResponse 對象. 這個 response 對象可以是傳入函數的那一個原始對象（通常已被修改），也可以是全新生成的。

參考資料：https://baijiahao.baidu.com/s?id=1622776730103957680