写一个手写基于NestJS的限流器，用滑动时间窗口算法轻松拒绝请求！

2023-01-24 17:30:02

限流：保障应用程序稳定性的关键

在当今以网络为中心的时代，应用程序面临着来自大量用户请求的持续压力。如果没有适当的机制来管理这些请求，应用程序可能会超负荷，导致响应缓慢、甚至完全不可用。这就是限流器的用武之地。限流器是一种保护应用程序免受请求洪峰侵袭的工具，它通过控制一段时间内允许的请求数量来实现这一目的。

滑动时间窗口算法：精准控制请求数量

滑动时间窗口算法是一种广受欢迎的限流算法，因为它可以准确地限制一段时间内的请求数量。它将时间分成多个固定长度的时间窗口，每个窗口都有自己的请求数量限制。当一个请求到达时，算法会检查当前时间窗口的请求数量是否超过了限制。如果超过了限制，则拒绝该请求；如果未超过限制，则允许该请求通过。

滑动时间窗口算法的优点在于，它能够准确地限制一段时间内的请求数量，同时避免误判。这是因为时间窗口是固定的，不会随着时间的推移而改变。因此，算法不会出现误判的情况，例如，在某个时间段内突然出现大量请求，导致算法误判为超过了限制，而拒绝所有请求。

NestJS Guard：轻松实现限流功能

NestJS是一个流行的Node.js框架，它提供了许多有用的特性来帮助开发人员快速构建Web应用程序。其中一个特性就是Guard，Guard可以用来限制对应用程序某些路由的访问。我们可以利用这个特性来实现限流器。

import { Injectable, CanActivate, ExecutionContext } from '@nestjs/common';

@Injectable()
export class RateLimiterGuard implements CanActivate {
  async canActivate(context: ExecutionContext): Promise<boolean> {
    // 获取请求对象
    const request = context.switchToHttp().getRequest();

    // 根据请求 IP 获取请求数量
    const count = await this.redisClient.get(`rate-limiter:${request.ip}`);

    // 如果请求数量超过限制，则拒绝请求
    if (count >= 10) {
      return false;
    }

    // 增加请求数量
    this.redisClient.incr(`rate-limiter:${request.ip}`);

    // 设置请求数量的过期时间
    this.redisClient.expire(`rate-limiter:${request.ip}`, 60);

    // 允许请求通过
    return true;
  }
}

Redis和Lua脚本：高效处理限流请求

Redis是一个流行的键值数据库，它提供了许多有用的特性，包括原子操作、持久化和Lua脚本支持。我们可以利用Redis的Lua脚本支持来实现限流器。Lua脚本可以原子地执行一系列操作，这对于限流器来说非常重要。

实战教程：一步一步打造限流器

现在，让我们一步一步来创建一个基于NestJS、Redis和Lua脚本的限流器：

1. 安装依赖

首先，我们需要安装NestJS、Redis和Lua脚本的依赖：

npm install nestjs redis ioredis lua-script

2. 创建NestJS应用程序

接下来，我们需要创建一个NestJS应用程序：

nest new nestjs-rate-limiter

3. 创建Guard

现在，我们需要创建一个Guard来限制对应用程序某些路由的访问：

nest generate guard rate-limiter

4. 实现限流逻辑

在Guard中，我们需要实现限流逻辑：

import { Injectable, CanActivate, ExecutionContext } from '@nestjs/common';
import { ClientProxyFactory, Transport, ClientProxy } from '@nestjs/microservices';
import * as redis from 'redis';

@Injectable()
export class RateLimiterGuard implements CanActivate {
  private readonly client: ClientProxy;
  private readonly redisClient: redis.RedisClient;

  constructor() {
    this.client = ClientProxyFactory.create({
      transport: Transport.REDIS,
      options: {
        url: 'redis://localhost:6379',
      },
    });

    this.redisClient = redis.createClient({
      host: 'localhost',
      port: 6379,
    });
  }

  async canActivate(context: ExecutionContext): Promise<boolean> {
    // 获取请求对象
    const request = context.switchToHttp().getRequest();

    // 根据请求 IP 获取请求数量
    const count = await this.redisClient.get(`rate-limiter:${request.ip}`);

    // 如果请求数量超过限制，则拒绝请求
    if (count >= 10) {
      return false;
    }

    // 增加请求数量
    this.redisClient.incr(`rate-limiter:${request.ip}`);

    // 设置请求数量的过期时间
    this.redisClient.expire(`rate-limiter:${request.ip}`, 60);

    // 允许请求通过
    return true;
  }
}

5. 应用Guard

现在，我们需要将Guard应用到应用程序的某些路由上：

import { Controller, Get, UseGuards } from '@nestjs/common';
import { RateLimiterGuard } from './rate-limiter.guard';

@Controller()
export class AppController {
  @Get()
  @UseGuards(RateLimiterGuard)
  getHello(): string {
    return 'Hello World!';
  }
}