快捷導(dǎo)航

Django中間件Middleware功能詳解

更新時(shí)間：2024年10月06日 09:58:39 作者：向上的車(chē)輪

Django中間件（Middleware）是Django框架中的一個(gè)功能,它允許開(kāi)發(fā)者在處理請(qǐng)求和響應(yīng)的過(guò)程中插入自定義代碼,中間件能夠在視圖函數(shù)執(zhí)行前后進(jìn)行操作,本文給大家介紹Django中間件Middleware功能,感興趣的朋友一起看看吧

Django中間件（Middleware）是一段在Django的請(qǐng)求/響應(yīng)處理過(guò)程中，可以介入并改變請(qǐng)求或響應(yīng)的代碼。中間件是Django框架中一個(gè)非常強(qiáng)大的功能，它允許你在Django的視圖函數(shù)之前或之后執(zhí)行自定義代碼。

中間件可以用于：

執(zhí)行一些請(qǐng)求預(yù)處理。
對(duì)請(qǐng)求執(zhí)行一些檢查，比如用戶認(rèn)證。
修改請(qǐng)求對(duì)象。
修改響應(yīng)對(duì)象。
記錄請(qǐng)求和響應(yīng)的日志。

Django中間件的工作原理是，中間件以一個(gè)有序列表的形式存在，Django會(huì)按照這個(gè)列表的順序調(diào)用中間件。

創(chuàng)建中間件

要?jiǎng)?chuàng)建一個(gè)中間件，你需要定義一個(gè)Python類，該類包含若干個(gè)特定的方法。最常用的方法有：

__init__：初始化方法，中間件實(shí)例化時(shí)調(diào)用。
__call__：每個(gè)請(qǐng)求都會(huì)調(diào)用這個(gè)方法，可以在這里編寫(xiě)處理請(qǐng)求的代碼。
process_view：在視圖函數(shù)調(diào)用之前調(diào)用。
process_exception：當(dāng)視圖函數(shù)拋出異常時(shí)調(diào)用。
process_template_response：在模板響應(yīng)對(duì)象生成后調(diào)用。

示例

下面是一個(gè)簡(jiǎn)單的中間件示例，它會(huì)在每個(gè)請(qǐng)求的響應(yīng)中添加一個(gè)自定義的HTTP頭部：

class SimpleMiddleware:
    def __init__(self, get_response):
        self.get_response = get_response
    def __call__(self, request):
        # 在視圖函數(shù)之前執(zhí)行的代碼
        response = self.get_response(request)
        # 在視圖函數(shù)之后執(zhí)行的代碼
        response['X-Custom-Header'] = 'Custom Value'
        return response

使用中間件

要使用中間件，你需要將它添加到你的Django項(xiàng)目的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',
    'myapp.middleware.SimpleMiddleware',  # 添加你的中間件
    ...
]

確保中間件的順序符合你的業(yè)務(wù)邏輯需求。

注意事項(xiàng)

中間件的執(zhí)行順序很重要，因?yàn)樗鼤?huì)影響請(qǐng)求和響應(yīng)的處理流程。
要謹(jǐn)慎使用中間件，因?yàn)椴磺‘?dāng)?shù)氖褂每赡軙?huì)導(dǎo)致安全問(wèn)題或性能問(wèn)題。
某些中間件可能會(huì)修改請(qǐng)求或響應(yīng)對(duì)象，這可能會(huì)影響其他中間件或視圖函數(shù)的行為。

通過(guò)中間件，你可以為Django應(yīng)用添加強(qiáng)大的功能和靈活性。

過(guò)濾請(qǐng)求

在Django中，中間件可以用來(lái)過(guò)濾請(qǐng)求和記錄日志。這通常涉及到兩個(gè)方面：請(qǐng)求處理和響應(yīng)處理。下面我將介紹如何使用中間件來(lái)實(shí)現(xiàn)這兩個(gè)功能。

過(guò)濾請(qǐng)求+記錄日志

過(guò)濾請(qǐng)求通常是指在請(qǐng)求到達(dá)視圖函數(shù)之前，根據(jù)某些條件決定是否允許請(qǐng)求繼續(xù)進(jìn)行。例如，你可能想要實(shí)現(xiàn)一個(gè)簡(jiǎn)單的訪問(wèn)控制，只允許來(lái)自特定IP地址的請(qǐng)求通過(guò)。

下面是一個(gè)簡(jiǎn)單的中間件示例，它檢查請(qǐng)求的來(lái)源IP地址，并拒絕非授權(quán)的IP：

class IPFilterMiddleware:
    def __init__(self, get_response):
        self.get_response = get_response
    def __call__(self, request):
        # 定義允許的IP地址列表
        allowed_ips = ['192.168.1.1', '127.0.0.1']
        # 獲取請(qǐng)求的IP地址
        x_forwarded_for = request.META.get('HTTP_X_FORWARDED_FOR')
        if x_forwarded_for:
            ip = x_forwarded_for.split(',')[0]
        else:
            ip = request.META.get('REMOTE_ADDR')
        # 檢查IP是否在允許的列表中
        if ip not in allowed_ips:
            # 如果不在允許的列表中，返回403禁止訪問(wèn)
            from django.http import HttpResponseForbidden
            return HttpResponseForbidden("You are not allowed to access this site.")
        # 繼續(xù)處理請(qǐng)求
        response = self.get_response(request)
        return response

記錄日志

記錄日志是中間件的另一個(gè)常見(jiàn)用途。你可以記錄請(qǐng)求的詳細(xì)信息，比如請(qǐng)求的URL、方法、IP地址等，這對(duì)于調(diào)試和監(jiān)控應(yīng)用非常有用。

下面是一個(gè)簡(jiǎn)單的日志記錄中間件示例：

import datetime
class LoggingMiddleware:
    def __init__(self, get_response):
        self.get_response = get_response
    def __call__(self, request):
        # 請(qǐng)求到達(dá)的時(shí)間
        start_time = datetime.datetime.now()
        # 處理請(qǐng)求
        response = self.get_response(request)
        # 請(qǐng)求結(jié)束的時(shí)間
        end_time = datetime.datetime.now()
        # 記錄日志
        logger = logging.getLogger(__name__)
        logger.info(
            f'Status Code: {response.status_code} '
            f'| Method: {request.method} '
            f'| Path: {request.path} '
            f'| Time: {(end_time - start_time).total_seconds()}s'
        )
        return response

配置中間件

要使用這些中間件，你需要將它們添加到你的Django項(xiàng)目的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',
    'myapp.middleware.IPFilterMiddleware',  # 添加IP過(guò)濾中間件
    'myapp.middleware.LoggingMiddleware',  # 添加日志記錄中間件
    ...
]

確保中間件的順序符合你的業(yè)務(wù)邏輯需求。