01

My구독의 React Query 전환기

안녕하세요, 톡FE파트에서 My구독, 이모티콘 스토어를 개발하고 있는 Hugo입니다.

My구독은 정기 결제를 통해 ‘이모티콘 플러스’, ‘톡서랍 플러스’ 서비스를 이용할 수 있는 구독형 서비스입니다. 이번에 My구독에서 Redux와 Redux-Saga를 제거하고, React Query(v.3.34.0)로 전환하면서 느낀 점들을 공유드리려고 합니다.

– 이 글은 React Query(v.3.34.0) 기준으로 작성되었습니다.


React Query란?

React Query에 대한 내용은 공식 사이트에 자세히 설명되어 있으니 간단한 소개만 드리겠습니다.

React Query는 데이터 Fetching, 캐싱, 동기화, 서버 쪽 데이터 업데이트 등을 쉽게 만들어 주는 React 라이브러리입니다. 기존에 Redux, Mobx, Recoil과 같은 다양하고 훌륭한 상태 관리 라이브러리들이 있긴 하지만, 클라이언트 쪽의 데이터들을 관리하기에 적합할 순 있어도 서버 쪽의 데이터들을 관리하기에는 적합하지 않은 점들이 있어서 등장하게 되었습니다.

예를 들어, 관리자 화면에서 동시에 두 명의 관리자가 같은 페이지를 바라보고 있는 상황에서 한 관리자가 유저의 데이터를 변경하면, 다른 관리자도 그 유저의 변경된 데이터를 바라볼 수 있어야 합니다. 이러한 유저의 데이터는 클라이언트 쪽보다는 서버 쪽에 좀 더 적합하다고 볼 수 있습니다.


React Query로 전환한 이유

My구독은 클라이언트 데이터보다 서버 데이터에 의존적인 성향의 서비스입니다.

클라이언트의 복잡도가 높지 않고, 각 페이지에서 공통적으로 사용하는 전역 상태 데이터를 많이 가지고 있지도 않았습니다.

프로젝트 구성 당시에는 Redux와 Redux-Saga를 같이 사용하였습니다. 하지만, 프로젝트를 진행하면서 점점 API가 추가가 되고, 하나의 API 당 1~4개의 액션 타입과 액션들이 생성되는 등 Ducks 구조와 Saga 파일들로 인해 프로젝트의 구성이 좀 더 복잡해지는 걸 느끼고 있었습니다.

가지처럼 뻗어 나가는 Redux-Saga의 사이드 이펙트들을 체계적으로 잘 관리, 제어할 수 있다면 Redux-Saga를 유용하게 사용할 수 있겠지만, Saga가 다른 Saga를 호출하고, 또 다른 Saga를 호출하는 등의 과정이 들어가면, 사이드 이펙트들을 관리하고 흐름을 제어하는 게 쉽지 않을 수 있습니다. 

또한, 서버의 데이터와 클라이언트의 데이터 구분의 모호함도 존재하였고, 서버의 응답을 Store에 저장할 필요가 없는 상황에서도 구조화를 위해 Action Types, Actions, Reducer를 만들고, Action을 호출하는 등의 불필요한 상황, 캐싱 처리 및 관리 문제 등이 존재하였습니다.

이러한 상황에서 Redux와 Redux-Saga를 활용한 구조는 My구독의 서비스 로직과는 잘 맞지 않았습니다. 이후 프로젝트에 기능이 추가될수록 더 무거워지고 복잡해지면서 관리가 어려울 수 있다는 내부 의견들이 있었고, 좀 더 서비스에 적합한 라이브러리를 찾다가 React Query를 알게 되었습니다.

React Query를 일부 페이지에 적용하여 테스트를 진행해 보니 다음과 같은 이점들 때문에, 점진적으로 적용하게 되었습니다.

  1. 프로젝트 구조가 기존보다 단순해졌습니다.
  2. 캐싱 처리가 더 간단해졌습니다.
  3. 직접 만들어서 사용했던 기타 기능들을 옵션으로 지원합니다.
  4. Redux와 Redux-Saga를 사용할 때는 Success, Failure 값을 useEffect의 deps로 전달해서 처리해야 하는 과정이 필요했었는데, 이 과정을 onSuccess와 onError로 간단하게 처리할 수 있었습니다.

