社区
学习
工具库
AI工具
休闲
搜索
简体中文
首页 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,
  });
}
登录后复制
登录后复制

处理每种模式类型

在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,
  });
}
登录后复制
登录后复制

添加自定义选项

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

热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

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

显示更多

热门文章

如何修复KB5055523无法在Windows 11中安装？
3 周前 By DDD
如何修复KB5055518无法在Windows 10中安装？
3 周前 By DDD
R.E.P.O.的每个敌人和怪物的力量水平
3 周前 By 尊渡假赌尊渡假赌尊渡假赌
<🎜>：死铁路 - 如何驯服狼
3 周前 By DDD
蓝王子：如何到达地下室
3 周前 By DDD
显示更多

热工具

记事本++7.3.1

记事本++7.3.1

好用且免费的代码编辑器

SublimeText3汉化版

SublimeText3汉化版

中文版，非常好用

禅工作室 13.0.1

禅工作室 13.0.1

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

Dreamweaver CS6

Dreamweaver CS6

视觉化网页开发工具

SublimeText3 Mac版

SublimeText3 Mac版

神级代码编辑软件(SublimeText3)

显示更多

热门话题

Java教程
1654
14
CakePHP 教程
1413
52
Laravel 教程
1306
25
PHP教程
1252
29
C# 教程
1225
24
显示更多
Related knowledge
前端热敏纸小票打印遇到乱码问题怎么办？ 前端热敏纸小票打印遇到乱码问题怎么办？ Apr 04, 2025 pm 02:42 PM

前端热敏纸小票打印的常见问题与解决方案在前端开发中，小票打印是一个常见的需求。然而，很多开发者在实...

神秘的JavaScript：它的作用以及为什么重要 神秘的JavaScript：它的作用以及为什么重要 Apr 09, 2025 am 12:07 AM

JavaScript是现代Web开发的基石，它的主要功能包括事件驱动编程、动态内容生成和异步编程。1)事件驱动编程允许网页根据用户操作动态变化。2)动态内容生成使得页面内容可以根据条件调整。3)异步编程确保用户界面不被阻塞。JavaScript广泛应用于网页交互、单页面应用和服务器端开发，极大地提升了用户体验和跨平台开发的灵活性。

谁得到更多的Python或JavaScript？ 谁得到更多的Python或JavaScript？ Apr 04, 2025 am 12:09 AM

Python和JavaScript开发者的薪资没有绝对的高低，具体取决于技能和行业需求。1.Python在数据科学和机器学习领域可能薪资更高。2.JavaScript在前端和全栈开发中需求大，薪资也可观。3.影响因素包括经验、地理位置、公司规模和特定技能。

如何实现视差滚动和元素动画效果，像资生堂官网那样？ 或者： 怎样才能像资生堂官网一样，实现页面滚动伴随的动画效果？ 如何实现视差滚动和元素动画效果，像资生堂官网那样？ 或者： 怎样才能像资生堂官网一样，实现页面滚动伴随的动画效果？ Apr 04, 2025 pm 05:36 PM

实现视差滚动和元素动画效果的探讨本文将探讨如何实现类似资生堂官网（https://www.shiseido.co.jp/sb/wonderland/）中�...

JavaScript的演变：当前的趋势和未来前景 JavaScript的演变：当前的趋势和未来前景 Apr 10, 2025 am 09:33 AM

JavaScript的最新趋势包括TypeScript的崛起、现代框架和库的流行以及WebAssembly的应用。未来前景涵盖更强大的类型系统、服务器端JavaScript的发展、人工智能和机器学习的扩展以及物联网和边缘计算的潜力。

如何使用JavaScript将具有相同ID的数组元素合并到一个对象中？ 如何使用JavaScript将具有相同ID的数组元素合并到一个对象中？ Apr 04, 2025 pm 05:09 PM

如何在JavaScript中将具有相同ID的数组元素合并到一个对象中？在处理数据时，我们常常会遇到需要将具有相同ID�...

JavaScript引擎：比较实施 JavaScript引擎：比较实施 Apr 13, 2025 am 12:05 AM

不同JavaScript引擎在解析和执行JavaScript代码时，效果会有所不同，因为每个引擎的实现原理和优化策略各有差异。1.词法分析：将源码转换为词法单元。2.语法分析：生成抽象语法树。3.优化和编译：通过JIT编译器生成机器码。4.执行：运行机器码。V8引擎通过即时编译和隐藏类优化，SpiderMonkey使用类型推断系统，导致在相同代码上的性能表现不同。

前端开发中如何实现类似 VSCode 的面板拖拽调整功能？ 前端开发中如何实现类似 VSCode 的面板拖拽调整功能？ Apr 04, 2025 pm 02:06 PM

探索前端中类似VSCode的面板拖拽调整功能的实现在前端开发中，如何实现类似于VSCode...

See all articles