脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 网络编程 → JavaScript → node.js → NestJS Middleware中间件

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.js中将SVG图像转换为PNG，JPEG，TIFF，WEBP和HEIF格式的方法

    在Node.js中将SVG图像转换为PNG，JPEG，TIFF，WEBP和HEIF格式的方法

    这篇文章主要介绍了在Node.js中将SVG图像转换为PNG，JPEG，TIFF，WEBP和HEIF格式的方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2019-08-08
  • 详解NodeJS模块化

    详解NodeJS模块化

    简单的说Node.js就是运行在服务端的JavaScript。Node.js是一个基于Chrome JavaScript运行时建立的一个平台。Node.js是一个事件驱动I/O服务端JavaScript环境，基于Google的V8引擎，V8引擎执行Javascript的速度非常快，性能非常好
    2021-06-06
  • Node.js基于cors解决接口跨域的问题(推荐)

    Node.js基于cors解决接口跨域的问题(推荐)

    这篇文章主要介绍了Node.js基于cors解决接口跨域的问题,本文通过示例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
    2022-08-08
  • NodeJS连接MySQL数据库并进行增删改查操作详解

    NodeJS连接MySQL数据库并进行增删改查操作详解

    本篇是使用NodeJS的模块MySQL操作MySQL数据库的基础教程,连接MySQL数据库并进行增删改查操作详解,需要的朋友可以参考下
    2024-02-02
  • nodejs二进制与Buffer的介绍与使用

    nodejs二进制与Buffer的介绍与使用

    这篇文章主要给大家介绍了关于nodejs二进制与Buffer的相关资料，文中通过示例代码介绍的非常详细，对大家学习或者使用nodejs具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧
    2019-07-07
  • 基于Express+multer实现文件上传功能

    基于Express+multer实现文件上传功能

    Multer是Node.js中的一个第三方包,或者说是第三方中间件,主要用于是实现文件上传的功能,本文小编讲给大家详细介绍一下基于Express+multer来实现文件上传功能,文章通过代码示例和图文介绍的非常详细,需要的朋友可以参考下
    2023-11-11
  • Nodejs学习笔记之NET模块

    Nodejs学习笔记之NET模块

    之前两篇文章基本上都是给我们介绍的nodejs的理论基础，今天我们来点干货，先从NET模块开始讲起吧。
    2015-01-01
  • node通过express搭建自己的服务器

    node通过express搭建自己的服务器

    本篇文章主要介绍了node通过express搭建自己的服务器 ，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2017-09-09
  • Node.js 的 GC 机制详解

    Node.js 的 GC 机制详解

    随着 Node 的发展，JavaScript 的应用场景早已不再局限在浏览器中。但随着 Node 在服务端的广泛应用，JavaScript 的内存管理需要引起我们的重视。下面我们来一起学习一下吧
    2019-06-06
  • 如何优雅地在Node应用中进行错误异常处理

    如何优雅地在Node应用中进行错误异常处理

    这篇文章主要介绍了如何优雅地在Node应用中进行错误处理，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2019-11-11

最新评论