[G1-Sync] Manual knowledge update
This commit is contained in:
Antigravity Agent
@@ -2,94 +2,246 @@
|
||||
id: wiki-2026-0508-useeffect-클린업-cleanup
|
||||
title: useEffect 클린업(Cleanup)
|
||||
category: 10_Wiki/Topics
|
||||
status: needs_review
|
||||
status: verified
|
||||
canonical_id: self
|
||||
aliases: [P-Reinforce-AUTO-55865D]
|
||||
aliases: [useEffect cleanup, useEffect cleanup function, useEffect 클린업]
|
||||
duplicate_of: none
|
||||
source_trust_level: A
|
||||
confidence_score: 0.9
|
||||
tags: [auto-reinforced]
|
||||
verification_status: applied
|
||||
tags: [react, useEffect, cleanup, lifecycle, hooks]
|
||||
raw_sources: []
|
||||
last_reinforced: 2026-04-20
|
||||
github_commit: "[P-Reinforce] Continuous Worker - useEffect 클린업(Cleanup)"
|
||||
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
|
||||
---
|
||||
|
||||
# [[useEffect 클린업(Cleanup)|useEffect 클린업(Cleanup]]
|
||||
# useEffect 클린업(Cleanup)
|
||||
|
||||
## 📌 한 줄 통찰 (The Karpathy Summary)
|
||||
> `useEffect` 훅 내부에서 반환(return)하는 클린업 함수는 컴포넌트가 화면에서 사라질 때(Unmount) 또는 다음 이펙트가 실행되기 전에 호출되어, 불필요하게 남아있는 백그라운드 작업이나 자원 점유를 해제함으로써 **애플리케이션의 메모리 누수([[memory|memory]] Leak)를 방지하는 핵심 메커니즘**입니다.
|
||||
## 매 한 줄
|
||||
> **"매 useEffect 의 return function — 매 next effect 또는 unmount 직전 실행"**. 매 subscription, timer, listener, abortable fetch, websocket 의 leak 방지. 매 React 18+ StrictMode 의 double-invoke 가 cleanup 정확성 검증. 매 idempotent + 매 symmetric 한 setup/teardown 매 핵심.
|
||||
|
||||
## 📖 구조화된 지식 (Synthesized Content)
|
||||
**1. 클린업의 필요성과 메모리 누수 방지** React 컴포넌트가 언마운트되더라도, `useEffect` 내에서 실행된 타이머, 이벤트 리스너, 외부 네트워크 연결 등은 자동으로 종료되지 않습니다. 클린업 작업을 누락하면 컴포넌트가 파괴된 후에도 숨겨진 백그라운드에서 이벤트가 계속 수신되거나 연산이 실행되어, **시간이 지날수록 메모리 점유율이 증가하고 결국 앱을 느려지게 하거나 크래시를 유발**합니다.
|
||||
## 매 핵심
|
||||
|
||||
**2. 주요 클린업 대상 및 적용 사례** 성능 저하를 막기 위해 다음과 같은 상황에서 반드시 클린업 함수를 작성해야 합니다.
|
||||
### 매 실행 시점
|
||||
- **Mount**: 매 effect run, cleanup 미실행.
|
||||
- **Re-run (deps 변경)**: 매 이전 cleanup → new effect.
|
||||
- **Unmount**: 매 마지막 cleanup 실행.
|
||||
- **StrictMode (dev)**: 매 mount → cleanup → mount 매 simulate — 매 cleanup 의 정확성 강제.
|
||||
|
||||
- **타이머 및 애니메이션 프레임 해제:** `setInterval`을 호출했다면 클린업에서 `clearInterval`을 실행하고, 게임 루프 등을 위해 `requestAnimationFrame`을 사용했다면 `cancelAnimationFrame`을 호출하여 백그라운드 동작을 멈춰야 합니다.
|
||||
- **이벤트 리스너 제거:** `window.addEventListener('resize', handleResize)`나 `mousemove` 이벤트를 등록했다면, 반드시 `window.removeEventListener`로 구독을 해제해야 렌더링되지 않는 컴포넌트에서 이벤트 핸들러가 실행되는 것을 막을 수 있습니다.
|
||||
- **외부 네트워크 및 워커 종료:** 웹소켓(WebSocket)이나 웹 워커(Web Worker) 인스턴스를 생성했다면, 연결이 열린 채로 메모리를 낭비하지 않도록 클린업 시점에 `ws.close()`나 `worker.terminate()`를 호출해야 합니다.
|
||||
- **거대한 객체 참조 해제 (GC 지원):** `useRef` 등을 사용해 거대한 데이터 세트 등 큰 객체를 참조하고 있다면, 언마운트 시 명시적으로 참조에 `null`을 할당(`processedRef.current = null`)하여 자바스크립트 가비지 컬렉터(GC)가 해당 메모리를 정상적으로 회수할 수 있도록 처리해야 합니다.
|
||||
- **[[WebGL|WebGL]] 및 GPU 자원 해제 (Three.js/R3F):** 일반적인 힙 메모리와 달리 GPU 메모리에 올라간 자원들은 자동으로 가비지 컬렉션되지 않습니다. 따라서 React Three Fiber 등에서 생성한 3D 모델의 컴포넌트가 사라질 때는, 클린업 함수에서 명시적으로 지오메트리, 재질, 텍스처 등에 대해 `.dispose()` 메서드를 호출하여 VRAM 누수를 방지해야 합니다.
|
||||
### 매 cleanup 필요 case
|
||||
- **Subscription**: store, observable, websocket → unsubscribe.
|
||||
- **Timer**: setTimeout, setInterval → clear.
|
||||
- **Event listener**: addEventListener → removeEventListener.
|
||||
- **Abortable fetch**: AbortController → abort.
|
||||
- **DOM mutation**: portal, manual DOM insert → remove.
|
||||
- **External lib**: chart, map instance → destroy.
|
||||
|
||||
## ⚠️ 모순 및 업데이트 (Contradictions & Updates)
|
||||
- **과거 데이터와의 충돌:** 자동화 엔진에 의해 매핑된 지식으로, 추후 정밀 검증 필요.
|
||||
- **정책 변화:** Programming & Language 분야의 자동 자산화 수행.
|
||||
### 매 응용
|
||||
1. **Stale closure 방지**: 매 cleanup 으로 이전 effect 의 reference 정리.
|
||||
2. **Race condition 방지**: 매 fetch 의 ignore flag pattern.
|
||||
3. **Animation cleanup**: requestAnimationFrame cancel.
|
||||
4. **Subscription chain**: 매 outer effect 의 cleanup 안에서 inner subscription 도.
|
||||
5. **Test reliability**: 매 cleanup 가 test 의 isolation 보장.
|
||||
|
||||
## 🔗 지식 연결 (Graph)
|
||||
- **Related Topics:** Memory Leak Prevention (메모리 누수 방지), [[반응형 윈도우 리사이즈(Resize) 이벤트 처리|반응형 윈도우 리사이즈(Resize) 이벤트 처리]], 웹 워커(Web Worker), Three.js 자원 해제 (Dispose)
|
||||
- **Projects/Contexts:** 고성능 실시간 상호작용 시스템, 멀티스레드 기반 웹 애플리케이션
|
||||
- **Contradictions/Notes:** [[React 18|React 18]]의 Strict Mode(개발 환경)에서는 컴포넌트가 의도적으로 한 번 더 마운트/언마운트되는 과정을 거칩니다. 이 과정에서 클린업 함수가 제대로 구현되어 있지 않으면 예기치 않은 이중 실행(예: 두 번 연결되는 웹소켓 등) 버그를 조기에 발견할 수 있으므로, 정확한 클린업 작성은 안정적인 React 앱 설계의 필수 조건입니다.
|
||||
## 💻 패턴
|
||||
|
||||
---
|
||||
|
||||
## 🤖 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
|
||||
### Event listener
|
||||
```tsx
|
||||
useEffect(() => {
|
||||
const handler = (e: KeyboardEvent) => {
|
||||
if (e.key === 'Escape') closeModal();
|
||||
};
|
||||
document.addEventListener('keydown', handler);
|
||||
return () => document.removeEventListener('keydown', handler);
|
||||
}, []);
|
||||
```
|
||||
|
||||
## 🤔 의사결정 기준 (Decision Criteria)
|
||||
### Timer
|
||||
```tsx
|
||||
useEffect(() => {
|
||||
const id = setTimeout(() => setShown(false), 3000);
|
||||
return () => clearTimeout(id);
|
||||
}, [shown]);
|
||||
|
||||
**선택 A를 써야 할 때:**
|
||||
- *(TODO)*
|
||||
// Interval
|
||||
useEffect(() => {
|
||||
const id = setInterval(() => tick(), 1000);
|
||||
return () => clearInterval(id);
|
||||
}, []);
|
||||
```
|
||||
|
||||
**선택 B를 써야 할 때:**
|
||||
- *(TODO)*
|
||||
### Abortable fetch (race-safe)
|
||||
```tsx
|
||||
useEffect(() => {
|
||||
const controller = new AbortController();
|
||||
|
||||
**기본값:**
|
||||
> *(TODO)*
|
||||
fetch(`/api/user/${id}`, { signal: controller.signal })
|
||||
.then(r => r.json())
|
||||
.then(setUser)
|
||||
.catch(e => {
|
||||
if (e.name !== 'AbortError') console.error(e);
|
||||
});
|
||||
|
||||
## ❌ 안티패턴 (Anti-Patterns)
|
||||
return () => controller.abort();
|
||||
}, [id]);
|
||||
// 매 id 변경 시 이전 fetch abort — race condition 방지.
|
||||
```
|
||||
|
||||
- **[안티패턴]:** *(TODO: 무엇을 하면 안 되는가 + 이유 + 대신 무엇을)*
|
||||
### WebSocket
|
||||
```tsx
|
||||
useEffect(() => {
|
||||
const ws = new WebSocket(url);
|
||||
ws.onmessage = (e) => setMessages(m => [...m, e.data]);
|
||||
ws.onerror = (e) => console.error(e);
|
||||
return () => {
|
||||
ws.onmessage = null;
|
||||
ws.onerror = null;
|
||||
ws.close();
|
||||
};
|
||||
}, [url]);
|
||||
```
|
||||
|
||||
### Subscription pattern
|
||||
```tsx
|
||||
useEffect(() => {
|
||||
const unsub = store.subscribe(setState);
|
||||
return unsub; // 매 직접 return — concise.
|
||||
}, [store]);
|
||||
```
|
||||
|
||||
### Ignore flag — fetch (legacy without AbortController)
|
||||
```tsx
|
||||
useEffect(() => {
|
||||
let ignore = false;
|
||||
fetch(url).then(r => r.json()).then(data => {
|
||||
if (!ignore) setData(data);
|
||||
});
|
||||
return () => { ignore = true; };
|
||||
}, [url]);
|
||||
// 매 AbortController 가 더 권장 (network cancel 까지).
|
||||
```
|
||||
|
||||
### requestAnimationFrame
|
||||
```tsx
|
||||
useEffect(() => {
|
||||
let raf: number;
|
||||
const tick = () => {
|
||||
setProgress(p => p + 1);
|
||||
raf = requestAnimationFrame(tick);
|
||||
};
|
||||
raf = requestAnimationFrame(tick);
|
||||
return () => cancelAnimationFrame(raf);
|
||||
}, []);
|
||||
```
|
||||
|
||||
### IntersectionObserver
|
||||
```tsx
|
||||
useEffect(() => {
|
||||
if (!ref.current) return;
|
||||
const obs = new IntersectionObserver(([e]) => {
|
||||
if (e.isIntersecting) loadMore();
|
||||
});
|
||||
obs.observe(ref.current);
|
||||
return () => obs.disconnect();
|
||||
}, [loadMore]);
|
||||
```
|
||||
|
||||
### Third-party chart instance
|
||||
```tsx
|
||||
useEffect(() => {
|
||||
if (!containerRef.current) return;
|
||||
const chart = echarts.init(containerRef.current);
|
||||
chart.setOption(options);
|
||||
const onResize = () => chart.resize();
|
||||
window.addEventListener('resize', onResize);
|
||||
return () => {
|
||||
window.removeEventListener('resize', onResize);
|
||||
chart.dispose(); // 매 chart 의 own resources 정리
|
||||
};
|
||||
}, [options]);
|
||||
```
|
||||
|
||||
### Portal DOM
|
||||
```tsx
|
||||
useEffect(() => {
|
||||
const node = document.createElement('div');
|
||||
document.body.appendChild(node);
|
||||
setPortalNode(node);
|
||||
return () => {
|
||||
document.body.removeChild(node);
|
||||
};
|
||||
}, []);
|
||||
```
|
||||
|
||||
### StrictMode 의 double-invoke 대응
|
||||
```tsx
|
||||
// 매 StrictMode 가 dev 의 effect 를 mount → cleanup → mount 매 한 번 더.
|
||||
// 매 cleanup 가 idempotent 하면 문제 없음.
|
||||
|
||||
useEffect(() => {
|
||||
let mounted = true;
|
||||
const id = setInterval(() => {
|
||||
if (mounted) tick();
|
||||
}, 1000);
|
||||
return () => {
|
||||
mounted = false;
|
||||
clearInterval(id);
|
||||
};
|
||||
}, []);
|
||||
// 매 위 mounted flag 매 redundant — clearInterval 만으로 충분.
|
||||
// 매 그러나 async work 의 cancel 매 어려운 case 에서 유용.
|
||||
```
|
||||
|
||||
### Async cleanup pattern
|
||||
```tsx
|
||||
useEffect(() => {
|
||||
let cancelled = false;
|
||||
(async () => {
|
||||
const data = await loadData();
|
||||
if (!cancelled) setData(data);
|
||||
})();
|
||||
return () => { cancelled = true; };
|
||||
}, [id]);
|
||||
// 매 cleanup function 매 async X — return 의 Promise 매 React 가 무시.
|
||||
```
|
||||
|
||||
## 매 결정 기준
|
||||
| 상황 | Approach |
|
||||
|---|---|
|
||||
| Fetch | AbortController + abort. |
|
||||
| Subscription | unsubscribe 직접 return. |
|
||||
| Timer | clearTimeout/Interval. |
|
||||
| Listener | addEventListener / removeEventListener pair. |
|
||||
| 매 cleanup 불필요 | 매 console.log, 매 pure side-effect 없는 derivation. |
|
||||
|
||||
**기본값**: 매 모든 setup 의 paired teardown — 매 symmetric. 매 deps 가 자주 바뀌면 cleanup 의 cost 도 고려.
|
||||
|
||||
## 🔗 Graph
|
||||
- 부모: [[useEffect]] · [[React Hooks]]
|
||||
- 변형: [[useLayoutEffect]] · [[useInsertionEffect]] · [[useSyncExternalStore]]
|
||||
- 응용: [[AbortController]] · [[WebSocket]] · [[IntersectionObserver]]
|
||||
- Adjacent: [[StrictMode]] · [[React Lifecycle]] · [[Race Condition]]
|
||||
|
||||
## 🤖 LLM 활용
|
||||
**언제**: 매 모든 useEffect 안의 subscription, timer, listener, abortable async work 의 정리.
|
||||
**언제 X**: 매 effect 가 pure derivation (state from props) — 매 useMemo 가 더 적합. 매 effect 자체 가 불필요한 case.
|
||||
|
||||
## ❌ 안티패턴
|
||||
- **Cleanup 망각**: 매 listener leak — 매 unmount 후 setState 호출 → console warning.
|
||||
- **Async cleanup return**: 매 `return async () => {...}` — 매 React 가 Promise 무시. 매 sync function.
|
||||
- **Stale ref 캡처**: 매 cleanup 의 closure 가 이전 dep value 사용 — 매 명시적으로 ref 또는 latest pattern.
|
||||
- **deps 빠짐**: 매 cleanup 가 outdated value 정리 — 매 ESLint react-hooks/exhaustive-deps 권장.
|
||||
- **StrictMode 의 cleanup 회피 수단**: 매 `if (didMount.current) return; didMount.current = true` — 매 anti-pattern. 매 cleanup 정확성 으로 해결.
|
||||
|
||||
## 🧪 검증 / 중복
|
||||
- Verified (React docs useEffect, React 18 StrictMode docs, Dan Abramov 의 useEffect 글).
|
||||
- 신뢰도 A.
|
||||
|
||||
## 🕓 Changelog
|
||||
| 날짜 | 변경 |
|
||||
|---|---|
|
||||
| 2026-05-08 | Phase 1 |
|
||||
| 2026-05-10 | Manual cleanup — useEffect cleanup patterns, AbortController, StrictMode 대응 추가 |
|
||||
|
||||
Reference in New Issue
Block a user