스프링 YAML, @Profile

 

0️⃣ YAML 이란? 

스프링은 설정 데이터를 사용할 때 application.properties 말고도  appliction.yml YAML 파일 형식을 지원한다. 

이때 YAML 이란 YAML Ain't Markup Language 의 약자로 확장자는 yaml, yml로 주로 yml 을 사용한다. 

 

 

application.properties 

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

 

 

application.yml 

my:
  datasource:
    url: local.db.com
    username: local_user
    password: local_pw
    etc:
      max-connection: 1
      timeout: 60s
      options: LOCAL, CACHE

YAML와  application.properties를 비교해보면 application.properties는 평평? 하게 되어 있어서 구조 파악이 어렵지만 YAML 은 사람이 읽기 좋게 계층 구조로 이루어져 있다. 

근데 YAML 은 사람이 읽기 좋게 계층 구조 형태를 띄는거지 스프링이 실제 읽을 때는 평평하게 만들어서 읽는다. 

 

YAML 은 space(공백)으로 계층 구조를 만들고 space는 보통 2칸을 사용하고 이때 일관성 있지 않다면 구조가 깨질 수도 있다. 

 

 

 

* 그리고 만약 application.properties와 application.yml이 두개 같이 있다면 application.properties가 우선권을 가진다고는 하는데 보통 실무에서는 properties보다는 yml 이 읽기 편하기 때문에 yml을 사용한다. 

 

 

 

1️⃣ 프로필 설정 

YML 에서도 properties와 같이 프로필을 설정할 수 있다. 

my:
  datasource:
    url: local.db.com
    username: local_user
    password: local_pw
    etc:
      max-connection: 1
      timeout: 60s
      options: LOCAL, CACHE

---
spring:
  config:
    activate:
      on-profile: dev

my:
  datasource:
    url: dev.db.com
    username: dev_user
    password: dev_pw
    etc:
      max-connection: 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:
      max-connection: 50
      timeout: 10s
      options: PROD, CACHE

yml 에서는 ---- 을 사용해 논리 파일을 구분하고, 

spring.config.active.on-prifle 을 사용해서 프로필을 적용할 수 있다. 

 

 

 

2️⃣ @Profile 

application.yml 에 프로필을 설정해서 프로필에 따라 각 환경에 맞는 설정값을 지정할 수 있도록 했는데 

만약 설정값 뿐만 아니라 각 환경마다 서로 다른 빈을 등록해야 한다면 ? 어떻게 해야할까 ? 

예로 결제 기능인데 운영 환경에서는 실제 결제가 되야 하는게 맞지만 개발 환경에서는 테스트하는데 실제 결제가 되면 안된다. 

이럴 때 운영 환경에서는 실제 결제가 되는 빈을 등록하고, 개발 환경에서는 가짜 결제 기능의 빈을 등록하도록 해야 한다. 

 

 

PayClient

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

 

LocalPayClient

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

 

 

ProdPayClient

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

 

 

OrderService

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

OrderService는 PayClient를 사용하는 부분으로 상황에 따라 LocalPayClient 또는 ProdPayClient를 주입 받도록 한다. 

 

 

PayConfig

@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 을 빈으로 등록한다. 

 

 

OrderRunner 

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

ApplicationRunner 인터페이스를 사용하면 스프링은 이제 빈 초기화를 끝내고 애플리케이션 로딩이 완료되는 시점에 run 메서드를 호출한다. 

 

@Profile prod 인 경우 

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

 

 

💌 @Profile 을 사용하면 특정 조건에 따라 해당 빈을 등록할지 말지 선택한다. 

@Profile 을 사용하면 각 환경 별로 외부 설정 값을 분리를 포함해서 스프링 빈도 분리해서 사용할 수 있다.