Typescript中如何mock Express的Req和Res 解决测试时类型不匹配问题
TypeScript Express 控制器单测的类型兼容方案
问题背景
从JavaScript切换到TypeScript开发Express微服务时,原本在JS环境中灵活手写mock测试中间件、控制器的写法,会触发静态类型检查报错:
- 测试目标:验证
validateQueryParams控制器对非法查询参数的处理逻辑 - 现有测试代码中,手写的mock
req/res对象传入生产方法时,被TS提示不符合express.Request、express.Response的类型定义 - 核心诉求:不修改生产代码的原有类型定义,尽量沿用原有手写mock的测试习惯,消除类型报错,适配TS的检查规则
适配TS规则的测试实现方案
所有方案都不需要调整生产代码的类型定义,可根据自己的习惯选择:
最小改动适配原有写法
针对当前手写mock的场景,可在传参时做类型断言解决报错,不需要补全完整的Express对象结构:
import type { Request, Response, NextFunction } from 'express' // 原有mock逻辑完全保留 const req = { query: { limit: "AA", skip: "AA", }, }; const res = { status: jest.fn(chainableMock), json: () => {}, }; const next = jest.fn(); // 仅在传参时加类型断言,消除检查报错 const response = myController.validateQueryParams( req as Request, res as Response, next as NextFunction );
如果TS提示两个类型结构差异过大无法直接断言,可在断言时先中转为unknown类型,这是TS允许的类型转换路径——本质是你明确知晓当前mock只覆盖测试场景用到的属性,运行时完全符合预期,只是静态检查的形式匹配问题。
减少冗余断言的写法
如果不想在所有调用处都加断言,可在定义mock对象时就标注类型:
const req = { query: { limit: "AA", skip: "AA", }, } as Request;
这种方式不需要手动补全express.Request的几十项内置属性,因为测试逻辑根本不会访问到这些冗余属性,补全纯属无意义的工作量。
批量测试场景的可选优化
如果后续需要编写大量控制器单测,可引入专门的Express mock工具生成自带类型的req/res对象,不需要自己手写jest mock的结构,工具生成的对象天然匹配Express的类型定义,连类型断言都可以省略。
注意:该优化方案为可选项,如果偏好保留原有手写mock的习惯,前面两种方式完全可以满足需求,不需要额外引入依赖增加项目负担。
常见认知澄清
刚转TS写测试时不需要走入“mock必须和真实Express对象100%结构一致”的误区:
- 单测的核心目标是覆盖当前被测逻辑的分支,只要mock覆盖的属性是被测函数实际会访问到的,运行时就不会出现异常
- TS的类型检查是为了提前发现书写笔误,不是要求开发者为了适配静态检查,写和业务逻辑无关的冗余mock代码
内容的提问来源于stack exchange,提问作者SeekanDestroy
相关产品推荐
相关产品推荐

