[스프링 핵심 원리와 활용] 섹션8. 외부 설정과 프로필 2 #865

YuDeokRin · 2025-08-16T00:10:09Z

YuDeokRin
Aug 16, 2025
Maintainer

섹션8. 외부설정과 프로필2

1️⃣ 프로젝트 설정

2️⃣ 외부 설정 사용 - Enviroment

3️⃣ 외부 설정 사용 - @value

4️⃣ 외부 설정 사용 - @ConfiguartionProperties 시작

5️⃣ 외부 설정 사용 - @ConfigurationProperties 생성자

@ConfigurationProperties는 Getter, Setter를 사용하는 자바빈 프로퍼티 방식이 아니라 생성자를 통해서 객체를 만드는 기능도 지원한다.
MyDataSourcePropertiesV2

package hello.datasource;

import lombok.Getter;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.bind.DefaultValue;

import java.time.Duration;
import java.util.List;

@Getter
@ConfigurationProperties("my.datasource")
public class MyDataSourcePropertiesV2 {

		private String url;
		private String username;
		private String password;
		private Etc etc;

		public MyDataSourcePropertiesV2(String url, String username, String
			password, @DefaultValue Etc etc) {
			this.url = url;
			this.username = username;
			this.password = password;
			this.etc = etc;
		}

		@Getter
		public static class Etc {
				private int maxConnection;
				private Duration timeout;
				private List<String> options;
				
				public Etc(int maxConnection, Duration timeout, @DefaultValue("DEFAULT")
					List<String> options) {
					this.maxConnection = maxConnection;
					this.timeout = timeout;
					this.options = options;
				}
		}
}

생성자를 만들어 두면 생성자를 통해서 설정 정보를 주입한다.
@Getter 롬복이 자동으로 getter 를 만들어준다.
@DefaultValue : 해당 값을 찾을 수 없는 경우 기본값을 사용한다.
- @DefaultValue Etc etc
  - etc 를 찾을 수 없을 경우 Etc 객체를 생성하고 내부에 들어가는 값은 비워둔다. (null , 0 )
- @DefaultValue("DEFAULT") List<String> options
  - options 를 찾을 수 없을 경우 DEFAULT 라는 이름의 값을 사용한다.

package hello.config;

import hello.datasource.MyDataSource;
import hello.datasource.MyDataSourcePropertiesV2;
import lombok.extern.slf4j.Slf4j;

import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;

@Slf4j
@EnableConfigurationProperties(MyDataSourcePropertiesV2.class)
public class MyDataSourceConfigV2 {

			private final MyDataSourcePropertiesV2 properties;
			public MyDataSourceConfigV2(MyDataSourcePropertiesV2 properties) {
				this.properties = properties;
			}
			
			@Bean
			public MyDataSource dataSource() {
					return new MyDataSource(
							properties.getUrl(),
							properties.getUsername(),
							properties.getPassword(),
							properties.getEtc().getMaxConnection(),
							properties.getEtc().getTimeout(),
							properties.getEtc().getOptions());
			}
}

✅ ExternalReadApplication - 수정

//@Import(MyDataSourceConfigV1.class)
@Import(MyDataSourceConfigV2.class)
@SpringBootApplication(scanBasePackages = "hello.datasource")
public class ExternalReadApplication {...}

@import(MyDataSourceConfigV1.class)를 주석처리
@import(MyDataSourceConfigV2.class)를 추가
실행 결과

url=local.db.com
username=local_user
password=local_pw
maxConnection=1
timeout=PT3.5S
options=[CACHE, ADMIN]

정리
- application.properties에 필요한 외부 설정을 추가하고 @ConigurationProperties의 생성자 주입을 통해서 값을 읽음 하지만 Setter가 없으므로 개발자 중간에 실수로 값을 변경하는 문제가 발생하지 않는다.
문제
- 예를 들어서 max-connection 의 값을 0으로 설정하면 커넥션이 하나도 만들어지지 않는 심각한 문제가 발생한다고 가정해보자.
- max-connection 은 최소 1 이상으로 설정하지 않으면 애플리케이션 로딩 시점에 예외를 발생시켜서 빠르게 문제를 인지할 수 있도록 하고 싶다.

6️⃣ 외부 설정 사용 - @ConfigurationProperties 검증

