使用 Zod 和 Faker 构建用于生成模拟数据的 TypeScript 助手

发布日期： 2024-11-06 阅读量： 作者： 网络

使用 zod 和 faker 构建用于生成模拟数据的 typescript 助手

构建应用程序时，模拟数据对于测试、开发和原型设计非常宝贵。借助 zod 强大的模式验证和 faker 的数据生成功能，我们可以创建一个强大的助手来为任何 zod 模式生成真实的、符合模式的模拟数据。

介绍

在本指南中，我们将创建一个辅助函数generatemockdatafromschema，它接受 zod 模式并返回与该模式的结构和验证规则匹配的模拟数据。让我们一步步深入吧！

文章演练

简介
文章演练
代码片段
为什么使用 zod 和 faker 来模拟数据？
创建模拟数据生成器
- generatemockdatafromschema 辅助函数
- 处理每种模式类型
  - 有特定要求的字符串
  - 数值
  - 布尔值
  - 数组
  - 可选字段和可为空字段
  - 具有嵌套字段的对象
- 用法示例
- 添加自定义选项
- 测试辅助函数
结论

代码片段

模拟数据生成器辅助函数
react 示例 stackblitz

为什么使用 zod 和 faker 来模拟数据？

在开始编码之前，让我们讨论一下为什么 zod 和 faker 非常适合这项任务：

zod：提供了一种健壮、类型安全的方法来在 typescript 中定义数据模式。其架构验证功能可确保我们的模拟数据符合特定规则，例如电子邮件格式、uuid 或最小/最大值。
faker：生成真实的随机数据，例如姓名、日期、电子邮件和 url。当我们需要类似于真实场景的模拟数据时，这特别有用，使其非常适合测试和演示目的。

结合 zod 和 faker 使我们能够创建既真实又符合架构的模拟数据。

创建模拟数据生成器

我们解决方案的核心是generatemockdatafromschema辅助函数，它可以解释zod模式并生成匹配的模拟数据。该函数处理各种数据类型（字符串、数字、数组、对象）并遵守每种模式类型内的验证约束。让我们探索一下它是如何构建的。

generatemockdatafromschema 辅助函数

generatemockdatafromschema 函数接受两个参数：

schema：zod schema，定义数据的形状和规则。
options（可选）：用于自定义数组长度和可选字段行为的对象。

这是该函数，分为每个部分来解释不同模式类型的处理。

import {
  zodschema,
  zodobject,
  zodstring,
  zodnumber,
  zodboolean,
  zodarray,
  zodoptional,
  zodnullable,
  zodtypeany,
  zodstringcheck,
} from "zod";
import { faker } from "@faker-js/faker";
import { z } from "zod";

const handlestringcheck = (check: zodstringcheck) => {
  switch (check.kind) {
    case "date":
      return faker.date.recent().toisostring();
    case "url":
      return faker.internet.url();
    case "email":
      return faker.internet.email();
    case "uuid":
    case "cuid":
    case "nanoid":
    case "cuid2":
    case "ulid":
      return crypto.randomuuid();
    case "emoji":
      return faker.internet.emoji();
    default:
      return faker.lorem.word();
  }
};

type generatorprimitiveoptions = {
  array?: {
    min?: number;
    max?: number;
  };
  optional?: {
    probability?: number;
  };
};

const getarraylength = (options?: generatorprimitiveoptions) => {
  return faker.number.int({
    min: options?.array?.min || 1,
    max: options?.array?.max || 10,
  });
};

export function generatetestdatafromschema<t>(
  schema: zodschema<t>,
  options?: generatorprimitiveoptions
): t {
  if (schema instanceof zodstring) {
    const check = schema._def.checks.find((check) => handlestringcheck(check));
    if (check) {
      return handlestringcheck(check) as t;
    }
    return faker.lorem.word() as t;
  }

  if (schema instanceof zodnumber) {
    return faker.number.int() as t;
  }

  if (schema instanceof zodboolean) {
    return faker.datatype.boolean() as t;
  }

  if (schema instanceof zodarray) {
    const arrayschema = schema.element;
    const length = getarraylength(options);
    return array.from({ length }).map(() =>
      generatetestdatafromschema(arrayschema)
    ) as t;
  }

  if (schema instanceof zodoptional || schema instanceof zodnullable) {
    const probability = options?.optional?.probability || 0.5;
    return (
      math.random() > probability
        ? generatetestdatafromschema(schema.unwrap())
        : null
    ) as t;
  }

  if (schema instanceof zodobject) {
    const shape = schema.shape;
    const result: any = {};
    for (const key in shape) {
      result[key] = generatetestdatafromschema(shape[key] as zodtypeany);
    }
    return result as t;
  }

  throw new error("unsupported schema type", {
    cause: schema,
  });
}

# typescript # ai # switch # 键值对

上一篇: Docker怎么解决Redis连接不上问题

下一篇: docker怎么解决启动mysql失败问题

使用 Zod 和 Faker 构建用于生成模拟数据的 TypeScript 助手

随便看看