[.env] dotenv 파일 내에서 주석 처리하는 법과 주의사항

 

 

 

 

 

.env 파일이란 무엇인가?

 

 

 

.env 파일 형식은 간단한 key=value 쌍으로 이루어진 텍스트 파일이다

 

시스템의 환경 변수를 정의하는 데 사용되는 셀 스크립트 문법에서 유래했다고...

 

.env는 'enviroment'의 약자인 것.

 

 

 

.env 파일 형식을 사용하는 이유

 

보통 API_KEY를 저장한다던지, DATABASE_URL을 적어두는데 많이 사용한다.

 

민간함 정보를 코드에서 분리하여 하드코딩하는 것을 방지하는 목적이다.

API_KEY=YOUR_SECRET_KEY
DATABASE_URL=postgres://user:password@host:port/dbname

 

 

 

 

 

.env 파일 작성하는 법

 

 

위처럼 변수 이름은 대문자와 언더스코어(_)로 구성하는 것이 관례다.

 

관례는 적당히 따라줘야 간지라는 것을 명심하자.

 

 

 

 

 

.env 파일을 깃허브(GitHub)에 안올리고 제외하는 법

보통 .env 파일을 Git 에서 제외하도록 설정함으로써

 

민감한 정보가 저장소에 실수로 올라가는 것을 방지한다.

 

 

Next.js 프로젝트를 생성할 때, 자동으로 생성되는 .gitignore 파일을 열어보면,

 

아래처럼 스크린샷 처럼 .env 로 시작하는 모든 파일은 git에 올라가지 않도록 기본적으로 기재 되어 있다.

 

그래도 혹시 모르니 한번씩 확인하는 것이 좋겠다.

 

 

 

 

 

 

.env 파일 안에서 주석다는 법

 

.env 파일 안에서는 '#'을 사용해서 주석을 달 수 있다. 

 

하지만 주의해야 한다.

 

#은 줄의 시작에 있을 때만 주석으로 인식한다.

 

# 올바른 주석 (파서가 무시함)
API_KEY=YOUR_SECRET_API_KEY

API_KEY=YOUR_SECRET_API_KEY # 잘못된 주석 (값의 일부로 인식될 수 있음)

 

 

변수 값 뒤에 붙는 인라인 주석은 파서(parser)에 따라 다르게 처리되거나, 주석부분까지 값의 일부로 인식될 수 있다.

 

참고하자.

 

 

끝.