[Git] application-secret.properties 관리하기

토큰을 만들 때 사용할 비밀 키나, OAuth 클라이언트 Id, 보안 비밀번호 등 깃허브 같은 외부 사이트에 업로드하지 않아야하는 프로퍼티들을 관리해야할 때 .gitignore 파일을 사용하는 것이 효과적이다.

 

1. .gitignore 파일 열기 또는 생성하기

프로젝트 루트 디렉토리에 .gitignore 파일을 열거나 없다면 새로 생성한다.

 

2. application-secret.properties 파일 추가하기

resources 폴더 하위에 application-secret.properties 파일을 추가한 뒤 .gitignore 파일에 다음과 같이 작성한 후 저장한다.

### etc ###
src/main/resources/application-secret.properties

 

3. 캐시에서 제거하기

단, Git이 이미 application-secret.properties 파일을 추적 중이라면, 캐시에서 제거해 주어야한다. 터미널에서 프로젝트 루트 디렉토리로 이동한 후 다음 명령을 실행한다.

git rm --cached src/main/resources/application-secret.properties

 

4. 변경 사항 커밋하기

git add .gitignore
git commit -m "Add application-secret.properties to .gitignore and remove from cache"

 

참고 1)

properties 파일에서 한글이 깨져보인다면

[intelliJ] properties 파일 UTF-8 인코딩

 

참고 2)

스프링 프레임워크에서 특정 프로퍼티를 포함하도록 설정하려면

# profile
spring.profiles.include=secret

• spring.profiles.include
  • 애플리케이션이 실행될 때 추가적으로 포함할 프로파일을 지정
  • 여기서는 secret 프로파일을 추가로 포함하겠다는 의미
  • 이 설정을 통해 애플리케이션은 추가적인 설정 파일이나 프로파일을 포함시켜서 다양한 환경에 맞게 설정을 유연하게 관리할 수 있음!

 

1. 기본 설정 로드
   • 애플리케이션이 시작되면 기본 설정 파일인 application.properties가 로드됨
2. 추가 프로파일 로드
   • spring.profiles.include=secret 설정이 있으면, secret 프로파일에 해당하는 설정 파일인 application-secret.properties을 추가로 로드
3. 설정 병합
   • 기본 설정과 secret 프로파일의 설정이 병합됨
   • 만약 동일한 키에 대해 설정 값이 충돌하면, secret 프로파일의 설정 값이 우선함