🚀 NestJS 기본 개념 ‐ Modules

NestJS 앱을 생성하면 기본적으로 app.controller.ts, app.module.ts, app.service.ts 등으로 보일러플레이트가 구성되어 있고 이를 기본으로 애플리케이션이 구동된다

src
 |- main.ts                    # Nest 앱의 실행파일
 |- app.module.ts              # 실행파일에서 등록, 사용하는 root 모듈파일
 |- app.controller.ts          # Nest 앱의 root 기본 컨트롤러
 |- app.service.ts             # Nest 앱의 root 기본 비즈니스 서비스

이중 중요 개념중 하나인 Module에 관한 정리를 위한 포스트이다

Modules overview

간단 예제를 통해 모듈이 어떻게 사용이 되는지를 살펴보자

// app.module.ts
import { Module } from '@nestjs/common';
import { CatsModule } from './cats/cats.module';

@Module({
  imports: [CatsModule],
})
export class AppModule {}

우선 NestJS에서 모듈은 @Module이라는 데코레이터를 통하여 정의된다

해당 예제에서 AppModule은 root에 위치해 있는 module로써 진입점의 역할을 담당하게 된다. 또 AppModule이 CatsModule을 import하여 사용 할 수 있는 것을 볼수가 있다

그렇다면 여기서 import 되는 CatsModule은 어떤 구조를 가지고 있을까?

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

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

CatsModule 자체에서는 별도의 다른 import를 사용하지 않고 있다

다만 CatsModule 안에서 controllers와 providers 옵션이 있고 각각 CatsController와 CatsService를 갖는 것을 볼 수 있다

결국 Module이라는 것은 쉽게 말하자면 구현했던 cats의 controller와 service, repository 등 provider들을 하나의 'cats' 모듈로 묶어주는 역할을 한다 (Provider들을 사용하고 프로그램의 진입점 역할을 하는 controller들은 provider랑 분리되어 구분이 된다)

그러고 그렇게 정의 된 CatsModule을 AppModule에서 import하여 사용이 되는 것이다

전체적인 구조를 모듈로 효과적으로 볼 수 있다:

Module 기본 구성 요소에 관한 정리

기본적으로 @Module 데코레이터 안에는 하나의 객체만 들어가는데 이 객체 내 attribute들은 다음과 같이 정리 할 수가 있다 (참고로 attribute들은 여러개가 필요할 경우 배열로 정의를 할 수가 있다)

providers: Nest의 Injector에 의해 인스턴스화 되어 해당 모듈에서 공유 될 수 있는 provider들
controllers: 모듈 내에서 인스턴스화 되어야할 기능에 부합하는 controller list
import: 해당 모듈 내에서 필요한 provider를 export하는 모듈을 외부에서 가져오는 목록 (주로 모듈만을 import 한다)
export: 해당 모듈에서 제공하기에, 해당 모듈을 import하는 다른 모듈에서 사용할 수 있는 provider의 집합

Re-Export를 통한 모듈의 효율적인 관리

Module을 import 하고 그대로 다시 re-export하는 방법이 있는데, 방식은 다음과 같다

@Module({
  imports: [CommnonModule],
  exports: [CommonModule],
 })
export class CoreModule {}

가져온 모듈을 바로 export하면 좋은 점이 뭘까? 주요 장점으로는

중복 import 문 제거
의존성 관리 단순화를 통한 코드 유지 보수 용이
모듈 구조의 일관성 유지

가 있다

// core.module.ts
@Module({
  imports: [
    ConfigModule,
    LoggerModule,
    DatabaseModule
  ],
  exports: [
    ConfigModule,
    LoggerModule,
    DatabaseModule
  ]
})
export class CoreModule {}

// feature.module.ts
@Module({
  imports: [CoreModule] // 필요한 모든 모듈을 한 번에 임포트
})
export class FeatureModule {}

해당 예시에서 CoreModule이 ConfigModule, LoggerModule, DatabaseModule을 모두 받아와서 바로 export를 하는 것을 볼수가 있다

이렇게 될경우에 FeatureModule에서는 상기된 모듈들을 사용하기 위해서는 CoreModule하나만 import 하면 되는 것이니 전반적으로 import에 관한 관리가 용이해진 것을 볼수가 있다

Single Module approach vs Multiple Module approach

Single Module Approach: 하나의 root module (주로 app.module.ts)에서 모든 기능을 관리하는 방식을 말한다

// app.module.ts
@Module({
  imports: [
    TypeOrmModule.forFeature([User, Order, Product, Payment]),
    ConfigModule.forRoot(),
  ],
  controllers: [
    UserController, 
    OrderController, 
		...
  ],
  providers: [
    UserService,
    OrderService,
    ProductService,
    ...
  ],
})
export class AppModule {}

설정이 간단하고 빠른 개발이 가능하다
의존성 관리가 단순하다
다만 애플리케이션 규모가 커지면 관리 차원에서 어려워질 수도 있다
또한 기능별 분리가 어려워 질 수도 있다
비교적 작은 프로젝트에 적합하다

Multiple Module Approach : 여러 모듈로 분리하여 도메인별로 관리하는 방식을 말한다

여러 모듈로 분리하여 도메인별로 관리하는 방식을 말한다

// user.module.ts
@Module({
  imports: [TypeOrmModule.forFeature([User])],
  controllers: [UserController],
  providers: [UserService],
  exports: [UserService],
})
export class UserModule {}

// product.module.ts
@Module({
  imports: [TypeOrmModule.forFeature([Product])],
  controllers: [ProductController],
  providers: [ProductService],
})
export class ProductModule {}

// app.module.ts
@Module({
  imports: [
    ConfigModule.forRoot(),
    UserModule,
    ProductModule,
    ...
  ],
})
export class AppModule {}