Typescript & Express 제너릭을 사용한 응답 처리 방식

웹 개발에서 API를 만들 때, 클라이언트에게 일관되고 구조화된 응답을 전달하는 것이 중요합니다.

 

API 응답을 처리하는 제너릭(Generic)을 어떻게 사용할 수 있는지, 그리고 이를 통해 얻을 수 있는 장점과 단점을 소개하겠습니다. 

 

1. 제너릭(Generic)이란?

TypeScript에서 제너릭은 함수, 클래스, 인터페이스에서 타입을 동적으로 정의할 수 있게 해주는 기능입니다. 제너릭을 사용하면, 함수나 클래스의 타입을 호출 시점에 지정할 수 있어, 다양한 데이터 타입을 다룰 때 유용합니다.

간단히 말하면, 제너릭은 "어떤 타입을 사용할지 미리 정해놓지 않고, 나중에 그 타입을 정의하겠다"는 의미입니다.

2. responseSuccess 함수에 제너릭 사용하기

API 응답에서 데이터의 형식을 유연하게 처리하려면, responseSuccess와 같은 함수에서 제너릭을 사용하는 것이 유용합니다. 예를 들어, responseSuccess 함수는 여러 가지 형태의 데이터를 받아야 할 수 있습니다. 이를 위해 제너릭을 사용하여 데이터의 타입을 호출 시점에 정의할 수 있습니다.

export interface ResponseData {
  status: string;
  message: string;
  data?: any;
  error?: string;
}

export const responseSuccess = <T>(res: any, data: T, message = "Request was successful") => {
  const response: ResponseData = {
    status: 'success',
    message,
    data
  };
  return res.json(response);  // JSON 형식으로 응답 반환
};

위 코드에서 responseSuccess 함수는 제너릭을 사용하여 응답 데이터의 타입을 동적으로 설정할 수 있습니다. 예를 들어, 사용자 정보를 반환할 때, data의 타입은 User[]일 수 있고, 다른 API에서는 Product[]일 수 있습니다.

---

타입 추론과 가독성 향상

TypeScript는 제너릭을 사용할 때, 타입 추론을 통해 함수 호출 시점에서 자동으로 타입을 유추해 줍니다. 이는 코드의 가독성을 높이고, 개발자가 불필요하게 타입을 명시할 필요를 줄여줍니다.

const user = [{ id: 1, name: 'Alice' }];
responseSuccess(res, user, 'Success');  // TypeScript가 user 타입을 자동으로 추론

---

제너릭 사용의 단점

1. 코드 복잡성 증가

제너릭을 사용하면 코드가 다소 복잡해질 수 있습니다. 특히 작은 프로젝트나 간단한 API에서는 제너릭을 사용하는 것보다 구체적인 타입을 사용하는 것이 더 효율적일 수 있습니다.

2. 불필요한 타입 선언

만약 API 응답 데이터가 고정된 형식이라면, 제너릭을 사용하는 것이 불필요할 수 있습니다. 제너릭은 유연성을 제공하지만, 타입이 고정적이라면 그냥 고정 타입을 사용하는 것이 더 직관적이고 코드가 간결할 수 있습니다.

// 고정된 타입으로 응답 처리
export const responseSuccess = (res: any, data: { id: number, name: string }[], message = "Request was successful") => {
  const response: ResponseData = {
    status: 'success',
    message,
    data
  };
  return res.json(response);
};

---

결론

제너릭을 사용하면 API 응답 처리 함수에서 유연성과 타입 안전성을 동시에 확보할 수 있습니다. 특히 다양한 데이터 타입을 처리할 수 있는 공통 응답 처리 함수가 필요할 때 매우 유용합니다. 그러나 제너릭을 사용할 때는 코드 복잡성과 불필요한 타입 선언이 증가할 수 있음을 염두에 두어야 합니다.

따라서, 응답 데이터의 타입이 동적으로 변화할 가능성이 있을 때는 제너릭을 사용해 코드의 재사용성과 타입 안전성을 높이는 것이 좋습니다. 반대로 데이터 타입이 고정되어 있다면 제너릭을 사용하지 않고 고정된 타입을 사용하는 것이 더 간단하고 직관적일 수 있습니다.