搜索
首页web前端js教程使用 Zod 和 Faker 构建用于生成模拟数据的 TypeScript 助手

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

Patricia Arquette
Patricia Arquette
Nov 07, 2024 pm 06:52 PM

Building a TypeScript Helper for Mock Data Generation with Zod and Faker

构建应用程序时，模拟数据对于测试、开发和原型设计非常宝贵。借助 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,
  });
}
</t></t>

处理每种模式类型

在generateMockDataFromSchema中，每种Zod模式类型（如ZodString、ZodNumber等）都会进行不同的处理，以适应其独特的需求。让我们来看看每种类型。

有特定要求的字符串

对于 ZodString，我们需要考虑任何特定的检查，例如电子邮件、url 或 uuid。这就是我们的辅助函数 handleStringCheck 的用武之地。它检查字符串模式，如果存在任何检查，则返回相关的模拟值（例如，电子邮件为电子邮件，网址为 URL）。如果没有找到特定的检查，则默认生成随机单词。

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();
  }
};

在generateMockDataFromSchema中，我们使用这个助手为带有检查的字符串字段生成数据。

数值

对于 ZodNumber，我们使用 Faker 的 faker.number.int() 方法生成整数。如果在架构中定义了最小值和最大值，则可以进一步自定义此部分以处理最小值和最大值。

if (schema instanceof ZodNumber) {
  return faker.number.int() as T;
}

布尔值

对于布尔值，Faker 提供了一个简单的 faker.datatype.boolean() 函数来随机生成 true 或 false 值。

if (schema instanceof ZodBoolean) {
  return faker.datatype.boolean() as T;
}

数组

在处理 ZodArray 时，我们为数组中的每个元素递归生成模拟数据。我们还允许使用 options 参数自定义数组长度。

要生成数组，我们首先使用 getArrayLength 确定长度，这是一个辅助函数，用于检查选项中的最小和最大长度。对于每个数组元素，都会递归调用generateMockDataFromSchema，确保数组中的嵌套模式也得到处理。

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

if (schema instanceof ZodOptional || schema instanceof ZodNullable) {
  const probability = options?.optional?.probability || 0.5;
  return (
    Math.random() > probability
      ? generateTestDataFromSchema(schema.unwrap())
      : null
  ) as T;
}

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

可选字段和可为空字段

可选字段和可为空字段是通过随机决定是否将它们包含在输出中来处理的。 options.Optional.probability 设置允许我们控制这个概率。如果生成了一个字段，它会递归调用generateMockDataFromSchema来获取内部模式。

if (schema instanceof ZodOptional || schema instanceof ZodNullable) {
  const shouldGenerate =
    Math.random() > (options?.optional?.probability || 0.5);
  return shouldGenerate
    ? generateMockDataFromSchema(schema.unwrap(), options)
    : null;
}

具有嵌套字段的对象

对于 ZodObject，我们迭代每个键值对并递归地为每个字段生成数据。这种方法支持深度嵌套的对象，使其高度灵活。

if (schema instanceof ZodObject) {
  const shape = schema.shape;
  const result: any = {};
  for (const key in shape) {
    result[key] = generateMockDataFromSchema(shape[key] as ZodTypeAny, options);
  }
  return result as T;
}

用法示例

generateMockDataFromSchema 就位后，让我们看看它的实际效果。这是一个示例架构 UserSchema，具有不同的类型、可选字段和嵌套数组。

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,
  });
}
</t></t>

添加自定义选项

generateMockDataFromSchema 函数还接受可选的 options 参数来自定义数组长度和可选字段行为。以下是如何使用这些选项的示例：

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();
  }
};

这将确保数组字段的长度在 2 到 5 之间，并且可选字段的生成概率为 70%。

测试辅助函数

要确认generateMockDataFromSchema 按预期工作，请为不同的架构配置创建单元测试。以下是数组模式测试的示例：

if (schema instanceof ZodNumber) {
  return faker.number.int() as T;
}

通过为各种模式类型和配置编写测试，您可以确保辅助函数在不同场景下正确运行。

结论

通过结合 Zod 和 Faker，我们创建了一个针对 TypeScript 项目量身定制的强大、可重用的模拟数据生成器。测试不同场景并查看实际数据的能力对于快速开发和质量测试来说非常宝贵。

以上是使用 Zod 和 Faker 构建用于生成模拟数据的 TypeScript 助手的详细内容。更多信息请关注PHP中文网其他相关文章！

声明
本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系admin@php.cn
相关文章
Python vs. JavaScript：开发人员的比较分析Python vs. JavaScript：开发人员的比较分析May 09, 2025 am 12:22 AM

Python和JavaScript的主要区别在于类型系统和应用场景。1.Python使用动态类型，适合科学计算和数据分析。2.JavaScript采用弱类型，广泛用于前端和全栈开发。两者在异步编程和性能优化上各有优势，选择时应根据项目需求决定。

