Nest.js 中如何创建中间件？

推荐答案

在 Nest.js 中，创建中间件可以通过以下步骤实现：

1. 使用 @Injectable() 装饰器定义一个类，并实现 NestMiddleware 接口。
2. 实现 use 方法，该方法接收 Request、Response 和 NextFunction 作为参数。
3. 在模块中注册中间件，可以通过 configure 方法在模块类中配置中间件。

示例代码如下：

// www.javascriptcn.com code example
import { Injectable, NestMiddleware } from '@nestjs/common';
import { Request, Response, NextFunction } from 'express';

@Injectable()
export class LoggerMiddleware implements NestMiddleware {
  use(req: Request, res: Response, next: NextFunction) {
    console.log('Request...');
    next();
  }
}

在模块中注册中间件：

// www.javascriptcn.com code example
import { Module, MiddlewareConsumer, NestModule } from '@nestjs/common';
import { LoggerMiddleware } from './logger.middleware';

@Module({})
export class AppModule implements NestModule {
  configure(consumer: MiddlewareConsumer) {
    consumer
      .apply(LoggerMiddleware)
      .forRoutes('*'); // 应用到所有路由
  }
}

本题详细解读

中间件的作用

中间件是 Nest.js 中处理请求和响应的一个重要机制。它可以在请求到达控制器之前或响应发送给客户端之前执行一些逻辑，例如日志记录、身份验证、请求验证等。

中间件的实现步骤

1. 定义中间件类：使用 @Injectable() 装饰器标记类，并实现 NestMiddleware 接口。NestMiddleware 接口要求实现 use 方法。
2. 实现 use 方法：use 方法是中间件的核心逻辑所在。它接收三个参数：
   • req：请求对象，包含客户端发送的请求信息。
   • res：响应对象，用于向客户端发送响应。
   • next：一个函数，调用它可以将控制权传递给下一个中间件或路由处理程序。
3. 注册中间件：在模块类中实现 NestModule 接口，并使用 configure 方法注册中间件。MiddlewareConsumer 提供了 apply 和 forRoutes 方法，用于指定中间件应用的路由。

中间件的应用场景

• 日志记录：记录每个请求的详细信息，如请求路径、请求方法、请求时间等。
• 身份验证：验证用户的身份，确保只有授权用户才能访问某些路由。
• 请求验证：验证请求体或查询参数是否符合预期格式。
• 错误处理：捕获并处理请求过程中发生的错误。

注意事项

• 中间件的执行顺序与注册顺序一致，因此需要注意中间件的注册顺序。
• 中间件可以应用于特定的路由，也可以应用于所有路由。
• 中间件可以异步执行，只需在 use 方法中使用 async/await 即可。

通过以上步骤，你可以在 Nest.js 中轻松创建和使用中间件，增强应用程序的功能和灵活性。