TypeDI 를 활용한 의존성 주입

📌 TypeDI 란?

typeDI 는 Typescript와 Javascript 의 의존성 주입을 위한 라이브러리 입니다.

의존성 주입 을 통해 OOP 아키텍쳐의 백엔드 서버 구조를 견고히 유지할 수 있으며 유지보수를 쉽게 합니다.

이번 프로젝트에서는 이를 이용해서 각각의 service 와 controller layer 의 구조를 잡으려 합니다.

 

📌 패키지 설치

먼저 typeDI 를 사용하기 위한 패키지를 설치합니다.

$ npm i typedi reflect-metadata

typeDI 는 데코레이터를 사용하기 때문에 tsconfig.json 에서 다음 설정을 적용해야 합니다.

"emitDecoratorMetadata": true,
"experimentalDecorators": true,

 

📌 Node.js + TypeDI 적용 예시

데코레이터를 사용하는 코드 내에서는 최 상단에 다음과 같이 reflect-metadata 를 불러와야 합니다.

Express.js 를 사용하고 있기 때문에 app.ts 에서 이를 불러 오겠습니다.

// app.ts

import 'reflect-metadata'

 

실제 프로젝트에 적용한 사례는 다음과 같습니다.

우선 닉네임을 생성하기 위한 service 계층 클래스를 생성합니다.

그리고 Service 데코레이터를 사용해서 클래스가 인스턴스화 될 수 있도록 명시합니다.

// services/nickname.ts

import { Service } from 'typedi';

@Service()
class NicknameService {
  public constructor() {
    // ...
  }

  public createNickname() {
    // ... nickname 생성하고

    return nickname;
  }
}

export default NicknameService;

 

이후 controller 계층에서 위 서비스 클래스를 가져와서 사용합니다.

이때는 Container.get 을 이용해서 가져올 수 있습니다.

// controllers/nickname.ts

import { Container } from 'typedi';
import { Request, Response, NextFunction } from 'express';
import NicknameService from '@/service/nickname';

export const getRandomNickname = async (
  req: Request,
  res: Response,
  next: NextFunction
) => {
  const nicknameService = Container.get(NicknameService);

  res.status(200).json({
    message: '랜덤 닉네임 1개를 생성하였습니다.',
    data: {
      nickname: nicknameService.createNickname(),
    },
  });
};

위에는 간단한 코드라 활용되지 않았지만 만약 클래스 간에 의존성을 주입하고자 한다면

Inject 데코레이터를 활용하면 됩니다.

 

💡 Inject 활용 방법 (/w Typescript)

프로젝트에서 사용한 Inject 데코레이터 활용 예시를 통해 어떻게 적용할 수 있는지 알아보겠습니다.

먼저 커스텀 클래스를 주입 대상으로 활용할 것이기 때문에 다음과 같이 Container 에 등록 해줍니다.

// databases/redis/index.ts

import { Container } from 'typedi';

class RedisClient {
    // ...
}

Container.set('nicknameDB', new RedisClient());

 

이제 nicknameDB 라는 네임 스페이스로 의존성을 주입할 수 있습니다.

다음과 같이 서비스 계층에서 위 클래스를 의존성 항목으로 지정하겠습니다.

// service/nickname.ts

import { Service, Inject } from 'typedi';
import RedisClient from '@/databases/redis';

@Service()
class NicknameService {
  @Inject('nicknameDB') nicknameDB!: RedisClient;
    // ...
}

 

📌 참고 자료

TypeScript와 typedi로 의존성 주입 이해하기

Getting Started