Python vs. JavaScript：选择合适的工具Python vs. JavaScript：选择合适的工具May 08, 2025 am 12:10 AM

选择Python还是JavaScript取决于项目类型：1)数据科学和自动化任务选择Python；2)前端和全栈开发选择JavaScript。Python因其在数据处理和自动化方面的强大库而备受青睐，而JavaScript则因其在网页交互和全栈开发中的优势而不可或缺。

Python和JavaScript：了解每个的优势Python和JavaScript：了解每个的优势May 06, 2025 am 12:15 AM

Python和JavaScript各有优势，选择取决于项目需求和个人偏好。1.Python易学，语法简洁，适用于数据科学和后端开发，但执行速度较慢。2.JavaScript在前端开发中无处不在，异步编程能力强，Node.js使其适用于全栈开发，但语法可能复杂且易出错。

JavaScript的核心：它是在C还是C上构建的？JavaScript的核心：它是在C还是C上构建的？May 05, 2025 am 12:07 AM

javascriptisnotbuiltoncorc; saninterpretedlanguagethatrunsonenginesoftenwritteninc.1）javascriptwasdesignedAsalightweight，解释edganguageforwebbrowsers.2）Enginesevolvedfromsimpleterterterpretpreterterterpretertestojitcompilerers，典型地提示。

JavaScript应用程序：从前端到后端JavaScript应用程序：从前端到后端May 04, 2025 am 12:12 AM

JavaScript可用于前端和后端开发。前端通过DOM操作增强用户体验，后端通过Node.js处理服务器任务。1.前端示例：改变网页文本内容。2.后端示例：创建Node.js服务器。

Python vs. JavaScript：您应该学到哪种语言？Python vs. JavaScript：您应该学到哪种语言？May 03, 2025 am 12:10 AM

选择Python还是JavaScript应基于职业发展、学习曲线和生态系统：1)职业发展：Python适合数据科学和后端开发，JavaScript适合前端和全栈开发。2)学习曲线：Python语法简洁，适合初学者；JavaScript语法灵活。3)生态系统：Python有丰富的科学计算库，JavaScript有强大的前端框架。

JavaScript框架：为现代网络开发提供动力JavaScript框架：为现代网络开发提供动力May 02, 2025 am 12:04 AM

JavaScript框架的强大之处在于简化开发、提升用户体验和应用性能。选择框架时应考虑：1.项目规模和复杂度，2.团队经验，3.生态系统和社区支持。

JavaScript，C和浏览器之间的关系JavaScript，C和浏览器之间的关系May 01, 2025 am 12:06 AM

引言我知道你可能会觉得奇怪，JavaScript、C 和浏览器之间到底有什么关系？它们之间看似毫无关联，但实际上，它们在现代网络开发中扮演着非常重要的角色。今天我们就来深入探讨一下这三者之间的紧密联系。通过这篇文章，你将了解到JavaScript如何在浏览器中运行，C 在浏览器引擎中的作用，以及它们如何共同推动网页的渲染和交互。JavaScript与浏览器的关系我们都知道，JavaScript是前端开发的核心语言，它直接在浏览器中运行，让网页变得生动有趣。你是否曾经想过，为什么JavaScr

See all articles

热AI工具

Undresser.AI Undress

Undresser.AI Undress

人工智能驱动的应用程序，用于创建逼真的裸体照片

AI Clothes Remover

AI Clothes Remover

用于从照片中去除衣服的在线人工智能工具。

Undress AI Tool

Undress AI Tool

免费脱衣服图片

Clothoff.io

Clothoff.io

AI脱衣机

Video Face Swap

Video Face Swap

使用我们完全免费的人工智能换脸工具轻松在任何视频中换脸！

显示更多

热门文章

<🎜>：种植花园 - 完整的突变指南
3 周前ByDDD
<🎜>：泡泡胶模拟器无穷大 - 如何获取和使用皇家钥匙
3 周前By尊渡假赌尊渡假赌尊渡假赌
如何修复KB5055612无法在Windows 10中安装？
3 周前ByDDD
蓝王子：如何到达地下室
1 个月前ByDDD
北端：融合系统，解释
3 周前By尊渡假赌尊渡假赌尊渡假赌
显示更多

热工具

PhpStorm Mac 版本

PhpStorm Mac 版本

最新（2018.2.1 ）专业的PHP集成开发工具

适用于 Eclipse 的 SAP NetWeaver 服务器适配器

适用于 Eclipse 的 SAP NetWeaver 服务器适配器

将Eclipse与SAP NetWeaver应用服务器集成。

禅工作室 13.0.1

禅工作室 13.0.1

功能强大的PHP集成开发环境

WebStorm Mac版

WebStorm Mac版

好用的JavaScript开发工具

SublimeText3汉化版

SublimeText3汉化版

中文版，非常好用

显示更多

热门话题

Java教程
1664
14
CakePHP 教程
1423
52
Laravel 教程
1318
25
PHP教程
1269
29
C# 教程
1248
24
显示更多