يعد التخزين المؤقت تقنية أساسية لتحسين أداء تطبيقاتك وقابلية التوسع. في Nest.js، يمكن دمج التخزين المؤقت بسلاسة باستخدام مدير ذاكرة التخزين المؤقت المدمج. في هذه المقالة، سنستكشف كيفية إنشاء مصمم @Cacheable مخصص لتبسيط التخزين المؤقت في خدمات Nest.js أو وحدات التحكم الخاصة بك.

؟ لماذا نستخدم مصمم ديكور @Cacheable مخصص؟

بينما يوفر Nest.js آليات تخزين مؤقت قوية خارج الصندوق، فإن تطبيق منطق التخزين المؤقت مباشرة ضمن أساليبك يمكن أن يؤدي إلى فوضى التعليمات البرمجية الخاصة بك. يلخص مصمم الديكور المخصص هذا المنطق، مما يجعل التعليمات البرمجية الخاصة بك أكثر وضوحًا وأكثر قابلية للصيانة.

؟ إنشاء @Cacheable Decorator

لنبدأ بإنشاء مصمم @Cacheable الذي سنستخدمه لتخزين نتائج أساليبنا مؤقتًا.

import { Cache } from 'cache-manager';

export function Cacheable(cacheKey: string) {
  return function (
    target: any,
    propertyName: string,
    descriptor: PropertyDescriptor,
  ) {
    const originalMethod = descriptor.value;

    descriptor.value = async function (...args: any[]) {
      const cache: Cache = this.cacheManager;

      if (!cache) {
        throw new Error(
          'Cannot use Cacheable() decorator without injecting the cache manager.',
        );
      }

      // Try to get cached data
      try {
        const cachedResult = await cache.get(cacheKey);
        if (cachedResult) {
          return cachedResult;
        }
      } catch (error) {
        console.error(`Cache get error for key: ${cacheKey}:`, error);
      }

      // Call the original method if cache miss
      const result = await originalMethod.apply(this, args);

      // Set the new result in cache
      try {
        await cache.set(cacheKey, result);
      } catch (error) {
        console.error(`Cache set error for key: ${cacheKey}:`, error);
      }

      return result;
    };

    return descriptor;
  };
}

؟ توضيح

• استرجاع ذاكرة التخزين المؤقت: قبل تنفيذ الطريقة الأصلية، يتحقق مصمم الديكور مما إذا كانت النتيجة مخزنة مؤقتًا بالفعل.
• معالجة ذاكرة التخزين المؤقت المفقودة: إذا لم تكن النتيجة في ذاكرة التخزين المؤقت، فسيتم تنفيذ الطريقة الأصلية ثم تخزين النتيجة مؤقتًا.
• معالجة الأخطاء: يلتقط ويسجل أي أخطاء أثناء استرداد ذاكرة التخزين المؤقت أو الإعداد، مما يضمن عدم تعطل التطبيق الخاص بك بسبب مشكلات التخزين المؤقت.

؟ باستخدام @Cacheable Decorator

إليك كيفية تطبيق مصمم @Cacheable على طريقة في خدمتك:

import { Injectable } from '@nestjs/common';
import { Cacheable } from './cacheable.decorator';

const SETTING_CACHE_KEY = 'settings';

@Injectable()
export class SettingsService {
  // Inject the cache manager
  constructor(private readonly cacheManager: Cache) {}

  /**
   * Retrieves settings from the cache if available, or loads them from the
   * repository and caches the result.
   *
   * @returns A promise that resolves to a `Settings` object.
   */
  @Cacheable(SETTING_CACHE_KEY)
  async getSettings(): Promise {
    return await this.findAll();
  }

  // ... other methods like findAll() and buildTree()
}

؟ توضيح

• تطبيق الديكور: يتم تطبيق مصمم @Cacheable على طريقة getSettings() باستخدام مفتاح ذاكرة تخزين مؤقت محدد.
• حقن التبعية: يتم حقن مدير ذاكرة التخزين المؤقت في الخدمة ليستخدمها مصمم الديكور.

؟ دمج مدير ذاكرة التخزين المؤقت في Nest.js

لاستخدام مدير ذاكرة التخزين المؤقت في تطبيقك، تحتاج إلى تسجيله في وحدتك:

import { Module } from '@nestjs/common';
import { CacheModule } from '@nestjs/cache-manager';
import { SettingsService } from './settings.service';

@Module({
  imports: [
    CacheModule.register({
      isGlobal: true,
      ttl: 300, // Time to live in seconds
      max: 100, // Maximum number of items in cache
    }),
  ],
  providers: [SettingsService],
})
export class AppModule {}

؟ توضيح

• ذاكرة التخزين المؤقت العامة: الإعداد عالمي: صحيح يجعل مدير ذاكرة التخزين المؤقت متاحًا في جميع أنحاء التطبيق الخاص بك.
• TTL والحد الأقصى للعناصر: قم بتكوين مدة البقاء (ttl) والحد الأقصى لعدد العناصر (الحد الأقصى) في ذاكرة التخزين المؤقت.

؟ حقن مدير ذاكرة التخزين المؤقت

تأكد من إدخال مدير ذاكرة التخزين المؤقت في أي خدمة أو وحدة تحكم تستخدم مصمم الديكور @Cacheable:

import { Injectable } from '@nestjs/common';
import { Cache } from 'cache-manager';

@Injectable()
export class SettingsService {
  constructor(private readonly cacheManager: Cache) {}

  // ... your methods
}

؟ خاتمة

من خلال إنشاء مصمم @Cacheable مخصص، يمكنك الحفاظ على أساليبك نظيفة والتركيز على المنطق الأساسي، وترك مخاوف التخزين المؤقت لمصمم الديكور. يعمل هذا الأسلوب على تحسين إمكانية قراءة التعليمات البرمجية وإمكانية صيانتها، مما يجعل تطبيق Nest.js الخاص بك أكثر كفاءة وقابلية للتطوير.

لا تتردد في ترك التعليقات أو الأسئلة أدناه. ترميز سعيد! ?