EVILEG-CORE. Кэширование свойств объектов моделей с помощью model_cached_property

EVILEG, ESNF-C, model_cached_property, Django

Для ускорения работы сайта, помимо оптимизации запросов к базе данных, можно использовать кеширование.

Django позволяет кэшировать:

• индивидуальное view , как Class Based View , так и обычные функции view
• целые шаблоны или части этих шаблонов
• QuerySet
• а также свойства объектов модели с помощью cached_property

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

Так был написан декоратор model_cached_property

model_cached_property

Этот декоратор использует redis в качестве механизма кэширования, поскольку для аннулирования кеша может потребоваться удаление группы ключей, принадлежащих этому свойству. Так как свойство может кэшироваться для разных пользователей по-разному.

Установка EVILEG-CORE

pip install evileg-core

Также evileg_core подтянет все зависимости, необходимые для этого пакета. Включая библиотеку django-redis , которая используется для работы с redis .

Если вы еще не используете redis , вам необходимо его установить.

sudo apt install redis-server

settings.py

Добавить evileg_core к установленным приложениям

INSTALLED_APPS = [
    ...
    'evileg_core',
]

Настройка кэширующего бэкэнда

CACHES = {
    "default": {
        "BACKEND": "django_redis.cache.RedisCache",
        "LOCATION": "redis://127.0.0.1:6379/1",
        "OPTIONS": {
            "CLIENT_CLASS": "django_redis.client.DefaultClient",
        }
    }
}

Использование model_cached_property

Нормальное кэширование

from evileg_core.cache.decorators import model_cached_property

class Article(models.Model):

    @model_cached_property
    def comments_count(self):
        return self.comments.count()

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

Set Caching Timeout

Если вы хотите установить конкретное время кэширования, вы можете использовать аргумент timeout с декоратором.

class Article(models.Model):

    @model_cached_property(timeout=3000)
    def comments_count(self):
        return self.comments.count()

Глобальная настройка длительности кеша

Вы также можете установить глобальное время кэширования для всех декораторов в settings.py в секундах.

MODEL_CACHED_PROPERTY_TIMEOUT = 300000

Использование свойств с аргументами

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

Это одновременно и преимущество этого декоратора, и его недостаток. Дело в том, что кэширование правильное, нужно, чтобы входные аргументы были уникальными. Например, если входные аргументы являются временными неуникальными объектами, такими как AnonymousUser , кэширование не будет работать.

Однако декоратор может использоваться для кэширования в зависимости от пользователя. Это может выглядеть так.

class Article(models.Model):

    @model_cached_property
    def __user_in_bookmarks(self, user):
        return self.bookmarks.filter(user=user).exists()

    def user_in_bookmarks(self, user):
        return self.__user_in_bookmarks(user) if user.is_authenticated else False

Обратите внимание, что есть проверка на user.is_authenticated , потому что кеширование неаутентифицированного пользователя будет работать некорректно, а для аутентифицированного будет работать корректно, так как аутентифицированный пользователь является уникальным объектом.

Cache invalidation

В том случае, если кеш стал неактуален до истечения срока его жизни, то можно воспользоваться функцией invalidate_model_cached_property

from evileg_core.cache.utils import invalidate_model_cached_property

class Article(models.Model):

    def invalidate_cache(self):
        invalidate_model_cached_property(self, self.comments_count)

Для корректной инвалидации кэша необходимо передать объект, кэш которого вы хотите очистить, а также метод этого объекта.

Это может выглядеть так же.

article = get_object_or_404(Article, pk=12)
invalidate_model_cached_property(article, article.comments_count)

Вывод

Таким образом, model_cached_property можно использовать для

• кеширование свойств объектов модели на длительное время, большее времени жизни объекта при запросе страницы
• кеширование свойств объектов модели в зависимости от входных аргументов

Есть ограничения

• этот декоратор можно использовать только в моделях, то есть классах, унаследованных от models.Model
• кеширование свойств модели в зависимости от аргументов должно производиться только для уникальных входных аргументов, иначе кеширование будет некорректным