React에서 Debouncing 좀 더 잘 적용해보기 / Custom Hook

시소·2024년 7월 13일

들어가며

리액트로 개발을 하다가 보면, 사용자 입력이나 API 호출과 같이 빈번하게 발생할 수 있는 이벤트를 처리할 때 흔히 성능 문제를 마주하게 된다. 이러한 상황에서 디바운싱(Debouncing)이 효과적으로 사용될 수 있지만, 막상 리액트의 특성을 잘 고려하지 못하고 구현해 버리면 오히려 예기치 못한 문제가 발생하게 될 수도 있다.

따라서 이번 포스팅에서는 리액트에서 디바운싱을 적용하며 마주했던 문제와, 그에 대한 해결 과정을 찾기까지의 과정을 정리해 보았다. 조사한 내용을 기반으로, 여러 훅을 활용해 좀 더 효율적이고 안정적인 디바운싱 구현 방법에 대해 알아보자.

Debouncing이 필요한 곳

사용자 입력을 처리할 때, 특히 ID 중복 체크 같은 기능을 구현해 본다고 생각해보자.
이 때 사용자가 키보드를 입력하는 대로, change event가 발생할 때마다 서버에 API 요청을 보내는 것은 매우 비효율적이며 서버에 부하를 주기도 한다. 이런 상황에서 적절한 기술이 일반적으로 함수가 호출되는 빈도를 제어할 수 있는 디바운싱(Debouncing)이다.

Debounce는 일정 시간동안 연속해서 여러 번 호출되는 함수 중 마지막 함수(또는 첫번째)만을 실행하도록 하는 기술이다. 이를 통해 사용자의 입력이 잠시 멈추는 순간에만 API 요청을 보내도록 최적화할 수 있다.

(유사한 개념으로는 Throttling이 있다. 일정 시간 간격으로 함수를 한 번씩만 실행하도록 하는 방식이다. 예를 들어 scroll event가 발생할 때, 스크롤 위치에 따라 어떠한 처리를 해줘야 할 때 스로틀이 도움이 될 수 있다.)

다시 돌아와서, 위의 중복 체크 기능을 실제 코드로 구현해 본다고 가정해보자.

ℹ️ 이 포스트에서는 debounce를 직접 구현하는 대신, 이미 구현되어 있는 lodash 라이브러리의 debounce 함수를 사용하였다.

직관적으로 구현해 본 코드

const InputBox = () => {
  const [value, setValue] = useState(''); // 입력 필드의 현재 값
  const [debouncedValue, setDebouncedValue] = useState(''); // 디바운싱으로 업데이트를 조절하고 싶은 값
  
  // API 요청을 보내는 함수 (예제에서는 단순하게 상태만 업데이트)
  const sendRequest = (val) => {
    setDebouncedValue(val);
  };
  
  // 콜백 함수를 디바운스 처리하기 위한 함수
  // 0.5초 동안 추가 호출이 없으면, 마지막 전달된 값으로 함수 실행
  const debouncedSendRequest = debounce(sendRequest, 500);
  
  // 입력 필드 값이 변경될 때마다 호출되는 핸들러
  const onChange = (e) => {
    const value = e.target.value;
    setValue(value); // 입력 필드의 현재 값을 즉시 업데이트
    debouncedSendRequest(value); // 디바운스 처리된 함수를 호출
  };
  
  // 디바운스 된 값 업데이트를 확인하려 임시로 넣은 이펙트
  useEffect(() => {
    console.log(debouncedValue);
  }, [debouncedValue]);
  
  return (
  	<>
      <input type="text" value={value} onChange={onChange} />  
      <p>debounced value: {debouncedValue}</p>
    </>
  );
}

이 코드는 꽤 논리적으로 보인다. 하지만, 실제 실행시켜서 입력 필드에 값을 입력해 보면 예상과는 조금 다르게 동작한다.

"안녕하세요"를 빠르게 타이핑 하면 입력이 다 끝날때까지 기다렸다가 debouncedValue에 "안녕하세요"가 저장될 것 같지만, 실제로는 "ㅇ", "아", "안", "안ㄴ", "안녀", "안녕", ... 과 같은 식으로 순차적으로 저장이 된다.

단지 기존의 방식에서 아주 약간의 지연만 일어나 보일 뿐이다. 왜 그런 것일까?

문제 원인 분석

re-rendering으로 인한 현상

컴포넌트가 리렌더링 되는 주된 상황 중 하나는, 상태가 변경되었을 때이다.

위 코드의 경우 사용자가 입력 필드에 타이핑할 때마다, onChange가 호출되고, 그 안에서 setValue로 상태 업데이트가 발생함에 따라 컴포넌트 리렌더링이 일어난다.

문제는 리렌더링이 일어날 때마다 debouncedSendRequest 함수가 새로 생성된다는데 있다.

React는 기본적으로 컴포넌트가 re-rendering 되면, 모든 자식들을 재귀적으로 re-rendering한다.
JavaScript에서 function () {} 또는 () => {}가 항상 새 객체를 생성하는 것과 유사하게, {} 객체 리터럴도 항상 다른 함수를 생성한다.
출처: useCallback Reference

