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

 

스프링 외부 설정 방법 (OS 환경 변수, 자바 시스템 속성) (tistory.com)

스프링 외부 설정 방법 (OS 환경 변수, 자바 시스템 속성)

스프링 외부 설정 방법 (커맨드 라인 인수, 커맨드 라인 옵션 인수, 스프링 통합) (tistory.com)

스프링 외부 설정 방법 (커맨드 라인 인수, 커맨드 라인 옵션 인수, 스프링 통합)

 

 

0️⃣ 외부 설정 방법 

스프링에서 외부 설정하는 방법으로는 4가지 정도가 있다. 

- OS 환경 변수: OS 에서 지원하는 외부 설정, 해당 OS를 사용하는 모든 프로세스에서 사용 
- 자바 시스템 속성 : 자바에서 지원하는 외부 설정, 해당 JVM 안에서 사용 
- 자바 커맨드 라인 인수 : 커맨드 라인에서 전달하는 외부 설정, 실행 시 main(args) 메서드에서 사용
- 외부 파일(설정 데이터) : 프로그램에서 외부 파일을 직접 읽어서 사용 

앞에 글에서 OS 환경 변수, 자바 시스템 속성, 자바 커맨드 라인 인수로 설정 값을 지정하고 읽어오는 방법에 대해서 알아봤다. 

위의 세가지 방법은 직접 값을 지정해줘야 하는데 외부에 값을 지정해줘야하는게 많아지면 사용하기 점점 불편해진다. 

 

실무에서는 수십개의 설정값이 필요해지는데 이를 프로그램 실행할 때 마다 입력하려고 한다면 누락되는 부분도 있을 것이고, 관리 역시 어렵다. 

 

이러한 단점을 해결하기 위한 방법으로는 설정값을 파일에 넣어서 관리하는 방법이 있다. 

설정값을 파일에 넣어 관리한 다음 실행할 때는 애플리케이션 로딩 시점에 이 파일을 읽어서 사용하면 된다. 

파일 형식중에서는 .properties 파일이 key=value 형식을 사용하기 때문에 설정값을 관리하기에 용이하다. 

 

 

 

1️⃣  외부 설정 방법 : 외부 파일 

application.properties 파일을 설정 값을 다르게 사용해야 하는 개발 서버와 운영 서버에 각각 같은 이름으로 만들어둔다. 

그 다음 애플리케이션 로딩 시점에 해당 파일을 읽어서 그 속에 있는 값들을 외부 설정값으로 사용하면 된다. 

(이제 파일이름은 같기 때문에 코드를 수정해야하는 그런 불편함은 없다.) 

 

url=dev.db.com
user=dev_user
password=dev_pw

application.properties에 이런식으로 작성만 해두면 스프링부트가 이 설정값을 읽어서 사용할 수 있도록 구현을 다 해뒀다. 

따라서 그냥 개발자는 application.properties 파일만 자바를 실행하는 위치에 만들어 두기만 하면 된다. 

 

-> 그러면 스프링에서 PropertySoource의 구현체를 제공해 해당 파일을 읽어올 수 있고, Environment 를 통해서 설정 데이터를 조회할 수 있다. 

 

 

❗ 근데 외부에 application.properties 파일을 둬서 관리하게 되면 설정 파일 자체를 관리하는데 번거로운 문제가 발생한다. 

만약 서버가 만약 10대면 변경사항이 있다면 10개 서버의 외부 설정 파일을 모두 변경해줘야 한다는 불편함이 있다. 

 

 

2️⃣ 외부 설정 방법 : 내부 파일 

위에서 외부 파일로 application.properties을 두면 설정 파일 자체를 관리하는데 불편함이 있는데 이 문제를 해결할 수 있는 방법으로는 설정 파일을 프로젝트 내부에 포함해서 관리하고 빌드 시점에 같이 빌드하는 것이다. 

 

이렇게 하면 애플리케이션을 배포할 때 설정 파일도 함께 배포하는건데 즉, jar 하나에 설정 데이터까지 포함해서 관리하는 것이다. 

src > main > resources 에 application-dev.properties, application-prod.properties 이런식으로 개발, 운영 설정 파일을 만들고, 함께 포함해서 빌드하고 jar 는 두 설정 파일을 모두 가지고 배포하게 된다. 

그 다음 각각 실행할 때 어떤 설정 파일을 가지고 실행하면 되는지만 지정해주면 된다. 

(개발 서버라면 application-prod.properties, 운영 서버라면 application-dev.properties) 

그리고 이 구분은 profile 프로필을 통해서 구분해주면 스프링이 이 프로필에 따라 각각 파일을 읽는 방법을 구현해뒀다. 

 

 

* 프로필 

스프링은 설정 파일 같은 것을 구분해서 사용하기 위해 프로필이라는 개념을 지원한다. 

 spring.profiles.active 로 외부 설정에 값을 넣으면 해당 프로필을 사용한다고 판단한다. 

그리고 이 프로필은 application-{profile}.properties 규칙에 따라 해당 프로필에 맞는 내부 파일 (설정 데이터)를 조회한다. 

--spring.profiles.active=prod 로 설정하면 프로필을 prod로 한다는 것으로 application-prod.properties 파일의 설정을 조회한다. 

지금은 커맨드 라인 옵션 인수로 설정해서 실행했는데 자바 시스템 속성이나 os 환경 변수 뭐든 사용은 가능하다. 

 

 

-> 이렇게 설정 데이터 파일을 프로젝트 내부에 생성해서 관리할 수 있고, 배포 시점에 설정 파일도 함께 배포하게 된다. 

그런데 이렇게 파일을 나눠서 사용하면 설정 데이터를 한눈에 파악하기 어려운데 파일 하나에 다 포함할 수도 있다. 

 

 

3️⃣ 외부 설정 방법 : 내부 파일 통합 

위에 내부 파일은 설정 파일을 분리해서 사용하고 있는데 이러면 각각 파일을 분리했기 때문에 설정 데이터를 한눈에 파악하기 어렵다는 단점이 존재한다. 

-> 스프링은 이 문제를 또 해결하기 위해서 내부 파일 하나 가지고 분리해서 사용할 수 있는 방법도 제공한다. 

 

 

application.properties에 위 그림과 같이 dev, prod 환경에 대한 설정 데이터를 작성해주고, #--- 또는 !---로 구분해서 영역을 나눌 수 있다. 

#--- 또는 !---로 구분해주면 하나의 파일을 가지고 분리해서 사용할 수 있다. 

그리고 spring.config.activate.on-profile에 profile 을 지정해주면 프로필 값에 따라서 해당하는 데이터를 활성화해서 사용할 수 있다. 

 

(테스트를 위해서 위에 만들었던 application-dev.properties와 application-prod.properties의 데이터들은 주석처리해준다.) 

 

 

* 프로필을 prod 로 지정 

 

* 프로필을 dev로 지정 

 

-> 이렇게 application.properties 파일 하나에 통합해서 다양한 프로필의 설정 데이터를 관리할 수 있다.