07 비동기 호출

7.2 API 상태 관리하기

실제 API를 요청하는 코드는 컴포넌트 내에서 비동기 함수를 직접 호출하지는 않는다.

비동기 API 호출하기 위해서는 API 성공·실패에 따른 상태가 관리되어야 하므로 상태 관리 라이브러리의 액션이나 훅과 같이 재정의된 형태를 사용해야 한다.

1. 상태 관리 라이브러리에서 호출하기

상태 관리 라이브러리의 비동기 함수들은 서비스 코드를 사용해서 비동기 상태를 변화시킬 수 있는 함수를 제공한다.

컴포넌트는 이러한 함수를 사용하여 상태를 구독하며, 상태가 변경될 때 컴포넌트를 다시 렌더링하는 방식으로 동작한다.

Redux는 비교적 초기에 나온 상태 관리 라이브러리다.

다음 예시를 살펴보자.

import { useEffect } from 'react'
import { useDispatch, useSelector } from 'react-redux'

export function useMonitoringHistory() {
  const dispatch = useDispatch()

  // 전역 Store 상태(RootState)에서 필요한 데이터만 가져온다
  const searchState = useSelector(
    (state: RootState) => state.monitoringHistory.searchState
  )

  // history 내역을 검색하는 함수, 검색 조건이 바뀌면 상태를 갱신하고 API를 호출한다
  const getHistoryList = async (
    newState: Partial<MonitoringHistorySearchState>
  ) => {
    const newSearchState = { ...searchState, ...newState }
    dispatch(monitoringHistorySlice.actions.changeSearchState(newSearchState))
    const response = await getHistories(newSearchState) // 비동기 API 호출하기
    dispatch(monitoringHistorySlice.actions.fetchData(response))
  }

  return { searchState, getHistoryList }
}

스토어에서 getHistories API만 호출하고, 그 결과를 받아와서 상태를 업데이트하는(상태에 저장하는) 일반적인 방식으로 사용할 수 있다.

그러나 앞의 예시와 같이 getHistoryList 함수에서는 dispatch 코드를 제외하더라도 다음과 같이 API 호출과 상태 관리 코드를 작성해야 한다.

enum ApiCallStatus {
  Request,
  None,
}
const API = axios.create()

const setAxiosInterceptor = (store: EnhancedStore) => {
  API.interceptors.request.use(
    (config: AxiosRequestConfig) => {
      const { params, url, method } = config

      store.dispatch(
        // API 상태 저장을 위해 redux reducer `setApiCall` 함수를 사용한다
        // 상태가 `요청됨`인 경우 API가 Loading 중인 상태
        setApiCall({
          status: ApiCallStatus.Request, // API 호출 상태를 `요청됨`으로 변경
          urlInfo: { url, method },
        })
      )

      return config
    },
    (error) => Promise.reject(error)
  )

  // onSuccess 시 인터셉터로 처리한다
  API.interceptors.response.use(
    (response: AxiosResponse) => {
      const { method, url } = response.config

      store.dispatch(
        setApiCall({
          status: ApiCallStatus.None, // API 호출 상태를 `요청되지 않음`으로 변경
          urlInfo: { url, method },
        })
      )

      return response?.data?.data || response?.data
    },
    (error: AxiosError) => {
      const { config: { url, method }, } = error

      store.dispatch(
        setApiCall({
          status: ApiCallStatus.None, // API 호출 상태를 `요청되지 않음`으로 변경
          urlInfo: { url, method },
        })
      )

      return Promise.reject(error)
    }
  )
}

API를 호출할 때, 호출한 뒤 그리고 호출하고 에러가 발생했을 때 각각 setApiCall을 호출해서 상태를 업데이트해야 한다.

Redux는 비동기 상태가 아닌 전역 상태를 위해 만들어진 라이브러리이기 때문에 미들웨어라고 불리는 여러 도구를 도입하여 비동기 상태를 관리한다.

따라서 보일러플레이트 코드가 많아지는 등 간편하게 비동기 상태를 관리하기 어려운 상황도 발생한다.

반면 MobX 같은 라이브러리에서는 이러한 불편함을 개선하기 위해 비동기 콜백 함수를 분리하여 액션으로 만들거나 runInAction과 같은 메서드를 사용하여 상태 변경을 처리한다.

또한 async / await나 flow 같은 비동기 상태 관리를 위한 기능도 있어 더욱 간편하게 사용할 수 있다.

비동기 상태 관리 코드 예시를 살펴보자.

import { runInAction, makeAutoObservable } from 'mobx'
import type Job from 'models/Job'

class JobStore {
  job: Job[] = []

  constructor() {
    makeAutoObservable(this)
  }
}

type LoadingState = 'PENDING' | 'DONE' | 'ERROR'

class Store {
  job: Job[] = []
  state: LoadingState = 'PENDING'
  errorMsg = ''

  constructor() {
    makeAutoObservable(this)
  }

  async fetchJobList() {
    this.job = []
    this.state = 'PENDING'
    this.errorMsg = ''

    try {
      const projects = await this.fetchJobList()
      runInAction(() => {
        this.job = projects
        this.state = 'DONE'
      })
    } catch (e) {
      runInAction(() => {
        this.state = 'ERROR'
        this.errorMsg = e.message
      })
    }
  }
}

모든 상태 관리 라이브러리에서 비동기 처리 함수를 호출하기 위해 액션이 추가될 때마다 관련된 스토어나 상태가 계속 늘어난다.

