Django 中間件

一 什麼是中間件

中間件顧名思義,是介於request與response處理之間的一道處理過程,相對比較輕量級,而且在全局上改變django的輸入與輸出。由於改變的是全局,因此須要謹慎實用,用很差會影響到性能html

Django中有7個默認的中間件,Django中的7大中間件就像Django的門衛同樣,每次請求來都須要通過7大中間件,若是這7大中間件若是有限制的話就走不進你的Django的程序,在Django中也能夠自定義中間件,自定義中間件通常的應用場景在,控制用戶訪問頻率,全局登錄校驗,用戶訪問白名單,黑名單,反爬等。python

二 中間件有什麼用

若是你想修改請求,例如被傳送到view中的HttpRequest對象。 或者你想修改view返回的HttpResponse對象,這些均可以經過中間件來實現。jquery

可能你還想在view執行以前作一些操做,這種狀況就能夠用 middleware來實現。ajax

Django默認的中間件:(在django項目的settings模塊中,有一個 MIDDLEWARE_CLASSES 變量,其中每個元素就是一箇中間件,以下)django

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

三 自定義中間件

想要自定義中間件須要分下面幾步驟:json

第一在app下面創建文件夾以及文件瀏覽器

第二步導入模塊:服務器

from django.utils.deprecation import MiddlewareMixin

第三步核心代碼cookie

class MyMid(MiddlewareMixin):
    def process_request(self, request):
        print('我是MyMid中間件process_request')
        # 這裏就是寫中間件的一些邏輯代碼

第四在settings中MIDDLEWARE下添加你的中間件路徑以下示例:session

'app01.mymiddleware.mymid.MyMid' #  這裏只是個人路徑

自定義中間件分爲五種:

第一種是:process_request(與請求相關)

process_request有一個參數,就是request,這個request和視圖函數中的request是同樣的(在交給Django後面的路由以前,對這個request對象能夠進行一系列的操做)。

因爲request對象是同樣的,因此咱們能夠對request對象進行一系列的操做,包括request.變量名=變量值,這樣的操做,咱們能夠在後續的視圖函數中經過相同的方式便可獲取到咱們在中間件中設置的值。

它的返回值能夠是None也能夠是HttpResponse對象。返回值是None的話,按正常流程繼續走,交給下一個中間件處理,若是是HttpResponse對象,Django將不執行視圖函數,而將相應對象返回給瀏覽器。

第二種是:process_response(與響應相關)
第三種:process_template_response(self,request,response)

第四種:process_exception(self, request, exception)

 第五種:process_response(self, request, response)

process_request和process_response

當用戶發起請求的時候會依次通過全部的的中間件,這個時候的請求時process_request,最後到達views的函數中,views函數處理後,在依次穿過中間件,這個時候是process_response,最後返回給請求者。

1560868264316

上述截圖中的中間件都是django中的,咱們也能夠本身定義一箇中間件,咱們能夠本身寫一個類,可是必須繼承MiddlewareMixin

第一步:導入

from django.utils.deprecation ``import MiddlewareMixin

from django.utils.deprecation import MiddlewareMixin
from django.shortcuts import HttpResponse

class Md1(MiddlewareMixin):

    def process_request(self,request):
        print("Md1請求")
 
    def process_response(self,request,response):
        print("Md1返回")
        return response

class Md2(MiddlewareMixin):

    def process_request(self,request):
        print("Md2請求")
        #return HttpResponse("Md2中斷")
    def process_response(self,request,response):
        print("Md2返回")
        return response

第三步:在view中定義一個視圖函數(index)

def index(request):

    print("view函數...")
    return HttpResponse("OK")

第四步:在settings.py的MIDDLEWARE裏註冊本身定義的中間件

1560868456241

結果:

Md1請求
Md2請求
view函數...
Md2返回
Md1返回

注意:若是當請求到達請求2的時候直接不符合條件返回,即return HttpResponse("Md2中斷"),程序將把請求直接發給中間件2返回,而後依次返回到請求者,結果以下:

返回Md2中斷的頁面,後臺打印以下:

Md1請求
Md2請求
Md2返回
Md1返回

1560868504158

由此總結一下:

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

多箇中間件中的process_response方法是按照MIDDLEWARE中的註冊順序倒序執行的,也就是說第一個中間件的process_request方法首先執行,而它的process_response方法最後執行,最後一箇中間件的process_request方法最後一個執行,它的process_response方法是最早執行。

process_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並返回結果。

process_view(self, request, callback, callback_args, callback_kwargs)
from django.utils.deprecation import MiddlewareMixin
from django.shortcuts import HttpResponse

class Md1(MiddlewareMixin):

    def process_request(self,request):
        print("Md1請求")
        #return HttpResponse("Md1中斷")
    def process_response(self,request,response):
        print("Md1返回")
        return response

    def process_view(self, request, callback, callback_args, callback_kwargs):
        print("Md1view")

class Md2(MiddlewareMixin):

    def process_request(self,request):
        print("Md2請求")
        return HttpResponse("Md2中斷")
    def process_response(self,request,response):
        print("Md2返回")
        return response

    def process_view(self, request, callback, callback_args, callback_kwargs):
        print("Md2view")
Md1請求
Md2請求
Md1view
Md2view
view函數...
Md2返回
Md1返回

1560868597663

當最後一箇中間的process_request到達路由關係映射以後,返回到中間件1的process_view,而後依次往下,到達views函數,最後經過process_response依次返回到達用戶。

process_view能夠用來調用視圖函數:

