NestJS Redis 模块使用教程

NestJS Redis 模块使用教程

项目地址:https://gitcode.com/gh_mirrors/ne/nestjs-redis

项目介绍

nestjs-redis 是一个用于在 NestJS 框架中集成 Redis 的开源模块。Redis 是一个高性能的键值存储系统，常用于缓存、消息队列和实时分析等场景。通过集成 nestjs-redis，开发者可以轻松地在 NestJS 应用中使用 Redis，从而提升应用的性能和响应速度。

项目快速启动

安装依赖

首先，确保你已经安装了 Node.js 和 NestJS CLI。然后，通过以下命令安装 nestjs-redis 模块：

npm install @liaoliaots/nestjs-redis

配置 Redis

在 NestJS 项目中，创建一个配置文件 redis.config.ts，并添加以下内容：

import { RedisModuleOptions } from '@liaoliaots/nestjs-redis';

export const redisConfig: RedisModuleOptions = {
  config: {
    host: 'localhost',
    port: 6379,
  },
};

集成到 NestJS 应用

在 app.module.ts 中导入并配置 RedisModule：

import { Module } from '@nestjs/common';
import { RedisModule } from '@liaoliaots/nestjs-redis';
import { redisConfig } from './redis.config';

@Module({
  imports: [
    RedisModule.forRoot(redisConfig),
  ],
})
export class AppModule {}

使用 Redis 服务

在需要使用 Redis 的服务中注入 RedisService：

import { Injectable } from '@nestjs/common';
import { RedisService } from '@liaoliaots/nestjs-redis';

@Injectable()
export class AppService {
  constructor(private readonly redisService: RedisService) {}

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

  async getValue(key: string): Promise<string | null> {
    return await this.redisService.get(key);
  }
}

应用案例和最佳实践

缓存数据

使用 Redis 进行数据缓存是常见的应用场景。以下是一个简单的示例，展示如何在 NestJS 应用中缓存 API 响应：

import { Injectable, HttpService } from '@nestjs/common';
import { RedisService } from '@liaoliaots/nestjs-redis';

@Injectable()
export class ApiService {
  constructor(
    private readonly httpService: HttpService,
    private readonly redisService: RedisService,
  ) {}

  async fetchData(url: string): Promise<any> {
    const cachedData = await this.redisService.get(url);
    if (cachedData) {
      return JSON.parse(cachedData);
    }

    const response = await this.httpService.get(url).toPromise();
    await this.redisService.set(url, JSON.stringify(response.data));
    return response.data;
  }
}

实时消息系统

Redis 的发布/订阅功能可以用于构建实时消息系统。以下是一个简单的示例：

import { Injectable } from '@nestjs/common';
import { RedisService } from '@liaoliaots/nestjs-redis';

@Injectable()
export class MessageService {
  constructor(private readonly redisService: RedisService) {}

  async publishMessage(channel: string, message: string): Promise<void> {
    await this.redisService.publish(channel, message);
  }

  async subscribeToChannel(channel: string, callback: (message: string) => void): Promise<void> {
    const subscriber = this.redisService.getClient().duplicate();
    await subscriber.subscribe(channel);
    subscriber.on('message', (ch, msg) => {
      if (ch === channel) {
        callback(msg);
      }
    });
  }
}

典型生态项目

Redis 生态系统

Redis 拥有丰富的生态系统，包括以下几个典型的项目：

1. Redis Stack: 提供了一系列的扩展功能，如全文搜索、JSON 支持、

nestjs-redis Redis(ioredis) module for Nest framework (node.js). 项目地址: https://gitcode.com/gh_mirrors/ne/nestjs-redis