#CacheManager

#Ikhtisar

CacheManager dibangun berdasarkan node-cache-manager, menyediakan fungsi manajemen modul Cache untuk NocoBase. Tipe Cache bawaan:

• memory - lru-cache yang disediakan secara default oleh node-cache-manager
• redis - fungsionalitas didukung oleh node-cache-manager-redis-yet

Tipe lainnya dapat diperluas melalui registrasi API.

#Penjelasan Konsep

• Store: Mendefinisikan satu metode cache, mencakup factory method untuk membuat cache, dan konfigurasi terkait lainnya. Setiap metode cache memiliki identifier unik, disediakan saat registrasi. Identifier unik untuk dua metode cache bawaan adalah memory dan redis.

• Factory Method Store: Disediakan oleh node-cache-manager dan paket ekstensi terkait, digunakan untuk membuat cache. Contoh 'memory' yang disediakan default oleh node-cache-manager, redisStore yang disediakan oleh node-cache-manager-redis-yet, dll. Yaitu parameter pertama dari method caching di node-cache-manager.

• Cache: Class yang di-wrap NocoBase, menyediakan method terkait penggunaan cache. Saat menggunakan cache yang sebenarnya dioperasikan adalah instance Cache, setiap instance Cache memiliki identifier unik, dapat digunakan sebagai namespace untuk membedakan modul yang berbeda.

#Method Class

#constructor()

#Signature

• constructor(options?: CacheManagerOptions)

#Tipe

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

#Detail

#CacheManagerOptions

#StoreOptions

#options Default

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

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

Parameter options akan di-merge dengan default options, isi parameter default options yang sudah ada dapat dikosongkan, contoh:

const cacheManager = new CacheManager({
  stores: {
    defaultStore: 'redis',
    redis: {
      // redisStore sudah disediakan di default options, hanya perlu menyediakan konfigurasi redisStore.
      url: 'redis://localhost:6379',
    },
  },
});

#registerStore()

Mendaftarkan metode cache baru, lihat

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

cacheManager.registerStore({
  // Identifier unik store
  name: 'redis',
  // Factory method untuk membuat store
  store: redisStore,
  // Menutup koneksi store
  close: async (redis: RedisStore) => {
    await redis.client.quit();
  },
  // Konfigurasi global
  url: 'xxx',
});

#Signature

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

#createCache()

Membuat cache, lihat

await cacheManager.createCache({
  name: 'default', // identifier unik cache
  store: 'memory', // identifier unik store
  prefix: 'mycache', // Otomatis menambahkan prefix 'mycache:' ke key cache, opsional
  // Konfigurasi store lainnya, konfigurasi kustom, akan di-merge dengan konfigurasi global store
  max: 2000,
});

#Signature

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

#Detail

#options

Saat store dilewati, akan menggunakan defaultStore, dalam hal ini metode cache akan berubah mengikuti perubahan metode cache default sistem.

Saat tidak ada konfigurasi kustom, akan mengembalikan ruang cache default yang dibuat oleh konfigurasi global, dibagikan oleh metode cache saat ini, disarankan menambahkan prefix untuk menghindari konflik key.

// Menggunakan cache default, menggunakan konfigurasi global
await cacheManager.createCache({ name: 'default', prefix: 'mycache' });

#Cache

Lihat Cache

#getCache()

Mendapatkan cache yang sesuai

cacheManager.getCache('default');

#Signature

• getCache(name: string): Cache

#flushAll()

Mereset semua cache

await cacheManager.flushAll();

#close()

Menutup koneksi semua middleware cache

await cacheManager.close();