class Md1(MiddlewareMixin):

    def process_request(self,request):
        print("Md1請求")
        #return HttpResponse("Md1中斷")
    def process_response(self,request,response):
        print("Md1返回")
        return response

    def process_view(self, request, callback, callback_args, callback_kwargs):

        # return HttpResponse("hello")

        response=callback(request,*callback_args,**callback_kwargs)
        return response
Md1請求
Md2請求
view函數...
Md2返回
Md1返回

注意:process_view若是有返回值,會越過其餘的process_view以及視圖函數,可是全部的process_response都還會執行。

process_exception

process_exception(self, request, exception)

該方法兩個參數:

一個HttpRequest對象

一個exception是視圖函數異常產生的Exception對象。

這個方法只有在視圖函數中出現異常了才執行,它返回的值能夠是一個None也能夠是一個HttpResponse對象。若是是HttpResponse對象,Django將調用模板和中間件中的process_response方法,並返回給瀏覽器,不然將默認處理異常。若是返回一個None,則交給下一個中間件的process_exception方法來處理異常。它的執行順序也是按照中間件註冊順序的倒序執行。

process_exception(self, request, exception)

class Md1(MiddlewareMixin):

def process_request(self,request):
    print("Md1請求")
    #return HttpResponse("Md1中斷")
def process_response(self,request,response):
    print("Md1返回")
    return response

def process_view(self, request, callback, callback_args, callback_kwargs):

    # return HttpResponse("hello")

    # response=callback(request,*callback_args,**callback_kwargs)
    # return response
    print("md1 process_view...")

def process_exception(self,request,exception):
    print("md1 process_exception...")

class Md2(MiddlewareMixin):

def process_request(self,request):
    print("Md2請求")
    # return HttpResponse("Md2中斷")
def process_response(self,request,response):
    print("Md2返回")
    return response
def process_view(self, request, callback, callback_args, callback_kwargs):
    print("md2 process_view...")

def process_exception(self,request,exception):
    print("md1 process_exception...")

結果以下:

Md1請求
Md2請求
md1 process_view...
md2 process_view...
view函數...

Md2返回
Md1返回

流程圖以下:

當views出現錯誤時:

1560868683109

將md2的process_exception修改以下:

def process_exception(self,request,exception):

        print("md2 process_exception...")
        return HttpResponse("error")

結果以下:

Md1請求
Md2請求
md1 process_view...
md2 process_view...
view函數...
md2 process_exception...
Md2返回
Md1返回

process_template_response(self,request,response)

該方法對視圖函數返回值有要求,必須是一個含有render方法類的對象,纔會執行此方法

class Test:
    def __init__(self,status,msg):
        self.status=status
        self.msg=msg
    def render(self):
        import json
        dic={'status':self.status,'msg':self.msg}

        return HttpResponse(json.dumps(dic))
def index(response):
    return Test(True,'測試')

四 中間件應用場景

一、作IP訪問頻率限制

某些IP訪問服務器的頻率太高,進行攔截,好比限制每分鐘不能超過20次。

二、URL訪問過濾

若是用戶訪問的是login視圖(放過)

若是訪問其餘視圖,須要檢測是否是有session認證,已經有了放行,沒有返回login,這樣就免得在多個視圖函數上寫裝飾器了!

做爲延伸擴展內容,有餘力的同窗能夠嘗試着讀一下如下兩個自帶的中間件:

'django.contrib.sessions.middleware.SessionMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',

回到目錄

五 CSRF_TOKEN跨站請求僞造

在form表單中應用:

<form action="" method="post">
    {% csrf_token %}
    <p>用戶名:<input type="text" name="name"></p>
    <p>密碼:<input type="text" name="password"></p>
    <p><input type="submit"></p>
</form>

在Ajax中應用:

放在data裏:

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <script src="/static/jquery-3.3.1.js"></script>
    <title>Title</title>
</head>
<body>
<form action="" method="post">
    {% csrf_token %}
    <p>用戶名:<input type="text" name="name"></p>
    <p>密碼:<input type="text" name="password" id="pwd"></p>
    <p><input type="submit"></p>
</form>
<button class="btn">點我</button>
</body>
<script>
    $(".btn").click(function () {
        $.ajax({
            url: '',
            type: 'post',
            data: {
                'name': $('[name="name"]').val(),
                'password': $("#pwd").val(),
                'csrfmiddlewaretoken': $('[name="csrfmiddlewaretoken"]').val()
            },
            success: function (data) {
                console.log(data)
            }

        })
    })
</script>
</html>

放在cookie裏:

獲取cookie:document.cookie

是一個字符串,能夠本身用js切割,也能夠用jquery的插件

獲取cookie:$.cookie('csrftoken')

設置cookie:$.cookie('key','value')

放在cookie裏

其它操做

全站禁用:註釋掉中間件 'django.middleware.csrf.CsrfViewMiddleware',

局部禁用:用裝飾器(在FBV中使用)

from django.views.decorators.csrf import csrf_exempt,csrf_protect
# 再也不檢測,局部禁用(前提是全站使用)
# @csrf_exempt
# 檢測,局部使用(前提是全站禁用)
# @csrf_protect
def csrf_token(request):
    if request.method=='POST':
        print(request.POST)

        return HttpResponse('ok')
    return render(request,'csrf_token.html')

在CBV中使用:

# CBV中使用
from django.views import View
from django.views.decorators.csrf import csrf_exempt,csrf_protect
from django.utils.decorators import method_decorator
# CBV的csrf裝飾器,只能加載類上(指定方法爲dispatch)和dispatch方法上(django的bug)
# 給get方法使用csrf_token檢測
@method_decorator(csrf_exempt,name='dispatch')class Foo(View):
    def get(self,request):
        pass
    def post(self,request):
        pass
相關文章
相關標籤/搜索