[06] Externalized Configuration

🌐 외부화된 설정

Spring Boot는 설정을 외부화하여 같은 애플리케이션 코드가 다른 환경들로 작동되게 할 수 있다. Java properties 파일, YAML 파일, 환경 변수 그리고 명령줄(Command-line) 인수 같은 다양한 외부화 설정 소스들을 사용할 수 있다.

속성 값들은 @Value 어노테이션을 사용하여 Bean으로 주입되거나 Spring의 Environment 추상화를 통하여 접근하거나 @ConfiurationPerperties 어노테이션을 통해 구조화된 객체들로 바인딩될 수 있다.

Spring Boot는 매우 특별한 PropertySource 순서를 사용하며 값들의 분별있는 오버라이딩을 허용한다.
(우선 순위가 낮을 수록 높은 순위의 값을 오버라이딩)

우선순위	PropertySource
1	Devtools 전역 설정 변수, %HOME/.config/spring-boot 폴더
2	@TestPropertySource 어노테이션
3	테스트에서의 properties 속성, @SpringBootTest 및 @...Test 어노테이션
4	명령줄(Command-line) 인수
5	SPRING_APPLICATION_JSON, 환경 변수나 시스템 속성에 내장된 inline JSON
6	ServletConfig 초기화 파라미터
7	ServletContext 초기화 파라미터
8	JNDI 속성, java:comp/env
9	Java 시스템 변수, System.getProperties()
10	OS 환경 변수
11	오직 ramdom.* 만 속성으로 갖는 RandomValueProertySource
12	Config data
13	@Confiuration 클래스 내 @PropertySource 어노테이션
14	기본 properties, SpringApplication.setDefaultProperties

---

🍎 Command Line Properties

기본적으로 SpringApplication은 명령줄 옵션 인수들을 property로 변환하고 Spring Environment에 추가한다. Command Line Properties는 항상 파일 property 소스 파일들보다 더 높은 우선순위를 갖는다.

$ java -jar myproject.jar --server.port=9000

만약 Command Line Properties를 Environment에 추가되지 않게 하려면, 다음과 같이 비활성화할 수 있다.

SpringApplication.setAddCommandLineProperties(false)

---

🍎 JSON Application Properties

환경 변수와 시스템 속성은 몇몇 속성명을 사용할 수 없는 제한이 있다. 이것을 해결하기 위해 Spring Boot는 단일 JSON 구조로 속성들을 인코딩하도록 해준다.

애플리케이션이 시작될 때, spring.application.json이나 SPRING_APPLICATION_JSON 속성들은 파싱되고 Environment에 추가된다.

// 환경 변수
$ SPRING_APPLICATION_JSON='{"my":{"name":"test"}}' java -jar myapp.jar

// 시스템 속성
$ java -Dspring.application.json='{"my":{"name":"test"}}' -jar myapp.jar

// 명령줄 인수
$ java -jar myapp.jar --spring.application.json='{"my":{"name":"test"}}'

---

🍎 External Application Properties

Spring Boot는 애플리케이션이 시작될 때 자동적으로 다음의 위치에서 application.properties나 application.yaml 파일들을 찾고 불러온다. 불려진 파일들의 내용들은 Spring Environment에 PropertySources로 추가된다.

우선순위	위치
1	/config 하위 폴더의 자식 폴더
2	현재 폴더의 /config 하위 폴더
3	현재 폴더
4	classpath /config 패키지
5	classpath root

만약 "application" 이름으로 설정 파일명을 사용하기 싫다면, spring.config.name 환경 속성을 사용하여 바꿀 수 있다.

$ java -jar myproject.jar --spring.config.name=myproject

spring.config.location 환경 속성을 사용하여 명시적 위치를 참조할 수 도 있다.

$ java -jar myproject.jar --spring.config.location=\
    optional:classpath:/default.properties,\
    optional:classpath:/override.properties

Profile Specific Files

Spring Boot는 application.properties 파일 뿐만 아니라 application-{profile} 명명 규칙을 사용하여 profile-specific 파일들을 불러온다. profile-specific properties는 application.properties와 같은 위치에서 불러오며, application.properties를 항상 오버라이딩한다.

아래와 같이 특정 properties를 활성화 할 수 있다.

spring.config.activate.on-profile=prod

---

🍎 Properties 암호화

Spring Boot는 Properties 암호화에 대한 내장 기능을 지원하지 않지만, Spring Environment 안에 포함된 값들을 수정할 때 필요한 "hook points"를 지원한다. "EnvironmentPostProcessor" 인터페이스는 애플리케이션이 시작하기 전에 Environment를 조작할 수 있도록 해준다.

만약 자격(credentials)이나 암호들을 저장하는 안전한 방법을 찾는다면, Spring Cloud Valut 프로젝트는 "HashiCorp Vault"으로 외부화된 설정을 저장한다.

---

🍎 Random Values

RandomValuePropertySource는 랜덤한 값들을 주입하기에 유용하다. Interger, Long, UUID 혹은 String으로 생산할 수 있다.

my.secret=${random.value}
my.number=${random.int}
my.bignumber=${random.long}
my.uuid=${random.uuid}
my.number-less-than-ten=${random.int(10)}
my.number-in-range=${random.int[1024,65536]}

---

🍎 시스템 환경 변수 구성

Spring Boot는 환경 변수를 위한 prefix 설정을 지원하며 SpringApplication 클래스에 직접적으로 설정할 수 있다. 이 설정은 시스템 환경이 다른 설정 요구사항을 가진 여러 Spring Boot 애플리케이션에 공유된다면 유용한다.

예를 들어, 'input'으로 prefix를 설정하면, remote.timeout 같은 속성은 input.remote.timeout으로 시스템 환경에 할당된다.

---

🍎 Type-safe 구성 Properties

@Value("${property}") 어노테이션으로 구성 속성을 주입하는 것은 때때로 번거로울 수 있다. 특히 다수의 속성들로 작업하거나 데이터가 계층적인 경우 더욱 그러하다. Spring Boot는 Properties로 작업하는 대체 방법을 제공하며, 강력하게 정형화된 Bean으로 제어하고 애플리케이션의 설정을 검사한다.

😪 외부화 설정은 차후 추가적으로 자세히 알아보자.