@ConfigurationProperties를 통해서 숫자가 들어가야 하는 부분에 문자가 입력되는 문제와 같은 타입이 맞지 않는 데이터를 입력하는 문제는 예방할 수 있다.
하지만 문제는 숫자의 범위, 문자의 길이 같은 부분이 검증이 어렵움
예) 최대 커넥션 숫자는 최소 1, 최대 999라는 범위를 가져야 한다면 어떻게 검증할까?
- 이메일을 외부 설정에 입력했는데, 만약 이메일 형식에 맞지 않는다면 어떻게 검증할 수 있을까?
- 개발자가 직접 하나하나 검증 코드를 작성해도 되지만, 자바에는 자바 빈 검증기(java bean validation)이라는 훌륭한 표준 검증기가 제공된다.
build.gradle

implementation 'org.springframework.boot:spring-boot-starter-validation' //추가

검증기를 추가하여 ConfigurationProperties 만들기
MyDataSourcePropertiesV3

package hello.datasource;

import jakarta.validation.constraints.Max;
import jakarta.validation.constraints.Min;

import jakarta.validation.constraints.NotEmpty;
import lombok.Getter;
import org.hibernate.validator.constraints.time.DurationMax;
import org.hibernate.validator.constraints.time.DurationMin;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.validation.annotation.Validated;

import java.time.Duration;
import java.util.List;

@Getter
@ConfigurationProperties("my.datasource")
@Validated
public class MyDataSourcePropertiesV3 {

		@NotEmpty
		private String url;
	
		@NotEmpty
		private String username;

		@NotEmpty
		private String password;
		private Etc etc;

		public MyDataSourcePropertiesV3(String url, String username, String
																		password, Etc etc) {
				this.url = url;
				this.username = username;
				this.password = password;
				this.etc = etc;
		}

		@Getter
		public static class Etc {

		@Min(1)
		@Max(999)
		private int maxConnection;
		@DurationMin(seconds = 1)
		@DurationMax(seconds = 60)
		private Duration timeout;
		private List<String> options;
		
		public Etc(int maxConnection, Duration timeout, List<String> options) {
			this.maxConnection = maxConnection;
			this.timeout = timeout;
			this.options = options;
		}

	}
}

@notempty url,username,password는 항상 값이 있어야 한다.
필수 값이 된다.@min(1) @max(999) maxConnection: 최소1, 최대999의 값을 허용한다.
@DurationMin(seconds = 1) @DurationMax(seconds = 60) : 최소 1, 최대 60초를 허용한
다.
jakarta.validation.constraints.Max패키지 이름에 jakarta.validation으로 시작하는 것은 자바 표준 검증기에서 지원하는 기능이다.

org.hibernate.validator.constraints.time.DurationMax패키지 이름에org.hibernate.validator로 시작하는 것은 자바 표준 검증기에서 아직 표준화 된 기능은 아니고, 하이버네이트 검증기라는 표준 검증기의 구현체에서 직접 제공하는 기능이다. 대부분 하이버네이트 검증기를 사용
하므로 이 부분이 크게 문제가 되지는 않는다.

package hello.config;

import hello.datasource.MyDataSource;
import hello.datasource.MyDataSourcePropertiesV3;
import lombok.extern.slf4j.Slf4j;

import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;

@Slf4j
@EnableConfigurationProperties(MyDataSourcePropertiesV3.class)
public class MyDataSourceConfigV3 {
		private final MyDataSourcePropertiesV3 properties;
		
		public MyDataSourceConfigV3(MyDataSourcePropertiesV3 properties) {
			this.properties = properties;
		}

		@Bean
		public MyDataSource dataSource() {
			return new MyDataSource(
					properties.getUrl(),
					properties.getUsername(),
					properties.getPassword(),
					properties.getEtc().getMaxConnection(),
					properties.getEtc().getTimeout(),
					properties.getEtc().getOptions());
		}
}

ExternalReadApplication - 수정

//@Import(MyDataSourceConfigV2.class)
@Import(MyDataSourceConfigV3.class)
@SpringBootApplication(scanBasePackages = "hello.datasource")
public class ExternalReadApplication {...}

@Import(MyDataSourceConfigV2.class) 를 주석처리 한다.
@Import(MyDataSourceConfigV3.class) 를 추가 한다.

✅ 값이 검증 범위를 넘어서게 설정

