NestJS核心概念之Middleware中間件創(chuàng)建使用示例
更新時間：2023年08月29日 09:17:50 作者：南玖
這篇文章主要為大家介紹了NestJS核心概念之Middleware中間件創(chuàng)建使用示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪
前言
用過express與koa的同學(xué)，對中間件這個概念應(yīng)該非常熟悉了，中間件可以拿到Request、Response對象和next函數(shù).
一般來講中間件有以下作用：
- 執(zhí)行任何代碼
- 對請求與響應(yīng)攔截并改造
- 結(jié)束
request-response周期 - 通過
next()調(diào)用下一個中間件 - 如果當(dāng)前中間件沒有結(jié)束當(dāng)前
request-response周期，必須調(diào)用next()函數(shù)，否則請求會處于掛起狀態(tài)，阻塞整個應(yīng)用
中間件一般有兩種：類中間件、函數(shù)中間件
類中間件
創(chuàng)建類中間件
使用@Injectable()裝飾器，并且需要實現(xiàn)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();
}
}使用類中間件
類中間創(chuàng)建完之后，需要在模塊中進行掛載，但@Module裝飾器并沒有中間件的相關(guān)配置，我們需要讓module類實現(xiàn)NestModule接口，實現(xiàn)里面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)作用是一樣，只針對部分路徑起作用- 當(dāng)給
forRoutes方法傳遞的是一個controller控制器時，那么該中間件則對整個控制器下的路徑生效
比如這里傳遞的是UserController控制器，那么針對該控制器下的路徑都會生效
forRootes方法還能做更詳細(xì)的配置，比如可以針對特定的請求方法、請求路徑可以使用正則匹配（需要注意的是使用fastify驅(qū)動不能使用）
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需要最后調(diào)用
函數(shù)中間件
這種方式較為簡單，使用起來與類中間件一致
創(chuàng)建函數(shù)中間件
export function LoggerMiddleware(req: Request, res: Response, next: () => void) {
console.log('logger middleware', `url: ${req.url}`);
next();
}使用函數(shù)中間件
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) // 日志中間件
中間件其實可以用來實現(xiàn)很多功能，比如：日志系統(tǒng)、cors跨域處理、圖片防盜等...
對圖片防盜感興趣的可以看我這篇文章：你不知道的 HTTP Referer
以上就是NestJS核心概念之Middleware中間件創(chuàng)建使用示例的詳細(xì)內(nèi)容，更多關(guān)于NestJS Middleware中間件的資料請關(guān)注腳本之家其它相關(guān)文章！
相關(guān)文章
本文記錄了在項目中使用node.js請求favican.ico的時候會出現(xiàn)2條請求，浪費資源，經(jīng)過一番改進，記錄下來過程，以后注意。2014-12-12
Node.js + Redis Sorted Set實現(xiàn)任務(wù)隊列
本文給大家分享的是使用Node.js + Redis Sorted Set實現(xiàn)任務(wù)隊列的方法示例，非常的實用，有需要的小伙伴可以參考下2016-09-09
這篇文章主要介紹了node.js中的buffer.copy方法使用說明,本文介紹了buffer.copy的方法說明、語法、接收參數(shù)、使用實例和實現(xiàn)源碼,需要的朋友可以參考下2014-12-12
這篇文章主要介紹了使用node打造自己的命令行工具方法教程，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2018-03-03
這篇文章主要介紹了Express定制路由,結(jié)合實例形式分析了express框架定制路由原理、用法及相關(guān)注意事項,需要的朋友可以參考下2023-05-05
Node.js中使用Log.io在瀏覽器中實時監(jiān)控日志（等同tail -f命令）
這篇文章主要介紹了Node.js中使用Log.io在瀏覽器中實時監(jiān)控日志,Log.io等同于tail -f命令,但更強大,需要的朋友可以參考下2014-09-09
本文通過nodejs的一個具體示例來對比分析現(xiàn)階段我們交社保合不合適，主要是對nodejs的一個小的應(yīng)用，當(dāng)然大家也可以改成其他語言的，程序猿們，來算算吧。2015-03-03
這篇文章主要給大家介紹了關(guān)于yarn的使用與利用yarn升級Node.js的方法，文中介紹的非常詳細(xì)，對大家具有一定的參考學(xué)習(xí)價值，需要的朋友們下面來一起看看吧。2017-06-06
從零開始學(xué)習(xí)Node.js系列教程六：EventEmitter發(fā)送和接收事件的方法示例
這篇文章主要介紹了Node.js EventEmitter發(fā)送和接收事件的方法,結(jié)合實例形式分析了EventEmitter發(fā)送和接收事件的原理、實現(xiàn)方法與相關(guān)操作技巧,需要的朋友可以參考下2017-04-04
這篇文章主要為大家詳細(xì)介紹了基于nodejs實現(xiàn)微信支付功能，具有一定的參考價值，感興趣的小伙伴們可以參考一下2017-12-12