天天看點
傳回

Django中間件

前戲

在前面的部落格中已經學會了給視圖函數加裝飾器來判斷是使用者是否登入，把沒有登入的使用者請求跳轉到登入頁面。我們通過給幾個特定視圖函數加裝飾器實作了這個需求。但是以後添加的視圖函數可能也需要加上裝飾器，這樣是不是稍微有點繁瑣。

下面的内容即将讓我們通過一些特點的方式實作控制全局的效果，運籌帷幄于室内(室外太熱~~~)

中間件

中間件介紹

什麼是中間件？

官方的說法：中間件是一個用來處理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之後就不再注釋這個中間件了。

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

Django中間件

自定義中間件

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

自定義一個中間件示例

Django中間件
Django中間件

process_request

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

由于request對象是一樣的，是以我們可以對request對象進行一系列的操作，包括request.變量名=變量值,這樣的操作，我們可以在後續的視圖函數中通過相同的方式即可擷取到我們在中間件中設定的值。

它的傳回值可以是None也可以是HttpResponse對象。傳回值是None的話，按正常流程繼續走，交給下一個中間件處理，如果是HttpResponse對象，Django将不執行視圖函數，而将相應對象傳回給浏覽器。

我們來看看多個中間件時，Django是如何執行其中的process_request方法的。

Django中間件
Django中間件
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")
        pass

View Code

在settings.py的MIDDLEWARE配置項中注冊上述兩個自定義中間件：

Django中間件
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',
    'middlewares.MD1',  # 自定義中間件MD1
    'middlewares.MD2'  # 自定義中間件MD2
]

此時，我們通路一個視圖，會發現終端中列印如下内容：

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

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

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

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

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

由此總結一下：

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

process_response

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

定義process_response方法時，必須給方法傳入兩個形參，request和response。request就是上述例子中一樣的對象，response是視圖函數傳回的HttpResponse對象(也就是說這是Django背景處理完之後給出一個的一個具體的視圖)。該方法的傳回值(必須要有傳回值)也必須是HttpResponse對象。如果不傳回response而傳回其他對象，則浏覽器不會拿到Django背景給他的視圖，而是我的中間件中傳回的對象

Django中間件
Django中間件
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")
        pass

    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_view

該方法有四個參數

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方法，最後傳回給浏覽器

給MD1和MD2添加process_view方法:

Django中間件
Django中間件
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")
        pass

    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方法是在Django路由系統之後，視圖系統之前執行的，執行順序按照MIDDLEWARE中的注冊順序從前到後順序執行的

process_exception

該方法兩個參數:

一個HttpRequest對象

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

這個方法隻有在視圖函數中出現異常了才執行，它傳回的值可以是一個None也可以是一個HttpResponse對象。如果是HttpResponse對象，Django将調用模闆和中間件中的process_response方法，并傳回給浏覽器，否則将預設處理異常。如果傳回一個None，則交給下一個中間件的process_exception方法來處理異常。它的執行順序也是按照中間件注冊順序的倒序執行。

 給MD1和MD2添加上這個方法：

Django中間件
Django中間件
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")
        pass

    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方法不執行。

想辦法，在視圖函數中抛出一個異常：

Django中間件
Django中間件
def index(request):
    print("app01 中的 index視圖")
    raise ValueError("呵呵")
    return HttpResponse("O98K")

在MD1的process_exception中傳回一個響應對象：

Django中間件
Django中間件
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方法直接傳回了一個響應對象。

process_template_response（用的比較少）

process_template_response(self, request, response)

它的參數，一個HttpRequest對象，response是TemplateResponse對象（由視圖函數或者中間件産生）。

process_template_response是在視圖函數執行完成後立即執行，但是它有一個前提條件，那就是視圖函數傳回的對象有一個render()方法（或者表明該對象是一個TemplateResponse對象或等價方法）。

Django中間件
Django中間件
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")
        pass

    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中：

Django中間件
Django中間件
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方法。

中間件的執行流程

上一部分，我們了解了中間件中的5個方法，它們的參數、傳回值以及什麼時候執行，現在總結一下中間件的執行流程。

請求到達中間件之後，先按照正序執行每個注冊中間件的process_request方法，process_request方法傳回的值是None，就依次執行，如果傳回的值是HttpResponse對象，不再執行後面的process_request方法，而是執行目前對應中間件的process_response方法(注意不是掉頭執行所有的process_response方法)，将HttpResponse對象傳回給浏覽器。也就是說：如果MIDDLEWARE中注冊了6個中間件，執行過程中，第3個中間件傳回了一個HttpResponse對象，那麼第4,5,6中間件的process_request和process_response方法都不執行，順序執行3,2,1中間件的process_response方法。

Django中間件

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

Django中間件

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

Django中間件
Django中間件

中間件版登入驗證 

中間件版的登入驗證需要依靠session，是以資料庫中要有django_session表。

urls.py

Django中間件
Django中間件
from app02 import views as v2
urlpatterns = [
    url(r'^admin/', admin.site.urls),
    url(r'^login/',v2.login),
    url(r'^home/',v2.home),
    url(r'^index/',v2.index)
]

views.py

Django中間件
Django中間件
from django.shortcuts import render,redirect,HttpResponse
from app02 import models
# Create your views here.
def login(request):
    error_msg=''
    if request.method=='POST':
        username=request.POST.get('username')
        password=request.POST.get('password')
        user_obj=models.User.objects.filter(username=username,password=password)
        if  user_obj:
            #設定session
            request.session['login']='ok'
            #擷取使用者想直接通路的URL
            url=request.GET.get('next')
            #如果有，就跳轉到客戶初始想通路的URL
            if not url:
                #沒有則預設跳轉到home頁面
                url='/home/'
            return redirect(url)
        else:
            error_msg='username or password error!'
    return render(request,'login.html',{'error_msg':error_msg})

def home(request):
    return HttpResponse('<h1>這是home頁面 隻有登入了才能看到</h1>')

def index(request):
    return HttpResponse('<h1>這是index頁面 也隻有登入了才能看到<h1>')

login.html

Django中間件
Django中間件
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>登陸頁面</title>
    <meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body>
<form action="" method="post">
    {% csrf_token %}
    <label for="">username:<input type="text" name="username"></label>
    <label for="">password:<input type="password" name="password"></label>
    <input type="submit" value="submit">
</form>
<h1 style="color: red">{{ error_msg }}</h1>

</body>
</html>

middlewares.py

Django中間件
Django中間件
from django.utils.deprecation import MiddlewareMixin
from django.shortcuts import redirect

class Check_Login(MiddlewareMixin):
    def process_request(self,request):
        next_url=request.path_info
        if not next_url.startswith('/login/'):
            is_login=request.session.get('login','')
            if not is_login:
                return redirect('/login/?next={}'.format(next_url))

在settings.py中注冊

Django中間件
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',
    'middleware.my_middleware.Check_Login',

]

附：Django請求流程圖

Django中間件
上一篇: 前端基礎之JavaScript
下一篇: Task.Result, Task.Wait(), Task.WaitAll(), Task.WaitAny()都會抛出AggregateException異常（連結）