Nestjs 환경변수 (env) 설정 및 사용

Nestjs 환경변수 (env) 설정 및 사용

 

강사님이 강의 중 다댐브 다댐브 라고 말씀하시길래

env를 왜 다댐브라고 부르시지? 싶었는데

dotenv = .env

요거 였당 ㅋ

 

 

dotenv란?

 

우선 env란, 유닉스 및 유닉스 계열 운영 체제용 셀 명령어이다. 환경변수의 목록을 출력하거나, 현존하는 환경을 수정하지 않고도 변경된 환경 내에서 다른 유틸리티를 실행하는데 사용할 수 있다. env를 사용함으로써 변수를 추가하거나 제거할 수 있으며, 기존 변수는 새로운 값을 이들에 할당함으로써 변경할 수 있다.

 

dotenv는 환경변수를 .env라는 파일에 저장하고 

process.env로 로드하는 의존성 모듈이다.

 

이를 사용하는 이유로는 개발과정에서 사용되는 고유한 api key값 등 민감한 정보의 보안을 위해서이다.

만약, 깃허브 같이 오픈소스에 공개도리 경우엔 해킹을 당할 위험이 있기 때문에 민감한 정보의 경우엔 .env를 사용해야 한다.

 

 

1. 패키지 설치

 

$ npm i --save @nestjs/config

 

-> 환경 변수 관리를 위해 config 패키지를 설치한다.

 

2. ConfigModule설정

 

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

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

 

- 설치한 config패키지 설정을 추가한다.

 

- AppModule에서 직접 import 해도 상관 없는데, ConfigModule설정 부분이 코드가 많아지는 경우, APpModule이 복잡해 보일 수도 있어 별도의디렉토리를 만들고 ConfigurationModule 을 만들어서 AppModule에서 import 하도록 설정했다.

 

3. 환경 변수 정의

 

.env>

SECRET = 제로초바보
PORT = 3030

 

- 프로젝트 a-nest 폴더에 .env파일을 만들고, 위와 같이 환경 변수를 설정할 수 있다.

 

- 별도의 옵션을 명시하지 않는 경우, env파일에 환경변수가 있다고 암묵적으로 약속이 되어 있다.

 

- 환경변수를 참조할 파일 path를 변경하고 싶으면 envFilePath옵션으로 설정을 바꾸면 된다.

 

 

4. 환경 변수 사용

 

 

app.module.ts>

 

@Get() 
  getHello(){
    return this.appService.getHello();
  }

 

app.service.ts>

 

@Injectable()
export class AppService {
  async getHello() {
    return process.env.SECRET;
  }
}

 

 

process.env말고, @nestjs/config를 사용해야 하는 이유

 

dotenv만 쓰면 되지 @nest/config를 왜 사용해야 하나요??

 

nest와 같은 프레임워크에서는 최소한 test/dev/prod 세 환경에서 실행하게 되는데

각 환경마다 다른 환경 변수를 사용할 필요가 있다.

예전처럼 dev/prod 단 두 환경만 있었다면 어느 환경인지 간단하게 체크하기만 했어도 되었지만 

이제는 점차 환경이 분화되고 있기에 @nestjs/config를 통해서 다양한 환경에 다양한 환경변수를 사용하는 것이 좋다.

 

물론, nest 프레임워크를 사용하지 않고서도 다양한 환경에 적합한 환경 변수를 불러오는 방법이 있다.

 

if (process.env.NODE_ENV === 'production') {
    module.exports = require('./prod');
} else if (process.env.NODE_ENV === 'testing') {
    module.exports = require('./test');
} else {
    module.exports = require('./dev');
}

 

요런 방식으로 별도의 환경 변수를  require하는 방식도 있다.

 

but, 현재 nest 프레임워크를 이용해 프로젝트를 진행하고 있다면, 

굳이 이런 방식을 사용할 필요가 없다.

 

또한 의존성 주입할 때, 환경변수 값을 자유자재로 사용가능!

 

 

따라서!

 

service.ts>

    return process.env.SECRET;

 

process.env를 직접 가져다가 쓰기보다는, 

이것마저도 configService에 쓰는게 좋음!

 

service.ts>

@Injectable()
export class AppService {
  constructor (private readonly configService: ConfigService){
  }

  getHello() : string {
    return this.configService.get('DB_PASSWORD');
    //process.env.DB_PASSWORD
  }
}

 

요런 방식!

 

DB_PASSWORD 정보는 .env안에 있다.

 

- process.env 대신 ConfigService를 쓰는 것이 좋다.

 

- process.env는 외부객체로 환경변수 객체인데 이것마저도 nest가 관리할 수 있도록 해준다.

자유자재로 환경변수를 바꿀 수 있음

 

외부에서 요청을 가져와 내 config로 만드는 비동기 작업 하는 방법은 ?

-> load라는 것을 사용하면 됨!

 

const getEnv = async () => {
  const response = await axios.get('/비밀키요청')
  //외부 서버로부터 비밀키를 요청해서 
  return response.data;
  //그것에 대한 데이터를 가져온다
};

@Module({
  imports: [ConfigModule.forRoot({ isGlobal: true, load: [getEnv] })],
  controllers: [AppController],
  providers: [AppService, ConfigService],
})

 

이런 방식이다.