Nodejs Nestjs限流插件nestjs-throttler的使用

Nodejs Nestjs限流插件nestjs-throttler的使用
nestjs-throttler 是一个用于 NestJS 应用程序的限流插件，它可以帮助你限制在一定时间内的请求次数，以防止滥用或 DDoS 攻击。下面是如何安装和配置 nestjs-throttler 的步骤：

1. 安装 nestjs-throttler

首先，你需要安装 nestjs-throttler 包及其依赖项。你可以使用 npm 或 yarn 来安装：

npm install @nestjs/throttler @nestjs/common

或者

yarn add @nestjs/throttler @nestjs/common

2. 配置 ThrottlerModule

接下来，在你的应用程序中配置 ThrottlerModule。通常，你可以在主模块（通常是 AppModule）中进行配置。

import { ThrottlerModule, ThrottlerGuard } from '@nestjs/throttler';
import { Module, UseGuards } from '@nestjs/common';

@Module({
  imports: [
    ThrottlerModule.forRoot({
      ttl: 60, // 允许请求的时间窗口（秒）
      limit: 10, // 在时间窗口内允许的最大请求数
    }),
  ],
  providers: [ThrottlerGuard],
})
export class AppModule {}

3. 使用 ThrottlerGuard

你可以通过装饰器来应用限流策略到特定的路由或控制器。

全局应用限流策略

如果你想为整个应用程序的所有路由应用限流策略，可以在全局级别注册 ThrottlerGuard：

import { ThrottlerModule, ThrottlerGuard } from '@nestjs/throttler';
import { Module, UseGuards } from '@nestjs/common';

@Module({
  imports: [ThrottlerModule.forRoot()],
  providers: [ThrottlerGuard],
})
export class AppModule {
  configure(consumer: MiddlewareConsumer) {
    consumer.apply(ThrottlerGuard).forRoutes('*');
  }
}

局部应用限流策略

你也可以为特定的控制器或路由应用限流策略：

import { Controller, Get, UseGuards } from '@nestjs/common';
import { ThrottlerGuard } from '@nestjs/throttler';

@Controller('api')
@UseGuards(ThrottlerGuard)
export class ApiController {
  @Get()
  getHello(): string {
    return 'Hello World!';
  }
}

4. 自定义限流策略

如果你需要更细粒度的控制，可以自定义限流策略。例如，你可以基于 IP 地址或其他标识符来限制请求：

import { ThrottlerModule, ThrottlerGuard } from '@nestjs/throttler';
import { Module, UseGuards } from '@nestjs/common';

@Module({
  imports: [
    ThrottlerModule.forRoot({
      ttl: 60,
      limit: 10,
      ignoreUserAgent: false, // 是否忽略 User-Agent
    }),
  ],
  providers: [ThrottlerGuard],
})
export class AppModule {}

5. 测试

确保你的应用程序正常运行，并且限流策略按预期工作。你可以尝试多次访问受保护的路由，看看是否会在达到限制后被阻止。

以上就是如何在 NestJS 中使用 nestjs-throttler 插件的基本步骤。希望这对你有所帮助！


3 回复

当然，了解nestjs-throttler插件能让您的应用更健壮！想象一下，您正在经营一家在线咖啡店，突然间，成千上万的顾客同时想品尝您的招牌拿铁。为了避免服务器崩溃，就像避免咖啡溢出一样重要，nestjs-throttler就是您的防溢盖。

首先，确保安装了@nestjs/throttler和@nestjs/common：

npm install @nestjs/throttler @nestjs/common

接着，在您的应用模块中启用它，就像给咖啡机加水：

import { ThrottlerModule } from '@nestjs/throttler';

@Module({
  imports: [
    ThrottlerModule.forRoot({
      ttl: 60, // 每分钟内允许的请求数
      limit: 100, // 允许的最大请求数
    }),
  ],
})
export class AppModule {}

现在，为特定路由设置限流，就像为特别受欢迎的咖啡设置优先级：

import { Throttle } from '@nestjs/throttler';

@Controller('coffee')
export class CoffeeController {
  @Get()
  @Throttle(5, 60) // 每分钟最多5次请求
  findAll() {
    return 'Here is your coffee!';
  }
}

这样，当顾客们蜂拥而至时，您的应用仍然能优雅地处理请求，而不是像未盖盖子的咖啡壶一样喷涌而出。


nestjs-throttler 是一个用于 NestJS 的限流中间件插件。它可以帮助你在 API 端点上实现限流策略，防止滥用和 DDoS 攻击。以下是如何使用 nestjs-throttler 的步骤。

1. 安装 nestjs-throttler

首先，你需要安装 nestjs-throttler 插件以及相关的依赖项：

npm install @nestjs/throttler

2. 配置 ThrottlerModule

接下来，在你的应用程序中配置 ThrottlerModule。你可以在 AppModule 中进行全局配置，或者为特定的控制器或方法单独配置。

全局配置

在 AppModule 中引入 ThrottlerModule 并进行全局配置：

import { Module } from '@nestjs/common';
import { ThrottlerModule } from '@nestjs/throttler';

@Module({
  imports: [
    ThrottlerModule.forRoot({
      ttl: 60, // 时间窗口（秒）
      limit: 100, // 最大请求数
    }),
  ],
})
export class AppModule {}

控制器或方法级别配置

你也可以在控制器或特定的方法级别上设置限流规则：

import { Controller, Get } from '@nestjs/common';
import { Throttle } from '@nestjs/throttler';

@Controller('example')
export class ExampleController {
  @Get()
  @Throttle(5, 60) // 每个IP地址每分钟最多5次请求
  get() {
    return { message: 'Hello World!' };
  }
}

3. 使用 ThrottleGuard

如果你需要在特定的路由上启用限流功能，你可以手动启用 ThrottleGuard。例如：

import { Controller, Get, UseGuards } from '@nestjs/common';
import { Throttle, ThrottleGuard } from '@nestjs/throttler';

@Controller('example')
@UseGuards(ThrottleGuard)
export class ExampleController {
  @Get()
  @Throttle(5, 60) // 每个IP地址每分钟最多5次请求
  get() {
    return { message: 'Hello World!' };
  }
}

总结

通过以上步骤，你可以在 NestJS 应用程序中使用 nestjs-throttler 来实现限流功能。你可以根据需要调整时间窗口 (ttl) 和最大请求数 (limit)，以适应不同的业务需求。

nestjs-throttler 是一个用于 NestJS 的限流插件。首先，你需要安装它：

npm install @nestjs/throttler throttler

然后，在你的模块中配置 ThrottlerModule：

import { ThrottlerModule } from '@nestjs/throttler';

@Module({
  imports: [
    ThrottlerModule.forRoot({
      ttl: 60, // 时间窗口（秒）
      limit: 10, // 限制请求数量
    }),
  ],
})
export class AppModule {}

你可以为特定路由添加限流：

import { ThrottlerGuard } from '@nestjs/throttler';
import { UseGuards } from '@nestjs/common';

@Controller('example')
@UseGuards(ThrottlerGuard)
export class ExampleController {
}

这样就为 example 控制器下的所有路由设置了限流规则。

回到顶部