ЖАМАНДЫҚ ЯРЕК. Model_cached_property бар үлгі нысанының сипаттарын кэштеу

EVILEG, ESNF-C, model_cached_property, Django

Сайтты жеделдету үшін дерекқор сұрауларын оңтайландырудан басқа, кэштеуді пайдалануға болады.

Django кэштеуге мүмкіндік береді:

• жеке көрініс , Класқа негізделген көрініс және тұрақты көру функциялары
• тұтас үлгілер немесе осы үлгілердің бөліктері
• Сұраулар жинағы
• сонымен қатар cached_property көмегімен үлгі нысандарының қасиеттері

Мені ауыр есептеулер немесе ауыр дерекқор сұраулары үшін үлгі нысандарының жеке қасиеттерін кэштеу мүмкіндігі қызықтырды.
cached_property декораторының осындай функционалдығы бар, бірақ мен үшін минус кэштеу объектінің қызмет ету мерзімі ішінде ғана орын алды.
Ал маған бет сұралған кезде объектінің бар болуынан ұзақ уақыт бойы кэштеу қажет. Сондай-ақ кіріс аргументтеріне байланысты қасиеттерді кэштеу керек болды. Бұл сайт безендірушісі ұнатулар мен ұнатпаулар санын, сондай-ақ ағымдағы пайдаланушыға белгілі бір мазмұн элементін ұнатқан-ұнамағаны туралы ақпаратты кэштейді.

model_cached_property декораторы осылай жазылған

үлгінің_кэштелген_сипаты

Бұл декоратор өзінің кэштеу механизмі ретінде redis пайдаланады, себебі кэшті жарамсыз деп тану үшін осы сипатқа жататын кілттер тобын жою қажет болуы мүмкін. Өйткені сипат әртүрлі пайдаланушылар үшін әртүрлі жолдармен кэштелуі мүмкін.

EVILEG-CORE орнату

pip install evileg-core

Сондай-ақ, evileg_core осы пакетке қажетті барлық тәуелділіктерді тартады. Соның ішінде redis -мен жұмыс істеу үшін пайдаланылатын django-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",
        }
    }
}

Үлгі_кэштелген_сипатты пайдалану

Қалыпты кэштеу

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 секунд ішінде кэштейді. Келесі жолы мақала беті сұралғанда, сұрау алдымен белгілі бір мақала нысанының кэшіне жасалады және кэштің мерзімі өткен жағдайда ғана сұрау дерекқорға қайта жасалады.

Кэштеу уақытын орнату

Белгілі бір кэш уақытын орнатқыңыз келсе, декоратормен тайм-аут аргументін пайдалануға болады.

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 -дан мұраланған сыныптарда пайдалануға болады.
• аргументтерге байланысты үлгі қасиеттерін кэштеу тек бірегей енгізу аргументтері үшін орындалуы керек, әйтпесе кэштеу дұрыс емес болады.