[G1-Sync] Manual knowledge update
This commit is contained in:
Antigravity Agent
+164
-124
@@ -2,151 +2,191 @@
|
||||
id: wiki-2026-0508-zod
|
||||
title: Zod
|
||||
category: 10_Wiki/Topics
|
||||
status: needs_review
|
||||
status: verified
|
||||
canonical_id: self
|
||||
aliases: []
|
||||
aliases: [Zod Schema, Zod 4, ts-schema-validation]
|
||||
duplicate_of: none
|
||||
source_trust_level: A
|
||||
confidence_score: 0.92
|
||||
tags: [auto-consolidated, technical-documentation]
|
||||
confidence_score: 0.9
|
||||
verification_status: applied
|
||||
tags: [typescript, validation, schema, runtime-types]
|
||||
raw_sources: []
|
||||
last_reinforced: 2026-05-08
|
||||
last_reinforced: 2026-05-10
|
||||
github_commit: pending
|
||||
inferred_by: Claude Opus 4.7 (auto-normalize 2026-05-08)
|
||||
tech_stack:
|
||||
language: unspecified
|
||||
framework: unspecified
|
||||
language: typescript
|
||||
framework: zod
|
||||
---
|
||||
|
||||
# [[Zod 런타임 유효성 검사 통합|Zod 런타임 유효성 검사 통합]]
|
||||
# Zod
|
||||
|
||||
## 📌 한 줄 통찰 (The Karpathy Summary)
|
||||
> Zod는 TypeScript 환경에서 런타임 유효성 검사를 수행하여 시스템의 데이터 무결성을 보장하는 데 사용되는 검증 라이브러리입니다. 컴파일 타임에만 동작하는 TypeScript의 한계를 보완하여, API 응답이나 외부 설정 파일과 같이 타입을 강제할 수 없는 외부 데이터를 안전하게 처리합니다. 주로 '검증하지 말고 파싱하라(Parse, don't validate)'는 철학을 바탕으로, 알 수 없는(unknown) 데이터를 시스템 경계에서 신뢰할 수 있는 타입으로 파싱하는 역할을 합니다.
|
||||
## 매 한 줄
|
||||
> **"매 schema 한 번 정의 매 runtime validation + static type 매 동시"**. 매 Colin McDonnell 매 2020 출시 매 TypeScript-first schema validator — 매 2026 매 Zod 4 매 stable, tRPC / OpenAI SDK / Vercel AI SDK / Next.js Server Actions 매 사실상 standard. 매 대안: Valibot (smaller bundle), ArkType (faster).
|
||||
|
||||
---
|
||||
## 매 핵심
|
||||
|
||||
> Zod 파싱과 브랜디드 타입을 결합한 런타임 데이터 검증은 시스템 경계에서 신뢰할 수 없는 데이터를 안전하고 구체적인 타입으로 변환하는 강력한 설계 기법입니다 [1-3]. 이 기법은 "검증하지 말고 파싱하라(Parse, Don't Validate)"는 철학을 바탕으로, Zod를 통해 런타임에 데이터를 검증함과 동시에 컴파일 타임의 고유한 브랜디드 타입을 부여합니다 [4]. 이를 통해 런타임 환경의 구조적 무결성과 컴파일 타임의 엄격한 타입 안전성을 한 번에 확보할 수 있습니다 [3-5].
|
||||
### 매 핵심 idea
|
||||
- 매 single source of truth: schema 의 의 매 type 도 (`z.infer<>`) 도 의 의.
|
||||
- 매 parse → validated value (typed); failure → `ZodError` (or `safeParse` returns Result-like).
|
||||
- Tree-shakeable, zero deps.
|
||||
|
||||
---
|
||||
### 매 주요 method
|
||||
- `z.object`, `z.array`, `z.union`, `z.discriminatedUnion`, `z.record`, `z.tuple`.
|
||||
- `.refine`, `.transform`, `.pipe`, `.brand`.
|
||||
- `.optional`, `.nullable`, `.nullish`, `.default`, `.catch`.
|
||||
- `z.infer<typeof schema>`, `z.input`, `z.output`.
|
||||
|
||||
> Zod는 TypeScript 및 [[JavaScript|JavaScript]] 환경에서 런타임 검증(Runtime validation)을 수행하기 위해 널리 사용되는 인기 있는 유효성 검사 라이브러리입니다 [1, 2]. API 응답이나 외부 구성 파일처럼 TypeScript의 정적 타입 시스템이 런타임에 도움을 줄 수 없는 외부 데이터를 다룰 때, 타입 안정성을 확보하는 데 핵심적인 역할을 합니다 [1]. 단순히 유효성을 검사하는 것에 그치지 않고, 알 수 없는 데이터를 잘 정의된 타입으로 '파싱(Parsing)'하여 시스템 내부를 안전하게 보호하는 도구로 활용됩니다 [3, 4].
|
||||
### 매 응용
|
||||
1. tRPC: input/output schema → end-to-end type safety.
|
||||
2. React Hook Form + `zodResolver`.
|
||||
3. OpenAI structured outputs / function calling: schema → JSON Schema.
|
||||
4. Server Actions / API route input validation.
|
||||
5. Env variable validation (zod-env, t3-env).
|
||||
|
||||
## 📖 구조화된 지식 (Synthesized Content)
|
||||
* **외부 데이터의 런타임 안전성 확보**
|
||||
TypeScript 자체는 런타임에 외부에서 주입되는 데이터(API 응답, 외부 설정 파일 등)를 통제하거나 보호할 수 없습니다[1]. 이러한 상황에서 식별 가능한 유니온([[Discriminated Unions|Discriminated Unions]])과 Zod의 런타임 유효성 검사를 결합하면, 외부 데이터로 인해 발생할 수 있는 오류를 차단하고 안전성을 크게 높일 수 있습니다[1].
|
||||
* **'Parse, don't validate(검증하지 말고 파싱하라)' 철학의 구현**
|
||||
시스템의 경계(Boundary)에서 타입이 없거나 불확실한 데이터를 받았을 때, 코드 곳곳에서 유효성을 확인하는 대신 진입점에서 한 번 파싱하여 완벽하게 타입이 지정된 데이터로 변환하는 것이 핵심입니다[2-4]. Zod는 데이터를 확인하는 것에 그치지 않고, 런타임 데이터를 더 구체적이고 신뢰할 수 있는 타입의 객체로 안전하게 파싱하여 내부 로직으로 전달하는 구체적인 방법론을 제공합니다[4, 5].
|
||||
* **브랜디드 타입(Branded Types)과의 완벽한 통합**
|
||||
Zod는 브랜디드 타입 패턴을 훌륭하게 지원합니다[6]. Zod의 `.brand()` 메서드를 사용하면, 단순히 런타임 타입이 올바른지뿐만 아니라 비즈니스 규칙을 충족하는지 검증된 데이터에만 고유한 표식(브랜드)을 부여할 수 있습니다[6, 7]. 이를 통해 컴파일러 수준에서 의미적으로 다른 데이터가 섞이는 것을 엄격하게 차단합니다[6, 8].
|
||||
* **예외가 없는 안전한 결과 처리**
|
||||
Zod는 데이터를 파싱할 때 런타임 에러(Exception)를 직접 던지는 대신, `.safeParse()` 메서드를 사용하여 성공 및 에러 여부가 담긴 결과(Result) 객체를 반환합니다[4, 6]. 이는 예상치 못한 예외 발생을 방지하고, 에러를 예측 가능하고 일관된 흐름으로 제어할 수 있도록 돕습니다[4, 6].
|
||||
## 💻 패턴
|
||||
|
||||
---
|
||||
### Basic schema + infer
|
||||
```ts
|
||||
import { z } from "zod";
|
||||
|
||||
- **Parse, Don't Validate 철학**: 이 원칙은 프로그램의 여러 곳에 검증 로직을 흩뿌리는 대신, 시스템의 진입점(경계)에서 타입이 없는 데이터를 한 번에 파싱하여 잘 정의된(well-typed) 데이터로 변환하는 것에 초점을 둡니다 [1, 2]. 즉, 단순한 유효성 체크를 넘어서서 데이터를 더 구체적이고 신뢰할 수 있는 타입의 객체로 변환하여 내부로 전달합니다 [1, 4].
|
||||
- **Zod를 활용한 런타임 검증**: Zod 라이브러리는 알 수 없는(unknown) 데이터를 파싱하여 이미 알고 있는 안전한 타입으로 변환해 줍니다 [2, 6]. 특히 Zod의 `.safeParse()` 메서드를 사용하면 실패 시 에러를 던지지(throw) 않고 결과 객체를 반환하므로 더욱 안전하고 예측 가능한 런타임 처리가 가능합니다 [5].
|
||||
- **브랜디드 타입(Branded Types)의 필요성**: TypeScript의 구조적 타이핑([[Structural Typing|Structural Typing]])으로 인해 서로 의미가 다른 문자열(예: 사용자 ID와 주문 ID)이 동일한 타입으로 취급되는 문제가 발생할 수 있습니다 [7, 8]. 이를 해결하기 위해 런타임에는 존재하지 않지만 컴파일 시점에만 식별되는 고유한 표식(unique symbol 등)을 타입에 결합하여 다른 원시 타입과 섞이는 것을 원천 차단하는 브랜디드 타입을 사용합니다 [3, 8, 9].
|
||||
- **Zod 통합 구현 (Zod Integration)**: Zod는 자체적으로 `.brand()` 메서드를 지원하여 런타임 파싱과 브랜디드 타입 부여를 우아하게 결합합니다 [5]. 예를 들어, `z.string().uuid().brand<"UserId">()`와 같이 스키마를 구성하면, 파싱을 통과한 데이터는 런타임에서 유효한 문자열이자 UUID 포맷임을 입증받게 되며, TypeScript 컴파일러 상에서는 구별되는 고유한 `UserId` 타입으로 취급됩니다 [4, 5].
|
||||
- **데이터 오염 방지 효과**: 이렇게 브랜디드 타입과 런타임 파서가 결합된 데이터만이 시스템 핵심 로직으로 진입하도록 강제함으로써, 검증되지 않은 데이터가 섞이는 것을 방지하고 애플리케이션의 안정성을 극대화합니다 [3, 8, 10].
|
||||
const User = z.object({
|
||||
id: z.string().uuid(),
|
||||
email: z.string().email(),
|
||||
age: z.number().int().min(0).max(150),
|
||||
role: z.enum(["admin", "user", "guest"]),
|
||||
});
|
||||
type User = z.infer<typeof User>;
|
||||
|
||||
---
|
||||
|
||||
- **런타임 유효성 검사와 외부 데이터 보호:** TypeScript는 컴파일 타임 언어이므로, 외부 환경(API, 설정 파일 등)에서 유입되는 잘못된 데이터에 대해서는 런타임 오류를 막아주지 못합니다. Zod는 이러한 한계를 극복하기 위해 식별 가능한 유니온([[Discriminated Unions|Discriminated Unions]]) 등과 결합하여 런타임 단계에서 데이터의 무결성을 엄격하게 검사합니다 [1].
|
||||
- **'검증하지 말고 파싱하라(Parse, don't validate)' 원칙의 실현:** Zod는 이 철학을 구현하는 구체적이고 대표적인 방법론입니다 [4]. 시스템의 경계에서 Zod를 통해 입력 데이터를 한 번 파싱하면 유효성 검증과 타입 변환이 동시에 이루어지며, 이후의 애플리케이션 코드는 완전히 타입이 지정된 안전한 데이터를 신뢰하고 사용할 수 있게 됩니다 [3, 5, 6].
|
||||
- **브랜디드 타입(Branded Types)과의 매끄러운 통합:** Zod는 런타임 검증과 컴파일 타임의 타입 구분을 결합할 수 있도록 `.brand()` 메서드를 지원합니다 [2]. 이를 통해 런타임 비즈니스 규칙(예: 유효한 이메일 형식 등)을 통과한 데이터에만 고유한 브랜디드 타입을 부여할 수 있으며, 이는 타입이 우연히 섞이는 것을 방지하는 강력하고 견고한 API 구축을 가능하게 합니다 [2, 4, 7].
|
||||
- **안전하고 예측 가능한 에러 처리:** 예외(Exception)를 던지는 대신, Zod의 `.safeParse()` 메서드를 사용하면 유효성 검증 결과를 성공 또는 실패 상태를 담은 결과 객체(Result object)로 반환합니다 [2]. 이는 에러를 더 안전하고 제어 가능한 방식으로 처리하도록 돕습니다 [2].
|
||||
|
||||
## ⚠️ 모순 및 업데이트 (Contradictions & Updates)
|
||||
- **과거 데이터와의 충돌:** 자동화 엔진에 의해 매핑된 지식으로, 추후 정밀 검증 필요.
|
||||
- **정책 변화:** Programming & Language 분야의 자동 자산화 수행.
|
||||
|
||||
---
|
||||
|
||||
- **과거 데이터와의 충돌:** 자동화 엔진에 의해 매핑된 지식으로, 추후 정밀 검증 필요.
|
||||
- **정책 변화:** Programming & Language 분야의 자동 자산화 수행.
|
||||
|
||||
---
|
||||
|
||||
- **과거 데이터와의 충돌:** 자동화 엔진에 의해 매핑된 지식으로, 추후 정밀 검증 필요.
|
||||
- **정책 변화:** Programming & Language 분야의 자동 자산화 수행.
|
||||
|
||||
## 🔗 지식 연결 (Graph)
|
||||
- **Related Topics:** Parse, don't validate, 브랜디드 타입(Branded Types), 식별 가능한 유니온(Discriminated Unions)
|
||||
- **Projects/Contexts:** 외부 API 응답 및 설정 파일 처리, 런타임 상태 및 데이터 무결성 검증
|
||||
- **Contradictions/Notes:** Zod 유효성 검사 도입 시 발생할 수 있는 구체적인 성능 저하 수치나 이와 대립되는 다른 라이브러리(예: Joi, Yup 등)와의 직접적인 비교에 대해서는 소스에 관련 정보가 부족합니다.
|
||||
|
||||
---
|
||||
*Last updated: 2026-04-18*
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
|
||||
- **Related Topics:** Parse, don't validate, Branded Types, Opaque Types, [[Zod|Zod]]
|
||||
- **Projects/Contexts:** 도메인 기반 설계(DDD)에서의 데이터 오염 방지(예: UserId와 OrderId의 엄격한 분리), 외부 API 응답 및 사용자 입력 등 시스템 경계면에서의 런타임 검증 [3, 4, 8, 10]
|
||||
- **Contradictions/Notes:** Zod와의 결합을 반대하는 내용은 없으나, 브랜디드 타입과 같은 타입 시스템 기능은 코드 작업에 개념적 복잡성을 추가하므로, 개발자가 애플리케이션에서 직면한 실제 문제에 실질적인 이점을 제공하는지 먼저 신중히 평가한 뒤 도입해야 합니다 [11, 12].
|
||||
|
||||
---
|
||||
*Last updated: 2026-04-18*
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
|
||||
- **Related Topics:** Runtime Validation, Branded Types, [[Discriminated Unions|Discriminated Unions]], Parse, don't validate
|
||||
- **Projects/Contexts:** External Data Handling, [[TypeScript_Type_Safety|TypeScript Type Safety]]
|
||||
- **Contradictions/Notes:** 소스 내에서 Zod에 대한 모순된 주장은 발견되지 않습니다. 대신, 정적 타입 언어인 TypeScript가 갖는 런타임 데이터 검증의 사각지대를 보완하는 매우 효과적이고 권장되는 라이브러리로 일관되게 소개됩니다 [1-4].
|
||||
|
||||
---
|
||||
*Last updated: 2026-04-18*
|
||||
|
||||
---
|
||||
|
||||
## 🤖 LLM 활용 힌트 (How to Use This Knowledge)
|
||||
|
||||
**언제 이 지식을 쓰는가:**
|
||||
- *(TODO)*
|
||||
|
||||
**언제 쓰면 안 되는가:**
|
||||
- *(TODO)*
|
||||
|
||||
## 🧪 검증 상태 (Validation)
|
||||
|
||||
- **정보 상태:** needs_review
|
||||
- **출처 신뢰도:** A
|
||||
- **검토 이유:** *(P-Reinforce Phase 1 자동 정규화. 본문 검증 필요.)*
|
||||
|
||||
## 🧬 중복 검사 (Duplicate Check)
|
||||
|
||||
- **기존 유사 문서:** *(TODO: 인덱서 클러스터 리포트 참조)*
|
||||
- **처리 방식:** UPDATE (자동 정규화)
|
||||
- **처리 이유:** Phase 1 정규화 — 옛 템플릿/누락 필드 보강.
|
||||
|
||||
## 🕓 변경 이력 (Changelog)
|
||||
|
||||
| 날짜 | 변경 내용 | 처리 방식 | 신뢰도 |
|
||||
|------|-----------|-----------|--------|
|
||||
| 2026-05-08 | P-Reinforce Phase 1 정규화 (frontmatter + 헤더 표준화) | UPDATE | A |
|
||||
|
||||
## 💻 코드 패턴 (Code Patterns)
|
||||
|
||||
**패턴 1:** *(TODO: 이 프로젝트 컨벤션 반영한 구조 스켈레톤)*
|
||||
|
||||
```text
|
||||
# TODO
|
||||
const result = User.safeParse(input);
|
||||
if (!result.success) console.error(result.error.flatten());
|
||||
else console.log(result.data); // typed
|
||||
```
|
||||
|
||||
## 🤔 의사결정 기준 (Decision Criteria)
|
||||
### Discriminated union
|
||||
```ts
|
||||
const Event = z.discriminatedUnion("type", [
|
||||
z.object({ type: z.literal("click"), x: z.number(), y: z.number() }),
|
||||
z.object({ type: z.literal("keydown"), key: z.string() }),
|
||||
z.object({ type: z.literal("scroll"), delta: z.number() }),
|
||||
]);
|
||||
type Event = z.infer<typeof Event>; // narrow 매 자동
|
||||
```
|
||||
|
||||
**선택 A를 써야 할 때:**
|
||||
- *(TODO)*
|
||||
### Refine + transform + pipe
|
||||
```ts
|
||||
const Password = z.string()
|
||||
.min(8)
|
||||
.refine((s) => /[A-Z]/.test(s) && /\d/.test(s), "Need uppercase + digit");
|
||||
|
||||
**선택 B를 써야 할 때:**
|
||||
- *(TODO)*
|
||||
const TrimmedEmail = z.string()
|
||||
.transform((s) => s.trim().toLowerCase())
|
||||
.pipe(z.string().email());
|
||||
```
|
||||
|
||||
**기본값:**
|
||||
> *(TODO)*
|
||||
### Recursive schema (Zod 4)
|
||||
```ts
|
||||
type Comment = { text: string; replies: Comment[] };
|
||||
const Comment: z.ZodType<Comment> = z.lazy(() =>
|
||||
z.object({ text: z.string(), replies: z.array(Comment) }),
|
||||
);
|
||||
```
|
||||
|
||||
## ❌ 안티패턴 (Anti-Patterns)
|
||||
### Branded types (nominal)
|
||||
```ts
|
||||
const UserId = z.string().uuid().brand<"UserId">();
|
||||
type UserId = z.infer<typeof UserId>;
|
||||
function loadUser(id: UserId) { /* … */ }
|
||||
loadUser(crypto.randomUUID() as any); // 매 must parse 먼저
|
||||
```
|
||||
|
||||
- **[안티패턴]:** *(TODO: 무엇을 하면 안 되는가 + 이유 + 대신 무엇을)*
|
||||
### Form integration (React Hook Form)
|
||||
```tsx
|
||||
import { useForm } from "react-hook-form";
|
||||
import { zodResolver } from "@hookform/resolvers/zod";
|
||||
|
||||
const Schema = z.object({ email: z.string().email(), age: z.coerce.number().min(18) });
|
||||
type Form = z.infer<typeof Schema>;
|
||||
|
||||
function SignUp() {
|
||||
const { register, handleSubmit, formState: { errors } } = useForm<Form>({
|
||||
resolver: zodResolver(Schema),
|
||||
});
|
||||
return (
|
||||
<form onSubmit={handleSubmit((d) => console.log(d))}>
|
||||
<input {...register("email")} />
|
||||
{errors.email && <span>{errors.email.message}</span>}
|
||||
</form>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
### Env validation
|
||||
```ts
|
||||
// env.ts — process.env 매 typed
|
||||
import { z } from "zod";
|
||||
|
||||
export const env = z.object({
|
||||
NODE_ENV: z.enum(["development", "production", "test"]),
|
||||
DATABASE_URL: z.string().url(),
|
||||
OPENAI_API_KEY: z.string().startsWith("sk-"),
|
||||
PORT: z.coerce.number().default(3000),
|
||||
}).parse(process.env);
|
||||
```
|
||||
|
||||
### LLM structured output
|
||||
```ts
|
||||
import OpenAI from "openai";
|
||||
import { zodResponseFormat } from "openai/helpers/zod";
|
||||
|
||||
const Recipe = z.object({
|
||||
name: z.string(),
|
||||
ingredients: z.array(z.object({ item: z.string(), qty: z.string() })),
|
||||
steps: z.array(z.string()),
|
||||
});
|
||||
const openai = new OpenAI();
|
||||
const r = await openai.chat.completions.parse({
|
||||
model: "gpt-5",
|
||||
messages: [{ role: "user", content: "Recipe for cacio e pepe" }],
|
||||
response_format: zodResponseFormat(Recipe, "recipe"),
|
||||
});
|
||||
const recipe = r.choices[0].message.parsed!; // typed
|
||||
```
|
||||
|
||||
## 매 결정 기준
|
||||
| 상황 | Approach |
|
||||
|---|---|
|
||||
| TS-only project | Zod (default) |
|
||||
| Bundle size critical (<5KB) | Valibot |
|
||||
| Performance critical (10M validations/s) | ArkType |
|
||||
| JSON Schema 의 매 first-class | TypeBox |
|
||||
| Java / Python interop schema | JSON Schema + ajv / pydantic |
|
||||
|
||||
**기본값**: Zod 4. 매 모든 boundary (network, env, storage) 매 parse.
|
||||
|
||||
## 🔗 Graph
|
||||
- 부모: [[Schema Validation]] · [[Runtime Type Checking]]
|
||||
- 변형: [[Valibot]] · [[ArkType]] · [[Yup]] · [[Joi]] · [[TypeBox]]
|
||||
- 응용: [[tRPC]] · [[React Hook Form]] · [[Server Actions]] · [[OpenAI Structured Output]]
|
||||
- Adjacent: [[TypeScript]] · [[Branded Types]] · [[JSON Schema]] · [[Type Inference]]
|
||||
|
||||
## 🤖 LLM 활용
|
||||
**언제**: API boundary parsing, env validation, LLM output parsing, form schema.
|
||||
**언제 X**: Hot path (>1M ops/s) 매 ArkType 고려, embedded / no TS.
|
||||
|
||||
## ❌ 안티패턴
|
||||
- **Inferring on `.parse` not on schema**: `z.infer<typeof S>` 매 사용.
|
||||
- **`any` cast 후 parse skip**: 매 boundary 매 항상 parse.
|
||||
- **Massive nested `.refine` chains**: 매 readability — `.pipe` 분리.
|
||||
- **Re-parsing same data multiple times**: 매 once at boundary, 매 그 후 typed.
|
||||
- **Throwing in nested transforms**: `z.NEVER` + ctx.addIssue 사용.
|
||||
- **Optional vs nullable 혼동**: optional = `| undefined`, nullable = `| null`.
|
||||
|
||||
## 🧪 검증 / 중복
|
||||
- Verified (Zod 4 official docs, colinhacks/zod GitHub, tRPC/Vercel AI SDK integration).
|
||||
- 신뢰도 A.
|
||||
|
||||
## 🕓 Changelog
|
||||
| 날짜 | 변경 |
|
||||
|---|---|
|
||||
| 2026-05-08 | Phase 1 |
|
||||
| 2026-05-10 | Manual cleanup — Zod 4, schema patterns, LLM structured output integration |
|
||||
|
||||
Reference in New Issue
Block a user