📒Providers

프로바이더는 Nest의 핵심 개념입니다. 많은 기본 Nest 클래스들은 services, repositories, factories, helpers 등의 provider로 취급될 수 있습니다.

provider의 핵심은 의존성으로 주입될 수 있다는 것입니다.(객체들이 서로 의존하며 다양한 관계를 형성함), 그리고 객체 인스턴스 간의 관계를 맺는 작업(연결)은 Nest 런타임 시스템에 위임합니다.

컨트롤러는 HTTP 요청을 받고 복잡한 핵심 로직들을 프로바이덩게 위임하는 일을 전담합니다.
프로바이더는 순수 자바스크립트 클래스로 module에 provider로 선언되어 있습니다.

Nest는 객체 지향적인 방식으로 의존성을 설계하고 구성할 수 있게 해주기 때문에 SOLID 원칙을 따르는 것을 권장합니다.

✔️Services

$ nest g service <service class name>
위와 같은 nest cli 명령어로 간단하게 service를 생성할 수 있습니다.

// cats.service.ts
import { Injectable } from '@nestjs/common';
import { Cat } from './interfaces/cat.interface';

@Injectable()
export class CatsService {
  private readonly cats: Cat[] = [];

  create(cat: Cat) {
    this.cats.push(cat);
  }

  findAll(): Cat[] {
    return this.cats;
  }
}

위의 CatsService 하나의 프로퍼티와 두 개의 메서드를 가진 간단한 클래스입니다.

@Injectable() 데코레이터는 CatsService가 Nest IoC 컨테이너에 의해 관리되는 클래스라는 정보를 첨부하는 역할을 합니다.

// interfaces/cat.interface.ts
export interface Cat {
  name: string;
  age: number;
  breed: string;
}

위는 Cat 인터페이스 입니다.

// cats.controller.ts
import { Controller, Get, Post, Body } from '@nestjs/common';
import { CreateCatDto } from './dto/create-cat.dto';
import { CatsService } from './cats.service';
import { Cat } from './interfaces/cat.interface';

@Controller('cats')
export class CatsController {
  constructor(private catsService: CatsService) {}

  @Post()
  async create(@Body() createCatDto: CreateCatDto) {
    this.catsService.create(createCatDto);
  }

  @Get()
  async findAll(): Promise<Cat[]> {
    return this.catsService.findAll();
  }
}

자 고양이 정보를 검색하는 CatsService 와 Cat 인터페이스도 생성했으니 이제 CatsService를 CatsController 내부에서 사용하는 예제를 살펴보겠습니다.

위 CatsController에서 CatsService는 클래스 생성자를 통해 주입되었습니다.

위처럼 private 단축 구문을 사용하면 선언과 초기화를 동시에 할 수 있습니다. TS 문법을 확인하세요

✔️Dependency Injection

Nest는 DI로 알려진 강력한 디자인 패턴을 바탕으로 구축되었습니다.

constructor(private catsService: CatsService) {}

catsService는 생성되어 반환된 CatsService의 인스턴스를 할당받습니다.(일반적인 싱글톤의 경우에는 이미 만들어진 기존 인스턴스를 할당받습니다.)

✔️Scopes

프로바이더는 일반적으로 애플리케이션 수명 주기와 동기화된 scope(라이프타임)을 가집니다.

애플리케이션이 부트스트랩 될 때 모든 의존성이 해결되어야 하기 때문에 모든 프로바이더들은 인스턴스화되어야 합니다.

동일하게 애플리케이션이 종료될 때 모든 프로바이더들 또한 삭제됩니다.

프로바이더의 라이프타임을 request-sceoped로 만들 수도 있습니다. injection scopes

✔️Custom providers

Nest는 빌트인 IoC 컨테이너를 가지고 있습니다. IoC 컨테이너는 의존성 주입 기능을 기반으로 프로바이더 간의 관계, 의존성을 해결합니다.

프로바이더를 정의하는 방법은 여러 가지가 있습니다, 단순 값, 클래스, 비동기 또는 동기 팩토리들을 프로바이더로 정의할 수 있습니다.

custom providers

✔️Optional providers

반드시 의존성 주입이 필요하지 않은 경우에는 생성자 시그니처에 @Optional 데코레이터를 사용하여 선택적 프로바이더임을 명시할 수 있습니다.

클래스가 구성 객체에 의존할 수 있지만, 전달되지 않는다면 기본값을 사용하도록 해야합니다. 프로바이더의 부재로 오류가 발생하지 않게 하기 위함입니다.

import { Injectable, Optional, Inject } from '@nestjs/common';

@Injectable()
export class HttpService<T> {
  constructor(@Optional() @Inject('HTTP_OPTIONS') private httpClient: T) {}
}

위의 예에서는 사용자 정의 프로바이더를 사용하고 있으며, 이 때문에 HTTP_OPTIONS 사용자 정의 토큰을 포함하고 있습니다.

이전 예제들은 생성자 기반 주입을 보여주었는데, 이는 생성자 안에서 클래스를 통해 의존성을 나타내는 것입니다.

사용자 정의 프로바이더와 그들과 관련된 토큰에 대해 더 자세한 정보는 다음을 참조하세요

custom providers

✔️Property-based injection

지금까지 살펴본 의존성 주입은 생성자 기반 주입(constructor-based injection)이라고 부릅니다. 프로바이더가 생성자 메서드를 통해 주입되기 때문입니다.

어떤 경우에는 속성 기반 주입(property-based injection)이 유용합니다. 최상위 클래스가 하나 이상의 프로바이더에 의존하는 경우,

하위 클래스에서 super()를 호출해서 모든 의존성들을 전달하는 것은 번거로운 일입니다. 이러한 일을 피하기 위해서 사용하는 것이 프로퍼티 레벨에서 @Inject() 데코레이터를 사용하여 의존성 주입을 하는 방법입니다.

import { Injectable, Inject } from '@nestjs/common';

@Injectable()
export class HttpService<T> {
  @Inject('HTTP_OPTIONS')
  private readonly httpClient: T;
}

만약 아무 클래스도 확장하지 않는다면, 생성자 기반 주입을 사용할 것을 권장합니다.

✔️Provider registration

// app.module.ts
import { Module } from '@nestjs/common';
import { CatsController } from './cats/cats.controller';
import { CatsService } from './cats/cats.service';

@Module({
  controllers: [CatsController],
  providers: [CatsService],
})
export class AppModule {}

프로바이더인 CatsService와 서비스의 consumer CatsController 를 정의하였으니까, Nest에 서비스를 등록하여 의존성 주입이 가능하도록 해야합니다.

그러기 위해서 app.module.ts를 위와 같이 수정하여 @Module 데코레이터에 CatsService를 프로바이더에 추가합니다.

이렇게 함으로써 Nest는 CatsController 클래스의 의존성을 해결해 줄 수 있습니다.

✔️디렉토리 구조

✔️Manual instantiation

특정 상황에서는 내장된 의존성 주입 시스템을 벗어나서 수동으로 프로바이더를 검색하거나 인스턴스화 해야할 수 있습니다.

기존 인스턴스를 가져오거나 프로바이더를 동적으로 인스턴스화 하려면 Module 레퍼런스를 참조하세요. Module reference

bootstrap() 함수 안에서 프로바이더를 가져오기 위해서는 Standalone application 문서를 참조하세요 Standalone application