[Node.js][Nest.js] Configuration (설정)

 

 

 

Node.js 교과서:기본기에 충실한 노드제이에스 14 입문서

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."

 

 

 

🚀 Configuration (설정)

    🔽  개요

Source Code 안에서 어떤 내용들은 개발 환경이나, 운영 환경에 따라 다르게 넣어주어야 하는 값들이 있을 수 있는 것이에요. 예를 들어 남들에게 노출되지 않아야 하는 Data Base Connection 정보나 JWT 정보들인 것이에요.

`Spring Boot`에서는 기본적으로 `application.yml`이나, `application.properties`를 이용해서 해당 작업을 해 줄 수 있는데, `Nest.js`에서도 이와 유사하게 작업을 해 줄 수 있는 기능이 있는 것이에요.

이 기능은 `Run Time` 도중 바뀌는 것이 아닌 Application이 시작할 때 Load 되어 그 값들을 정의해 주는 것이에요. 그리고, 설정 File은 여러가지 File 형식을 이용할 수 있는데, 대표적으로 `XML`, `JSON`, `YAML(YML)`, `Enviroment Variables`와 같은 것들이에요.

 

 

        📦 Codebase와 Enviroment Variables(환경 변수) 차이

위에서 언급한 `XML`, `JSON`, `YAML(YML)`은 Codebase에 해당하는 것이에요.

그리고, 다른 방법은 환경 변수로 처리할 수 있는 것이에요. 이 둘을 나누어서 작업하는 이유는 비밀번호, API Key와 같이 남들에게 노출되면 안되는 정보들 때문인데, 이러한 정보는 주로 환경 변수로 처리하는 것이에요.

 

 

 

 

    🔽  Module

해당 기능을 이용하기 위해서 먼저 Window OS에서는 `win-node-env`를 설치해야 하는 것이에요.

그 이유는 Window에서는 기본적으로 환경 변수를 지원하지 않기 때문인 것이에요.

 

명령어

npm install -g win-node-env --save

반응형

그리고, Linux(RHEL, Cent OS, Debian 등), Unix(Mac OS, Solaris 등), Window 모두 `config`라는 Module을 설치해줘야 하는 것이에요.

 

 

명령어

npm install config --save

 

 

 

 

 

    🔽  설정 File 생성

최초 Root Directory(Project Directory) 밑에 `config` Directory를 만든 뒤 그 안에 `JSON`, `YAML` 등 형식에 File을 생성해 주면 되는 것이에요.

그런 뒤 `config` Directory 안에 `default.yml`, `development.yml`, `production.yml`을 만들어 Local, 개발, 운영 환경에 맞는 설정 File들을 각각 생성해 줄 수 있는 것이에요. 

 

 

 

 

 

    🔽  설정 File 이용 방법

어느 Class(File)에서든 `config` Module을 `import`하면 이용할 수 있는 것이에요.

 

예시 코드

import * as config from 'config';

 

 

main.js - config 이용 예시

 

 

typeorm.config.ts 이용 예시

 

 

 

참고 자료 및 출처 : 인프런 - 따라하며 배우는 NestJS 강의

 

 

 

 

 

Node.js 교과서:기본기에 충실한 노드제이에스 14 입문서

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."