#CacheManager

#Genel Bakış

CacheManager, node-cache-manager üzerine kuruludur ve NocoBase için önbellek (cache) modülü yönetimini sağlar. Dahili önbellek türleri şunlardır:

• memory - node-cache-manager tarafından varsayılan olarak sağlanan lru-cache
• redis - node-cache-manager-redis-yet tarafından desteklenir

API aracılığıyla daha fazla tür kaydedilebilir ve genişletilebilir.

#Kavramlar

• Store: Bir önbellekleme yöntemini tanımlar. Bu tanım, önbellek oluşturmak için bir fabrika yöntemi ve diğer ilgili yapılandırmaları içerir. Her önbellekleme yönteminin, kayıt sırasında sağlanan benzersiz bir tanımlayıcısı vardır. Dahili iki önbellekleme yönteminin benzersiz tanımlayıcıları memory ve redis'tir.

• Store Fabrika Yöntemi: node-cache-manager ve ilgili eklenti paketleri tarafından önbellek oluşturmak için sağlanan bir yöntemdir. Örneğin, node-cache-manager tarafından varsayılan olarak sağlanan 'memory' ve node-cache-manager-redis-yet tarafından sağlanan redisStore gibi. Bu, node-cache-manager'ın caching yönteminin ilk parametresine karşılık gelir.

• Cache: NocoBase tarafından kapsüllenmiş, önbelleği kullanmak için ilgili yöntemleri sağlayan bir sınıftır. Önbelleği fiilen kullanırken, bir Cache örneği üzerinde işlem yaparsınız. Her Cache örneğinin, farklı modülleri ayırt etmek için bir ad alanı olarak kullanılabilecek benzersiz bir tanımlayıcısı vardır.

#Sınıf Yöntemleri

#constructor()

#İmza

• constructor(options?: CacheManagerOptions)

#Türler

export type CacheManagerOptions = Partial<{
  defaultStore: string;
  stores: {
    [storeType: string]: StoreOptions;
  };
}>;

type StoreOptions = {
  store?: 'memory' | FactoryStore<Store, any>;
  close?: (store: Store) => Promise<void>;
  // global config
  [key: string]: any;
};

#Detaylar

#CacheManagerOptions

#StoreOptions

#Varsayılan options

import { redisStore, RedisStore } from 'cache-manager-redis-yet';

const defaultOptions: CacheManagerOptions = {
  defaultStore: 'memory',
  stores: {
    memory: {
      store: 'memory',
      // global config
      max: 2000,
    },
    redis: {
      store: redisStore,
      close: async (redis: RedisStore) => {
        await redis.client.quit();
      },
    },
  },
};

options parametresi, varsayılan seçeneklerle birleştirilecektir. Varsayılan seçeneklerde zaten bulunan özellikler atlanabilir. Örneğin:

const cacheManager = new CacheManager({
  stores: {
    defaultStore: 'redis',
    redis: {
      // redisStore is already provided in the default options, so you only need to provide the redisStore configuration.
      url: 'redis://localhost:6379',
    },
  },
});

#registerStore()

Yeni bir önbellekleme yöntemi kaydeder. Örneğin:

import { redisStore } from 'cache-manager-redis-yet';

cacheManager.registerStore({
  // store için benzersiz tanımlayıcı
  name: 'redis',
  // store oluşturmak için fabrika yöntemi
  store: redisStore,
  // store bağlantısını kapat
  close: async (redis: RedisStore) => {
    await redis.client.quit();
  },
  // genel yapılandırma
  url: 'xxx',
});

#İmza

• registerStore(options: { name: string } & StoreOptions)

#createCache()

Bir önbellek oluşturur. Örneğin:

await cacheManager.createCache({
  name: 'default', // önbellek için benzersiz tanımlayıcı
  store: 'memory', // store için benzersiz tanımlayıcı
  prefix: 'mycache', // önbellek anahtarlarına otomatik olarak 'mycache:' öneki ekler, isteğe bağlı
  // diğer store yapılandırmaları, özel yapılandırmalar genel store yapılandırmasıyla birleştirilecektir
  max: 2000,
});

#İmza

• createCache(options: { name: string; prefix?: string; store?: string; [key: string]: any }): Promise<Cache>

#Detaylar

#options

store atlanırsa, defaultStore kullanılacaktır. Bu durumda, önbellekleme yöntemi sistemin varsayılan önbellekleme yöntemine göre değişecektir.

Özel yapılandırma olmadığında, genel yapılandırma tarafından oluşturulan ve mevcut önbellekleme yöntemi tarafından paylaşılan varsayılan önbellek alanı döndürülür. Anahtar çakışmalarını önlemek için bir prefix eklemeniz önerilir.

// Varsayılan önbelleği genel yapılandırma ile kullanın
await cacheManager.createCache({ name: 'default', prefix: 'mycache' });

#Cache

Cache bölümüne bakın

#getCache()

İlgili önbelleği alır.

cacheManager.getCache('default');

#İmza

• getCache(name: string): Cache

#flushAll()

Tüm önbellekleri sıfırlar.

await cacheManager.flushAll();

#close()

Tüm önbellek ara yazılımı bağlantılarını kapatır.

await cacheManager.close();