React Query 외에도, RTK-Query, SWR 등이 있지만, React Query에 비해 오프라인 처리, 쿼리의 select와 같은 기능들이 부족하다고 판단하여 React Query로 전환하였습니다.

React Query 전환

React Query를 사용하면서 어떻게 사용해야 할지 여러 가지 시도를 해보았고, 지금도 계속해서 여러 방법을 연구하고 있습니다. 전환 과정에서 초기에는 어떻게 설정하고 사용하였는지 공유드리겠습니다.

 

1. QueryClient의 Default Option

먼저, QueryClient의 Default Option을 보자면, retry 옵션은 API가 실패하면 설정한 값만큼 재시도 하는 옵션입니다. 

My구독에서는 API 요청 실패가 발생한다는 건, 서버의 문제가 있다고 판단하여 유저에게 빠른 응답을 보여주기 위해 0으로 설정하였습니다.

useErrorBoundary옵션은 리액트16 이상에서 제공하는 Fallback UI 설정에 대한 옵션입니다. 예기치 못한 에러 케이스가 생길 수 있다고 판단하여 queries와 mutations에 true 값으로 설정하였습니다.

				
					new QueryClient({
  defaultOptions: {
    queries: {
      retry: 0,
      useErrorBoundary: true,
    },
    mutations: {
      useErrorBoundary: true,
    },
  },
});

				
			

2. useQuery 사용

useQuery 같은 경우는 각 도메인 페이지에서 필요한 옵션들을 설정하여, src/hooks/queries에 선언된 쿼리들을 불러와서 사용하고 있었습니다.

				
					// src/pages/subscribe/index.jsx
