天天看點
傳回

Django中間件

中間件是面向切面程式設計的好例子，它是一個可以介入Django的request和response處理過程的鈎子架構，一個輕量級、底層的“插件”系統，用于在全局修改Django的輸入或輸出。

要使用中間件，首先要在settings中設定：

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',
]

上述是Django項目的預設設定，每一項字元串都代表一個中間件。中間件就像洋蔥一樣，每個中間件都是一個層，在使用者請求階段，調用定義的view函數之前，請求以自上而下的順序通過所有的層，view函數處理之後，響應以自下而上的順序通過所有的層，期間經過的每個中間件都會對請求或者響應進行處理。

自定義中間件

要自定義中間件，寫一個類即可：

class SimpleMiddleware(object):
    def __init__(self, get_response):
        self.get_response = get_response
        # One-time configuration and initialization.

    def __call__(self, request):
        # Code to be executed for each request before
        # the view (and later middleware) are called.

        response = self.get_response(request)

        # Code to be executed for each request/response after
        # the view is called.

        return response

__init__初始化方法隻在web服務啟動時調用一次，get_response參數是必需的，這個參數指的是下一個中間件或者view函數(如果是最後一個中間件)。

每個請求都會調用一次__call__，先對請求做處理，然後将請求發往下一個中間件(get_response)，一層層的疊代，就像棧一樣，傳回時對響應做處理。

如果其中一個層的中間件決定短路并傳回響應而不調用其get_response，那麼該層下面的層都不會看到請求或響應，隻有該中間件和之上的中間件才會看到響應。

短路可以起到一些ip過濾之類的效果：

class IpFilterMiddleware(object):
    def __init__(self, get_response):
        self.get_response = get_response
        # One-time configuration and initialization.

    def __call__(self, request):
        if request.META.has_key('HTTP_X_FORWARDED_FOR'):
            ip = request.META['HTTP_X_FORWARDED_FOR']
        else:  
            ip = request.META['REMOTE_ADDR']
        if ip == '127.0.0.1':
            return HttpResponse('You are forbidden')
        response = self.get_response(request)
        return response

設定：

