Django自定義中間件實(shí)現(xiàn)全鏈路操作日志記錄

更新時(shí)間：2025年07月01日 10:19:46 作者：小王子1024

在 Django 中,中間件（Middleware）是一組輕量級(jí)、底層的插件系統(tǒng),用于全局地改變 Django 的輸入和輸出,本文給大家介紹Django自定義中間件實(shí)現(xiàn)全鏈路操作日志記錄,感興趣的朋友跟隨小編一起看看吧

一、中間件

介紹

在 Django 中，中間件（Middleware）是一組輕量級(jí)、底層的插件系統(tǒng)，用于全局地改變 Django 的輸入和輸出。中間件可以在請(qǐng)求被處理之前和響應(yīng)返回之前執(zhí)行代碼，從而實(shí)現(xiàn)各種功能，例如跨域資源共享（CORS）、用戶(hù)認(rèn)證、日志記錄等。

激活中間件

若要激活中間件，需要添加到settings.MIDDLEWARE中

每個(gè)中間件組件由字符串表示：指向中間件工廠類(lèi)的完整 Python 路徑。
需求注意中間件的添加順序。因?yàn)橹虚g件有執(zhí)行順序，而且中間件之間可能有依賴(lài)關(guān)系。
中間件的全局執(zhí)行順序
- 請(qǐng)求階段：按settings.MIDDLEWARE中從上到下的順序執(zhí)行。
- 視圖處理：請(qǐng)求到達(dá)視圖函數(shù)。
- 響應(yīng)階段：按settings.MIDDLEWARE中從下到上的順序執(zhí)行。

MIDDLEWARE = [
    "corsheaders.middleware.CorsMiddleware",  # CORS跨域支持
    "django.middleware.security.SecurityMiddleware",
    "django.contrib.sessions.middleware.SessionMiddleware",
    "django.middleware.locale.LocaleMiddleware",  # I18N多語(yǔ)言支持，注意放置順序
    "django.middleware.common.CommonMiddleware",
    "django.middleware.csrf.CsrfViewMiddleware",
    "django.contrib.auth.middleware.AuthenticationMiddleware",
    "django.contrib.messages.middleware.MessageMiddleware",
    "django.middleware.clickjacking.XFrameOptionsMiddleware",
    # "myapp_system.operate_log.services.OperateLogMiddleware",  # 操作日志開(kāi)關(guān)：如果數(shù)據(jù)庫(kù)磁盤(pán)IO性能一般，建議關(guān)閉
]

生命周期

中間件生命周期

請(qǐng)求階段：process_request(request)：在視圖函數(shù)被調(diào)用之前執(zhí)行，用于處理請(qǐng)求。如果返回 HttpResponse 對(duì)象，則后續(xù)的中間件和視圖不會(huì)被調(diào)用，直接返回響應(yīng)。
視圖階段：process_view(request, view_func, view_args, view_kwargs)：在視圖函數(shù)被調(diào)用之前執(zhí)行，可以用于根據(jù)視圖函數(shù)的參數(shù)或請(qǐng)求信息進(jìn)行額外處理。
響應(yīng)階段：process_response(request, response)：在視圖函數(shù)返回響應(yīng)后執(zhí)行，用于處理響應(yīng)對(duì)象，可以修改響應(yīng)內(nèi)容或響應(yīng)頭。
異常階段：process_exception(request, exception)：當(dāng)視圖函數(shù)拋出異常時(shí)執(zhí)行，用于處理異常并返回一個(gè) HttpResponse 對(duì)象。

內(nèi)置中間件示例

django.contrib.auth.middleware.AuthenticationMiddleware：Django內(nèi)置的認(rèn)證中間件，實(shí)現(xiàn)將 user 屬性添加到每個(gè)傳入的 HttpRequest 對(duì)象中，表示當(dāng)前已登錄的用戶(hù)

class AuthenticationMiddleware(MiddlewareMixin):
    def process_request(self, request):
        if not hasattr(request, "session"):
            raise ImproperlyConfigured(
                "The Django authentication middleware requires session "
                "middleware to be installed. Edit your MIDDLEWARE setting to "
                "insert "
                "'django.contrib.sessions.middleware.SessionMiddleware' before "
                "'django.contrib.auth.middleware.AuthenticationMiddleware'."
            )
        request.user = SimpleLazyObject(lambda: get_user(request))

二、自定義中間件

中間件鉤子函數(shù)

process_view()中間件鉤子函數(shù)

語(yǔ)法：process_view(request, view_func, view_args, view_kwargs)
調(diào)用順序：process_view() 只在 Django 調(diào)用視圖前被調(diào)用。
返回
- 如果它返回 None ，Django 將繼續(xù)處理這個(gè)請(qǐng)求，執(zhí)行任何其他的 process_view() ，然后執(zhí)行相應(yīng)的視圖。
- 如果它返回 HttpResponse 對(duì)象，Django 不會(huì)去影響調(diào)用相應(yīng)的視圖；它會(huì)將響應(yīng)中間件應(yīng)用到 HttpResponse 并返回結(jié)果。

基于類(lèi)的中間件

基于類(lèi)的自定義中間件格式

語(yǔ)句response = self.get_response(request)，將__call__()方法中的代碼分為兩部分

class SimpleMiddleware:
    def __init__(self, get_response):
        # 執(zhí)行一次性配置和初始化工作
        self.get_response = get_response
    def __call__(self, request):
        # 每個(gè)請(qǐng)求調(diào)用一次，在視圖函數(shù)被調(diào)用之前執(zhí)行
        response = self.get_response(request)
        # 每個(gè)請(qǐng)求調(diào)用一次，在視圖函數(shù)被調(diào)用之后執(zhí)行
        return response