#CacheManager

#Огляд

CacheManager базується на node-cache-manager та надає NocoBase функціонал для керування модулями кешу. Вбудовані типи кешу:

• memory - lru-кеш, що надається за замовчуванням node-cache-manager
• redis - підтримується node-cache-manager-redis-yet

Більше типів можна зареєструвати та розширити через API.

#Концепції

• Store: Визначає метод кешування, що включає фабричний метод для створення кешів та інші пов'язані конфігурації. Кожен метод кешування має унікальний ідентифікатор, який надається під час реєстрації. Унікальні ідентифікатори для двох вбудованих методів кешування – це memory та redis.

• Фабричний метод Store: Метод, що надається node-cache-manager та пов'язаними пакетами розширень для створення кешів. Наприклад, 'memory', що надається за замовчуванням node-cache-manager, або redisStore, що надається node-cache-manager-redis-yet. Це відповідає першому параметру методу caching у node-cache-manager.

• Cache: Клас, інкапсульований NocoBase, який надає методи для використання кешу. При фактичному використанні кешу ви працюєте з екземпляром Cache. Кожен екземпляр Cache має унікальний ідентифікатор, який можна використовувати як простір імен для розрізнення різних модулів.

#Методи класу

#constructor()

#Сигнатура

• constructor(options?: CacheManagerOptions)

#Типи

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;
};

#Деталі

#CacheManagerOptions

#StoreOptions

#options за замовчуванням

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

const defaultOptions: CacheManagerOptions = {
  defaultStore: 'memory',
  stores: {
    memory: {
      store: 'memory',
      // глобальна конфігурація
      max: 2000,
    },
    redis: {
      store: redisStore,
      close: async (redis: RedisStore) => {
        await redis.client.quit();
      },
    },
  },
};

Параметр options буде об'єднано з параметрами за замовчуванням. Властивості, які вже присутні в параметрах за замовчуванням, можна опустити. Наприклад:

const cacheManager = new CacheManager({
  stores: {
    defaultStore: 'redis',
    redis: {
      // redisStore вже надано в параметрах за замовчуванням, тому вам потрібно лише надати конфігурацію redisStore.
      url: 'redis://localhost:6379',
    },
  },
});

#registerStore()

Реєструє новий метод кешування. Наприклад:

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

cacheManager.registerStore({
  // унікальний ідентифікатор store
  name: 'redis',
  // фабричний метод для створення store
  store: redisStore,
  // закрити з'єднання store
  close: async (redis: RedisStore) => {
    await redis.client.quit();
  },
  // глобальна конфігурація
  url: 'xxx',
});

#Сигнатура

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

#createCache()

Створює кеш. Наприклад:

await cacheManager.createCache({
  name: 'default', // унікальний ідентифікатор кешу
  store: 'memory', // унікальний ідентифікатор store
  prefix: 'mycache', // автоматично додає префікс 'mycache:' до ключів кешу, необов'язково
  // інші конфігурації store, користувацькі конфігурації будуть об'єднані з глобальною конфігурацією store
  max: 2000,
});

#Сигнатура

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

#Деталі

#options

Якщо store опущено, буде використано defaultStore. У цьому випадку метод кешування змінюватиметься відповідно до системного методу кешування за замовчуванням.

Якщо немає користувацьких конфігурацій, повертається простір кешу за замовчуванням, створений глобальною конфігурацією та спільний для поточного методу кешування. Рекомендується додати prefix, щоб уникнути конфліктів ключів.

// Використовувати кеш за замовчуванням з глобальною конфігурацією
await cacheManager.createCache({ name: 'default', prefix: 'mycache' });

#Cache

Дивіться Cache

#getCache()

Отримує відповідний кеш.

cacheManager.getCache('default');

#Сигнатура

• getCache(name: string): Cache

#flushAll()

Скидає всі кеші.

await cacheManager.flushAll();

#close()

Закриває всі з'єднання проміжного програмного забезпечення кешу.

await cacheManager.close();