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 секунд. При наступному запиті сторінки статті запит буде виконаний спочатку до кешу для конкретного об'єкта статті, і тільки якщо тривалість кеша минула, то запит буде знову виконаний до бази даних.

Установка тривалості кешування

Якщо ж ви хочете задати певний час кешування, то можете використовувати аргумент 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 , оскільки кешування нерозпізнаних користувачів не працюватиме коректно, однак буде працювати коректно для аутентифицированного користувача, оскільки аутентіфіцированний користувач є унікальним об'єктом.

Інвалідація кеша

У тому випадку, якщо кеш став неактуальним завчасно закінчення його життя, то ви можете скористатися функцією 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
• Кешування властивостей моделей в залежності від аргументів повинно виконуватися тільки для унікальних вхідних аргументів, інакше кешування НЕ буде коректним