NestJS核心概念之Middleware中间件创建使用示例

更新时间：2023年08月29日 09:17:50 作者：南玖

这篇文章主要为大家介绍了NestJS核心概念之Middleware中间件创建使用示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

前言

用过express与koa的同学，对中间件这个概念应该非常熟悉了，中间件可以拿到Request、Response对象和next函数.

一般来讲中间件有以下作用：

执行任何代码
对请求与响应拦截并改造
结束request-response周期
通过next()调用下一个中间件
如果当前中间件没有结束当前request-response周期，必须调用next()函数，否则请求会处于挂起状态，阻塞整个应用

中间件一般有两种：类中间件、函数中间件

类中间件

创建类中间件

使用@Injectable()装饰器，并且需要实现NestMiddleware接口（use方法）

// Logger.middleware.ts
import { Injectable, NestMiddleware } from "@nestjs/common";
import { Request, Response } from "express";
@Injectable()
export class LoggerMiddleware implements NestMiddleware {
    use(req: Request, res: Response, next: () => void) {
        console.log('logger middleware', `url: ${req.url}`);
        next();
    }
}

使用类中间件

类中间创建完之后，需要在模块中进行挂载，但@Module装饰器并没有中间件的相关配置，我们需要让module类实现NestModule接口，实现里面configure方法来进行挂载

// user.module.ts
import { Module, NestModule } from '@nestjs/common';
import { UserService } from './user.service';
import { UserController } from './user.controller';
import { LoggerMiddleware } from '../middleware/Logger.middleware';
@Module({
  controllers: [UserController],
  providers: [UserService]
})
export class UserModule implements NestModule {
  configure(consumer) {
    consumer
      .apply(LoggerMiddleware)
      .forRoutes(UserController);
  }
}

apply方法表示挂载的是哪个中间件
forRoutes方法表示对哪个请求路径起作用，这种方式与app.use(path, middleware)作用是一样，只针对部分路径起作用
当给forRoutes方法传递的是一个controller控制器时，那么该中间件则对整个控制器下的路径生效

比如这里传递的是UserController控制器，那么针对该控制器下的路径都会生效

forRootes方法还能做更详细的配置，比如可以针对特定的请求方法、请求路径可以使用正则匹配（需要注意的是使用fastify驱动不能使用）

export class UserModule implements NestModule {
  configure(consumer) {
    consumer
      .apply(LoggerMiddleware)
      .forRoutes({ path: 'user', method: RequestMethod.GET});
  }
}

apply可以同时挂载多个中间件

export class UserModule implements NestModule {
  configure(consumer) {
    consumer
      .apply(LoggerMiddleware, aaaMiddleware, ...)
      .forRoutes({ path: 'user', method: RequestMethod.GET});
  }
}

forRoutes可以使用单个string路径，多个string路径，RouteInfo对象，单个Controller，多个Controller

export class AppModule implements NestModule {
  configure(consumer) {
    consumer
      .apply(LoggerMiddleware, NjMiddleware, ...)
      .forRoutes(UserController, NjController, ...);
  }
}

exclude可以用来排除不使用中间件的路径

export class UserModule implements NestModule {
  configure(consumer) {
    consumer
      .apply(LoggerMiddleware)
      .exclude({ path: '/user/a', method: RequestMethod.GET})
      .forRoutes(UserController);
  }
}

需要注意的是forRoutes需要最后调用

函数中间件

这种方式较为简单，使用起来与类中间件一致

创建函数中间件

export function LoggerMiddleware(req: Request, res: Response, next: () => void) {
    console.log('logger middleware', `url: ${req.url}`);
    next();
}

使用函数中间件

export class UserModule implements NestModule {
  configure(consumer) {
    consumer
      .apply(LoggerMiddleware)
      .exclude({ path: '/user/a', method: RequestMethod.GET})
      .forRoutes(UserController);
  }
}

全局中间件

可以直接在入口文件main.ts中使用app.use来挂载中间件，这样挂载的中间件将全局生效

app.use(LoggerMiddleware) // 日志中间件

中间件其实可以用来实现很多功能，比如：日志系统、cors跨域处理、图片防盗等...

对图片防盗感兴趣的可以看我这篇文章：你不知道的 HTTP Referer

以上就是NestJS核心概念之Middleware中间件创建使用示例的详细内容，更多关于NestJS Middleware中间件的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

Node使用Puppeteer监听并打印网页的接口请求
Puppeteer 是一个 Node 库,它提供了高级的 API 来通过 DevTools 协议控制 Chrome 或 Chromium,本文我们就来看看如何使用Puppeteer监听并打印网页的接口请求吧
2025-04-04
Node解决简单重复问题系列之Excel内容的获取
这篇文章主要给大家介绍了关于利用Node解决简单重复问题系列之Excel内容获取的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习吧。
2018-01-01
Node.js实现前端后端数据传输加密解密
这篇文章主要介绍了Node.js实现前端后端数据传输加密解密，文章围绕主题展开详细的内容介绍，具有一定的参考价值，需要的小伙伴可以参考一下
2022-08-08
使用nvm安装|更新|切换|nodejs的命令详解
这篇文章主要介绍了使用nvm安装|更新|切换|nodejs的命令详解,有了nvm就可以简单操作node版本的切换、安装、查看等，需要的朋友可以参考下
2022-07-07
轻松创建nodejs服务器（7）：阻塞操作的实现
这篇文章主要介绍了轻松创建nodejs服务器（7）：阻塞操作的实现,本文先是组出了代码,然后对代码一一分析,需要的朋友可以参考下
2014-12-12
Node.js插件安装图文教程
Node.js是一个基于Chrome JavaScript运行时建立的平台，用于方便地搭建响应速度快、易于扩展的网络应用。本文给大家介绍Node.js插件安装的教程，非常实用，特此分享给大家，需要的朋友一起学习吧
2016-05-05
Node.js中的不安全跳转如何防御详解
安全是不容忽视的，每个开发者都知道它非常重要，真正严肃对待它的却没有几人。下面这篇文章主要给大家介绍了关于Node.js中不安全跳转如何防御的相关资料，文中通过示例代码介绍的非常详细。需要的朋友可以参考下
2018-10-10
Nodejs异步回调之异常处理实例分析
这篇文章主要介绍了Nodejs异步回调之异常处理,结合实例形式分析了nodejs基于中间件进行异步回调异常处理过程出现的问题与相应的解决方法,需要的朋友可以参考下
2018-06-06
npm i报错以及解决方案实战案例
npm在前端开发流程中提供了非常完善的自动化工具链,但是同样由于其复杂性导致有很多奇奇怪怪的问题,下面这篇文章主要给大家介绍了关于npm i报错以及解决方案的相关资料,需要的朋友可以参考下
2022-07-07
使用nodejs + koa + typescript 集成和自动重启的问题
这篇文章主要介绍了nodejs + koa + typescript 集成和自动重启,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2021-12-12