maxConnection=0으로 설정한 예

Property: my.datasource.etc.maxConnection
Value: "0"
Origin: class path resource [application.properties] - 4:34
Reason: 1 이상이어야 합니다

실행 결과

url=local.db.com
username=local_user
password=local_pw
maxConnection=1
timeout=PT3.5S
options=[CACHE, ADMIN]

✅ConfigurationProperties 장점

외부 설정을 객체로 편리하게 변환해서 사용할 수 있다.
외부 설정의 계층을 객체로 편리하게 표현할 수 있다.
외부 설정을 타입 안전하게 사용할 수 있다.
검증기를 적용할 수 있다.

7️⃣ YAML

스프링은 설정 데이터를 사용할 때 application.properties 뿐만 아니라 application.yml 이라는 형식 지원함

YAML(YAML Ain't Markup Language)

사람이 읽기 좋은 데이터 구조를 목표
application.properties 예시

environments.dev.url=https://dev.example.com
environments.dev.name=Developer Setup
environments.prod.url=https://another.example.com
environments.prod.name=My Cool App

application.yml 예시

environments:
	dev:
		url: "https://dev.example.com"
		name: "Developer Setup"
	prod:
		url: "https://another.example.com"
		name: "My Cool App"

YAML의 가장 큰 특징은 사람이 읽기 좋게 계층 구조
YAML은 space (공백)로 계층 구조를 만든다. space 는 1칸을 사용해도 되는데, 보통 2칸을 사용한다.
일관성있게 사용하지 않으면 읽기 어렵거나 구조가 깨질 수 있다.
구분 기호로: 를 사용한다. 만약 값이 있다면 이렇게 key: value : 이후에 공백을 하나 넣고 값을 넣어
주면 된다.

➡️ 적용

application.properties를 사용하지 않도록 파일 이름을 변경하자.
application.properties → application_backup.properties

my.datasource.url=local.db.com
my.datasource.username=local_user
my.datasource.password=local_pw
my.datasource.etc.max-connection=1
my.datasource.etc.timeout=3500ms
my.datasource.etc.options=CACHE,ADMIN

src/main/resources/application.yml를 생성하자.

my:
	datasource:
		url: local.db.com
		username: local_user
		password: local_pw

	etc:
		max-connection: 1
		timeout: 60s
		options: LOCAL, CACHE

my:
	datasource:
		url: local.db.com
		username: local_user
		password: local_pw
		etc:
			maxConnection: 2
			timeout: 60s
			options: LOCAL, CACHE
---
spring:
	config:
		activate:
			on-profile: dev
my:
	datasource:
		url: dev.db.com
		username: dev_user
		password: dev_pw
		etc:
			maxConnection: 10
			timeout: 60s
			options: DEV, CACHE
---
spring:
	config:
		activate:
			on-profile: prod
my:
	datasource:
		url: prod.db.com
		username: prod_user
		password: prod_pw
		etc:
			maxConnection: 50
			timeout: 10s
			options: PROD, CACHE

yml 은 ---dash(-) 3개를 사용해서 논리 파일을 구분한다.
spring.config.active.on-profile을 사용해서 프로필을 적용할 수 있다.
나머지는application.properties 와 동일하다

8️⃣ @Profile

각 환경마다 서로 다른 빈을 등록해야 한다면 어떻게 해야할까?
예를 들어서 결제 기능을 붙여야 하는데, 로컬 개발 환경에서는 실제 결제가 발생하면 문제가 되니 가짜 결제 기능이 있는 스프링 빈을 등록하고, 운영 환경에서는 실제 결제 기능을 제공하는 스프링 빈을 등록한다고 가정해보자.
PayClient

package hello.pay;

public interface PayClient {
		void pay(int money);
}

DI를 적극 활용하기 위해 인터페이스를 사용
LocalPayClient

package hello.pay;

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class LocalPayClient implements PayClient {

	@Override
	public void pay(int money) {
		log.info("로컬 결제 money={}", money);
	}
}

ProdPayClient

package hello.pay;

import lombok.extern.slf4j.Slf4j;

@Slf4j
public class ProdPayClient implements PayClient {

	@Override
	public void pay(int money) {
		log.info("운영 결제 money={}", money);
	}
}

OrderService

package hello.pay;

import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;

@Service
@RequiredArgsConstructor
public class OrderService {
		private final PayClient payClient;
		
		public void order(int money) {
				payClient.pay(money);
		}
}

PayClient 를 사용하는 부분이다. 상황에 따라서 LocalPayClient 또는 ProdPayClient 를 주입받는다.
PayConfig

package hello.pay;

import lombok.extern.slf4j.Slf4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;

@Slf4j
@Configuration
public class PayConfig {

		@Bean
		@Profile("default")
		public LocalPayClient localPayClient() {
			log.info("LocalPayClient 빈 등록");
			return new LocalPayClient();
		}

		@Bean
		@Profile("prod")
		public ProdPayClient prodPayClient() {
			log.info("ProdPayClient 빈 등록");
			return new ProdPayClient();
		}
}

@Profile애노테이션을 사용하면 해당 프로필이 활성화된 경우에만 빈을 등록한다.
- default프로필(기본값)이 활성화 되어 있으면LocalPayClient를 빈으로 등록한다.
- prod프로필이 활성화 되어 있으면ProdPayClient를 빈으로 등록한다.
RunOrder

package hello.pay;

import lombok.RequiredArgsConstructor;
import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.stereotype.Component;

@Component
@RequiredArgsConstructor
public class OrderRunner implements ApplicationRunner {
		private final OrderService orderService;
	
		@Override
		public void run(ApplicationArguments args) throws Exception {
				orderService.order(1000);
		}
}

ApplicationRunner 인터페이스를 사용하면 스프링은 빈 초기화가 모두 끝나고 애플리케이션 로딩이 완료되는 시점에 run(args) 메서드를 호출해준다
ExternalReadApplication 변경

package hello;

import hello.config.*;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Import;

@Import(MyDataSourceConfigV3.class)
@SpringBootApplication(scanBasePackages = {"hello.datasource", "hello.pay"})
public class ExternalReadApplication {
		public static void main(String[] args) {
			SpringApplication.run(ExternalReadApplication.class, args);
		}
}

프로필 없이 실행

No active profile set, falling back to 1 default profile: "default"
LocalPayClient 빈 등록
...
로컬 결제 money=1000

prod 프로필 실행
- --spring.profiles.active=prod 프로필 활성화 적용

The following 1 profile is active: "prod"
ProdPayClient 빈 등록

운영 결제 money=1000

prod 프로필을 적용했다.
prod 프로필이 사용되면 ProdPayClient 가 빈으로 등록되는 것을 확인할 수 있다.

package org.springframework.context.annotation;

@Conditional(ProfileCondition.class)
public @interface Profile {
		String[] value();
}

@Profile은 특정 조건에 따라서 해당 빈을 등록할지 말지 선택한다. 어디서 많이 본 것 같지 않은가? 바
@conditional이다. 코드를 보면@conditional(ProfileCondition.class)를 확인할 수 있다. 스프링
@conditional기능을 활용해서 개발자가 더 편리하게 사용할 수 있는@Profile` 기능을 제공하는 것이
다.

✅정리

@Profile 을 사용하면 각 환경 별로 외부 설정 값을 분리하는 것을 넘어서, 등록되는 스프링 빈도 분리할 수 있다

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[스프링 핵심 원리와 활용] 섹션8. 외부 설정과 프로필 2 #865

Uh oh!

{{title}}

Uh oh!

Replies: 0 comments

Select a reply

Uh oh!

[스프링 핵심 원리와 활용] 섹션8. 외부 설정과 프로필 2 #865

Uh oh!

YuDeokRin Aug 16, 2025 Maintainer

섹션8. 외부설정과 프로필2

1️⃣ 프로젝트 설정

2️⃣ 외부 설정 사용 - Enviroment

3️⃣ 외부 설정 사용 - @value

4️⃣ 외부 설정 사용 - @ConfiguartionProperties 시작

5️⃣ 외부 설정 사용 - @ConfigurationProperties 생성자

✅ ExternalReadApplication - 수정

6️⃣ 외부 설정 사용 - @ConfigurationProperties 검증

✅ 값이 검증 범위를 넘어서게 설정

✅ConfigurationProperties 장점

7️⃣ YAML

YAML(YAML Ain't Markup Language)

➡️ 적용

8️⃣ @Profile

✅정리

Replies: 0 comments

YuDeokRin
Aug 16, 2025
Maintainer