Промежуточное ПО Django

Промежуточное ПО Django — это перехватчик для изменения объектов запроса или ответа Django; его можно понимать как этап обработки между обработкой HttpRequest и HttpResponse.

В процессе от запроса до ответа в браузере Django должен обрабатывать его через множество компонентов промежуточного ПО, как показано на следующем рисунке:

Назначение промежуточного ПО Django:

  • Изменять запрос, то есть объект HttpRequest, передаваемый представлению.
  • Изменять ответ, то есть объект HttpResponse, возвращаемый представлением.

Компоненты промежуточного ПО настраиваются в списке параметров MIDDLEWARE в файле settings.py.

Каждый строковый параметр в конфигурации — это класс, то есть промежуточное ПО.

Конфигурация промежуточного ПО 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',
]

Пользовательское промежуточное ПО

Промежуточное ПО может определять четыре метода, а именно:

process_request(self,request)
process_view(self, request, view_func, view_args, view_kwargs)
process_exception(self, request, exception)
process_response(self, request, response)

Шаги по настройке промежуточного ПО:

Создайте новый py-файл в каталоге приложения с произвольным именем и импортируйте MiddlewareMixin в этом py-файле:

from django.utils.deprecation import MiddlewareMixin

Пользовательский класс промежуточного ПО должен наследовать родительский класс MiddlewareMixin:

class MD1(MiddlewareMixin): 
    pass
Зарегистрируйте пользовательский класс промежуточного ПО в MIDDLEWARE в 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',
   
    'app01.middlewares.MD1',
]

Методы пользовательских классов промежуточного ПО

Методы пользовательского класса промежуточного ПО включают: process_request и process_response.

метод process_request

Метод process_request имеет один параметр request, который совпадает с request в функции представления.

Возвращаемое значение метода process_request может быть либо None, либо объектом HttpResponse.

  • Если возвращаемое значение — None, продолжите обычный поток и передайте его следующему промежуточному ПО для обработки.
  • Если возвращаемое значение — объект HttpResponse, Django не будет выполнять методы перед последующей функцией представления или саму функцию представления. Вместо этого, начиная с этого промежуточного ПО, он выполнит промежуточное ПО в обратном порядке и выполнит только методы, которые запускаются после функции представления.

Метод process_request выполняется перед функцией представления.

Когда настроено несколько промежуточных ПО, они выполняются в порядке регистрации в MIDDLEWARE, то есть по значению индекса в списке.

Параметр request, передаваемый между разными компонентами промежуточного ПО, — это один и тот же объект request.

Пример

from django.utils.deprecation import MiddlewareMixin

from django.shortcuts import render, HttpResponse

class MD1(MiddlewareMixin):
    def process_request(self, request):
       print("md1 process_request method.", id(request)) # Выполняется перед представлением

process_response

Метод process_response имеет два параметра: request и response. request — это объект запроса, а response — объект HttpResponse, возвращённый функцией представления. Этот метод должен возвращать значение, и это должен быть response.

Метод process_response выполняется после функции представления.

Если настроено несколько промежуточных слоёв, они выполняются в обратном порядке в соответствии с порядком регистрации в MIDDLEWARE, т. е. со значением индекса в списке.

Пример

class MD1(MiddlewareMixin):
    def process_request(self, request):
        print("md1 process_request method.", id(request)) # Выполняется перед представлением


    def process_response(self,request, response): :# На основе request/response
        print("md1 process_response method!", id(request)) # После View
        return response

На рисунке ниже в обычной ситуации выполнение идёт по зелёному маршруту. Предположим,Промежуточный слой 1Если есть возвращаемое значение, выполнение идёт по красному маршруту, напрямую выполняет метод process_response этого класса и возвращает результат; последующие другие промежуточные слои не выполняются.

process_view

Формат метода process_view следующий:

process_view(request, view_func, view_args, view_kwargs)
Метод process_view имеет четыре параметра:

  • request — это объект HttpRequest.
  • view_func — это функция представления, которую Django собирается использовать.
  • view_args — это список позиционных аргументов, передаваемых в представление.
  • view_kwargs — это словарь именованных аргументов, передаваемых в представление.

view_args и view_kwargs не включают первый параметр представления (request).

Метод process_view выполняется перед функцией представления и после метода process_request.

Возвращаемое значение может быть None, view_func(request) или объектом HttpResponse.

  • Если возвращаемое значение — None, продолжите обычный поток и передайте его следующему промежуточному ПО для обработки.
  • Если возвращаемое значение — объект HttpResponse, Django не будет выполнять методы перед последующей функцией представления или саму функцию представления. Вместо этого, начиная с этого промежуточного ПО, он выполнит промежуточное ПО в обратном порядке и выполнит только методы, которые запускаются после функции представления.
  • c. Если возвращаемое значение — view_func(request), Django не будет выполнять методы перед последующими функциями представления, но выполнит функцию представления досрочно, а затем выполнит методы после функции представления в обратном порядке.
  • После того как process_request последнего промежуточного ПО достигает сопоставления маршрута, происходит возврат к process_view первого промежуточного ПО, а затем последовательно продвигается вниз, пока не достигнет функции представления.

    Пример

    class MD1(MiddlewareMixin):
        def process_request(self, request):
            print("md1 process_request method.", id(request)) # Выполняется перед представлением


        def process_response(self,request, response): :# На основе request/response
            print("md1 process_response method!", id(request)) # После View
            return response


        def process_view(self,request, view_func, view_args, view_kwargs):
            print(md1 process_view method!) # Выполняется перед представлением; выполняются последовательно
            #return view_func(request)

    process_exception

    Метод process_exception выглядит следующим образом:

    process_exception(request, exception)

    Описание параметра:

    • request — это объект HttpRequest.
    • exception — это объект Exception, сгенерированный исключением в функции представления.

    Метод process_exception выполняется только тогда, когда в функции представления возникает исключение, и он выполняется в порядке, обратном порядку регистрации в настройках settings.

    Выполняется после функции представления и перед методом process_response.

    Возвращаемое значение метода process_exception может быть либо None, либо объектом HttpResponse.

    Если возвращаемое значение — None, страница выдаст ошибку с кодом состояния 500, а функция представления не будет выполнена.

    Метод process_exception выполняется в обратном порядке, а затем метод process_response выполняется в обратном порядке.

    Если возвращаемое значение — объект HttpResponse, страница не выдаст ошибку, а возвращаемый код состояния будет 200.

    Функция представления не выполняется, и последующие методы process_exception этого middleware также не выполняются. Выполнение начинается непосредственно с метода process_response последнего middleware в обратном порядке.

    Если метод process_view возвращает функцию представления и функция представления выполняется заранее, и функция представления сообщает об ошибке, то независимо от возвращаемого значения метода process_exception страница выдаст ошибку, и ни функция представления, ни метод process_exception не будут выполнены.

    Начинается непосредственное выполнение в обратном порядке с метода process_response последнего middleware:

    Пример

    class MD1(MiddlewareMixin):
        def process_request(self, request):
            print("md1 process_request method.", id(request)) # Выполняется перед представлением

        def process_response(self,request, response): :# На основе request/response
            print("md1 process_response method!", id(request)) # После View
            return response

        def process_view(self,request, view_func, view_args, view_kwargs):
            print(md1 process_view method!) # Выполняется перед представлением; выполняются последовательно
            #return view_func(request)


        def process_exception(self, request, exception):# Этот метод срабатывает только при возникновении ошибки
            print(md1 process_exception метод!)
            # return HttpResponse(exception) # Вернуть сообщение об ошибке

    Другие расширения