스프링 외부 설정 방법 (설정 파일 우선순위)

 

https://hyejin.tistory.com/1166

스프링 외부 설정 방법 (외부 데이터)

저번 글에서 스프링 외부 설정 방법 중 외부 파일, 내부 파일로 설정하는 방법을 작성했다. 

그리고 이 내부 파일을 통합해서 #--- 또는 !---로 구분해서 하나의 파일로 사용할 수 있는 것 까지 알아봤는데 

이때 profile을 지정하지 않는다면 스프링은 "default" 프로필로 지정하고, 프로필에 해당하는 값을 조회한다. 

 

url=local.db.com
username=local_user
password=local_pw
#---
spring.config.activate.on-profile=dev
url=dev.db.com
username=dev_user
password=dev_pw
#---
spring.config.activate.on-profile=prod
url=prod.db.com
username=prod_user
password=prod_pw

다음과 같이 맨 위에 프로필을 지정하지 않고 url, username, password 값을 지정해 기본값을 설정해줬다. 

그러면 프로필에 상관없이 이 값은 항상 사용할 수 있게 된다. 

 

이렇게 application.properties에 작성해주고, 프로필 없이 실행하면 

이렇게 기본값이 설정된 것을 확인할 수 있다. 

 

그리고 만약 프로필을 dev로 설정하면 기본값보다 프로필 설정해준 dev가 우선순위를 가져 

dev에서 지정한 키값을 조회할 수 있다. 

 

✏️ 설정 데이터 우선순위 

url=local.db.com
username=local_user
password=local_pw
#---
spring.config.activate.on-profile=dev
url=dev.db.com
username=dev_user
password=dev_pw
#---
spring.config.activate.on-profile=prod
url=prod.db.com
username=prod_user
password=prod_pw

application.properties 파일에서 실행순서는 단순하게 문서를 위에서 아래로 읽으면서 사용할 값을 설정한다고 할 수 있다. 

 

1️⃣ 우선 기본값인 데이터들을 읽어서 저장한다. 

(이 기본값들은 프로필과 무관하게 항상 값을 사용할 수 있다.) 

 

2️⃣ 다음 순서인 dev 관련 데이터들을 읽는데 이때 dev 프로필이 설정되어 있다면 기존 값에서 dev 값으로 대체하고, 프로필 설정이 되어있지 않는다면 dev 관련 문서는 무시되고 그 값은 사용하지 않는다. 

 

3️⃣ 그 다음 순서인 prod 관련 데이터들을 읽는데 이때도 prod 프로필이 설정되어 있다면 기존 값에서 prod 값으로 대체하고, 프로필 설정이 되어있지 않는다면 prod 관련 데이터는 무시하고 사용하지 않는다. 

 

* 그리고 프로필은 dev, prod 등 2개 이상 설정하는 것도 가능하다. 

--spring.profiles.active = dev, prod 

 

 

url=local.db.com
username=local_user
password=local_pw
#---
spring.config.activate.on-profile=dev
url=dev.db.com
username=dev_user
password=dev_pw
#---
spring.config.activate.on-profile=prod
url=prod.db.com
username=prod_user
password=prod_pw
#---
url=test.db.com 

만약 맨 밑에 구분선을 추가하고 url=test.db.com 을 추가하면.. 

스프링은 위에서 아래로 데이터를 읽는다고 했으니까 url 만 test.db.com으로 변경되는 것을 확인할 수 있다. 

* 근데 물론 이렇게는 거의 사용하지 않는다. 그리고 프로필도 대체로 한개만 사용한다. 

 

 

💌 정리 

- 스프링은 applicatioin.properties 문서를 위에서 아래로 순서대로 읽으면서 값을 설정한다. (기존 값이 있다면 대체한다.)

- application.properties 문서에 spring-config.activate.on-profiles 옵션이 있으면 해당 프로필을 사용할 때만 논리 문서를 적용한다. 

 

 

 

⭐️ 스프링 외부 설정 관련 우선순위 

우선순위는 유연하면서 범위가 좁은 것이 우선권을 갖게된다. (딱 지정해서 변경하기 어려운 파일보다는 실행 시 원하는 값을 줄 수 있는 것이 더 우선권을 갖게되며, 적용 범위가 더 좁은 것이 우선권을 갖게 된다.) 

 

- 외부 설정 관련 우선순위 

1. @TestPropertySource (테스트에서 사용하는 것으로 테스트 설정 값을 따로 줄 수 있도록 하는 어노테이션) 

2. 커맨드 라인 옵션 인수 

3. 자바 시스템 속성 

4. OS 환경 변수 

5. 설정 데이터 (application.properties)

 

-> 따라서 Environmnet 가 조회할 때  우선순위에 따라 우선순위가 더 높은 것을 먼저 조회해서 값을 설정한다. 

 

- 설정 데이터 관련 우선순위 

1. jar 외부 프로필 적용 파일 application-{profile}.properties 

2. jar 외부 application.properties 

3. jar 내부 application-{profile}.properties 

4. jar 내부 application.properties 

 

 

실무에서는 보통 application.properties에 설정 데이터를 보관하고 사용하다가 급 속성을 변경해야 한다고 한다면 우선순위를 생각해서 

자바 시스템 속성이나 커맨드 라인 옵션 인수를 사용해서 속성 값을 대체해주면 된다. 

그리고 기본으로는 jar 내부의 application.properties 문서를 사용하다가 특별한 환경에서는 자바 실행위치인 외부 application.properties 를 새로 만들고 변경해야하는 값을 반영해서 사용하는 방법도 있다.