Nodejs Nestjs缓存管理插件@nestjs/cache-manager的使用

Nodejs Nestjs缓存管理插件@nestjs/cache-manager的使用
[@nestjs](/user/nestjs)/cache-manager 是一个在 NestJS 应用程序中实现缓存功能的插件。它允许你轻松地将缓存机制集成到你的应用中。下面是一个简单的示例，展示如何安装和配置这个插件，并在控制器中使用它。

1. 安装依赖

首先，你需要安装 [@nestjs](/user/nestjs)/cache-manager 和你喜欢的缓存适配器（例如 Redis 或 Memory）。这里我们以 Redis 为例：

npm install [@nestjs](/user/nestjs)/cache-manager redis

2. 配置模块

接下来，在你的应用程序中配置 CacheModule。这通常在你的根模块（如 AppModule）中完成。

import { Module } from '[@nestjs](/user/nestjs)/common';
import { CacheModule, CacheInterceptor } from '[@nestjs](/user/nestjs)/cache-manager';
import * as redisStore from 'cache-manager-redis-store';

@Module({
  imports: [
    CacheModule.register({
      isGlobal: true,
      store: redisStore,
      host: 'localhost',
      port: 6379,
    }),
  ],
  providers: [
    // 如果你想全局使用缓存拦截器，可以这样注册
    {
      provide: APP_INTERCEPTOR,
      useClass: CacheInterceptor,
    },
  ],
})
export class AppModule {}

3. 使用缓存服务

现在你可以在任何服务或控制器中注入并使用 CacheManager 来执行缓存操作。

在服务中使用

import { Injectable } from '[@nestjs](/user/nestjs)/common';
import { InjectCache } from '[@nestjs](/user/nestjs)/cache-manager';
import { Cache } from 'cache-manager';

@Injectable()
export class AppService {
  constructor(@InjectCache() private cacheManager: Cache) {}

  async getHello(): Promise<string> {
    const key = 'hello';
    let data = await this.cacheManager.get(key);
    if (!data) {
      data = 'Hello World!';
      await this.cacheManager.set(key, data, { ttl: 5000 }); // 缓存5秒
    }
    return data;
  }
}

在控制器中使用

import { Controller, Get } from '[@nestjs](/user/nestjs)/common';
import { AppService } from './app.service';

@Controller()
export class AppController {
  constructor(private readonly appService: AppService) {}

  @Get()
  getHello(): string {
    return this.appService.getHello();
  }
}

4. 使用缓存拦截器

如果你已经将 CacheInterceptor 注册为全局拦截器，你可以直接在控制器方法上使用 @Cacheable() 装饰器来标记需要缓存的方法。

import { Controller, Get, CacheInterceptor, UseInterceptors } from '[@nestjs](/user/nestjs)/common';

@Controller()
export class AppController {
  @Get()
  @UseInterceptors(CacheInterceptor)
  @Cacheable({ ttl: 5000 }) // 缓存5秒
  getHello(): string {
    return 'Hello World!';
  }
}

以上就是使用 [@nestjs](/user/nestjs)/cache-manager 插件的基本步骤。你可以根据自己的需求调整配置和使用方式。