본문으로 건너뛰기

Suspense, Error Boundary와 선언적 데이터 패칭

· 약 11분
Dongkyu Kim
Dongkyu Kim
Front-end Developer

데이터 요청 상태에 따라 다르게 노출되는 UX/UI 설계는 많은 고민을 필요로 한다. 이러한 문제를 해결하기 위해 React는 다양한 방법을 제공하는데, 그 중 Suspense와 ErrorBoundary를 활용한 선언적 데이터 패칭이 있다.

지금부터 Suspense와 ErrorBoundary를 활용한 선언적 데이터 패칭이 어떻게 효과적인지 함께 알아보자.


전통적인 데이터 패칭 처리​

데이터 패칭은 전통적으로(?) 컴포넌트 내부에서 data, loading, error의 상태들을 사용하여 반환되는 컴포넌트에 대한 분기 처리로 이루어졌다. 아래의 예시 코드는 비동기 요청으로 데이터를 받아와 사용자에게 전달하는 간단한 컴포넌트다.

SampleContents.jsx
const SampleContents = () => {
  const [sampleDatas, setSampleDatas] = useState();
  const [isLoading, setIsLoading] = useState(false);
  const [error, setError] = useState();

  useEffect(() => {
    (async () => {
      try {
        setIsLoading(true); // isLoading 상태변경
        const { data } = await queryFn(); // axios get 요청 예시 함수
        setSampleDatas(data);
      } catch (e) {
        setError(e);
      } finally {
        setIsLoading(false); // 성공이든 실패이든 isLoading은 false
      }
    })();
  }, []);

  if (isLoading) {
    return <Loader />;
  }

  if (error) {
    return <Error error={error} />;
  }

  return (
    <div>
      {sampleDatas.map(data => (
        <Content data={data} />
      ))}
    </div>
  );
};

export default SampleContents;

비동기 함수 queryFn가 반환하는 데이터가 들어오기 전까지 isLoading, error 상태에 따라 반환되는 컴포넌트를 분기 처리하여 로딩 중일 땐 <Loader />를 반환하고 에러가 발생했을땐 <Error />를 반환하며 사용자에게 정확한 정보를 전달할 수 있다.

React Query​

React-Query는 비동기 요청을 효과적으로 관리할 수 있는 캐싱 라이브러리다. React-Query API들이 제공하는 프로퍼티를 활용하면 좀 더 깔끔하게 비동기 로직을 처리할 수 있다.

SampleContents.jsx
const SampleContents = () => {
  const {
    data: sampleDatas,
    isLoading,
    error,
  } = useQuery({ queryKey, queryFn });

  if (isLoading) {
    return <Loader />;
  }

  if (error) {
    return <Error error={error} />;
  }

  return (
    <div>
      {sampleDatas.map(data => (
        <Content data={data} />
      ))}
    </div>
  );
};

export default SampleContents;

React Query의 API useQuery가 반환하는 isLoading, error 와 같은 프로퍼티를 통해 useEffect를 제거하고 useState 줄이는 등 컴포넌트 내부 로직을 좀 더 간소화해서 첫번째 예시와 마찬가지로 데이터 요청 상태에 따라 반환되는 컴포넌트 랜더링 여부를 작성할 수 있다.

선언적 데이터 패칭​

선언적 데이터 패칭은 React의 주요 개념인 **'선언형 프로그래밍'**에 기반한다. 이는 상태의 변화에 따라 UI를 직접 조작하지 않고, 어떤 상태에 따라 어떤 UI가 보여져야 하는지만 집중할 수 있다.

이러한 접근법은 비동기 작업의 복잡성을 크게 줄여주며 코드의 가독성과 유지보수성을 향상시키는데, Suspense와 ErrorBoundary는 선언형 프로그래밍 방식으로 비동기 작업과 에러 처리를 담당한다.

우선 Suspense와 Error Boundary에 대해 간단하게 살펴보자.

Suspense​

Suspense를 사용하면 자식이 로딩을 완료할 때까지 fallback을 표시할 수 있다. React는 자식에게 필요한 모든 코드와 데이터가 로드될 때까지 로딩 fallback을 표시한다.

// React 공식 문서의 예제
<Suspense fallback={<Loading />}>
  <SampleContents />
</Suspense>

Error Boundary​

Error Boundary는 하위 컴포넌트 트리에서 발생하는 에러를 캡처하여 대체 UI를 보여주거나 에러 리포팅 등의 작업을 수행한다.

필요에 따라 커스터마이징을 할 수 있는데, ErrorBoundary의 커스터마이징에 대한 내용은 또 다른 포스팅으로 진행해보겠다.

추천 라이브러리

react-error-boundary

React-Query 와 Suspense, Error Boundary 사용하기

useQuery를 Suspense, Error Boundary와 함께 사용하려면 suspense: true 옵션을 넣어주면 된다.

SampleWrapper.jsx
const SampleWrapper = () => {
  // ...

  return (
    <ErrorBoundary fallback={<Error />}>
      <Suspense fallback={<Loader />}>
        <SampleContents />
      </Suspense>
    </ErrorBoundary>
  );
};