이로 인해 매 렌더링 마다 debounce(callback, delay)가 새로 호출되고, 이전의 디바운스 타이머는 무시한 채 새 타이머를 다시 생성하게 되는 것이다.
문제는 여기서 끝나지 않는다. 이전에 생성된 함수들이 정리되지 않은 채로 메모리에 남아, 각자의 타이머가 완료될 때까지 대기하게 된다. 타이머가 종료되어야 자신의 콜백을 실행한 뒤 가비지 컬렉션의 대상이 된다.

그러한 과정으로 의도 했던 디바운싱 효과가 제대로 적용되지 않았던 것이다.
실제로 원하는 것은 '내부 타이머와 반환된 함수를 보존하도록 디바운싱된 함수를 한 번만 생성하는 것'이다.
어떤 방식으로 이를 달성할 수 있는지 알아보자.

해결 과정

useCallback 훅과 useMemo 훅

위에서 작성했었던 2개의 함수를 아래와 같이 변경하였다.

const sendRequest = useCallback((val) => {
  setDebouncedValue(val);
}, []);

const debouncedSendRequest = useMemo(() => {
  return debounce((val) => sendRequest(val), 500);  
}, [sendRequest]);

sendRequest

useCallback으로 함수를 메모이제이션 했다.
의존성이 변경될 때까지 리렌더링 간에 동일한 함수의 인스턴스를 재사용하도록 만들었다.
의존성 배열이 빈 배열([])이기 때문에, 컴포넌트가 마운트 될 때 한 번만 생성된다.

debouncedSendRequest

useMemo를 활용해 이번에는 디바운스 함수 자체를 메모이제이션 했다.
여기서 디바운스 함수는, sendRequest라는 콜백을 인자로 받아 debounce 함수의 실행 결과(즉, 디바운스 된 새로운 함수)를 반환하는 함수를 뜻한다.
이후 의존성 배열에 속한 sendRequest가 변경될 때만 새로 생성되며, 그 외의 경우는 이전과 동일한 debounce 된 함수를 재사용한다. (이 때 타이머와 같은 내부 상태가 그대로 유지된다.)

이제 브라우저에서 결과를 다시 한번 확인해 보자. 예상했던 대로 작동하기 시작한다.

만약 콜백 인자 대신 내부 상태값에서 작업하고자 한다면?

아까 작성했던 함수를 다시 한번 살펴보자. 여기서는 val이라는 값을 인자로 받아서 작업을 처리하고 있다.
해당 값은 사용자 입력에 맞춰 변경되는 상태 값으로, 컴포넌트 안에서 value로 직접 접근할 수도 있는 값이다.

const sendRequest = useCallback((val) => {
  setDebouncedValue(val);
}, []);

지금은 코드가 단순하지만, 실제 비즈니스 로직이 담겨 디바운스 함수가 복잡한 콜백 체인을 실행해야 한다면 어떨까? 콜백 체인에 계속해서 값을 인자로 전달하는 것은 바람직한 패턴이 아닐 수 있다. 따라서 디바운스 함수 내에서 직접 컴포넌트에서 관리되는 상태의 최신 값에 접근하기 위해 아래와 같이 코드를 수정해볼 수 있다.

const sendRequest = useCallback(() => {
  // state로부터 오는 값
  setDebouncedValue(value);
}, [value]);

const debouncedSendRequest = useMemo(() => {
  return debounce(sendRequest, 500);
}, [sendRequest]);

이걸로 완벽한 솔루션이라고 할 수 있을까? 아쉽지만, 브라우저에서 다시 확인해 보면 다시 디바운싱 처리 되기 이전처럼 입력에 약간의 딜레이만 생겼던 모습으로 되돌아갔다.

현재 문제점은 입력 값이 변경될 때마다 sendRequest 함수가 새로 생성되고, 이로 인해 debouncedSendRequest도 매번 새로 생성되어 디바운싱 효과가 사라진다는 것이다.

이 문제애 대한 해결책으로 도움이 될 만한 훅으로, useRef 훅이 있다. 해당 훅을 활용해 지금 마주한 문제를 해결해 보자.

useRef 훅

useRef는 렌더링과 관련되지 않은 값을 참조하는 데 도움을 주는 훅이다. 주로 렌더링에 영향을 주지 않는 데이터를 저장하는 목적으로 사용된다.

여기서는 컴포넌트의 수명 동안 유지되며, 컴포넌트가 리렌더링 되어도 초기화 되지 않고 그 값을 계속 유지한다는 특성을 이용할 것이다. 즉, 리렌더링 할 때마다 디바운싱된 함수를 재생성하지 않는 목적으로 사용할 것이다.

일반적으로 아래와 같은 흐름으로 작성된다.

// 기존의 debouncedSendRequest 함수
const ref = useRef(debounce(() => {
  // ...
}, 500));

const onChange = (e) => {
  const value = e.target.value; 
  setValue(value);
  
  // 디바운스된 함수 호출
  ref.current();
};

기존의 useMemo를 통해 작성했던 함수를, ref 기반으로 바꾸어 보았다.

