Vue.js에서 `setInterval` 및 `setTimeout` 클린업 기법

Vue.js 컴포넌트에서 setInterval 또는 setTimeout을 사용하여 주기적으로 작업을 수행할 때, 컴포넌트가 파괴될 때 이러한 타이머를 올바르게 해제하는 것은 메모리 누수 및 예기치 않은 동작을 방지하는 데 중요합니다. 일반적인 구현 방식과 잠재적 문제점, 그리고 Vue의 내장 기능을 활용한 효과적인 해결 방법을 살펴보겠습니다.

문제 상황

다음은 로그 데이터를 주기적으로 가져오는 Vue 컴포넌트의 예시입니다:

<template>
	<div>
		<p v-for="item in logList" :key="item.time">
			<span>{{ "[" + item.time + "]" }}</span>
			<span>{{ item.log }}</span>
		</p>
	</div>
</template>

<script>
	import { Component, Vue } from 'vue-property-decorator';
	import { getLogList } from './api';

	@Component({})
	export default class LogViewer extends Vue {
		logList = [];
		timerId = null; // 타이머 ID를 저장할 변수

		mounted() {
			this.fetchLogs();
		}

		async fetchLogs() {
			const response = await getLogList();
			if (response && response.logList) {
				this.logList = response.logList;
			}
			// setTimeout을 사용하여 재귀적으로 호출
			this.timerId = setTimeout(() => {
				console.log('Calling fetchLogs again. Timer ID:', this.timerId);
				this.fetchLogs();
			}, 1000);
		}

		beforeDestroy() {
			console.log('Component is about to be destroyed. Clearing timer:', this.timerId);
			clearTimeout(this.timerId); // 타이머 해제 시도
			this.timerId = null;
		}
	}
</script>

이 코드는 언뜻 보기에는 문제가 없어 보이지만, 컴포넌트가 파괴된 후에도 API 호출이 계속되는 현상을 발견할 수 있습니다. 이는 beforeDestroy 훅에서 clearTimeout을 호출하더라도, fetchLogs 함수가 호출될 때마다 timerId에 새로운 ID 값이 할당되기 때문입니다.

각 setTimeout 호출은 고유한 타이머 ID를 반환하며, beforeDestroy에서 해제하려는 timerId는 이미 다음 호출로 덮어쓰여 이전 타이머는 그대로 실행되는 식입니다. 네이티브 JavaScript에서는 전역 변수나 클로저를 사용하여 타이머 ID를 일관되게 관리하는 경우가 많았지만, Vue 컴포넌트의 라이프사이클에서는 이러한 방식이 적합하지 않을 수 있습니다.

해결 방법: `$once`와 이벤트 리스너

Vue는 컴포넌트 라이프사이클 이벤트에 대한 프로그래밍 방식의 리스닝을 지원하는 $once 메서드를 제공합니다. 이를 활용하면 타이머와 관련된 리소스를 컴포넌트가 파괴될 때 확실하게 정리할 수 있습니다.

<script>
	import { Component, Vue } from 'vue-property-decorator';
	import { getLogList } from './api';

	@Component({})
	export default class LogViewer extends Vue {
		logList = [];
		// timerId = null; // 인스턴스 변수로 timerId를 관리하지 않음

		mounted() {
			this.fetchLogs();
		}

		async fetchLogs() {
			const response = await getLogList();
			if (response && response.logList) {
				this.logList = response.logList;
			}

			// 현재 fetchLogs 실행 시점의 setTimeout ID를 반환받음
			const currentTimerId = setTimeout(() => {
				console.log('Recursive fetchLogs call.');
				this.fetchLogs();
			}, 1000);

			// 컴포넌트가 파괴되기 직전 'hook:beforeDestroy' 이벤트를 한 번만 리스닝
			this.$once('hook:beforeDestroy', () => {
				console.log('Clearing timer inside $once:', currentTimerId);
				clearTimeout(currentTimerId); // 해당 setTimeout만 명시적으로 해제
			});
		}

		// beforeDestroy 훅은 더 이상 필요하지 않음
	}
</script>

이 접근 방식은 다음과 같은 이점을 제공합니다:

  • 명확한 범위 관리: timerId가 컴포넌트 인스턴스의 상태로 유지되지 않아 불필요한 상태 관리를 줄입니다. 타이머 ID는 해당 fetchLogs 호출의 스코프 내에서만 유효하며, $once 콜백 함수에서 접근 가능합니다.
  • 의존성 분리: 타이머 생성 로직과 해제 로직이 좀 더 밀접하게 연관되어 관리하기 용이합니다.

TypeScript 환경에서의 추가 고려사항

TypeScript를 사용하는 프로젝트에서는 Node.js 환경의 타입 정의와 브라우저 환경의 타입 정의 간 충돌로 인해 추가적인 주의가 필요할 수 있습니다. Node.js 환경에서는 setTimeout 및 setInterval이 NodeJS.Timer 타입을 반환하지만, 브라우저 환경에서는 숫자 ID를 반환합니다.

이러한 타입 불일치로 인해 TypeScript 컴파일 오류가 발생할 경우, 명시적으로 window 객체를 사용하여 브라우저 API임을 지정해주는 것이 좋습니다:

const currentTimerId = window.setTimeout(() => {
	this.fetchLogs();
}, 1000);

this.$once('hook:beforeDestroy', () => {
	window.clearTimeout(currentTimerId);
});

window 접두사를 생략하면 Node.js 타입을 참조하여 Type 'Timer' is not assignable to type 'number'와 같은 타입 오류가 발생할 수 있습니다.

결론

$once('hook:beforeDestroy', ...)`를 사용하는 것은 Vue 컴포넌트 내에서 setTimeout, setInterval 뿐만 아니라 외부 라이브러리에서 생성된 인스턴스(예: date picker, charting library)를 정리하는 데에도 유용한 패턴입니다.

예를 들어, Pikaday와 같은 라이브러리를 사용할 경우 다음과 같이 정리할 수 있습니다:

mounted() {
	// Pikaday 라이브러리 인스턴스 생성
	const datePicker = new Pikaday({
		field: this.$refs.inputElement, // DOM 엘리먼트 참조
		format: 'YYYY-MM-DD'
	});

	// 컴포넌트 파괴 시 Pikaday 인스턴스의 destroy 메서드 호출
	this.$once('hook:beforeDestroy', function() {
		datePicker.destroy();
	});
}

이러한 방식을 통해 Vue 컴포넌트의 라이프사이클에 맞춰 리소스를 체계적으로 관리하고 메모리 누수를 예방할 수 있습니다.

태그: Vue.js JavaScript TypeScript setTimeout setInterval

10월 13일 03:22에 게시됨