Nest.js - 如何對HttpModule(axios)添加攔截器

由于工作需要礁苗,需要對所有的Http請求添加統(tǒng)一的攔截器爬凑。查了不少文檔,繞了不少彎路试伙,也get到不少東西嘁信,特此記錄下。

搜了很多資料疏叨,大多數(shù)答案如下:

  export class AppModule implements OnModuleInit {

  constructor(private httpService: HttpService) { }

  public onModuleInit() {

    this.httpService.axiosRef.interceptors.request.use((req) => {
      console.log('request', req);

      return req;
    })

    this.httpService.axiosRef.interceptors.response.use((response) => {

      console.log('response', response);

      return response;
    });
  }
}

先不管這種解決方案是否正確潘靖,我們先來看下這部分代碼里面的知識點:

生命周期

同react一樣,nest.js中也存在生命周期蚤蔓,如圖所示:


image.png

簡單介紹下

鉤子方法 觸發(fā)鉤子方法調(diào)用的生命周期事件
OnModuleInit 初始化主模塊后調(diào)用
OnApplicationBootstrap 在應(yīng)用程序完全啟動并引導(dǎo)后調(diào)用
OnModuleDestroy 在Nest銷毀主模塊(app.close()方法之前進行清理)
beforeApplicationShutdown 在調(diào)用OnModuleDestroy()完成后(promise或者reject)觸發(fā)
OnApplicationShutdown 響應(yīng)系統(tǒng)信號(當(dāng)應(yīng)用程序關(guān)閉時卦溢,例如SIGTERM)

具體參考官網(wǎng)介紹

添加攔截器

由于Nest.js的HttpModule模塊底層使用的是axios,所以對HttpModule添加攔截器秀又,實際就是對axios添加攔截器单寂。看下面代碼:

axios.interceptors.request.use(function (config) {
    // 在發(fā)送請求之前做些什么
    //config是axios請求的參數(shù)
    return config;
  }, function (error) {
    // 對請求錯誤做些什么
    return Promise.reject(error);
  });

axios.interceptors.response.use(function (response) {
    // 對響應(yīng)數(shù)據(jù)做點什么
    // response 是請求回來的數(shù)據(jù)
    return response;
  }, function (error) {
    // 對響應(yīng)錯誤做點什么
    return Promise.reject(error)
  }
)

所以在Nest.js中對axios添加就有了如下代碼:

    this.httpService.axiosRef.interceptors.request.use((req) => {
      console.log('request', req);

      return req;
    })

    this.httpService.axiosRef.interceptors.response.use((response) => {

      console.log('response', response);

      return response;
    });

結(jié)合上面兩個知識點吐辙,我們就能看懂最初的那段代碼了凄贩。它就是想在AppModule啟動的時候,統(tǒng)一對httpService添加攔截器袱讹。
想法是好的疲扎,現(xiàn)實卻很殘酷昵时,我試了很久都不行,于是繼續(xù)搜椒丧,直接在一個issue中找到了一樣的代碼以及Nest開發(fā)人員的回復(fù)
Issue及回答

按照官方回答壹甥,將第一段代碼遷入到單獨的Module下面,果然就能攔截到請求壶熏。
可是這樣實在太麻煩句柠,每次都要寫一坨代碼。

于是就想到注入的方式棒假,搜了下github溯职,果然有人實現(xiàn)了。nest-axios-interceptor

下來我們基于它帽哑,來寫個攔截器谜酒,實現(xiàn)記錄axios請求響應(yīng)時間的功能。

import { HttpService, Injectable } from '@nestjs/common'
import type { AxiosRequestConfig } from 'axios'
import {
  AxiosInterceptor,
  AxiosFulfilledInterceptor,
  AxiosRejectedInterceptor,
  AxiosResponseCustomConfig,
} from '@narando/nest-axios-interceptor'

// logging.axios-interceptor.ts
const LOGGING_CONFIG_KEY = Symbol('kLoggingAxiosInterceptor')

// Merging our custom properties with the base config
interface LoggingConfig extends AxiosRequestConfig {
  [LOGGING_CONFIG_KEY]: {
    startTime: number
  }
}

