NestJS로 프로젝트 만들어보기 - 4 (configuration 적용)

어느 언어이던간에 환경변수 값, 즉 configuration 이라는 모듈을 사용하게 되는데, Nest.js에서도 configuration 모듈을 제공해주고있으며, 해당 모듈은 dotenv 모듈을 기반해서 작동합니다.

공통으로 사용해야할 변수 값이거나 혹은 개발레벨 (프로덕션, 개발, 테스팅 등등..) 에 따른 다른 환경변수를 가져야하는 경우가 많으므로 프로젝트를 구성할 때 거의 대부분 셋팅하게 되는 모듈입니다. 이전에 포스팅한 데이터베이스 연결정보같은 경우도 config 파일로 따로 관리하는 경우가 많아서 해당 모듈을 먼저 셋팅하고 넘어가고자 합니다.

 

1. @nestjs/config 모듈 인스톨

$ npm i --save @nestjs/config
or
$ yarn add @nestjs/config

nestjs에서 공식으로 제공해주는 모듈을 인스톨합니다. 해당 패키지는 내부적으로 위에 말씀드렸다시피 dotenv를 사용합니다.

 

2. 모듈에 적용하기 (Getting Started)

공식 문서에서 가이드하는 방법이 여러가지입니다. 기본제공(Getting Started)에서는 이와같이 가이드합니다.

app.module.ts

import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';

@Module({
  imports: [ConfigModule.forRoot()],
})
export class AppModule {}

위의 코드는 기본 위치(프로젝트 루트 디렉터리)에서 .env 파일을 로드 및 구문 분석하고 .env 파일의 키/값 쌍을 process.env에 할당된 환경 변수와 병합하고 결과를 개인 구조에 저장합니다.

@nestjs/config는 dotenv에 의존하기 때문에 환경 변수 이름의 충돌을 해결하기 위해 해당 패키지의 규칙을 사용합니다.

키가 런타임 환경에 환경 변수로 존재하는 경우(예: export DATABASE_USER=test와 같은 OS 셸 내보내기를 통해) 및 .env 파일에 있는 경우 런타임 환경 변수가 우선합니다.

 

즉, bash_profile 혹은 bashrc 와 같은 파일에 이미 환경변수 설정이 되어있더라도, 프로젝트 루트에 있는 .env 파일의 환경변수 값이 우선순위가 더 높습니다.

 

가장 기본적인 가이드 방법이 있고, 저는 애초에 어플리케이션 시작시에 DB를 연동시키기 때문에
DB module에서 config를 로드하고, 그 이후에 로드된 config 값을 가지고 DB 연결을 먼저 진행하였습니다.

3.  DB 모듈 작성

src/common/db.module.ts

import { Module } from '@nestjs/common';
import {ConfigModule, ConfigService} from '@nestjs/config';
import configuration from '@Common/configuration';
import {TypeOrmModule} from '@nestjs/typeorm';
import * as Joi from 'joi';

@Module({
    imports: [
        ConfigModule.forRoot({
            isGlobal: true,
            load: [configuration],
            envFilePath: process.env.NODE_ENV == 'local' ? '.env' : process.env.NODE_ENV == 'development' ? '.env.development' : '.env.production',
            validationSchema: Joi.object({ // 환경변수 유효성 체크
                NODE_ENV: Joi.string().valid('local','development', 'production', 'testing', 'staging').required(),
                DATABASE_HOST: Joi.string().required(),
                DATABASE_PORT: Joi.string().required(),
                DATABASE_USER: Joi.string().required(),
                DATABASE_PASSWORD: Joi.string().required(),
                DATABASE_NAME: Joi.string().required(),
            })
        }),
        TypeOrmModule.forRootAsync({
            imports: [ConfigModule],
            inject: [ConfigService],
            useFactory: async (configService: ConfigService) => ({
                type: 'mysql',
                host: configService.get('database.host'),
                port: configService.get('database.port'),
                username: configService.get('database.user'),
                password: configService.get('database.password'),
                database: configService.get('database.name'),
                legacySpatialSupport: false,
                logging: true,
                acquireTimeout: 5000,
                charset: 'UTF8MB4_GENERAL_CI',
                entities: ['dist/**/*.entity.{ts,js}'], // Entity 연결
                synchronize: false, //true 값을 설정하면 어플리케이션을 다시 실행할 때 엔티티안에서 수정된 컬럼의 길이 타입 변경값등을 해당 테이블을 Drop한 후 다시 생성
                extra: {
                    connectionLimit: configService.get('CONNECTION_LIMIT')
                }
            }),
        }),
    ],
})
export class DatabaseModule {}

이전에 루트모듈에서 ConfigModule을 이용해 config값을 로드하면 ConfigService를 주입받을 수 있는데, 그 이후에는 ConfigService 객체를 통해 config의 값을 가져올 수 있습니다.

envFilePath를 통해 NODE_ENV값에 따른 참조 환경변수 파일을 다르게 가져올 수 있게끔 하였습니다.

 

.env

# #MYSQL
DATABASE_HOST = localhost
DATABASE_USER = root
DATABASE_NAME = store
DATABASE_PASSWORD = root
DATABASE_PORT = 3306
DATABASE_LOGGING = true
CONNECTION_LIMIT=15

프로젝트 루트에 이와같이 env 파일을 작성하면 ConfigModule에서 프로젝트 루트에 있는 해당 환경변수 파일을 로드하게됩니다.

 

4. 루트모듈에 DB모듈 import 및 타 모듈에서 configService 사용

DB 연결은 어플리케이션 시작 시에 필요하기때문에 아래와 같이 import 합니다.

app.module.ts

import { DatabaseModule } from '@Common/db.module';
import { Module } from '@nestjs/common';
import { OrderModule } from '@Order/order.module';
import {TypeOrmModule} from '@nestjs/typeorm';

@Module({
    imports: [
        DatabaseModule,
        TypeOrmModule.forFeature([]),
        OrderModule,
    ]
})
export class AppModule {}

DatabaseModule을 못가져오면 어플리케이션 실행 에러가 떨어질겁니다. 그리고 해당 모듈에서 ConfigModule도 같이 import했기때문에 정상실행됐다면 다른 모듈에서도 ConfigService를 주입하여 사용할 수 있습니다.

 

src/order/services/order.service.ts

import { Injectable } from '@nestjs/common';
import {ConfigService} from '@nestjs/config';

@Injectable()
export class OrderService {
    constructor(
      private readonly config: ConfigService
    ) {
        console.log(config.get("database.host"))
    }
}

물론 여기서 저 config값이 필요한건 아니지만 위와같이 ConfigService를 바로 주입받아서 config 값을 참조 가능하게됩니다.