【学习资料】玩转 Redis 和 Nest.js：从零开始的缓存之旅

在当今的互联网应用中，高频数据操作和大规模并发请求已经成为常态。Nest.js 作为一个灵活且模块化的 Node.js 框架，在面对这些挑战时，需要一个强大的工具来提升其性能。这时候，Redis 就成为了 Nest.js 的最佳搭档。

神奇小广告

引言

在开发中，Redis 是一个非常棒的工具，用来缓存数据、加快响应速度、甚至实现实时功能都特别方便。本文将展示如何在 Nest.js 项目中配置并使用 Redis，让你的应用“飞”起来！

1. 准备工作：安装 Redis 和依赖包

首先，确保在本地或服务器上安装了 Redis 服务（可以用 Docker 快速启动 Redis）。然后在 Nest.js 项目中安装 Redis 所需的依赖包：

bash复制代码npm install redis @nestjs-modules/ioredis ioredis

2. 配置 Redis 模块

在 Nest.js 中，可以使用 @nestjs-modules/ioredis 模块来连接和管理 Redis。我们首先创建一个 RedisModule，并配置连接信息。

代码示例：

在 app.module.ts 中导入并配置 Redis 模块：

import { Module } from '@nestjs/common';
import { RedisModule } from '@nestjs-modules/ioredis';

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

解释：上面的代码配置了 Redis 的主机和端口，连接成功后，就可以在 Nest.js 项目中使用 Redis 实现缓存或其他功能了。

3. 基础操作：存储和获取数据

配置好 Redis 后，让我们尝试在服务中使用 Redis，来完成最基础的“设置”和“获取”数据。

代码示例：

在服务文件 cache.service.ts 中实现简单的 set 和 get 操作：

import { Injectable } from '@nestjs/common';
import { InjectRedis, Redis } from '@nestjs-modules/ioredis';

@Injectable()
export class CacheService {
  constructor(@InjectRedis() private readonly redis: Redis) {}

  async setCache(key: string, value: string, ttl: number): Promise<void> {
    await this.redis.set(key, value, 'EX', ttl); // 设置过期时间
  }

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

解释：setCache 方法将数据存入 Redis，并设置一个过期时间；getCache 方法则用于根据键获取数据。这样，想要缓存的数据都可以通过 Redis 来管理。

4. 实际应用：在 API 响应中添加缓存

我们可以将 Redis 用于缓存 API 响应，比如有一个需要频繁查询的列表数据，把数据缓存起来可以大大提高性能。

代码示例：

在控制器 app.controller.ts 中调用 CacheService：

import { Controller, Get } from '@nestjs/common';
import { CacheService } from './cache.service';

@Controller('items')
export class AppController {
  constructor(private readonly cacheService: CacheService) {}

  @Get()
  async getItems() {
    const cacheKey = 'items_list';
    const cachedData = await this.cacheService.getCache(cacheKey);

    if (cachedData) {
      return JSON.parse(cachedData); // 返回缓存的数据
    }

    // 假设 fetchItems 是获取数据的方法
    const items = await this.fetchItems();
    await this.cacheService.setCache(cacheKey, JSON.stringify(items), 3600); // 缓存 1 小时

    return items;
  }

  async fetchItems() {
    // 模拟数据获取逻辑
    return [{ id: 1, name: 'Item A' }, { id: 2, name: 'Item B' }];
  }
}

解释：每次请求时，先检查是否有缓存数据，如果有，就直接返回缓存的内容；如果没有，先获取数据，然后把结果存到 Redis 中供下次使用。