import { useKioskData } from '@/hooks/queries;
const { isLoading, data: kioskData } = useKioskData({ storeCode, options: {
      onError:()=>{...}
      onSuccess: () => {...},
});

 
//src/hooks/queries/useKioskData.js
import { useQuery, useInfiniteQuery } from 'React Query';
import * as queryKeys from '@/constant/queryKeys';

export function useKioskData({ storeCode, options }) {
  return useQuery([queryKeys.KIOSK_DATA, storeCode], () => api.get(`...`), {
    select: ({ data }) => data?.kioskData,
    ...options,
  });
}


				
			

3. Query Key의 관리

React Query에서는 Query Key가 중복되지 않게 관리해야 캐싱을 활용할 수 있기에, 휴먼 에러를 방지하고자, 하나의 파일에서 관리하고, 접두사로는 도메인 네임을 설정하여 구분을 지었습니다.

React Query 개선

 

프로젝트를 진행하면서, 기존 Redux, Redux-Saga 부분을 걷어내고 React Query를 점진적으로 적용하고 있었습니다.

다만, 세부적인 규칙이 없어 제각각 사용법이 달라 코드 리뷰 과정에서 조금 혼동이 있었고, 컴포넌트가 복잡해지는 문제도 있었습니다.

프로젝트 이후에, My구독의 React Query 사용 방식을 정리하고, 좀 더 구조적으로 개선하는 작업을 진행하였습니다.

 

1. Query Key 네이밍 수정

파일은 기존 방식과 동일하게 중복되는 네이밍을 방지하기 위해 하나의 파일에서 관리하였습니다.

Query Key가 증가하면서, 기존의 네이밍 컨벤션으로는 조금 혼란스러운 점이 있어서, 리팩토링을 진행하면서 Query Key의 네이밍도 수정을 하였습니다.

접두사로는 그대로 도메인 그룹을 지정, 중간에는 query의 함수 이름을 추가하고, 접미사로는 API 응답에 영향을 주는 값으로 지정하였습니다.

[{도메인 그룹}_{query 함수 이름}, …(API 응답에 영향을 주는 값)]

 

2. useQuery에 중복되는 옵션 제거

defaultOptions에 useErrorBoundary를 true로 설정하였지만, 해당 값은 onError 옵션 값 여부에 따라 필요하지 않을 수 있습니다. 이런 부분을 매번 options 값을 확인하고 false로 설정하는 작업은 불필요할 수 있고, 휴먼에러가 생길 수 있기에 useQuery를 감싸서 처리하는 방식으로 변경하였습니다.

				
					import { useQuery as useQueryOrigin } from 'React Query';

export default function useQuery(queryKey, queryFn, options = {}) {
  const { onError } = options;

  return useQueryOrigin(queryKey, queryFn, { ...options, useErrorBoundary: !onError});
}

				
			

3. useQuery의 분리

먼저, 리팩토링 전, 기존의 폴더 구조를 보자면, pages 폴더 내에 각 페이지들이 선언되어 있고, 쿼리들의 정의는 src/hooks/queries에서 관리하고 있었습니다.

다른 페이지에서도 사용하는 공통적인 쿼리들이 존재할 수 있어 /src/hooks/queries에 도메인 별로 나눠서 쿼리들을 정의하였습니다.

위와 같이 구조화하고, 사용하다 보니 약간의 문제가 있었습니다.

useQuery를 사용할 때 options 쪽의 내용이 많아질수록, 컴포넌트의 복잡도가 증가하는 문제가 있었고, 병렬적으로 선언된 쿼리가 많아질수록 복잡도가 더 증가했었습니다.

				
					const voucher = useVoucherQuery({
  options: {
    enabled: productDataSuccess,
    useErrorBoundary: false,
    refetchOnMount: false,
    refetchInterval: false,
    refetchOnReconnect: false,
    refetchOnWindowFocus: false,
    refetchIntervalInBackground: false,
    select: () => {
      ...
    },
    onSuccess: () => {
      ...
    },
    onError: () => ...,
  },
});

				
			

이러한 문제를 해결하고자, 쿼리들을 컴포넌트에서 분리하였습니다.

src/hooks 아래에 있는 API에 매칭되는 모든 쿼리의 선언부들은 기존 방식 그대로 유지하였습니다. (이하 베이스 쿼리)

컴포넌트 내부에서 사용되던 options 설정이 들어간 커스텀 한 쿼리들은 각 페이지별 hooks 폴더 아래로 위치 시키고, 각 페이지에서 필요한 베이스 쿼리들을 불러와서 필요한 옵션들을 설정해서 사용하는 방식으로 변경하였습니다. (이하 커스텀 쿼리)

위와 같이, 커스텀 쿼리는 각 컴포넌트에서 필요한 서비스 로직을 정의하고, 베이스 쿼리를 활용하여 구조화하였습니다.

베이스 쿼리에서는 위에서 불필요한 useErrorBoundary 옵션을 제거하는 useQuery를 래핑한 함수를 사용하였습니다.

				
					/* src/hooks/queries/voucher.js (베이스 쿼리) */
import { useQuery } from '@/hooks/queries/useQuery';
export function voucher({ storeCode, options } = {}) {
  return useQuery([queryKeys.VOUCHER_LIST, storeCode], () => api.get('...'), {
    ...options,
  });
}

/* src/pages/Voucher/hooks/queries/useVoucher.js (커스텀 쿼리) */
export function useVoucher({storeCode}) {
  return voucher({storeCode, options:{
    // ...
  }})
}

				
			

이처럼 분리가 가능했던 이유는 다른 페이지 내에서 공통적으로 사용하는 API가 많지 않았고, 공통적으로 사용하는 API는 각 페이지마다 options에 대한 설정이 달랐기에 위와 같이 변경할 수 있었습니다.


React Query 사용 주의사항

React Query를 사용하면서 몇 가지 헷갈릴 수 있는 내용을 정리해 보았습니다.

 

1. useQueries에는 options 값을 설정할 수 없습니다.

useQueries는 쿼리들을 묶어서 처리할 수 있게 해주는 훅입니다. useQueries 자체적으로는 options 값을 설정할 수는 없지만, useQueries 안에 선언되는 쿼리는 options 값을 설정할 수 있습니다. options에 대한 Object 값을 설정하는 게 아닌, options에 대한 값 자체를 선언해야 동작합니다.

 

2. isLoading은 캐싱 된 데이터가 없을 때만 true를 리턴합니다.

isFetching은 캐싱 된 데이터 유무에 상관없이 데이터 Fetching 때마다 true를 리턴합니다. 반면, isLoading은 캐싱 된 데이터가 없을 때만 true를 리턴합니다. (initialData 옵션을 설정하면 항상 false를 리턴합니다.) 둘의 차이를 알면 더 적합한 Loading Indicator를 사용할 수 있습니다.

 

3. useMutation의 mutate함수는 Promise를 반환하지 않습니다.

GET 방식이 아닌 POST, PUT, DELETE 등의 Http Method를 사용할 때는 React Query의 useMutation을 활용하게 됩니다. useMutation의 mutate 함수를 사용하면, useMutation에 설정한 onSuccess, onError와 같은 옵션을 통해서 서버의 응답 결과를 처리할 수 있습니다.

mutate 함수는 Promise를 반환하지 않기 때문에, 이러한 설정 없이 const result = await mutate() 와 같은 방식으로 직접적으로 결과를 할당해서 사용할 수 없습니다.

반면에, mutateAsync 함수는 Promise를 반환하기 때문에 직접적인 사용이 가능합니다. try catch 문안에 mutateAsync를 호출하여 성공, 실패와 같은 서버의 응답 결과를 처리할 수 있습니다.

Redux-Saga를 사용했을 때는 takeLatest와 같은 이펙트를 사용하여 API의 중복 호출을 제어할 수 있었지만, useMutation은 중복 호출에 대한 제어 옵션이 없기 때문에 이를 제어하기 위해서는 쓰로틀링, 디바운싱을 구현해서 사용하거나, isLoading이나 useIsMutating을 활용해서 제어하는 방법들이 있습니다. 

 

4. useIsFetching과 queryClient.isFetching은 결과가 다릅니다.

useIsFetching은 현재 fetching 중인 쿼리의 개수를 리턴하는 훅입니다. queryClient의 isFetching 또한 동일한 기능을 하는 함수입니다.

useIsFetching은 내부적으로 queryClient의 queryCache들을 Observing 하면서 fetching 개수를 리턴하지만, queryClient.isFetching은 Observing 하지 않고 현재 캐싱 된 데이터의 fetching 개수를 리턴합니다.

				
					export default function Test() {
  const queryClient = useQueryClient();

  const isFetching = useIsFetching();
  const isFetching2 = queryClient.isFetching();

  const test = useUserData();

  /*
    0 0
    0 1
    1 1
  */
  console.log(isFetching, isFetching2);

  return <></>;
}

				
			

결과적으로는 동일한 기능을 하지만, 위와 같이 결과가 다른 이유는
useIsFetching의 내부에서는 Observing의 결과를 useEffect와 useState 통해 값을 리턴하기 때문에, queryclient.isFetching으로 사용하는 것보다 한 틱 더 늦게 값을 return 한다는 걸 알 수 있습니다. (여기서 틱이란, 훅이 return되기까지의 과정을 한 틱이라고 칭합니다.)

 

React Query 활용

 

React Query에서 제공하는 기능들을 활용해서 다양한 방식으로 사용이 가능합니다.

 

1. Query Key 활용

Query Key는 상황에 따라서 유용하게 쓰일 수 있습니다. 키는 hierarchy 구조이기 때문에, 이를 활용해서 화면 영역을 분리하는 용도로도 키를 설정할 수 있습니다. 예를 들어,

A-Key : [‘page-a’, ‘product’, ‘10’]

B-Key : [‘page-a’, ‘product’, ‘20’]

C-Key : [‘page-a’, ‘user’, ‘30’]

 

쿼리 키를 위와 같이 설정하고, A, B, C 쿼리를 모두 갱신하고 싶은 경우에는 invalidateQueries([‘page-a’])로 갱신이 가능하고, A, B 쿼리만 갱신하고 싶은 경우에는 invalidateQueries([‘page-a’, ‘product’])로 갱신이 가능합니다.

화면의 영역이 여러 개의 영역으로 나누고, 해당 영역에 대한 쿼리를 관리하고 싶으면 Query Key의 네이밍을 전략적으로 구성하면 효과적으로 사용할 수 있습니다.

만약, 쿼리에 대한 캐싱을 활용하고 싶고, 쿼리를 특정 영역별로 분할해서 관리하고 싶다면, 키의 인자 안에 object를 추가하면 좀 더 커스텀 하게 활용도 가능합니다. 


useQuery([‘todos’, { section:’section-a’ }], …)
useQuery([‘todos’, { section:’section-b’ }], …)


위 두 개 쿼리의 Query Key는 같은 Key 값으로 인식되어 캐싱이 되고, section-a 쿼리만 갱신을 처리하고 싶을 때는 invalidateQueries([‘todos’, { section:’section-a’}]) 와 같이 처리가 가능합니다.

 

2. Query Client를 활용한 커스텀 훅

Query Client를 활용해서 추가적인 기능의 훅들을 만들 수 있습니다. 예를 들어, useQuery를 병렬적으로 선언하여 사용하다 보면, 선언된 모든 쿼리들의 Fetching 여부를 확인하고 싶을 때가 있습니다.

선언된 각 쿼리들이 리턴하는 status 값들을 활용할 수 있으나, 선언된 쿼리가 많아지면 status 값들을 활용하여 처리하는 코드도 길어지고, 복잡해질 수 있습니다.

React Query에서 제공하는 useIsFethcing()과 같은 훅을 통해 체크를 할 수 있으나, 예외적인 상황들이 존재할 수 있습니다.

아래의 코드에서 q2Data와 q3Data의 참조 에러를 방지하기 위해, q2Loading, q3Loading에 대한 부분을 분기 처리로 추가하였는데, 이런 부분들이 많아지면 분기가 복잡해질 수 있습니다.

이러한 상황에서는 useIsFetching()을 활용할 수 없습니다. useQuery4처럼 enabled 값이 false인 쿼리가 존재하거나, useQuery2,3처럼 enabled 값이 다른 쿼리의 Fetching 성공 여부나 데이터를 의존하는 경우에는 idle 상태 때문에, useIsFethcing()으로는 Fetching 여부를 제대로 확인할 수 없습니다.

				
					export default function Test() {
  const { isSuccess: q1Succeed } = useQuery1();
  const { data: q2Data, isLoading: q2Loading } = useQuery2({
    options: {
      enabled: q1Succeed,
    },
  });
  const { data: q3Data, isLoading: q3Loading } = useQuery3({
    options:{
      enabled: q1Succeed
    },
  });
  const { refetch: q4Refetch } = useQuery4({
    options: {
      enabled: false,
    },
  });

  if (q2Loading || q3Loading) {
    return <>Loading...</>;
  }

  return (
    <>
      {q2Data.tmpData} / {q3Data.tmpData}
    </>
  );
}

				
			

위 코드 쿼리들의 상태 변화는 아래 표와 같이 변하기 때문에, 3번째 단계에서 useIsFetching은 false를 리턴하지만, 아직 useQuery2, useQuery3이 동작하지 않았기에 이 상태로 렌더링을 하게 되면 문제가 생길 수 있습니다.

 useQuery1useQuery2useQuery3useQuery4
1idleidleidleidle
2loadingidleidleidle
3successidleidleidle
4successloadingloadingidle
5successsuccesssuccessidle

이러한 문제를 해결하기 위해, My구독에서는 모든 쿼리들이 Fetching을 완료했는지 체크하는 커스텀 훅을 만들어서 컴포넌트의 렌더링 조건문을 줄일 수 있었습니다.

먼저, queryCache를 직접적으로 참조하면 선언된 쿼리들이 다 캐싱 되기 전에 훅이 동작을 하기 때문에, useEffect를 사용하여 선언된 쿼리들을 참조할 수 있게 만들고, 현재 선언된 쿼리의 개수를 state로 저장합니다.

React Query는 enabled 값이 false인 쿼리와, enabled 값이 특정 값을 의존하는 쿼리를 구분할 수 있는 상태 값을 제공하지 않습니다.

이 문제를 해결하기 위해 쿼리의 상태 변화 여부에 대한 카운트 값을 현재 선언된 쿼리의 개수만큼 설정하였습니다. 

초깃값을 선언된 쿼리의 개수만큼 설정하여 enabled 값이 모두 false로 선언되는 쿼리들의 경우에도  상태를 체크할 수 있게 처리하였습니다.

사용자가 임의로 enabled가 false로 설정된 쿼리의 개수를 확인해서 인자로 넘기는 방법으로 구현을 할 수도 있지만, 휴먼에러가 발생할 수 있고, 관리해야 할 포인트가 증가하기 때문에 아래와 같은 방식으로 구현하였습니다.

				
					export function useQueriesLoading() {
  const client = useQueryClient();
  const queries = client.getQueryCache().findAll();

  const [queryChangedCount, setQueryChangedCount] = useState(0);

  useEffect(() => {
    if (queries) {
      setQueryChangedCount(queries.length);
    }
  }, []);

  useEffect(() => {
    if (queries.every(({ state }) => state.status !== 'loading') && queryChangedCount >= 0) {
      setQueryChangedCount((prevState) => prevState - 1);
    }
  });

  if (queryChangedCount < 0) {
    return false;
  }

  return true;
}

				
			


마치며

1. 좋았던 점

기존에 Redux-Saga를 통해 관리했을 때는 API 처리의 성공, 실패에 따른 분기들이 파악하기 힘든 경우도 있었고, 사가가 깊어지면 관리하기가 까다로운 경우들이 있었는데, React Query로 좀 더 단순화 시킬 수 있어서 좋았습니다.

추가로, 캐싱에 대한 처리라든지, refetching에 대한 설정 등의 기능, placeHolder, failureCount 등 다양한 옵션을 제공하여서 개발 리소스를 좀 더 줄일 수 있었던 점들도 좋았습니다.

 

2. 아쉬웠던 점

아직 부족한 기능들이 있다고 생각합니다.

위에서 작성한 React Query 활용 부분의 useQueriesLoading과 같은 커스텀 훅의 기능도 React Query에서 제공했으면 더 좋았을 것 같고, 기존 Redux-Saga에서 쓰던 takeLatest와 같은 이펙트처럼 Mutation 중복 호출에 대한 부분을 좀 더 편하게 처리할 수 있게 제공하는 함수들이 있었으면 좋았을 것 같습니다.

React Query는 계속 업데이트 중이라서, V4에서 업데이트되는 쿼리의 status가 idle인 상태가 제거되는 등의 업데이트를 기대해 볼 수 있을 것 같습니다.

 

3. 어떤 상황에서 React Query를 사용하면 좋을까?

클라이언트 사이드의 데이터보다는 서버 사이드의 데이터 관리가 더 많을 때 유용하게 쓰일 있다고 생각합니다.

예를 들면, Admin 페이지와 같은 관리형 페이지에서는 클라이언트의 전역 상태 데이터는 많이 필요하지 않을 수 있습니다. 이러한 페이지에서 Ducks 구조보다는 React Query를 적용하면 구조를 더 단순화 시킬 수 있습니다.

또한, refetching 옵션들을 통해 서버의 데이터를 동기화할 수 있고, useMutation을 사용할 때도, defaultOptions에 onError를 추가하여, POST, PUT, DELETE 등의 API 실패 시, 안내 문구를 띄우는 기능도 유용하게 쓰일 수 있을 것 같습니다.

카카오톡 공유 보내기 버튼

Latest Posts

if kakao 2022 개발자 컨퍼런스를 개최합니다.

오래 기다리셨습니다. 카카오의 연례 개발자 컨퍼런스인 if(kakao) 2022를 12월 7일(수)~9일(금), 3일간 개최합니다. 공식 웹사이트(https://if.kakao.com) 및 카카오TV에서 온라인으로 진행되오니, 많은 참여와 관심 부탁드립니다.

(참여후기) 2022 부산대학교 정보컴퓨터공학부 산학교류회

안녕하세요, 카카오 광고추천팀 cory(최원영)입니다. 저는 부산대학교 정보컴퓨터공학부를 졸업하고, 현재는 카카오 광고추천팀에서 데이터엔지니어로 근무하면서 스트리밍 데이터를 분석하는 애플리케이션과 실시간 데이터 파이프라인 플랫폼을 개발

[post Server!] 브런치개발파트에 대한 모든 것!

브런치개발파트 채용시에 자주 나왔던 질문들에 대해서 답변하는 형식으로 브런치개발파트를 소개하려고 합니다.   브런치는 어떤 서비스인가요? 브런치는 작가가 글을 쓰고 그 글을 다양한