@Injectable()
export class LoggingAxiosInterceptor extends AxiosInterceptor<LoggingConfig> {
  constructor(httpService: HttpService) {
    super(httpService)
  }

  requestFulfilled(): AxiosFulfilledInterceptor<LoggingConfig> {
    return (config) => {
      config[LOGGING_CONFIG_KEY] = {
        startTime: Date.now(),
      }
      return config
    }
  }
  // requestRejected(): AxiosRejectedInterceptor {}
  responseFulfilled(): AxiosFulfilledInterceptor<
    AxiosResponseCustomConfig<LoggingConfig>
  > {
    return (res) => {
      const startTime = res.config[LOGGING_CONFIG_KEY].startTime
      const endTime = Date.now()
      const duration = endTime - startTime
      const log = `axios調(diào)用接口路由:${res.config.url};請求時間: ${duration}ms`
      console.log(log)
      return res
    }
  }
}

最后就是如何注入攔截器了,把它放進module的providers即可

import { Module, HttpModule } from '@nestjs/common'
import { ExampleController } from '../controller/index.controller'
import { ExampleService } from '../service/index.service'
import { LoggingAxiosInterceptor } from 'xxxx/axios.interceptor'
/**
 *  示例模塊
 */
@Module({
  imports: [HttpModule.register({})],
  controllers: [ExampleController],
  providers: [LoggingAxiosInterceptor, ExampleService],
})
export class ExampleModule {}

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末妻枕,一起剝皮案震驚了整個濱河市僻族,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌屡谐,老刑警劉巖述么,帶你破解...
    沈念sama閱讀 211,194評論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異愕掏,居然都是意外死亡度秘,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,058評論 2 385
  • 文/潘曉璐 我一進店門饵撑,熙熙樓的掌柜王于貴愁眉苦臉地迎上來敷钾,“玉大人,你說我怎么就攤上這事肄梨。” “怎么了挠锥?”我有些...
    開封第一講書人閱讀 156,780評論 0 346
  • 文/不壞的土叔 我叫張陵众羡,是天一觀的道長。 經(jīng)常有香客問我蓖租,道長粱侣,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,388評論 1 283
  • 正文 為了忘掉前任蓖宦,我火速辦了婚禮齐婴,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘稠茂。我一直安慰自己柠偶,他們只是感情好情妖,可當(dāng)我...
    茶點故事閱讀 65,430評論 5 384
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著诱担,像睡著了一般毡证。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上蔫仙,一...
    開封第一講書人閱讀 49,764評論 1 290
  • 那天料睛,我揣著相機與錄音,去河邊找鬼摇邦。 笑死恤煞,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的施籍。 我是一名探鬼主播居扒,決...
    沈念sama閱讀 38,907評論 3 406
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼法梯!你這毒婦竟也來了苔货?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,679評論 0 266
  • 序言:老撾萬榮一對情侶失蹤立哑,失蹤者是張志新(化名)和其女友劉穎夜惭,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體铛绰,經(jīng)...
    沈念sama閱讀 44,122評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡诈茧,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,459評論 2 325
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了捂掰。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片敢会。...
    茶點故事閱讀 38,605評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖这嚣,靈堂內(nèi)的尸體忽然破棺而出鸥昏,到底是詐尸還是另有隱情,我是刑警寧澤姐帚,帶...
    沈念sama閱讀 34,270評論 4 329
  • 正文 年R本政府宣布吏垮,位于F島的核電站,受9級特大地震影響罐旗,放射性物質(zhì)發(fā)生泄漏膳汪。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 39,867評論 3 312
  • 文/蒙蒙 一九秀、第九天 我趴在偏房一處隱蔽的房頂上張望遗嗽。 院中可真熱鬧,春花似錦鼓蜒、人聲如沸痹换。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,734評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽晴音。三九已至柔纵,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間锤躁,已是汗流浹背搁料。 一陣腳步聲響...
    開封第一講書人閱讀 31,961評論 1 265
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留系羞,地道東北人郭计。 一個月前我還...
    沈念sama閱讀 46,297評論 2 360
  • 正文 我出身青樓,卻偏偏與公主長得像椒振,于是被迫代替她去往敵國和親昭伸。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 43,472評論 2 348

推薦閱讀更多精彩內(nèi)容