Node.js : NestJS - 환경변수 설정(config, cross-env, joi)

출처

• [NestJS] Configuration 환경변수 설정 [@nestjs/config, cross-env, joi] : Tunko Development Diary

패키지 설치

@nestjs/config 설치

D:\workspace.nodejs\nestjs_example>npm i --save @nestjs/config

cross-env 설치 - 실행 옵션(dev, prod)에 따라서 참조하는 환경 변수 파일을 선택하기 위한 패키지

D:\workspace.nodejs\nestjs_example>npm i cross-env

joi 설치 - 환경변수 유효성 검사를 위한 패키지

D:\workspace.nodejs\nestjs_example>npm i joi

환경 파일 생성

• .env.dev
• .env.debug
• .env.prod

package.json 수정

cross-env 패키지를 이용해 환경변수를 할당한뒤 nest start 명령을 실행

    // 수정전
    "start": "nest start",
    "start:dev": "nest start --watch",
    "start:debug": "nest start --debug --watch",
    "start:prod": "node dist/src/main",
    
    // 수정후  
    "start": "nest start",
    "start:dev": "cross-env NODE_ENV=dev nest start --watch",
    "start:debug": "cross-env NODE_ENV=debug nest start --debug --watch",
    "start:prod": "cross-env NODE_ENV=prod node dist/main",

.env.xxx 내용

# DATABASE
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=dev-db
DB_USERNAME=dev-user
DB_PASSWORD=dev-passwd

src/app.module.ts 내용

내용 추가

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

import { configValidationSchema } from 'config/validation/config-validation';
import databaseConfig from '../config/database.config';

imports: [
    ConfigModule.forRoot({
      isGlobal: true,
      cache: true,
      envFilePath: [ '.env.' + process.env.NODE_ENV ],
      validationSchema: configValidationSchema,
      load: [ databaseConfig ],
    }),
  ],

전체 내용

import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';
import { AppController } from './app.controller';
import { AppService } from './app.service';

import { configValidationSchema } from 'config/validation/config-validation';
import databaseConfig from '../config/database.config';

@Module({
  imports: [
    ConfigModule.forRoot({
      isGlobal: true,
      cache: true,
      envFilePath: [ '.env.' + process.env.NODE_ENV ],
      validationSchema: configValidationSchema,
      load: [ databaseConfig ],
    }),
  ],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

config/validation/config-validation.ts 내용

import * as Joi from 'joi';

export const configValidationSchema = Joi.object({
  // DATABASE
  DB_CONNECTION: Joi.string().min(1).required(),
  DB_HOST: Joi.string().min(1).required(),
  DB_PORT: Joi.string().min(1).required(),
  DB_DATABASE: Joi.string().min(1).required(),
  DB_USERNAME: Joi.string().min(1).required(),
  DB_PASSWORD: Joi.string().optional(),
});

config/database.config.ts 내용

import { registerAs } from '@nestjs/config';

export default registerAs('database', () => {
  return {
    'name': 'default',
    'type': process.env.DB_CONNECTION,
    'host': process.env.DB_HOST,
    'port': process.env.DB_PORT,
    'username': process.env.DB_USERNAME,
    'password': process.env.DB_PASSWORD,
    'database': process.env.DB_DATABASE,
    'entities': [
      'dist/**/*.entity{.ts,.js}'
    ],
    'synchronize': false,
    'migrationsTableName': 'migrations_histories',
    'migrationsRun': true,
    'logging': false
    // 'ssl': false,
    // 'extra': {
    //   'ssl': {
    //     'rejectUnauthorized': false
    //   }
    // }
  }
});