export default SampleWrapper;
SampleContents.jsx
const SampleContents = () => {
  const { data: sampleDatas } = useQuery({ queryKey, queryFn, suspense: true });

  return (
    <div>
      {sampleDatas.map(data => (
        <Content data={data} />
      ))}
    </div>
  );
};

export default SampleContents;

Suspense는 컴포넌트가 준비될 때까지 대기하고 fallback props로 받은 컴포넌트를 보여주는 역할을 한다. 이로 인해 로딩 상태에 따른 로직이 컴포넌트 외부로 추출되어 각 컴포넌트에서 로딩 상태를 확인하고 처리할 필요가 없어진다.

Error Boundary는 하위 컴포넌트 트리에서 발생하는 에러를 캡처하여 대체 UI를 보여주거나 에러 리포팅 등의 작업을 수행한다. 이로 인해 각각의 컴포넌트에서 에러 처리 로직이 분산되지 않고 한 곳에서 관리될 수 있다.

위의 코드에서 볼 수 있듯이, Suspense와 ErrorBoundary를 사용하면 로딩 상태와 에러 처리 로직을 컴포넌트 외부로 분리하여 관리할 수 있는데, 컴포넌트로부터 분리된 로직으로 코드의 가독성을 높이고 유지보수를 용이하게 한다.

팁

모든 쿼리문에서 사용할 것 이라면 QueryClient를 생성할때 기본 옵션으로 지정해 줄 수 있다.

const queryClient = new QueryClient({
  defaultOptions: {
    queries: {
      suspense: true,
    },
  },
});
팁

ErrorBoundary는 하위 컴포넌트들의 에러들을 공통으로 처리할 수 있다.

ChildWrapper.jsx
const ChildComponent = () => {
  // ...

  return (
    <Suspense fallback={<Loader />}>
      <SampleContents />
    </Suspense>
  );
};
ParentWrapper.jsx
const ParentComponent = () => {
  // ...
  // 하위 컴포넌트에서 발생하는 error를 모두 캐치

  return (
    <ErrorBoundary fallback={<Error />}>
      <ChildComponent />
      <ChildComponent2 />
      <ChildComponent3 />
    </ErrorBoundary>
  );
};

선언적 데이터 패칭을 할 때 의 주의사항​

선언적 데이터 패칭은 많은 장점을 가지고 있지만, 몇 가지 주의사항도 존재한다.

경고

No Silver Bullet, 은탄환은 없다

비동기 요청 Waterfall​

Suspense로 감싼 컴포넌트 내에서 여러개의 useQuery를 사용하는 경우 비동기 요청 Waterfall이 발생한다.

<Suspense fallback={<Loading />}>
  <SampleContents /> // 3개의 query문이 있는 컴포넌트
</Suspense>

example image 1

<Suspense fallback={<Loading />}>
  <SampleContents1 /> // 1개의 query문 있는 컴포넌트
  <SampleContents2 /> // 1개의 query문 있는 컴포넌트
  <SampleContents3 /> // 1개의 query문 있는 컴포넌트
</Suspense>

example image 1

React Query v4.5 이후의 최신 버전을 사용한다면 useQuery대신 useQueries의 사용을 고려해 볼 만하다. 비동기 요청을 병렬로 처리해 주며 Suspense를 지원해 준다!

Loader와 Skeleton의 사용자 경험에 대한 고민필요​

데이터 패칭 시간이 짧은 경우 Loader나 Skeleton UI 같은 컴포넌트의 노출은 사용자에게 깜빡이는 오류 현상 처럼 보일 수 있어 오히려 부정확한 정보 전달 및 사용자 경험 저하로 이어질 수 있으므로 신중하게 고려해야 한다.

DeferredLoader.jsx
const DeferredLoader = () => {
  const [isDeferred, setIsDeferred] = useState(false);

  useEffect(() => {
    const id = setTimeout(() => {
      setIsDeferred(true);
    }, 200);
    return () => clearTimeout(id);
  }, []);

  if (!isDeferred) {
    return null;
  }

  return <Loader />;
};

짧은 시간 내에 비동기 상태가 변경되지 않으면 Loader나 Skeleton UI 대신 null을 반환하여 화면을 그리지 않고 그 이상의 로딩 시 Loader나 Skeleton UI를 노출하는 방식도 고려할 만하다.

결론​

지금까지 Suspense와 ErrorBoundary를 활용한 선언적 데이터 패칭에 대해 알아봤다.

Suspense와 ErrorBoundary를 활용한 비동기 처리는 컴포넌트의 가독성, 유지보수 측면, 비즈니스 로직 분리 측면에서 상당한 이점이 있지만, 무분별한 Suspense, ErrorBoundary는 성능 저하, 사용자 경험 저하를 일으킬 수 있기 때문에 장단점을 좀 더 고민하고 동작 원리와 적절한 사용성에 대해 탐구해 나아가야 할 것 같다.