请解释 NestJS 的中间件 (Middleware) 的概念和用法。如何创建和使用中间件？-JavaScript中文网-JavaScript教程资源分享门户

推荐答案

NestJS 的中间件 (Middleware) 是一种在请求处理管道中执行的函数，它可以访问请求对象 (Request)、响应对象 (Response) 以及下一个中间件函数 (Next Function)。中间件通常用于执行一些通用的任务，如日志记录、请求验证、身份验证等。

创建中间件

在 NestJS 中，中间件可以通过实现 NestMiddleware 接口来创建。中间件类需要实现 use 方法，该方法接收 Request、Response 和 NextFunction 作为参数。

// 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();
  }
}

使用中间件

中间件可以在模块级别或路由级别应用。在模块级别应用中间件时，需要在模块类中实现 configure 方法，并使用 MiddlewareConsumer 来应用中间件。

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

@Module({
  controllers: [CatsController],
})
export class AppModule implements NestModule {
  configure(consumer: MiddlewareConsumer) {
    consumer
      .apply(LoggerMiddleware)
      .forRoutes('cats');
  }
}

在路由级别应用中间件时，可以直接在路由定义中使用 apply 方法。

// www.javascriptcn.com code example
import { Controller, Get, UseMiddleware } from '@nestjs/common';
import { LoggerMiddleware } from './logger.middleware';

@Controller('cats')
export class CatsController {
  @Get()
  @UseMiddleware(LoggerMiddleware)
  findAll() {
    return 'This action returns all cats';
  }
}

本题详细解读

中间件的概念

中间件是 NestJS 中处理请求和响应的一个重要机制。它允许开发者在请求到达控制器之前或响应发送给客户端之前执行一些操作。中间件可以用于多种场景，如日志记录、请求验证、身份验证、错误处理等。

中间件的执行顺序

中间件的执行顺序是按照它们在 MiddlewareConsumer 中应用的顺序来执行的。如果一个中间件调用了 next()，那么请求将继续传递给下一个中间件或最终的控制器处理程序。如果中间件没有调用 next()，请求处理流程将终止。

中间件的类型

NestJS 支持两种类型的中间件：

全局中间件：应用于所有路由的中间件。
路由中间件：应用于特定路由或路由组的中间件。

中间件的配置

中间件可以通过 MiddlewareConsumer 进行配置，MiddlewareConsumer 提供了 apply 和 forRoutes 方法来指定中间件应用的路由。

中间件的依赖注入

NestJS 的中间件支持依赖注入，这意味着你可以在中间件中使用其他服务或提供者。中间件类需要使用 @Injectable() 装饰器，并且可以通过构造函数注入依赖。

中间件的异步操作

中间件可以执行异步操作，如数据库查询、HTTP 请求等。你可以在 use 方法中使用 async/await 来处理异步操作。

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

@Injectable()
export class AsyncMiddleware implements NestMiddleware {
  async use(req: Request, res: Response, next: NextFunction) {
    await someAsyncOperation();
    next();
  }
}

中间件的错误处理

中间件可以捕获并处理错误。如果中间件中发生错误，可以通过调用 next(error) 将错误传递给 NestJS 的异常过滤器进行处理。

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

@Injectable()
export class ErrorHandlingMiddleware implements NestMiddleware {
  use(req: Request, res: Response, next: NextFunction) {
    try {
      // Some operation that might throw an error
      next();
    } catch (error) {
      next(error);
    }
  }
}