Express Slow Down 项目启动与配置教程

1. 项目的目录结构及介绍

express-slow-down 是一个基于 Express 的中间件，用于减缓重复请求而不是直接阻止它们。项目的目录结构如下：

• .gitattributes: 定义 Git 仓库的属性。
• .gitignore: 指定 Git 忽略的文件和目录。
• .npmrc: npm 配置文件。
• .prettierignore: Prettier 忽略文件。
• changelog.md: 记录项目更新和修改历史。
• jest.config.json: Jest 测试配置文件。
• license.md: 项目许可证信息。
• package-lock.json: npm 包锁文件，确保安装的依赖与当前项目兼容。
• package.json: 项目包描述文件，包含项目信息和依赖。
• readme.md: 项目说明文件。
• tsconfig.json: TypeScript 配置文件。

此外，还包括以下目录：

• config/: 存放配置文件。
• husky/: 使用 Husky 工具的配置文件，用于在提交代码前执行脚本。
• source/: 源代码目录。
• test/: 测试代码目录。

2. 项目的启动文件介绍

项目的启动通常是通过 package.json 中的脚本实现的。以下是一个基本的启动脚本示例：

{
  "scripts": {
    "start": "node index.js"
  }
}

在这里，index.js 是项目的入口文件。当你运行 npm start 命令时，Node.js 将会执行这个文件。

index.js 的内容可能如下：

const express = require('express');
const slowDown = require('express-slow-down');

const app = express();

const limiter = slowDown({
  windowMs: 15 * 60 * 1000, // 15 minutes
  delayAfter: 5, // Allow 5 requests per 15 minutes.
  delayMs: (hits) => hits * 100 // Add 100 ms of delay to every request after the 5th one.
});

app.use(limiter);

app.get('/', (req, res) => {
  res.send('Hello, World!');
});

const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
  console.log(`Server is running on port ${PORT}`);
});

这段代码创建了一个 Express 应用，并使用 express-slow-down 中间件来减缓请求。

3. 项目的配置文件介绍

express-slow-down 的配置通常在创建中间件实例时进行。如上例所示，limiter 是通过调用 slowDown() 函数并传入配置对象创建的。

以下是一些常见的配置选项：

• windowMs: 用于检查/记住请求的时间框架（以毫秒为单位）。
• delayAfter: 在开始延迟响应之前允许的最大请求次数。
• delayMs: 达到限制后的延迟时间（以毫秒为单位）。
• maxDelayMs: 延迟时间的绝对最大值。

例如：

const limiter = slowDown({
  windowMs: 15 * 60 * 1000, // 15分钟
  delayAfter: 5, // 在15分钟内允许5次请求
  delayMs: (hits) => hits * 1000, // 达到限制后每次请求增加1秒延迟
  maxDelayMs: 5000 // 最大延迟5秒
});

这个配置文件定义了请求的检查时间框架为15分钟，允许5次请求后开始延迟，每次额外的请求都会增加1秒的延迟时间，但延迟时间不会超过5秒。