Node 系列（六）使用 Redis

什么是 Redis

Redis 是一款内存高速缓存数据库。Redis 是一个 key-value 存储系统（建值存储系统），支持丰富的数据类型，如：字符串、哈希、列表、集合、有序集合。

下载和启动

Redis 下载镜像和 MySQL 类似，也是去 【 Docker 】里下载

下载

$ docker pull redis:7.0.0

启动

$ docker run --name myRedis -d -p 6379:6379 -v /Users/gladysdrea/Applications/Docker/myRedis:/data redis:7.0.0

我们可以使用 “Another Redis Desktop Manager” 这个软件来查看 Redis 数据库。
这里我们同样做个数据持久化，Redis 的数据持久化是放在 /data 中的

在 MidWay 中使用 Redis

安装依赖

@midwayjs/redis 是主要的功能包，@types/ioredis 是 定义包。

$ npm i @midwayjs/redis@3 --save
$ npm i @types/ioredis --save-dev           // 安装到 dev 依赖

引入组件

在 src/configuration.ts 中导入

// src/configuration.ts
import * as redis from '@midwayjs/redis';

@Configuration({
  imports: [
    // 导入 redis 组件
    redis       
  ],
  importConfigs: [
    join(__dirname, 'config')
  ]
})

配置 Redis

// src/config/config.default.ts
export default {
  // ...
  redis: {
    client: {
      port: 6379,         // Redis port
      host: '127.0.0.1', // Redis host
      password: '',      // Redis 默认不需要密码，所以如果启动的时候没有设置密码的话，这里可以不填密码
      db: 0,
    },
  },
}

使用 Redis 服务

我们可以在任意代码中使用 Redis 服务。

// 一般情况下，我们在 Service 层去使用 Redis，当然其他文件也可以使用
import { RedisService } from '@midwayjs/redis';

@Provide('')
export class UserService {
  // 通过 @Inject 注入，之后就可以使用 Redis 了
  @Inject()
  redisService: RedisService;
}

• 设置

  await this.redisService.set('name', 'Avery')
  /*
    * 如果有需要的话，我们可以先使用 JSON.stringify() 序列化一下
   */
  const list = [
    {
      name: '测试'
    },
    {
      name: '测试'
    }
  ]
  await this.redisService.set('list', JSON.stringify(list))
  /*
    * 也可以设置过期时间，单位：秒
   */
  await redisService.set('name', 'Avery', 'EX', 1000);

• 获取

  const result = await this.redisService.get('name');

• 删除

  await this.redisService.del('name');

  了解了 Redis 的使用和方法之后，我们就可以使用 Redis 来存储热点数据。可以结合 expire ，设置过期时间（上边有介绍设置过期时间的方法），这些是也是项目中最常用的。
  我们来结合一个小需求来具体的运用一下：
  需求：
• 用户登录后，把用户信息存到 Redis 里，下次登录的时候，如果 Redis 有该用户的信息，直接从 Redis 中取。
• 删除用户时，把 Redis 中的该用户信息也删掉

首先，先写一个登录的 Service

// src/service/userService.ts
async findUserByName(name: string, pwd: string) {
  // 先查 Redis , 看是否有该用户
  const result = await this.redisService.get(name);
  if (!result) {
    /*
    * Redis 中不存在，先去查 MySQL 库，
    * 如果 MySQL 中有，就存到 Redis 中，
    * 如果 MySQL 中没有就说明没有该用户
    * */
    const user = await this.userModel
      .createQueryBuilder('user')
      .select()
      .where('user.name = :name', { name: `${name}` })
      .getOne();
    this.logger.info(user, 'user');
    if (user != null) {
      // MySQL 中有该用户，把用户信息放到 Redis 中，下次直接从 Redis 中获取
      await this.redisService.set(name, JSON.stringify(user));
      return user;
    } else {
      // MySQL 中没有该用户，说明用户不存在
      return null;
    }
  } else {
    // Redis 中有该用户，return 用户信息即可
    const res = await this.redisService.get(name);
    return JSON.parse(res);
  }
}

接下来，开始写登录的路由了

// src/controller/user.controller.ts
@Post('/login')
  async loginUser(@Body() user: User) {
  // 调用 Service 中的 findUserByName 方法
    const result = await this.user.findUserByName(user.name, user.password);
    const token = await this.jwt.sign({
      username: user.name,
      password: user.password,
    });
    this.logger.info(result, 'result');
    if (result != null) {
      // 用户登录成功，把 token 返回给客户端
      return ResultRtn.ofSuccess(token);
    } else {
      // 如果 findUserByName 方法返回的是 null ，则说明用户不存在，返回错误信息给客户端
      return ResultRtn.of(401, '用户不存在', result);
    }
  }

这样，第一个小需求就完成了，可以去 Redis 中查看一下保存的数据，如下图。接下来，我们继续第二个小需求，删除 Redis 中的数据

同样的，我们在 Service 中写一个删除的方法，在 Controller 中写一个删除的路由，这样在调用删除接口的时候，MySQL 和 Redis 中的数据就都被删除了。

// 删除数据
 async deleteUser(nameDel) {
   const user = await this.userModel.query(
     `SELECT * from user WHERE name='${nameDel}'`
   );
   await this.redisService.del(nameDel);
   await this.userModel.remove(user);
 }

@Get('/del')
  async userDel(@Query('name') name: string) {
    const result = await this.user.deleteUser(name);
    return ResultRtn.ofSuccess(result);
  }

我们发现， Redis 的增、删、查都有了，那更新呢，其实 Redis 中更新数据的话，直接把之前的数据删除重新添加就可以了。
此外 Redis 还可以实现排行榜、计数器、分布式锁等，可根据业务需求，灵活运用。

• 本文作者： Gladysdrea
• 本文链接： https://gladysdrea.github.io/blogs/2022/05/18/Node系列/Node系列(六)使用Redis/
• 版权声明： 本博客所有文章除特别声明外，均采用 MIT 许可协议。转载请注明出处！