이로 인한 가장 큰 문제점은 전역 상태 관리자가 모든 비동기 상태에 접근하고 변경할 수 있다는 것이다.

만약 2개 이상의 컴포넌트가 구독하고 있는 비동기 상태가 있다면 쓸데없는 비동기 통신이 발생하거나 의도치 않은 상태 변경이 발생할 수 있다.

2. 훅으로 호출하기

react-query나 useSwr 같은 훅을 사용한 방법은 상태 변경 라이브러리를 사용한 방식보다 훨씬 간단하다.

이러한 훅은 캐시를 사용하여 비동기 함수를 호출하며, 상태 관리 라이브러리에서 발생했던 의도치 않은 상태 변경을 방지하는 데 도움이 된다.

useSwr과 react-query의 사용법이 유사하므로 여기서는 react-query의 사용 예시만 살펴본다.

아래 코드는 Job 목록을 불러오는 훅과 Job 1개를 업데이트하는 예시다.

만약 Job이 업데이트되면 해당 Job 목록의 정보가 유효하지 않게 되므로 다시 API를 호출해야 함을 알려줘야 한다.

이런 기능을 구현하는 방법을 살펴보자.

react-query에서는 onSuccess 옵션의 invalidateQueries를 사용하여 특정 키의 API를 유효하지 않은 상태로 설정할 수 있다.

// Job 목록을 불러오는 훅
const useFetchJobList = () => {
  return useQuery(['fetchJobList'], async () => {
    const response = await JobService.fetchJobList()

    // View Model을 사용해서 결과
    return new JobList(response)
  })
}

// Job 1개를 업데이트하는 훅
const useUpdateJob = (
  id: number,
  // Job 1개 update 이후 Query Option
  { onSuccess, ...options }: UseMutationOptions<void, Error, JobUpdateFormValue>
): UseMutationResult<void, Error, JobUpdateFormValue> => {
  const queryClient = useQueryClient()

  return useMutation(
    ['updateJob', id],
    async (jobUpdateForm: JobUpdateFormValue) => {
      await JobService.updateJob(id, jobUpdateForm)
    },
    {
      onSuccess: (
        data: void, // updateJob의 return 값은 없다 (status 200으로만 성공 판별)
        values: JobUpdateFormValue,
        context: unknown
      ) => {
        // 성공 시 'fetchJobList'를 유효하지 않음으로 설정
        queryClient.invalidateQueries(['fetchJobList'])

        onSuccess & onSuccess(data, values, context)
      },
      ...options,
    }
  )
}

이후 컴포넌트에서는 일반적인 훅을 호출하는 것처럼 사용하면 된다.

JobList 컴포넌트가 반드시 최신 상태를 표현하려면 폴링(polling)이나 웹소켓(websocket) 등의 방법을 사용해야 한다.

아래 예시에서는 간단한 폴링 방식으로 최신 상태를 업데이트하는 것을 볼 수 있다.

폴링(polling)

클라이언트가 주기적으로 서버에 요청을 보내 데이터를 업데이트하는 것이다.

클라이언트는 일정한 시간 간격으로 서버에 요청을 보내고, 서버는 해당 요청에 대해 최신 상태의 데이터를 응답으로 보내주는 방식을 말한다.

const JobList: React.FC = () => {
  // 비동기 데이터를 필요한 컴포넌트에서 자체 상태로 저장
  const {
    isLoading,
    isError,
    error,
    refetch,
    data: jobList,
  } = useFetchJobList()

  // 간단한 Polling 로직, 실시간으로 화면이 갱신돼야 하는 요구가 없어서
  // 30초 간격으로 갱신한다
  useInterval(() => refetch(), 30000)

  // Loading인 경우에도 화면에 표시해준다
  if (isLoading) return <LoadingSpinner />

  // Error에 관한 내용은 11.3 API 에러 핸들링에서 더 자세하게 다룬다
  if (isError) return <ErrorAlert error={error} />

  return (
    <>
      {jobList.map((job) => (
        <Job job={job} />
      ))}
    </>
  )
}

최근 사내에서도 Redux나 MobX와 같은 전역 상태 관리 라이브러리를 react-query로 변경하고자 하는 시도가 이루어지고 있다.

앞서 언급했다시피 상태 관리 라이브러리에서는 비동기로 상태를 변경하는 코드가 점점 추가되면 전역 상태 관리 스토어가 비대해지기 때문이다.

단순히 상태를 변경하는 액션이 증가하는 것뿐만 아니라 전역 상태 자체도 복잡해진다.

에러 발생, 로딩 중 등과 같은 상태는 전역으로 관리할 필요가 거의 없다.

다른 컴포넌트가 에러 상태인지, 성공 상태인지를 구독하는 경우 컴포넌트의 결합도와 복잡도가 높아져 유지보수를 어렵게 만들 수 있다.

이런 고민으로 인해 비동기 통신을 react-query를 사용해서 처리하고 있다.

react-query를 가장 많이 활용하고 있지만 react-query는 전역 상태 관리를 위한 라이브러리가 아닌 만큼 상태 관리 라이브러리 중에서 가장 뛰어나다는 의미는 아니다.

어떤 상태 관리 라이브러리를 선택할지는 프로젝트의 도메인, 개발자의 학습 곡선 그리고 기존 코드와의 호환성 등에 따라 달라질 수 있다.

상태 관리 라이브러리에는 고정된 모범 사례(Best Practic)가 있는 것이 아니기 때문에 상황에 따라 적절한 판단이 필요하다.