Zod 및 Faker를 사용하여 모의 데이터 생성을 위한 TypeScript 도우미 구축

애플리케이션을 구축할 때 모의 데이터는 테스트, 개발, 프로토타입 제작에 매우 중요할 수 있습니다. Zod의 강력한 스키마 검증과 Faker의 데이터 생성 기능을 통해 모든 Zod 스키마에 대해 현실적이고 스키마를 준수하는 모의 데이터를 생성하는 강력한 도우미를 만들 수 있습니다.

소개

이 가이드에서는 Zod 스키마를 허용하고 스키마의 구조 및 유효성 검사 규칙과 일치하는 모의 데이터를 반환하는 도우미 함수 generateMockDataFromSchema를 만듭니다. 단계별로 살펴보겠습니다!

기사 둘러보기

• 소개
• 기사 둘러보기
• 코드 스니펫
• 모의 데이터에 Zod와 Faker를 사용하는 이유는 무엇인가요?
• 모의 데이터 생성기 만들기
  • generateMockDataFromSchema 도우미 함수
  • 각 스키마 유형 처리
    • 특정 요구사항이 있는 문자열
    • 숫자 값
    • 부울
    • 배열
    • 선택 및 Null 허용 필드
    • 중첩 필드가 있는 개체
  • 사용예
  • 사용자 정의 옵션 추가
  • 도우미 기능 테스트
• 결론

코드 조각

• 모의 데이터 생성 도우미 기능
• React 예시 Stackblitz

모의 데이터에 Zod와 Faker를 사용하는 이유는 무엇입니까?

코딩을 시작하기 전에 Zod와 Faker가 이 작업에 완벽한 이유를 논의해 보겠습니다.

• Zod: TypeScript에서 데이터 스키마를 정의하는 강력하고 유형이 안전한 방법을 제공합니다. 스키마 유효성 검사 기능을 통해 모의 데이터가 이메일 형식, UUID 또는 최소/최대 값과 같은 특정 규칙을 준수하는지 확인합니다.

• Faker: 이름, 날짜, 이메일, URL 등 현실적인 무작위 데이터를 생성합니다. 이는 실제 시나리오와 유사한 모의 데이터가 필요할 때 특히 유용하며 테스트 및 데모 목적에 적합합니다.

Zod와 Faker를 결합하면 현실적이고 스키마를 준수하는 모의 데이터를 생성할 수 있습니다.

모의 데이터 생성기 만들기

저희 솔루션의 핵심은 Zod 스키마를 해석하고 일치하는 모의 데이터를 생성할 수 있는 generateMockDataFromSchema 도우미 함수입니다. 이 함수는 다양한 데이터 유형(문자열, 숫자, 배열, 객체)을 처리하고 각 스키마 유형 내의 유효성 검사 제약 조건을 준수합니다. 어떻게 제작되었는지 살펴보겠습니다.

 generateMockDataFromSchema 도우미 함수

generateMockDataFromSchema 함수는 두 가지 매개변수를 허용합니다:

• 스키마: 데이터의 모양과 규칙을 정의하는 Zod 스키마입니다.
• 옵션(선택 사항): 배열 길이와 선택적 필드 동작을 사용자 정의하는 개체입니다.

다음은 다양한 스키마 유형의 처리를 설명하기 위해 각 섹션으로 분류된 함수입니다.

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와 같은 특정 검사를 고려해야 합니다. 이것이 우리의 도우미 함수인 handlerStringCheck가 들어오는 곳입니다. 문자열 스키마를 검사하고 검사가 있는 경우 관련 모의 값(예: 이메일의 경우 이메일, URL의 경우 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() 함수를 제공합니다.

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

배열

ZodArray를 다룰 때 배열의 각 요소에 대해 모의 데이터를 반복적으로 생성합니다. 옵션 매개변수를 사용하여 배열 길이를 사용자 정의할 수도 있습니다.

배열을 생성하려면 먼저 옵션의 최소 및 최대 길이를 확인하는 도우미 함수인 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,
  });
};

선택적 및 Null 허용 필드

선택 사항 및 null 허용 필드는 출력에 포함할지 여부를 무작위로 결정하여 처리됩니다. options.ional.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 함수는 선택적 옵션 매개변수도 허용하여 배열 길이와 선택적 필드 동작을 맞춤설정합니다. 다음은 이러한 옵션을 사용하는 방법의 예입니다.

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 중국어 웹사이트의 기타 관련 기사를 참조하세요!