1. 程式人生 > 其它 >django中介軟體Middleware

django中介軟體Middleware

熟悉web開發的同學對hook鉤子肯定不陌生,通過鉤子可以方便的實現一些觸發和回撥,並且做一些過濾和攔截。

django中的中介軟體(middleware)就是類似鉤子的一種存在。下面我們來介紹一下,並且給出一些例項。

1、Middleware的工作流程

我盜了一個圖,看網上很多人用這個圖,來源已經追不明白了。簡單宣告一下,這個圖不是我的。看著圖我們分析一下:

1)django的請求相應流程:HttpRequest -> RequestMiddleware -> view function -> ResponseMiddleware -> HttpResponse

可以看到一個請求到響應的過程,中間夾著兩個middleware流程,請求中介軟體和響應中介軟體。

也就是說,django提供了一種機制,在:

(1)請求到達檢視函式中間

(2)檢視函式到響應之間

支援嵌入鉤子。

這種鉤子的特點:

(1)全域性,一旦你使用了中介軟體,並且釋出生效的話,所有的請求都會經過你嵌入的中介軟體。

(2)效能敏感,如果你的中介軟體效能差的話,那麼會影響服務的整體效能。

2) django的middleware包含四個鉤子函式:process_request/process_view/process_response/process_exception

process_request:接受request之後確定所執行的view之前

process_view:確定了所要執行的view之後,view真正執行之前

process_response:view執行之後  

process_exceptionview:view執行丟擲異常

而插入middleware的過程是在settings.py中配置,如下預設配置,我只截取了兩個中介軟體:SessionMiddleware和CommonMiddleware。

MIDDLEWARE_CLASSES = (
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
   
    ...       
)

我們簡單看一下SessionMiddleware的實現

import time
from importlib import import_module

from django.conf import settings
from django.utils.cache import patch_vary_headers
from django.utils.http import cookie_date


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, None)
        request.session = self.SessionStore(session_key)

    def process_response(self, request, response):
        """
        If request.session was modified, or if the configuration is to save the
        session every time, save the changes and set a session cookie or delete
        the session cookie if the session has been emptied.
        """
        try:
            accessed = request.session.accessed
            modified = request.session.modified
            empty = request.session.is_empty()
        except AttributeError:
            pass
        else:
            # First check if we need to delete this cookie.
            # The session should be deleted only if the session is entirely empty
            if settings.SESSION_COOKIE_NAME in request.COOKIES and empty:
                response.delete_cookie(settings.SESSION_COOKIE_NAME)
            else:
                if accessed:
                    patch_vary_headers(response, ('Cookie',))
                if modified or settings.SESSION_SAVE_EVERY_REQUEST:
                    if request.session.get_expire_at_browser_close():
                        max_age = None
                        expires = None
                    else:
                        max_age = request.session.get_expiry_age()
                        expires_time = time.time() + max_age
                        expires = cookie_date(expires_time)
                    # Save the session data and refresh the client cookie.
                    # Skip session save for 500 responses, refs #3881.
                    if response.status_code != 500:
                        request.session.save()
                        response.set_cookie(settings.SESSION_COOKIE_NAME,
                                request.session.session_key, max_age=max_age,
                                expires=expires, domain=settings.SESSION_COOKIE_DOMAIN,
                                path=settings.SESSION_COOKIE_PATH,
                                secure=settings.SESSION_COOKIE_SECURE or None,
                                httponly=settings.SESSION_COOKIE_HTTPONLY or None)
        return response

可以看到在SessionMiddleware中預設只實現了process_request和process_response兩個hook函式。

我們就以這個例子說明一下一個請求的執行過程。我們假設場景是這樣的:

1)從上而下配置了兩個Middleware(注意順序):SessionMiddleware和CommonMiddleware

2)每個Middleware中的四個鉤子函式齊全process_request/process_view/process_response/process_exception

執行順序應該是這樣的:

1、HttpRequest

2、SessionMiddleware process_request

3、SessionMiddleware process_view

4、CommonMiddleware process_request

5、CommonMiddleware process_view

6、view

7、CommonMiddleware process_response

8、CommonMiddleware process_exception(如有必要)

9、SessionMiddleware process_response

10、SessionMiddleware process_exception(如有必要)

11、HttpResponse

2、Middleware的寫法

Middleware的寫法很簡單:

1)實現一個類,繼承object就行;

2)重寫其中的四個鉤子函式就可以了。

這裡要著重說一個常用的功能。

攔截器/過濾器(filter)

一般來說,每一個請求都要經過process_request這個鉤子函式。你的實現中,函式的執行結果必然有兩種(你要自己做異常處理):

1)None

2)HttpResponse 物件

如果返回None,請求流程繼續執行,也就是繼續進入其他的Middleware或者鉤子函式。

如果返回HttpResponse物件,那麼就直接返回到頁面。通過這個功能我們可以做黑名單。

給一個例子:

就是統計pv

# -*- coding:utf-8 -*-
from datetime import datetime
from data_monitor.utils.dbmanager import MysqlManager
from data_monitor.common.constant import MYSQL_JOBS as mysql_config

class RequestHookMiddleware(object):

    def process_request(self, request):
        try:
            username = request.COOKIES.get('username')
            uri = request.path
            timestamp = str(datetime.now())
            db_obj = MysqlManager(
                mysql_config.get('host'),
                mysql_config.get('port'),
                mysql_config.get('db'),
                mysql_config.get('user'),
                mysql_config.get('password'),
                format=True,
            )
            field_str = 'username, uri, timestamp'
            value_str = '"%s","%s","%s"' % (username, uri, timestamp)
            db_obj.insert('pv', field_str, value_str)
            db_obj.close()
            return
        except Exception, ex:
            return