Django-中間件

来源:https://www.cnblogs.com/fengqiang626/archive/2019/10/02/11617682.html
-Advertisement-
Play Games

[TOC] 1.中間件介紹 1.1什麼是中間件？ 官方的說法：中間件是一個用來處理Django的請求和響應的框架級別的鉤子。它是一個輕量、低級別的插件系統，用於在全局範圍內改變Django的輸入和輸出。每個中間件組件都負責做一些特定的功能。 但是由於其影響的是全局，所以需要謹慎使用，使用不當會影響性 ...


目錄

1.中間件介紹

1.1什麼是中間件？

官方的說法：中間件是一個用來處理Django的請求和響應的框架級別的鉤子。它是一個輕量、低級別的插件系統，用於在全局範圍內改變Django的輸入和輸出。每個中間件組件都負責做一些特定的功能。

但是由於其影響的是全局，所以需要謹慎使用，使用不當會影響性能。

說的直白一點中間件是幫助我們在視圖函數執行之前和執行之後都可以做一些額外的操作，它本質上就是一個自定義類，類中定義了幾個方法，Django框架會在處理請求的特定的時間去執行這些方法。

我們一直都在使用中間件，只是沒有註意到而已，打開Django項目的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',
]

MIDDLEWARE配置項是一個列表，列表中是一個個字元串，這些字元串其實是一個個類，也就是一個個中間件。

我們之前已經接觸過一個csrf相關的中間件了？我們一開始讓大家把他註釋掉，再提交post請求的時候，就不會被forbidden了，後來學會使用csrf_token之後就不再註釋這個中間件了。

那接下來就學習中間件中的方法以及這些方法什麼時候被執行。

2.自定義中間件

中間件可以定義五個方法，分別是：（主要的是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對象，則直接將該對象返回給用戶。

2.1自定義一個中間件示例

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

2.2process_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_requestapp01 中的 index視圖

把MD1和MD2的位置調換一下，再訪問一個視圖，會發現終端中列印的內容如下：

MD2裡面的 process_request
MD1裡面的 process_requestapp01 中的 index視圖

看結果我們知道：視圖函數還是最後執行的，MD2比MD1先執行自己的process_request方法。

在列印一下兩個自定義中間件中process_request方法中的request參數，會發現它們是同一個對象。

由此總結一下：

  1. 中間件的process_request方法是在執行視圖函數之前執行的。
  2. 當配置多個中間件時，會按照MIDDLEWARE中的註冊順序，也就是列表的索引值，從前到後依次執行的。
  3. 不同中間件之間傳遞的request都是同一個對象

2.3process_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方法是最先執行。

2.4process_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中的註冊順序從前到後順序執行的

2.5process_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方法直接返回了一個響應對象。

2.6process_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方法。

3.中間件的執行流程

請求到達中間件之後，先按照正序執行每個註冊中間件的process_reques方法，process_request方法返回的值是None，就依次執行，如果返回的值是HttpResponse對象，不再執行後面的process_request方法，而是執行當前對應中間件的process_response方法，將HttpResponse對象返回給瀏覽器。也就是說：如果MIDDLEWARE中註冊了6個中間件，執行過程中，第3個中間件返回了一個HttpResponse對象，那麼第4,5,6中間件的process_request和process_response方法都不執行，順序執行3,2,1中間件的process_response方法。

process_request方法都執行完後，匹配路由，找到要執行的視圖函數，先不執行視圖函數，先執行中間件中的process_view方法，process_view方法返回None，繼續按順序執行，所有process_view方法執行完後執行視圖函數。假如中間件3 的process_view方法返回了HttpResponse對象，則4,5,6的process_view以及視圖函數都不執行，直接從最後一個中間件，也就是中間件6的process_response方法開始倒序執行。

process_template_response和process_exception兩個方法的觸發是有條件的，執行順序也是倒序。總結所有的執行流程如下：

4.中間件版登錄驗證

中間件版的登錄驗證需要依靠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中間的下方

5.附：Django請求流程圖


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • a++與++a，談談C++的參數傳遞
    先看一段代碼： mov eax,dword ptr [a] add eax,1 mov dword ptr [a],eax //這三行指令將a+1 mov ecx,dword ptr [a] mov dword ptr [ebp 0D0h],ecx //這兩行指令將a的值存儲到一個臨時地址（寄存器間 ...
  • STS安裝Drools
    Open Eclipse.- Open the menu "Help", menu item "Install new software..."- Click on the button "Add..." to add a new software site.- Fill in the name " ...
  • Java中的容器（集合）之ArrayList源碼解析
    1、ArrayList源碼解析 源碼解析： 如下源碼來自JDK8:。 （以上所有內容皆為個人筆記，如有錯誤之處還望指正。） ...
  • C語言入門-指針
    終於到了精髓的地方了，這確實有點懵，總感覺這太麻煩了，而且寫著也不爽，還是懷念py或者java，但也沒辦法，還是要繼續學下去。 一、運算符& 1. scanf("%d" , &i); 里的& 2. 獲取變數的地址，它的操作數必須是變數 3. 地址的大小是否與int相同取決於編譯器 &不能取的地址 & ...
  • python解釋器安裝與環境變數調試
    Python解釋器安裝與環境變數調試 Python解釋器安裝(3.6): www.python.org這個是python解釋器的官網，一定要牢記。 鑒於市場上有兩種python版本(2和3)，今天兩種版本都裝一下，互相學習，如有錯誤還請各位評論指正。 ![img](https://img2018.c ...
  • Java中的容器（集合）
    1、Java常用容器：List，Set，Map List： 繼承了Collection介面（public interface List<E> extends Collection<E> ），有序且允許出現重覆值。 Set： 繼承了Collection介面（public interface Set<E ...
  • JAVA面試題 （一）
    java作用域public private protected 不寫 friendly的區別？ public：可以被任何類引用。 protected：除了其他包不能使用，當前類，子孫類，同一包下的所有類都可 以使用。 friendly：不寫時，子孫類和其他包不能使用，當前類，同一包下都可以使用。 p ...
  • 購物車程式
    #!/usr/bin/env python# -*- coding:utf-8 -*-Product_List = [ ('Iphone11',200), ('HUA WEI Mate 30',200), ('Pythoon基礎教程'，80)， （'Coffee',30） ]Buy_List = [ ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類