@nestjs/config

• nest 공식문서 : https://docs.nestjs.com/techniques/configuration#service

설치

$ npm i --save @nestjs/config

NestJS 설정

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

@Module({
  imports: [ConfigModule.forRoot({isGlobal:true})], // isGlobal은 앱 어디에서나 config 모듈에 접근할 수 있도록 한다.
})
export class AppModule {}

export interface ConfigModuleOptions {
    /**
     * If "true", values from the process.env object will be cached in the memory.
     * This improves the overall application performance.
     * See: https://github.com/nodejs/node/issues/3104
     */
    cache?: boolean;
    /**
     * If "true", registers `ConfigModule` as a global module.
     * See: https://docs.nestjs.com/modules#global-modules
     */
    isGlobal?: boolean;
    /**
     * If "true", environment files (`.env`) will be ignored.
     */
    ignoreEnvFile?: boolean;
    /**
     * If "true", predefined environment variables will not be validated.
     */
    ignoreEnvVars?: boolean;
    /**
     * Path to the environment file(s) to be loaded.
     */
    envFilePath?: string | string[];
    /**
     * Custom function to validate environment variables. It takes an object containing environment
     * variables as input and outputs validated environment variables.
     * If exception is thrown in the function it would prevent the application from bootstrapping.
     * Also, environment variables can be edited through this function, changes
     * will be reflected in the process.env object.
     */
    validate?: (config: Record<string, any>) => Record<string, any>;
    /**
     * Environment variables validation schema (Joi).
     */
    validationSchema?: any;
    /**
     * Schema validation options.
     * See: https://joi.dev/api/?v=17.3.0#anyvalidatevalue-options
     */
    validationOptions?: Record<string, any>;
    /**
     * Array of custom configuration files to be loaded.
     * See: https://docs.nestjs.com/techniques/configuration
     */
    load?: Array<ConfigFactory>;
    /**
     * A boolean value indicating the use of expanded variables, or object
     * containing options to pass to dotenv-expand.
     * If .env contains expanded variables, they'll only be parsed if
     * this property is set to true.
     */
    expandVariables?: boolean | DotenvExpandOptions;
}

ENV 세팅 팁

cross-env 설치

$ npm i cross-env

env 파일 생성

환경변수 값 대입 방법

"start:dev": "cross-env NODE_ENV=dev nest start --watch",

envFilePath 설정

ConfigModule.forRoot({
  isGlobal: true,
  envFilePath: process.env.NODE_ENV === 'dev' ? '.env.dev' : '.env.test',
}),

PRD 환경에선 env 파일 사용하지 않도록 설정

ConfigModule.forRoot({
  isGlobal: true,
  envFilePath: process.env.NODE_ENV === 'dev' ? '.env.dev' : '.env.test',
  ignoreEnvFile: process.env.NODE_ENV === 'prd',
}),

활용 예시

// app.module.ts

imports: [ ...,
	TypeOrmModule.forRoot({
	  type: 'postgres',
	  host: process.env.DB_HOST,
	  port: +process.env.DB_PORT,
	  username: process.env.DB_USERNAME,
	  password: process.env.DB_PASSWORD,
	  database: process.env.DB_NAME,
	  synchronize: true,
	  logging: true, // 콘솔에 출력
	}),
]

# .env.dev 파일

DB_HOST=localhost
DB_PORT=5432
DB_USERNAME=username
DB_PASSWORD=12345
DB_NAME=nuber-eats

환경변수 유효성 검사

• nest 공식문서 : https://docs.nestjs.com/techniques/configuration#schema-validation

joi 설치

$ npm install joi

import * as Joi from 'joi';

@Module({
  imports: [
    ConfigModule.forRoot({
      validationSchema: Joi.object({
        NODE_ENV: Joi.string()
          .valid('development', 'production', 'test', 'provision')
          .default('development'),
        PORT: Joi.number().port().default(3000),
      }),
    }),
  ],
})
export class AppModule {}

// validationSchema 작성 예시

validationSchema: Joi.object({
  NODE_ENV: Joi.string().valid('dev', 'prod').required(),
  DB_PORT: Joi.number().port().required(),
  DB_USERNAME: Joi.string().required(),
  DB_PASSWORD: Joi.string().required(),
  DB_NAME: Joi.string().required(),
}),

유효성 테스트

Module에서 환경변수 사용하는 방법

모듈에서의 설정

서비스에서의 설정

// users.service.ts

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

export class UsersService {
  constructor(
    @InjectRepository(User) private readonly users: Repository<User>,
    private readonly config: ConfigService,
  ) {}
  
  ...
  
  login(){
	  const token = jwt.sign({ id: user.id }, this.config.get('SECRET_KEY'));
  }
}

this.config.get(’환경변수명’)