后端Web框架【免費下載鏈接】egg Born to build better enterprise frameworks and apps with Node.js Koa. https://307.run/eggcode項目地址https://gitcode.com/gh_mirrors/eg/egg點擊查看免費下載導讀本文是 EGG 單元測試技能egg-unittest中 Mock 模式references/mock.md的完整實戰(zhàn)指南聚焦eggjs/mock提供的四種核心 Mock 手段mm()原型方法 Mock、mm.spy()調(diào)用記錄、app.mockHttpclient()外部 HTTP 請求 Mock、app.mockCsrf()跳過 CSRF 校驗。讀完本文你將掌握在 Vitest eggjs/mock/bootstrap測試環(huán)境下對 DI依賴注入對象、外部 API、安全校驗進行精確打樁與斷言的方法并理解其底層實現(xiàn)原理與自動恢復機制。一、為什么需要 Mock 模式在 EGG 應用中單元測試的目標是隔離被測對象、控制外部依賴。常見需要 Mock 的場景包括被測 Service 依賴其他 DI 對象如OrderService依賴UserService、NotifyService業(yè)務代碼通過Inject() httpclient: HttpClient發(fā)起的外部 HTTP 調(diào)用第三方 API、支付網(wǎng)關等POST/PUT/DELETE 請求觸發(fā)安全插件的 CSRF 校驗導致 403。Mock 的核心價值是在不修改業(yè)務代碼的前提下替換或觀察依賴行為從而讓測試穩(wěn)定、快速、可重復。測試運行環(huán)境由 egg-binVitest啟動app實例與mm工具從eggjs/mock/bootstrap統(tǒng)一導入。二、常見錯誤速查表錯誤寫法正確寫法說明mm(service, method, fn)mm(ServiceClass.prototype, method, fn)DI 對象需 mock 原型不是實例手動寫afterEach(mm.restore)不需要egg-bin 自動注入 mock 恢復new Ajv()mock 單獨實例mock 原型方法DI 容器管理的對象通過原型 mock為什么必須是原型而非實例EGG 的 tegg DI 容器在運行時通過app.getEggObject(Class)獲取對象實例實例的方法來自其原型鏈。如果對某個具體實例service直接mm(service, method, fn)該替換只存在于這一個實例上而測試代碼通過app.getEggObject()拿到的往往是容器新建或復用的另一個實例Mock 根本不會生效。因此必須mm(ServiceClass.prototype, method, fn)從類型定義層面全局生效。這一規(guī)則與mm()的源碼實現(xiàn)基于mm庫對目標對象屬性進行替換一致見 plugins/mock/src/index.ts。三、mm() — Mock Proto 方法mm()是最常用的 Mock 方式用于替換 DI 對象的原型方法使其返回固定數(shù)據(jù)或執(zhí)行自定義邏輯。import assert from node:assert; import { app, mm } from eggjs/mock/bootstrap; import { UserService } from ../app/modules/user/UserService.ts; import { OrderService } from ../app/modules/order/OrderService.ts; describe(OrderService, () { it(should mock user service, async () { mm(UserService.prototype, getById, async () { return { id: 1, name: mocked user }; }); const orderService await app.getEggObject(OrderService); const result await orderService.createForUser(1); assert.equal(result.userName, mocked user); }); });要點Mock 函數(shù)應為async 函數(shù)若原始方法是異步方法保證 Promise 語義一致通過await app.getEggObject(OrderService)獲取被測 DI 對象斷言應針對業(yè)務結(jié)果result.userName mocked user而非 Mock 函數(shù)本身驗證OrderService正確消費了UserService的返回值。調(diào)用信息斷言called / calledArguments / lastCalledArgumentsMock 函數(shù)會自動記錄調(diào)用信息可用來斷言是否正確調(diào)用、以什么參數(shù)調(diào)用import assert from node:assert; import { app, mm } from eggjs/mock/bootstrap; import { NotifyService } from ../app/modules/notify/NotifyService.ts; import { OrderService } from ../app/modules/order/OrderService.ts; it(should call notify with correct args, async () { const mockFn async (userId: string, message: string) {}; mm(NotifyService.prototype, send, mockFn); const orderService await app.getEggObject(OrderService); await orderService.create({ productId: 1 }); assert.equal(mockFn.called, 1); // 調(diào)用次數(shù) assert.deepStrictEqual(mockFn.lastCalledArguments, [user-1, 訂單創(chuàng)建成功]); // 最后一次調(diào)用參數(shù) // mockFn.calledArguments — 所有調(diào)用參數(shù)的數(shù)組 });Mock 函數(shù)上自動附加的斷言屬性屬性含義示例用法called被調(diào)用次數(shù)assert.equal(mockFn.called, 1)calledArguments所有調(diào)用參數(shù)的數(shù)組二維assert.deepStrictEqual(mockFn.calledArguments, [[user-1, msg]])lastCalledArguments最后一次調(diào)用的參數(shù)列表assert.deepStrictEqual(mockFn.lastCalledArguments, [user-1, msg])這種行為打樁 調(diào)用記錄的組合是驗證 Service 之間協(xié)作關系的標準手法。四、mm.spy() — 不替換實現(xiàn)只記錄調(diào)用當希望原方法正常執(zhí)行、同時又想觀察它是否被調(diào)用時使用mm.spy()it(should spy on method, async () { mm.spy(NotifyService.prototype, send); const orderService await app.getEggObject(OrderService); await orderService.create({ productId: 1 }); // 原方法正常執(zhí)行同時記錄了調(diào)用信息 const sendFn NotifyService.prototype.send; assert.equal(sendFn.called, 1); assert.equal(sendFn.lastCalledArguments[0], user-1); });與mm()的區(qū)別mm()用自定義函數(shù)替換原實現(xiàn)控制返回值/行為mm.spy()保留原實現(xiàn)僅附加called、calledArguments、lastCalledArguments等記錄屬性用于確認發(fā)生過調(diào)用、參數(shù)正確的驗證型斷言由于原型方法被記錄屬性包裝斷言可直接從NotifyService.prototype.send讀取。適用場景日志發(fā)送、消息通知、埋點上報等副作用型方法——你關心的是有沒有調(diào)、參數(shù)對不對而不是返回值。五、app.mockHttpclient() — Mock HttpClient 請求業(yè)務代碼通過Inject() httpclient: HttpClient注入的 HttpClient 發(fā)起的請求可用app.mockHttpclient()整體打樁避免測試真正訪問外部網(wǎng)絡it(should mock external API, () { app.mockHttpclient(https://api.example.com/users, { data: JSON.stringify({ name: test }), }); return app.httpRequest().get(/api/proxy/users).expect(200).expect({ name: test }); });參數(shù)簽名與重載實現(xiàn)見 plugins/mock/src/app/extend/application.ts 與 plugins/mock/src/lib/mock_httpclient.tsmockHttpclient( mockUrl: string | RegExp, // 匹配的 URL支持正則 mockMethod?: string | string[], // HTTP 方法默認 * mockResult?: string | MockResultOptions | MockResultFunction, ): this二參重載app.mockHttpclient(url, mockResult)時mockMethod默認為*匹配所有方法三參重載app.mockHttpclient(url, GET, mockResult)指定方法方法會統(tǒng)一轉(zhuǎn)為大寫mockUrl為字符串時解析為origin pathname匹配為RegExp時按origin path整體正則匹配可命中多條 Mock 配置。MockResultOptions 完整字段字段類型默認值說明datastring \| Buffer \| Object響應體Object 會被自動JSON.stringify序列化statusnumber200HTTP 狀態(tài)碼headersRecordstring, string{}響應頭delaynumber無延遲響應的毫秒數(shù)可模擬慢接口persistbooleantrue是否無限次命中該 Mock默認始終生效repeatsnumber無固定命中次數(shù)persist: false時生效源碼層面的行為細節(jié)mock_httpclient.tsdata為對象時轉(zhuǎn)為 JSON Buffer為字符串時按 UTF-8 編碼為 Buffer否則拋錯底層基于urllib的 MockAgentundici 攔截器實現(xiàn)persist默認true意味著同一條 URL 的 Mock 在恢復前會一直命中同一測試內(nèi)多次調(diào)用無需重復聲明mockResult也支持函數(shù)形式(url, options) MockResultOptions | string可依據(jù)請求path、method、body動態(tài)返回結(jié)果適合區(qū)分同一接口的不同請求場景。組合使用建議外部 API 的 Mock 常與接口測試鏈式配合先用mockHttpclient擋住下游 HTTP 依賴再通過app.httpRequest()supertest驅(qū)動 Controller 完整鏈路最終只斷言業(yè)務側(cè)響應。六、app.mockCsrf() — 跳過 CSRF 校驗POST/PUT/DELETE 請求默認會觸發(fā)安全插件的 CSRF 校驗未攜帶 token 時返回 403。測試中可直接跳過it(should POST without CSRF error, () { app.mockCsrf(); return app.httpRequest().post(/api/users).send({ name: test }).expect(200); });實現(xiàn)位于 application.tsmockCsrf(): this { mock(this.context, assertCSRF, () {}); mock(this.context, assertCsrf, () {}); return this; }即對 Context 原型上的assertCSRF/assertCsrf方法做空替換使校驗直接通過。使用注意只需在需要寫操作的測試中調(diào)用GET 等讀操作無需該方法只影響當前app實例afterEach恢復后自動失效若測試本身要驗證 CSRF 防護邏輯如 403 場景則不要調(diào)用mockCsrf()。七、Mock 恢復自動注入無需手寫egg-bin 自動注入eggjs/mock/setup_vitest該模塊在 Vitest 生命周期中自動完成三件事beforeAll單次啟動 MockApplicationapp并對啟動 Promise 做緩存同一 worker 內(nèi)只啟動一次afterEach等待后臺任務結(jié)束app.backgroundTasksFinished()并調(diào)用mm.restore()恢復所有 MockafterAll按共享模式判斷是否關閉 appisolate/threads 池場景下由 worker 線程回收。因此不要手動編寫afterEach(mm.restore)重復恢復沒有意義且可能干擾生命周期restore()的實現(xiàn)restore.ts會依次執(zhí)行mm庫恢復、cluster 恢復、MockAgent 恢復保證mm()、mm.spy()、mockHttpclient、mockCsrf等所有 Mock 全部還原到初始狀態(tài)測試之間互不污染。八、與其他 Mock API 的配合在 DI 場景下mm()通常與以下 API 組合使用構(gòu)成完整測試體系詳見 egg-unittest 技能總覽API用途app.getEggObject(Class)獲取 SingletonProto / ContextProto 實例app.mockContext(data)Mock Context 屬性app.mockService(name, method, fn)Mock Service字符串路徑或類app.mockServiceError(name, method, err)Mock Service 拋出指定錯誤app.mockSession(data)/app.mockCookies(obj)Mock Session / Cookieapp.mockHeaders(headers)/app.mockLog()Mock 請求頭 / 捕獲日志mm.env(env)/app.mockEnv(env)Mock 運行環(huán)境test/prod 等需要 Mock 單測依賴而當前測試文件又沒有app生命周期時可參考mm.app()/mm.cluster()的創(chuàng)建入口index.ts手動創(chuàng)建 MockApplication。九、總結(jié)EGG 單元測試的 Mock 模式可以歸納為三條原則DI 對象一律 Mock 原型mm(Class.prototype, method, fn)不要 Mock 實例驗證型場景用mm.spy()控制型場景用mm()前者記錄調(diào)用、保留實現(xiàn)后者替換實現(xiàn)、決定返回外部依賴與安全校驗交給 app 級 APIapp.mockHttpclient()攔截 HttpClientapp.mockCsrf()跳過 CSRF恢復由setup_vitest的afterEach自動完成。按此模式編寫測試即可獲得穩(wěn)定、隔離、可斷言的 Service/DI 單元測試為 EGG 應用的持續(xù)集成提供可靠保障。贊分享后端Web框架【免費下載鏈接】egg Born to build better enterprise frameworks and apps with Node.js Koa. https://307.run/eggcode項目地址https://gitcode.com/gh_mirrors/eg/egg點擊查看免費下載相關推薦手把手教你搭建i茅臺智能預約系統(tǒng)從零開始實現(xiàn)自動化預約手把手教你搭建i茅臺智能預約系統(tǒng)從零開始實現(xiàn)自動化預約 還在為每天9點準時搶購茅臺而煩惱嗎還在因為手速不夠快而錯過預約機會嗎今天我要為你介紹一個 i茅臺智后端Web框架掌握Egg.js單元測試從Mock到Stub的實戰(zhàn)進階指南掌握Egg.js單元測試從Mock到Stub的實戰(zhàn)進階指南 Egg.js作為基于Node.js和Koa的企業(yè)級框架其強大的測試體系是保障應用質(zhì)量的關鍵。本文后端Web框架如何在10分鐘內(nèi)完成AI語音克隆訓練Retrieval-based-Voice-Conversion-WebUI終極指南如何在10分鐘內(nèi)完成AI語音克隆訓練Retrieval based Voice Conversion WebUI終極指南 你是否曾夢想過擁有自己的專屬AI語音人工智能AI 應用語音音頻深度學習上一篇打造無屏編程體驗claude-code-local語音交互模式全攻略下一篇VirtualApp CI/CD監(jiān)控監(jiān)控構(gòu)建和部署狀態(tài)創(chuàng)作聲明：本文部分內(nèi)容由AI輔助生成（AIGC），僅供參考