하지만 아직 2% 모자란 부분이 있다. 바로 이 솔루션은 ref 내부에 상태에 대한 참조가 없을 때만 동작한다는 점이다. 만약 ref 안에 상태를 사용하는 부분이 있다면, 그때의 상태값은 실시간으로 업데이트 되는 값이 아닐 것이다. 컴포넌트가 마운트 되는 시점에 ref가 초기화될 때 가져온 값이 컴포넌트 수명 주기에 걸쳐서 사용된다.

useEffect와 결합하여 코드 완성시키기

이제 ref 기반으로 코드를 작성해 함수를 렌더링 간 지속되도록 만들고, useEffect와 결합하여 함수 내부에서 최신 상태 값에 접근할 수 있게 만들어 보자.

// 변화하는 value에 따라 실제 로직이 들어가는 곳
const sendRequest = () => {
  setDebouncedValue(value);
};

// 최신 value 값을 가지고 있는 sendRequest 함수에 대한 참조를 유지하는 곳
const callbackRef = useRef(sendRequest);

// 디바운스 함수를 한 번만 생성하고 메모이제이션 하기 위한 함수
// 컴포넌트 생명주기 동안 한 번만 생성됨
const debouncedCallback = useMemo(() => {
  return debounce(() => callbackRef.current(), 500);
}, []);

// value나 sendRequest가 변경될 때마다 디바운스 함수의 참조를 업데이트
// 이를 통해 디바운스 함수가 항상 최신 상태의 sendRequest를 호출
useEffect(() => {
  callbackRef.current = sendRequest;
}, [value, sendRequest]);

// 입력 필드 값이 변경될 때마다 호출되는 핸들러
const onChange = (e) => {
  setValue(e.target.value);
  debouncedCallback();
};

리액트의 여러 훅들이 동시에 활용되고 있기에, 코드가 다소 복잡해 보이기는 한다.
하지만 컴포넌트가 복잡해 지거나 성능이 중요하게 고려되어야 하는 경우 이와 같이 작성해 활용해 볼 수 있다.

다만, 마지막으로 추후 디바운스 함수를 다른 여러 컴포넌트에서도 활용할 수 있도록 분리하여 커스텀 훅으로 만들어 보고 이번 포스팅을 마무리 해보려 한다.

최종 수정된 코드

useDebounce.jsx

export function useDebounce(callback, delay = 500) {
  const callbackRef = useRef();

  const debouncedCallback = useMemo(() => {
    return debounce(() => callbackRef.current(), delay);
  }, [delay]);

  useEffect(() => {
    callbackRef.current = callback;
  }, [callback]);

  return debouncedCallback;
}

InputBox.jsx

const InputBox = () => {
  const [value, setValue] = useState("");
  const [debouncedValue, setDebouncedValue] = useState("");

  const sendRequest = useDebounce(() => {
    setDebouncedValue(value);
  });

  const onChange = (e) => {
    setValue(e.target.value);
    sendRequest();
  };

  return (
    <>
      <input type="text" value={value} onChange={onChange} />
      <p>debounced value: {debouncedValue}</p>
    </>
  );
}

별도의 커스텀 훅으로 분리하고 난 후의 모습을 보면 확실히 좀 더 간결해 보인다.

이제 원래의 컴포넌트에서 useMemo나 useCallback 등 번거로운 체인이나 종속성에 대한 걱정 없이도, useDebounce 안에 비즈니스 로직을 전달함으로써 원하는 작업에 디바운스 효과를 적용시키도록 만들 수 있었다. 물론, 디바운싱과 마찬가지로 스로틀 함수도 비슷한 방식으로 구현해 볼 수 있을 것이다.

마치며, 결론

지금까지 리액트에서 디바운싱 처리를 위한 함수를 구현해보는 과정을 통해 몇 가지 교훈을 얻을 수 있었다.

성능 최적화의 중요성: useCallback, useMemo, useRef 등 여러 훅을 적절히 활용하며, 불필요한 렌더링과 함수가 재생성 되는 것을 방지하여, 애플리케이션의 성능 향상을 이끌어낼 수 있었다.
디바운싱 적용: 사용자 입력, API 호출, 자동 완성 등 많은 시나리오에서 디바운싱이 유용하게 사용될 수 있다는 걸 확인하였다. 사용자 경험 뿐 아니라 서버 측의 부하 감소에도 큰 도움이 될 수 있다.
로직의 적절한 분리: 복잡한 로직을 구현하면서도, 코드의 가독성과 유지보수성을 향상시키기 위해 커스텀 훅을 사용해 로직을 적절하게 분리하고 간결하게 표현하는 것의 중요성을 느꼈다.

또한 이렇게 비동기 작업이나 타이머와 연관된 작업인 경우, 리액트의 라이프사이클이나 렌더링 특성을 잘 이해하지 못하고 사용하게 되면 올바르게 동작하지 않을 위험이 있다. 따라서 작업이 의도한 대로 작동하도록 만들기 위해 리액트의 기본 원리와 훅의 동작 방식을 제대로 이해하고 적용하는 것이 중요하다고 다시 한번 느끼게 되었다.