MIDDLEWARE = [
    'path.to.IpFilterMiddleware',

上述中間件把當地通路攔截了，實際應用中可以為ip建立黑名單，然後檢查通路ip是否在黑名單中。

我們也可以将中間件标記為未使用，隻要在__init__中引發一個django.core.exceptions.MiddlewareNotUsed異常即可。

其它的中間件鈎子

除了前面描述的基本請求/響應中間件模式，您還可以向基于類的中間件添加三種其他特殊方法：

process_view(request, view_func, view_args, view_kwargs)

在調用view之前被調用。

它應該傳回一個None 或一個HttpResponse對象。 如果傳回None，Django 将會繼續處理這個請求，執行其它的process_view() 中間件，然後調用對應的視圖。 如果它傳回一個HttpResponse對象，也會起到短路作用。

process_exception(request, exception)

當一個view引發異常時，Django會調用process_exception()來處理。傳回一個None或一個HttpResponse對象。如果傳回HttpResponse對象，會将響應交給處理響應的中間件處理。由于處理響應時是從下到上的，此層以上的process_exception()是不會被調用的。

process_template_response(request, response)

response參數應該是一個由view或者中間件傳回的TemplateResponse對像（或等價的對象）。

如果響應的執行個體有render()方法，process_template_response()會在view剛好執行完畢之後被調用。這個方法必須傳回一個實作了render方法的響應對象。 

開發階段通常将DEBUG打開以調試錯誤，部署時會關閉DEBUG以免使用者看到錯誤資訊。我們可以寫一個異常中間件，讓有權限的管理者可以在DEBUG關閉的情況下看到錯誤資訊，這樣就避免了切換的麻煩；

import sys

from django.views.debug import technical_500_response

class ExceptionMiddleware(object):
    def __init__(self, get_response):
        self.get_response = get_response
        # One-time configuration and initialization.

    def __call__(self, request):
        response = self.get_response(request)
        return response

    def process_exception(self, request, exception):
        if request.user.is_admin:
            return technical_500_response(request, *sys.exc_info())

置于中間件的最底層，這樣管理者可以看到使用者無法看到的錯誤詳細資訊。

關于異常處理

Django會自動将視圖或中間件引發的異常轉換為具有錯誤狀态代碼的适當HTTP響應，這種轉換發生在每個中間件之前和之後，我們是無需使用try捕捉異常的。

與舊版本中間件的相容

在Django 1.10版本之前，中間件設定名為MIDDLEWARE_CLASSES，是長這樣的：

class SessionMiddleware(object):
    def __init__(self):
        engine = import_module(settings.SESSION_ENGINE)
        self.SessionStore = engine.SessionStore

    def process_request(self, request):
        session_key = request.COOKIES.get(settings.SESSION_COOKIE_NAME)
        request.session = self.SessionStore(session_key)

    def process_response(self, request, response):
        ...

Django提供django.utils.deprecation.MiddlewareMixin以簡化與MIDDLEWARE和舊的MIDDLEWARE_CLASSES相容的中間件類。 Django中包含的所有中間件類都相容這兩種設定。

class MiddlewareMixin(object):
    def __init__(self, get_response=None):
        self.get_response = get_response
        super(MiddlewareMixin, self).__init__()

    def __call__(self, request):
        response = None
        if hasattr(self, 'process_request'):
            response = self.process_request(request)
        if not response:
            response = self.get_response(request)
        if hasattr(self, 'process_response'):
            response = self.process_response(request, response)
        return response

新版繼承自MiddlewareMixin的SessionMiddleware：

class SessionMiddleware(MiddlewareMixin):
    def __init__(self, get_response=None):
        self.get_response = get_response
        engine = import_module(settings.SESSION_ENGINE)
        self.SessionStore = engine.SessionStore

    def process_request(self, request):
        session_key = request.COOKIES.get(settings.SESSION_COOKIE_NAME)
        request.session = self.SessionStore(session_key)

    def process_response(self, request, response):
        ...

混合類提供一個__init__()方法，它接受一個可選的get_response參數，并将其存儲在self.get_response中。

__call__()方法：

  • 調用self.process_request(request)（已定義的話）。
  • 調用self.get_response(request)擷取後續中間件或者視圖的響應。
  • 調用self.process_response（request， response）（已定義的話）。
  • 傳回響應。

在大多數情況下，繼承這種混合類足以使舊式中間件與新系統相容，具有足夠的向後相容性。

上述的異常中間件也可以寫為：

from django.utils.deprecation import MiddlewareMixin

class ExceptionMiddleware(MiddlewareMixin):
    def process_exception(self, request, exception):
        if request.user.is_admin:
            return technical_500_response(request, *sys.exc_info())

使用MIDDLEWARE和MIDDLEWARE_CLASSES之間的行為差​​異：

  • 在MIDDLEWARE_CLASSES下，即使上層中間件的process_request方法短路，下層的中間件也會調用它的process_response方法。 在MIDDLEWARE下， 如果中間件發生短路，則隻有中間件和之上的中間件才會看到響應。
  • 在MIDDLEWARE_CLASSES下，process_exception适用于從中間件process_request方法引發的異常。 在MIDDLEWARE下，process_exception僅适用于view或者TemplateResponse的render方法引發的異常 。 從中間件引發的異常轉換為适當的HTTP響應，然後傳遞給下一個中間件。
  • 在MIDDLEWARE_CLASSES下，如果process_response方法引發異常，則會跳過所有較早中間件的process_response方法然後傳回500錯誤，而在MIDDLEWARE下，從中間件引發的異常将立即轉換為适當的HTTP響應，然後下一個中間件将會看到該響應。 由于中間件引發異常，中間件不會被跳過。

處理流式響應

StreamingHttpResponse并沒有content屬性，使用時必須加以判斷：

if response.streaming:
    response.streaming_content = wrap_streaming_content(response.streaming_content)
else:
    response.content = alter_content(response.content)

用生成器處理過大的内容：

def wrap_streaming_content(content):
    for chunk in content:
        yield alter_content(chunk)

　　

上一篇: 設計包含min函數的棧
下一篇: 微服務架構 | 3.3 Apache Zookeeper 注冊中心