Vue3 + Nest 实现权限管理系统后端篇（六）:如何在 NestJS 中使用 redis

站长

2023年09月30日 08:02 · 阅读数 10

当我们使用 MySQL 这样的关系型数据库时，数据是存储在硬盘中的，而计算机访问硬盘的速度通常相对较慢，这可能导致数据库查询数据时出现性能问题。为了解决这个问题，我们可以使用缓存技术，而其中最常用也是备受推崇的就是 Redis 了。

什么是 Redis

Redis 是一个开源的内存存储数据结构服务器。它具有以下特点：

高速读写：Redis 数据存储在内存中，因此具有非常高的读写速度。相比于从磁盘访问数据的 I/O 操作，通过内存访问数据可以显著提升数据库查询性能。
多种数据结构支持：Redis 不仅仅是一个简单的键值存储系统，还支持多种数据结构，如字符串、哈希、列表、集合等。这使得 Redis 适用于各种不同类型的数据存储需求，进一步提升了其灵活性和实用性。
缓存功能：Redis 可以用作缓存层，提供了快速、高效的读取和写入操作。它可以将经常访问的数据存储在内存中，从而避免了频繁地访问较慢的数据库。这样可以大大降低系统的负载并提升响应速度。

通过将数据存储在内存中并利用 Redis 的缓存功能，我们可以有效地减少对关系型数据库的查询频率，从而显著提高系统的性能和响应速度。

Redis 的设计是 key、value 的键值对的形式,下面让我们来看下 Redis 的使用

安装 Redis

以 windows 系统为例,github.com/MicrosoftAr…点击进去下载

Vue3 + Nest 实现权限管理系统后端篇（六）:如何在 NestJS 中使用 redis

这两个其中一个即可,我这里选择 zip 包,下载完成解压

Vue3 + Nest 实现权限管理系统后端篇（六）:如何在 NestJS 中使用 redis

点击redis-server.exe即可启动 redis,看到下面这个界面就说明启动成功了

Vue3 + Nest 实现权限管理系统后端篇（六）:如何在 NestJS 中使用 redis

点击redis-cli.exe可以打开 redis 的交互命令界面,在这里可以操作 redis,比如设置一个 key 为 a,值为 1 的键值对以及获取 key 为 a 的值

Vue3 + Nest 实现权限管理系统后端篇（六）:如何在 NestJS 中使用 redis

接下来我们就可以在 NestJS 中使用 Redis 了

NestJS 中使用 Redis

安装'redis'

npm i redis

一般我们会给对 redis 的操作单独建一个模块,后面有哪些模块需要使用 redis 直接引入这个模块即可,这里我们将模块命名为 cache,使用 nestcli 命令创建

nest g res cache

创建完成之后在cache.module.ts中引入redis,且自定义一个名为'REDIS_CLIENT'的 provider,同时将 CacheService 导出,因为要给别的模块使用

//cache.module.ts
import { Module } from '@nestjs/common';
import { CacheService } from './cache.service';
import { createClient } from 'redis';

@Module({
  providers: [
    CacheService,
    {
      provide: 'REDIS_CLIENT',
      async useFactory() {
        const client = createClient({
          socket: {
            host: process.env.RD_HOST,
            port: parseInt(process.env.RD_PORT),
          },
        });
        await client.connect();
        return client;
      },
    },
  ],
  exports: [CacheService],
})
export class CacheModule {}

其中 redis 的 host 和 port 我们放在了配置文件.env中了

# redis配置
RD_HOST=localhost
RD_PORT=6379

在cache.service.ts通过Inject注入REDIS_CLIENT,然后写写一下操作 redis 的方法

import { Inject, Injectable } from '@nestjs/common';
import { RedisClientType } from 'redis';
@Injectable()
export class CacheService {
  constructor(@Inject('REDIS_CLIENT') private redisClient: RedisClientType) {}
  //获取值
  async get(key) {
    let value = await this.redisClient.get(key);
    try {
      value = JSON.parse(value);
    } catch (error) {}
    return value;
  }
  /**
   * 设置值
   * @param key {string} key
   * @param value 值
   * @param second 过期时间 秒
   * @returns Promise<any>
   */
  async set(key: string, value: any, second?: number) {
    value = JSON.stringify(value);
    return await this.redisClient.set(key, value, { EX: second });
  }
  //删除值
  async del(key: string) {
    return await this.redisClient.del(key);
  }
  //清除缓存
  async flushall() {
    return await this.redisClient.flushAll();
  }
}

由于 Redis 不能存储 JS 中的对象,所以需要转成字符串的形式,获取的时候再用JSON.parse转成对象(转不了的话就原样返回)

接下来我们在其它模块中引入试一下

redis 模块的使用

以 user 模块为例,在user.module.ts导入CacheModule

//这里省略n
import { CacheModule } from 'src/cache/cache.module';
@Module({
  imports: [CacheModule],
})
export class UserModule {}

在user.service.ts使用,我们有user/test进行测试

//此处省略n
import { CacheService } from 'src/cache/cache.service';
@Injectable()
export class UserService {
  constructor(
    ...
    private cacheService: CacheService,
  ) {}

  async test(testParams) {
    return await this.cacheService.set('name','dfxy');
  }