TypeScript单元测试：如何基于接口Mock对象（Jest环境）

针对你提出的需求——在Jest等测试框架中通过TypeScript接口自动生成符合结构的Mock对象，以下是几个仍在维护的可行方案：

1. 使用@automock/jest #

这是专门为Jest设计的Mock生成工具，支持直接基于TypeScript接口/类型生成Mock实例，底层依赖TypeScript Compiler API解析类型信息，完全满足你通过createMockByInterface<IUser>()这类方式生成Mock的需求。

安装 #

npm install @automock/jest --save-dev

使用示例 #

import { Mock } from '@automock/jest';
import { IUser, Sex } from './your-interfaces';

describe('User测试', () => {
  it('生成符合IUser结构的Mock', () => {
    const mockUser = Mock.create<IUser>();
    
    // 验证Mock结构符合接口
    expect(mockUser.id).toBeDefined();
    expect(typeof mockUser.name).toBe('string');
    expect(Object.values(Sex)).toContain(mockUser.sex);
    expect(mockUser.location.city.id).toBeDefined();
  });
});

默认生成的Mock会填充对应类型的随机值：字符串类型生成随机字符串，枚举会随机取枚举值，嵌套对象也会递归生成符合结构的Mock，完全匹配你需要的输出格式。

2. faker.js + 类型约束 #

如果你需要更灵活地自定义Mock数据的生成规则，可以结合@faker-js/faker（流行的假数据生成库）和TypeScript的类型断言，手动实现符合接口的Mock生成函数。这种方式可控性更强，适合需要精准控制字段内容的场景。

安装 #

npm install @faker-js/faker --save-dev

使用示例 #

import { faker } from '@faker-js/faker';
import { IUser, Sex } from './your-interfaces';

const createMockUser = (): IUser => {
  const generateIdName = () => ({
    id: faker.string.uuid(),
    name: faker.person.fullName()
  });

  return {
    id: faker.string.uuid(),
    name: faker.person.fullName(),
    login: faker.internet.userName(),
    age: faker.number.int({ min: 18, max: 60 }).toString(), // 匹配接口中age的string类型
    sex: faker.helpers.arrayElement(Object.values(Sex)),
    location: {
      city: generateIdName(),
      country: generateIdName(),
      region: generateIdName()
    }
  };
};

// 使用
const mockUser = createMockUser();

3. Zod + faker.js #

如果你的项目已经在使用Zod做数据校验，可以通过定义与接口对应的Zod schema，再基于schema生成Mock数据。这种方式既能保证Mock数据的合法性，又能复用schema的类型定义。

安装 #

npm install zod @faker-js/faker zod-faker --save-dev

使用示例 #

import { z } from 'zod';
import { generate } from 'zod-faker';
import type { IUser } from './your-interfaces';

// 定义与IUser对应的Zod schema
const SexSchema = z.nativeEnum(Sex);
const IdNameSchema = z.object({
  id: z.string(),
  name: z.string()
});
const UserSchema = z.object({
  id: z.string(),
  name: z.string(),
  login: z.string(),
  age: z.string(),
  sex: SexSchema,
  location: z.object({
    city: IdNameSchema,
    country: IdNameSchema,
    region: IdNameSchema
  })
});

// 生成Mock并匹配IUser类型
const mockUser = generate(UserSchema) as IUser;

zod-faker会自动根据Zod schema的类型生成对应假数据，也支持自定义每个字段的生成规则。

内容的提问来源于stack exchange，提问作者Vladislav Kochurko