Nodejs Nestjs Redis缓存插件@nestjs/redis的使用

Nodejs Nestjs Redis缓存插件@nestjs/redis的使用
在NestJS中使用Redis作为缓存是一种常见的做法。NestJS提供了[@nestjs](/user/nestjs)/redis模块，它基于官方的ioredis库，可以方便地集成Redis到你的应用程序中。

安装依赖

首先，你需要安装[@nestjs](/user/nestjs)/redis和ioredis：

npm install [@nestjs](/user/nestjs)/redis ioredis

配置Redis模块

接下来，你需要配置Redis模块。你可以在你的应用模块（通常是AppModule）中进行配置：

import { Module } from '[@nestjs](/user/nestjs)/common';
import { APP_INTERCEPTOR } from '[@nestjs](/user/nestjs)/core';
import { RedisModule, RedisOptions } from '[@nestjs](/user/nestjs)/redis';

@Module({
  imports: [
    RedisModule.register({
      host: 'localhost',
      port: 6379,
    } as RedisOptions),
  ],
  providers: [],
})
export class AppModule {}

这里我们配置了一个简单的Redis连接，使用了默认的端口和主机地址。你可以根据需要修改这些配置。

使用Redis

一旦Redis模块被正确配置，你就可以在你的服务或控制器中注入Redis客户端并使用它了。

在服务中使用

import { Injectable } from '[@nestjs](/user/nestjs)/common';
import { InjectRedis } from '[@nestjs](/user/nestjs)/redis';

@Injectable()
export class AppService {
  constructor(@InjectRedis() private readonly redisClient) {}

  async getHello(): Promise<string> {
    const cacheKey = 'hello_cache';
    let result = await this.redisClient.get(cacheKey);

    if (!result) {
      // 如果缓存中没有数据，从数据库或其他地方获取
      result = 'Hello World!';
      await this.redisClient.set(cacheKey, result);
    }

    return result;
  }
}

在控制器中使用

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

注意事项

  • 确保Redis服务器正在运行并且可以通过配置的地址和端口访问。
  • 根据你的应用需求，可能需要更复杂的Redis配置，例如密码认证、集群模式等。
  • @InjectRedis()装饰器允许你注入一个默认的Redis客户端。如果你需要多个Redis客户端，可以使用@InjectRedis('customName')来注入特定配置的客户端。

通过以上步骤，你应该能够在NestJS项目中成功集成和使用Redis缓存。


3 回复

当然，没问题！想象一下，你正在烹饪一道美味的大餐，但你不想每次都从冰箱里拿出来食材。于是，你决定用一个超级聪明的助手——Redis来帮你保存一些常用的食材（数据），这样每次需要时都能快速拿到。

在NestJS的世界里，@nestjs/redis就是这个聪明的助手。首先，你需要安装它，就像去超市买食材一样：

npm install @nestjs/redis redis

然后，在你的模块中设置它，就像告诉助手在哪里放食材：

import { Module } from '@nestjs/common';
import { RedisModule } from '@nestjs/redis';
import { ConfigService } from '@nestjs/config';

@Module({
  imports: [
    RedisModule.registerAsync({
      useFactory: (configService: ConfigService) => ({
        url: configService.get<string>('REDIS_URL'),
      }),
      inject: [ConfigService],
    }),
  ],
})
export class AppModule {}

最后，你可以在一个服务中注入RedisClient，就像告诉助手开始工作：

import { Injectable } from '@nestjs/common';
import { RedisClient } from 'redis';

@Injectable()
export class MyService {
  constructor(private readonly redisClient: RedisClient) {}

  async getData(key: string) {
    const data = await new Promise((resolve, reject) => {
      this.redisClient.get(key, (err, data) => err ? reject(err) : resolve(data));
    });
    return data;
  }
}

现在，每当需要数据时，你就可以通过这个服务快速获取，就像是瞬间从冰箱里拿出食材一样方便！希望这能帮到你，享受编程的乐趣吧！


在NestJS项目中使用Redis缓存可以显著提升应用性能。这里我将介绍如何安装和配置@nestjs/redis模块，并给出一个简单的示例来演示如何使用它。

1. 安装必要的依赖

首先，你需要安装@nestjs/redis模块和ioredis库（@nestjs/redis是基于ioredis构建的）：

npm install @nestjs/redis ioredis

2. 配置Redis模块

接下来，在你的应用程序中注册@nestjs/redis模块。你可以通过创建一个模块来全局注册它，或者仅在需要它的特定模块中局部注册它。

假设你有一个全局的AppModule，你可以在其中配置Redis模块：

import { Module } from '@nestjs/common';
import { RedisModule, RedisOptions } from '@nestjs/redis';

@Module({
  imports: [
    RedisModule.register({
      host: 'localhost',
      port: 6379,
    } as RedisOptions),
  ],
})
export class AppModule {}

如果你希望在特定模块中使用Redis，只需在这个模块中导入RedisModule并传入相应的配置即可。

3. 使用Redis

现在你可以在服务中注入RedisClient或RedisModule提供的客户端来使用Redis了。以下是一个简单的例子：

import { Injectable } from '@nestjs/common';
import { InjectRedisClient, RedisClient } from '@nestjs/redis';

@Injectable()
export class AppService {
  constructor(@InjectRedisClient() private readonly redisClient: RedisClient) {}

  async getDataFromCache(key: string): Promise<string | null> {
    return this.redisClient.get(key);
  }

  async setDataInCache(key: string, value: string): Promise<void> {
    await this.redisClient.set(key, value);
  }
}

在这个例子中，我们定义了一个AppService，它提供了两个方法：getDataFromCache用于从Redis获取数据，setDataInCache用于向Redis存储数据。

这就是如何在NestJS中使用Redis的基本步骤。根据你的具体需求，你可能还需要探索更高级的功能，比如过期时间设置、事务处理等。

在NestJS中使用Redis缓存可以通过@nestjs/redis和ioredis包来实现。首先安装必要的依赖：

npm install @nestjs/redis ioredis

然后，在模块文件中配置Redis模块：

import { Module } from '@nestjs/common';
import { RedisModule } from '@nestjs/redis';
import { redisClientOptions } from './redis.config';

@Module({
  imports: [
    RedisModule.register(redisClientOptions),
  ],
})
export class ApplicationModule {}

在服务中注入Redis客户端并使用：

import { Injectable } from '@nestjs/common';
import { RedisService } from '@nestjs/redis';
import { Redis } from 'ioredis';

@Injectable()
export class AppService {
  private client: Redis;

  constructor(private readonly redisService: RedisService) {
    this.client = this.redisService.getClient();
  }

  async getData(key: string) {
    const data = await this.client.get(key);
    return data ? JSON.parse(data) : null;
  }

  async saveData(key: string, value: any) {
    await this.client.set(key, JSON.stringify(value));
  }
}

这样就完成了基本的Redis缓存操作。

回到顶部