Декоратор condition¶

Sometimes (in fact, quite often) you can create functions to rapidly compute the ETag value or the last-modified time for a resource, without needing to do all the computations needed to construct the full view. Django can then use these functions to provide an «early bailout» option for the view processing. Telling the client that the content has not been modified since the last request, perhaps.

Эти две функции передаются в качестве параметров декоратору django.views.decorators.http.condition. Этот декоратор использует две функции (вам нужно указать только одну, если вы не можете легко и быстро вычислить обе величины), чтобы определить, совпадают ли заголовки в HTTP-запросе с заголовками в ресурсе. Если они не совпадают, необходимо вычислить новую копию ресурса и вызвать обычное представление.

Подпись декоратора condition выглядит следующим образом:

condition(etag_func=None, last_modified_func=None)

The two functions, to compute the ETag and the last modified time, will be passed the incoming request object and the same parameters, in the same order, as the view function they are helping to wrap. The function passed last_modified_func should return a standard datetime value specifying the last time the resource was modified, or None if the resource doesn’t exist. The function passed to the etag decorator should return a string representing the ETag for the resource, or None if it doesn’t exist.

Декоратор устанавливает заголовки ETag и Last-Modified в ответе, если они еще не установлены представлением и если метод запроса безопасен (GET или HEAD).

Полезное использование этой функции, вероятно, лучше всего объяснить на примере. Предположим, у вас есть пара моделей, представляющих небольшую систему блогов:

import datetime
from django.db import models

class Blog(models.Model):
    ...

class Entry(models.Model):
    blog = models.ForeignKey(Blog, on_delete=models.CASCADE)
    published = models.DateTimeField(default=datetime.datetime.now)
    ...

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

def latest_entry(request, blog_id):
    return Entry.objects.filter(blog=blog_id).latest("published").published

Затем вы можете использовать эту функцию для раннего обнаружения неизмененной страницы для просмотра на главной странице:

from django.views.decorators.http import condition

@condition(last_modified_func=latest_entry)
def front_page(request, blog_id):
    ...

Ярлыки для вычисления только одного значения¶

Как правило, если вы можете предоставить функции для вычисления как ETag, так и времени последнего изменения, вам следует это сделать. Вы не знаете, какие заголовки отправит вам тот или иной HTTP-клиент, поэтому будьте готовы обрабатывать оба. Однако иногда легко вычислить только одно значение, и Django предоставляет декораторы, которые обрабатывают только ETag или только вычисления последнего изменения.

Декораторам django.views.decorators.http.etag и django.views.decorators.http.last_modified передаются функции того же типа, что и декоратору condition. Их подписи:

etag(etag_func)
last_modified(last_modified_func)

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

@last_modified(latest_entry)
def front_page(request, blog_id):
    ...

…или:

def front_page(request, blog_id):
    ...
front_page = last_modified(latest_entry)(front_page)

# Bad code. Don't do this!
@etag(etag_func)
@last_modified(last_modified_func)
def my_view(request):
    # ...

# End of bad code.

Использование декораторов с другими методами HTTP¶

Декоратор Condition полезен не только для запросов GET и HEAD (запросы HEAD в этой ситуации аналогичны запросам GET). Его также можно использовать для проверки запросов POST, PUT и DELETE. В таких ситуациях идея состоит не в том, чтобы вернуть ответ «не изменено», а в том, чтобы сообщить клиенту, что ресурс, который он пытается изменить, за это время был изменен.

Например, рассмотрим следующий обмен между клиентом и сервером:

1. Клиент запрашивает /foo/.

2. Сервер отвечает некоторым содержимым с ETag "abcd1234".

3. Клиент отправляет HTTP-запрос PUT в /foo/ для обновления ресурса. Он также отправляет заголовок «If-Match: «abcd1234»», чтобы указать версию, которую он пытается обновить.

4. Сервер проверяет, изменился ли ресурс, вычисляя ETag так же, как и для запроса GET (с использованием той же функции). Если ресурс изменен, он вернет код состояния 412, что означает «предварительное условие не выполнено».

5. Клиент отправляет запрос GET в /foo/ после получения ответа 412, чтобы получить обновленную версию контента перед его обновлением.

Важная вещь, которую показывает этот пример, заключается в том, что одни и те же функции могут использоваться для вычисления значений ETag и последней модификации во всех ситуациях. Фактически, вам следует использовать одни и те же функции, чтобы каждый раз возвращались одни и те же значения.

Сравнение с условной обработкой промежуточного программного обеспечения¶

Django обеспечивает условную обработку GET через django.middleware.http.ConditionalGetMiddleware. Хотя промежуточное программное обеспечение подходит для многих ситуаций, оно имеет ограничения для расширенного использования:

• Оно применяется глобально ко всем представлениям в вашем проекте.

• Это не избавляет вас от необходимости генерировать ответ, который может оказаться дорогостоящим.

• Это подходит только для HTTP-запросов GET.

Здесь вам следует выбрать наиболее подходящий инструмент для вашей конкретной проблемы. Если у вас есть способ быстро вычислить ETags и время модификации, и если для создания содержимого какого-либо представления требуется некоторое время, вам следует рассмотреть возможность использования декоратора «condition», описанного в этом документе. Если все уже работает достаточно быстро, придерживайтесь использования промежуточного программного обеспечения, и объем сетевого трафика, отправляемого обратно клиентам, все равно будет уменьшен, если представление не изменилось.