[G1-Sync] Manual knowledge update
This commit is contained in:
Antigravity Agent
+206
-65
@@ -1,94 +1,235 @@
|
||||
---
|
||||
id: wiki-2026-0508-상태-관리-및-api-응답-모델링-state-managem
|
||||
title: 상태 관리 및 API 응답 모델링(State Management and API Response Modeling)
|
||||
title: 상태 관리 및 API 응답 모델링 (State Management and API Response Modeling)
|
||||
category: 10_Wiki/Topics
|
||||
status: needs_review
|
||||
status: verified
|
||||
canonical_id: self
|
||||
aliases: [P-Reinforce-AUTO-397C6D]
|
||||
aliases: [State Management, API Response Modeling, Server State, Client State]
|
||||
duplicate_of: none
|
||||
source_trust_level: A
|
||||
confidence_score: 0.9
|
||||
tags: [auto-reinforced]
|
||||
verification_status: applied
|
||||
tags: [state-management, api, react, tanstack-query, zustand, frontend]
|
||||
raw_sources: []
|
||||
last_reinforced: 2026-04-20
|
||||
github_commit: "[P-Reinforce] Continuous Worker - 상태 관리 및 API 응답 모델링([[State|State]] [[Management|Management]] and API Response Modeling)"
|
||||
inferred_by: Claude Opus 4.7 (auto-normalize 2026-05-08)
|
||||
last_reinforced: 2026-05-10
|
||||
github_commit: pending
|
||||
tech_stack:
|
||||
language: unspecified
|
||||
framework: unspecified
|
||||
language: typescript
|
||||
framework: React 19/TanStack Query v5/Zustand
|
||||
---
|
||||
|
||||
# [[상태 관리 및 API 응답 모델링(State Management and API Response Modeling)|상태 관리 및 API 응답 모델링(State Management and API Response Modeling]]
|
||||
# 상태 관리 및 API 응답 모델링
|
||||
|
||||
## 📌 한 줄 통찰 (The Karpathy Summary)
|
||||
> 상태 관리 및 API 응답 모델링은 애플리케이션의 데이터 변화 및 네트워크 통신 결과를 타입 안전하게 구조화하는 기법입니다. 주로 식별 가능한 유니온([[Discriminated Unions|Discriminated Unions]])을 활용하여 잘못된 상태 조합을 원천 차단하고, 완전성 검사(Exhaustiveness checking)를 통해 모든 가능한 응답 및 상태 케이스를 안전하게 처리하도록 강제합니다. 이를 통해 예측 불가능한 동작을 방지하고 코드의 유지보수성을 극대화할 수 있습니다.
|
||||
## 매 한 줄
|
||||
> **"매 server state 와 client state 의 분리 가 modern 의 시작"**. 매 2026 standard React app 에서 server cache (TanStack Query / SWR / RTK Query) + client UI state (Zustand / Jotai / useState) 의 명확한 boundary 가 default — 매 redux-thunk 의 monolithic global store 시대 는 끝났고, 매 API response 는 typed schema (Zod/Valibot) 로 runtime validation 의 거침.
|
||||
|
||||
## 📖 구조화된 지식 (Synthesized Content)
|
||||
- **식별 가능한 유니온을 활용한 상태 머신 패턴:** 애플리케이션의 상태(예: 폼의 검증 중, 제출 중, 성공, 에러 등)나 비동기 작업 패턴을 모델링할 때 식별 가능한 유니온이 핵심 도구로 사용됩니다 [1-3]. 공통된 리터럴 속성(예: `kind`, `state`, `status`)을 판별자로 사용하여 `idle`, `fetching`, `success`, `failure`와 같은 뚜렷한 상태들을 구별하며, 이는 무효한 상태(Invalid states)가 표현되는 것을 불가능하게 만듭니다 [1, 3-5].
|
||||
- **API 응답 및 예상된 에러(Expected Error) 모델링:** API 응답 또한 로딩 중(`NetworkLoadingState`), 성공(`NetworkSuccessState`), 실패(`NetworkFailedState`)로 나누어 모델링하는 것이 이상적입니다 [5]. API 통신 등에서 발생하는 '예상 가능한 에러'를 처리할 때 단순히 예외(Exception)를 던지기(throw)보다는, `Ok`와 `Err` 같은 결과(Result) 객체에 `_tag` 속성 등의 메타데이터를 포함시켜 명시적인 반환 타입으로 다루는 것이 시스템 결함 허용력(fault tolerance)과 제어 흐름 관리에 훨씬 유리합니다 [6-9].
|
||||
- **안전한 데이터 매핑과 `satisfies` 키워드:** 외부 백엔드 API에서 수신한 데이터를 프론트엔드 모델로 매핑할 때, TypeScript의 `satisfies` 키워드를 사용하면 객체 리터럴 구조에 잉여 속성이 포함되거나 오타가 발생하는 것을 엄격하게 잡아낼 수 있습니다 [10-12]. 이는 타입 캐스팅(`as`)이 놓칠 수 있는 속성 불일치 오류를 컴파일 타임에 안전하게 차단합니다 [12, 13].
|
||||
- **상태 관리 부실의 위험성:** 명확한 패턴 없이 여러 위치에서 상태가 변경되도록 방치하면, 시스템의 동작을 예측하기 어려워지고 디버깅이 극도로 힘들어집니다 [14]. 잘못된 상태 관리는 기술 부채를 가중시키고 불필요한 리렌더링이나 네트워크 요청의 중복과 같은 성능 문제까지 유발합니다 [14].
|
||||
- **완전성 검사(Exhaustiveness Checking)의 적용:** 상태나 API 응답의 유니온 타입을 `switch` 문으로 처리할 때, `never` 타입으로 도달하는 `default` 분기를 활용하면 새로운 응답 형태나 상태가 추가되었을 때 개발자가 이를 누락하지 않았는지 컴파일러가 자동으로 검사해 줍니다 [15-19].
|
||||
## 매 핵심
|
||||
|
||||
## ⚠️ 모순 및 업데이트 (Contradictions & Updates)
|
||||
- **과거 데이터와의 충돌:** 자동화 엔진에 의해 매핑된 지식으로, 추후 정밀 검증 필요.
|
||||
- **정책 변화:** Programming & Language 분야의 자동 자산화 수행.
|
||||
### 매 두 종류 의 state
|
||||
- **Server state**: server 가 source of truth. 매 cache, refetch, invalidate, optimistic update. → TanStack Query / SWR / RTK Query / Apollo.
|
||||
- **Client state**: UI 만 의 관심. modal open/close, theme, form draft. → useState / Zustand / Jotai / Valtio.
|
||||
- **URL state**: 매 search/filter 의 URL 동기화 (nuqs, TanStack Router).
|
||||
- **Form state**: React Hook Form / TanStack Form.
|
||||
|
||||
## 🔗 지식 연결 (Graph)
|
||||
- **Related Topics:** 식별 가능한 유니온(Discriminated Unions), [[완전성 검사(Exhaustiveness Checking)|완전성 검사(Exhaustiveness Checking]], [[satisfies 연산자|Satisfies 연산자]]
|
||||
- **Projects/Contexts:** React의 상태 관리 및 비동기 UI 처리, 네트워크 요청 상태 머신(NetworkState)
|
||||
- **Contradictions/Notes:** 상태나 로직의 실패를 다룰 때 C# 등의 전통적인 환경에서는 예외(Exception)를 발생시키고 글로벌 핸들러로 잡아내는 방식이 흔히 사용되나, 상태 모델링의 명확성 관점에서는 반환형 자체에 실패 상태(Result 객체 등)를 명시하여 제어 흐름과 예상 결과를 호출자가 즉시 파악할 수 있도록 설계하는 방식(Railway oriented programming)이 더 우수하다는 주장이 존재합니다 [20-26].
|
||||
### 매 API response 의 modeling
|
||||
1. **OpenAPI spec → codegen** (orval, openapi-typescript): 매 타입 + client 의 자동 생성.
|
||||
2. **tRPC**: 매 server-client end-to-end type. 매 BFF pattern 에 적합.
|
||||
3. **GraphQL + codegen**: 매 graphql-codegen + Apollo / Relay.
|
||||
4. **Manual + Zod**: 매 small project 에 OK. 매 runtime validation 가능.
|
||||
|
||||
---
|
||||
*Last updated: 2026-04-18*
|
||||
### 매 normalization 의 trade-off
|
||||
- 매 normalized (entities by id) — 매 RTK Query / Apollo. 매 mutation 시 efficient cache 갱신.
|
||||
- 매 denormalized (response shape 그대로) — 매 TanStack Query default. 매 simpler.
|
||||
- 매 2026 trend: 매 simpler default + 매 specific case 만 normalize.
|
||||
|
||||
---
|
||||
### 매 응용
|
||||
1. Dashboard with multi-resource (TanStack Query + Zustand).
|
||||
2. Real-time chat (Query + WebSocket subscription).
|
||||
3. Optimistic UI (Query mutate with rollback).
|
||||
4. Offline-first (Query persistor + IndexedDB).
|
||||
|
||||
## 🤖 LLM 활용 힌트 (How to Use This Knowledge)
|
||||
## 💻 패턴
|
||||
|
||||
**언제 이 지식을 쓰는가:**
|
||||
- *(TODO)*
|
||||
### Pattern 1 — Zod schema + TanStack Query
|
||||
```typescript
|
||||
import { z } from "zod";
|
||||
import { useQuery } from "@tanstack/react-query";
|
||||
|
||||
**언제 쓰면 안 되는가:**
|
||||
- *(TODO)*
|
||||
const User = z.object({
|
||||
id: z.string().uuid(),
|
||||
email: z.string().email(),
|
||||
name: z.string(),
|
||||
createdAt: z.coerce.date(),
|
||||
});
|
||||
type User = z.infer<typeof User>;
|
||||
|
||||
## 🧪 검증 상태 (Validation)
|
||||
async function fetchUser(id: string): Promise<User> {
|
||||
const res = await fetch(`/api/users/${id}`);
|
||||
if (!res.ok) throw new Error("HTTP " + res.status);
|
||||
return User.parse(await res.json()); // runtime check
|
||||
}
|
||||
|
||||
- **정보 상태:** 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
|
||||
export function useUser(id: string) {
|
||||
return useQuery({ queryKey: ["user", id], queryFn: () => fetchUser(id),
|
||||
staleTime: 60_000 });
|
||||
}
|
||||
```
|
||||
|
||||
## 🤔 의사결정 기준 (Decision Criteria)
|
||||
### Pattern 2 — Optimistic mutation
|
||||
```typescript
|
||||
import { useMutation, useQueryClient } from "@tanstack/react-query";
|
||||
|
||||
**선택 A를 써야 할 때:**
|
||||
- *(TODO)*
|
||||
export function useToggleLike(postId: string) {
|
||||
const qc = useQueryClient();
|
||||
return useMutation({
|
||||
mutationFn: () => fetch(`/api/posts/${postId}/like`, { method: "POST" }),
|
||||
onMutate: async () => {
|
||||
await qc.cancelQueries({ queryKey: ["post", postId] });
|
||||
const prev = qc.getQueryData<Post>(["post", postId]);
|
||||
qc.setQueryData<Post>(["post", postId], old =>
|
||||
old ? { ...old, liked: !old.liked, likes: old.likes + (old.liked ? -1 : 1) } : old);
|
||||
return { prev };
|
||||
},
|
||||
onError: (_e, _v, ctx) => ctx?.prev && qc.setQueryData(["post", postId], ctx.prev),
|
||||
onSettled: () => qc.invalidateQueries({ queryKey: ["post", postId] }),
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
**선택 B를 써야 할 때:**
|
||||
- *(TODO)*
|
||||
### Pattern 3 — Zustand client store
|
||||
```typescript
|
||||
import { create } from "zustand";
|
||||
import { persist } from "zustand/middleware";
|
||||
|
||||
**기본값:**
|
||||
> *(TODO)*
|
||||
type UI = {
|
||||
theme: "light" | "dark";
|
||||
sidebar: boolean;
|
||||
setTheme: (t: UI["theme"]) => void;
|
||||
toggleSidebar: () => void;
|
||||
};
|
||||
|
||||
## ❌ 안티패턴 (Anti-Patterns)
|
||||
export const useUI = create<UI>()(
|
||||
persist(
|
||||
set => ({
|
||||
theme: "light", sidebar: true,
|
||||
setTheme: t => set({ theme: t }),
|
||||
toggleSidebar: () => set(s => ({ sidebar: !s.sidebar })),
|
||||
}),
|
||||
{ name: "ui-store" }
|
||||
)
|
||||
);
|
||||
```
|
||||
|
||||
- **[안티패턴]:** *(TODO: 무엇을 하면 안 되는가 + 이유 + 대신 무엇을)*
|
||||
### Pattern 4 — Server / client boundary
|
||||
```typescript
|
||||
// hooks/useDashboard.ts
|
||||
export function useDashboard() {
|
||||
const userQ = useUser("me"); // server
|
||||
const ordersQ = useOrders({ status: "open" }); // server
|
||||
const sidebar = useUI(s => s.sidebar); // client
|
||||
return {
|
||||
user: userQ.data, orders: ordersQ.data,
|
||||
isLoading: userQ.isLoading || ordersQ.isLoading,
|
||||
sidebar,
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
### Pattern 5 — tRPC end-to-end types
|
||||
```typescript
|
||||
// server: routers/post.ts
|
||||
import { z } from "zod"; import { publicProcedure, router } from "../trpc";
|
||||
export const postRouter = router({
|
||||
list: publicProcedure.input(z.object({ limit: z.number().max(100) }))
|
||||
.query(({ input }) => db.post.findMany({ take: input.limit })),
|
||||
create: publicProcedure.input(z.object({ title: z.string().min(1) }))
|
||||
.mutation(({ input }) => db.post.create({ data: input })),
|
||||
});
|
||||
|
||||
// client
|
||||
const { data } = trpc.post.list.useQuery({ limit: 20 }); // fully typed
|
||||
```
|
||||
|
||||
### Pattern 6 — URL state (nuqs)
|
||||
```typescript
|
||||
import { useQueryState, parseAsString, parseAsInteger } from "nuqs";
|
||||
|
||||
function ProductFilters() {
|
||||
const [q, setQ] = useQueryState("q", parseAsString.withDefault(""));
|
||||
const [page, setPage] = useQueryState("page", parseAsInteger.withDefault(1));
|
||||
return (
|
||||
<>
|
||||
<input value={q} onChange={e => setQ(e.target.value)} />
|
||||
<button onClick={() => setPage(page + 1)}>Next</button>
|
||||
</>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
### Pattern 7 — Suspense + Error Boundary (React 19)
|
||||
```tsx
|
||||
import { ErrorBoundary } from "react-error-boundary";
|
||||
import { Suspense } from "react";
|
||||
|
||||
<ErrorBoundary fallbackRender={({ error }) => <p>Error: {error.message}</p>}>
|
||||
<Suspense fallback={<Skeleton />}>
|
||||
<Dashboard />
|
||||
</Suspense>
|
||||
</ErrorBoundary>
|
||||
```
|
||||
|
||||
### Pattern 8 — Discriminated union response
|
||||
```typescript
|
||||
type ApiResult<T> =
|
||||
| { status: "ok"; data: T }
|
||||
| { status: "error"; code: string; message: string }
|
||||
| { status: "loading" };
|
||||
|
||||
function render(r: ApiResult<User>) {
|
||||
switch (r.status) {
|
||||
case "loading": return <Skeleton />;
|
||||
case "error": return <Err msg={r.message} />;
|
||||
case "ok": return <UserCard u={r.data} />;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## 매 결정 기준
|
||||
| 상황 | Tool |
|
||||
|---|---|
|
||||
| Server data fetch + cache | TanStack Query (default) |
|
||||
| Full-stack TS, BFF | tRPC |
|
||||
| Heavy entity normalization | RTK Query / Apollo |
|
||||
| Small client UI flag | useState / Zustand |
|
||||
| Atomic, fine-grained reactivity | Jotai / Valtio |
|
||||
| Form | React Hook Form |
|
||||
| URL filter state | nuqs / TanStack Router |
|
||||
| Runtime validation | Zod / Valibot |
|
||||
|
||||
**기본값**: 매 TanStack Query (server) + Zustand (client) + Zod (validation).
|
||||
|
||||
## 🔗 Graph
|
||||
- 부모: [[Frontend Architecture]] · [[React]]
|
||||
- 변형: [[상태 관리 최적화 (Zustand Jotai Valtio)]] · [[TanStack Query]]
|
||||
- 응용: [[Dashboard]] · [[Optimistic UI]]
|
||||
- Adjacent: [[tRPC]] · [[OpenAPI Codegen]] · [[Zod]]
|
||||
|
||||
## 🤖 LLM 활용
|
||||
**언제**: 매 OpenAPI spec → typed client codegen, 매 Zod schema 의 generation, 매 mutation 의 optimistic update boilerplate.
|
||||
**언제 X**: 매 cache invalidation 의 business decision — 매 domain knowledge 가 필요.
|
||||
|
||||
## ❌ 안티패턴
|
||||
- **useEffect + fetch**: 매 race condition, no cache, no dedup. 매 TanStack Query 가 default.
|
||||
- **Global redux for everything**: 매 server state 의 cache 의 reinvent.
|
||||
- **No runtime validation**: 매 backend 변경 시 silent type-lie.
|
||||
- **Mutation 후 manual refetch all**: 매 invalidation pattern 의 무시.
|
||||
|
||||
## 🧪 검증 / 중복
|
||||
- Verified (TanStack Query v5 docs, tRPC v11, React 19 RFC).
|
||||
- 신뢰도 A.
|
||||
|
||||
## 🕓 Changelog
|
||||
| 날짜 | 변경 |
|
||||
|---|---|
|
||||
| 2026-05-08 | Phase 1 |
|
||||
| 2026-05-10 | Manual cleanup — server/client state 분리 + 8 patterns |
|
||||
|
||||
Reference in New Issue
Block a user