Spring Boot profiles 설정하기

📎 Spring Boot profiles 설정하기

안녕하세요, 이번 포스팅에서는 스프링 부트에서 여러 profile을 설정하고, 설정 값들을 객체에 바인딩하는 방법에 대해 살펴보겠습니다.

 

실제 개발을 진행하고 운영을 하다보면 개발(dev), 테스트(stage), 알파(alpha), 상용(prod) 등 운영환경에 따라 서버나 설정 값들이 여러개로 나뉠 수 있는데요, 스프링 부트에서는 이러한 설정을 간단히 할 수 있습니다.

 

해당 포스팅에서는 yml 파일을 기준으로 설정을 해보겠습니다. 🤯

 

 

📎 yml 파일 작성하기

resource 하위 폴더에 작성할 yml 파일은 다음과 같습니다.

 

📝 application.yml

spring:
  profiles:
    active:
      - local
    group:
      local:
        - site-local
        - db-local
      dev:
        - site-dev
        - db-dev
    include:
      - db
      - my-service
      - site

애플리케이션이 실행될 때 기본적으로 참조하는 파일인데요, 각 설정들은 다음과 같습니다.

 

•  spring-profiles-active  : 기본적으로 활성화할 profile을 local로 설정합니다.
•  spring-profiles-group  : profile group을 정의할 수 있습니다.
  •  local : profile이 local일 경우 site-local, db-local 의 profile과 그룹을 정의합니다.
  •  dev : profile이 local일 경우 site-dev, db-dev 의 profile과 그룹을 정의합니다.
  •  해당 값들은 아래에서 다시 설명드리겠습니다.
•  spring-profiles-include  설정을 통해 어플리케이션을 실행할 때 profile을 포함하여 실행할 수 있습니다.
  • 즉 application-db.yml, application-my-site.yml, application-site.yml 파일을 함께 profile에 포함하여 어플리케이션이 구동됩니다.

profile = local

 

profile = dev

 

profile = prod

 

참고로, profile 값 변경은 IntelliJ 기준으로 아래와 같이 설정할 수 있습니다. 😷

Run > Edit Configurations... > Active profiles

 

📝 application-db.yml

#default 공통설정
spring:
  jpa:
    show-sql: false
    open-in-view: false
    database-platform: MYSQL
    hibernate:
      ddl-auto: none
      use-new-id-generator-mappings: true
    properties:
      hibernate.format_sql: true
      hibernate.show_sql: false
      hibernate.dialect: org.hibernate.dialect.MySQL57Dialect
      hibernate.default_fetch_size: ${chunkSize:100}
      hibernate.connection.provider_disables_autocommit: true
      hibernate.jdbc.batch_size: ${chunkSize:100}
      hibernate.order_inserts: true
      hibernate.order_updates: true

--- # local 설정
spring:
  config:
    activate:
      on-profile: "db-local"

  jpa:
    show-sql: true
    database-platform: H2
    hibernate:
      ddl-auto: create-drop

  datasource:
    hikari:
      driver-class-name: org.h2.Driver
      jdbc-url: jdbc:h2:mem://localhost/~/divelog;MODE=MySQL;DATABASE_TO_LOWER=TRUE;CASE_INSENSITIVE_IDENTIFIERS=TRUE;
      username: sa
      password:

--- # dev 설정
spring:
  config:
    activate:
      on-profile: "db-dev"

  jpa:
    hibernate:
      ddl-auto: update
  datasource:
    hikari:
      driver-class-name: org.mariadb.jdbc.Driver
      ...

.yml 파일은 위와 같이  --- 를 통해 파일 분할이 가능합니다. 이로 인해 여러 환경에서 사용될 값을 하나의 파일에 작성할 수 있습니다. 😃

•  #default : 프로젝트에 공통 값을 설정합니다.
• spring-config-active-on-profile : application.yml 파일에서 작성한 group의 profile 입니다. 위에서 local, dev일 때 매핑되는 db-local, db-dev 이랑 동일한 네이밍으로 설정합니다.
  • 참고로 Spring Boot 2.4 버전부터 설정 파일의 방법이 아래와 같이 변경되었습니다.

# before
spring:
  profiles: "prod"
secret: "production-password"


# after
spring:
  config:
    activate:
      on-profile: "prod"
secret: "production-password"

- https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-2.4-Release-Notes
- https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-Config-Data-Migration-Guide

 

📝 application-site.yml

site:
  author-name: JuHyun
  author-email: a@a.com

--- # local 설정
spring:
  config:
    activate:
      on-profile: "site-local"

site:
  author-name: JuHyun-local
  author-email: a.local@a.com

--- # dev 설정
spring:
  config:
    activate:
      on-profile: "site-dev"

site:
  author-name: JuHyun-dev
  author-email: a.dev@a.com

 

•  spring-config-active-on-profile : db와 마찬가지로 application.yml 파일에서 작성한 group의 profile입니다.

 

 

📎 Binding

다음으로 yml 파일에 설정한 값들을 코드에 바인딩하는 방법에 대해 살펴보겠습니다.

작성할 파일은 다음과 같습니다.

(@Value 어노테이션을 통해 바인딩하는 방법도 존재하지만, 포스팅에서는 Spring Boot 2.2 버전부터 가능한 @ConstructorBindg 어노테이션을 통해 Immutable Properties 설정으로 해보겠습니다.)

 

📝 AppConfiguration

import org.springframework.boot.context.properties.ConfigurationPropertiesScan;
import org.springframework.context.annotation.Configuration;
 
@Configuration
@EnableConfigurationProperties({SiteProperties.class})
public class AppConfiguration {
 
}
 

바인딩 설정을 위해 AppConfiguration 이라는 클래스 파일을 하나 생성해주었습니다.

그리고 여기에  @Configuration ,  @EnableConfigurationProperties  어노테이션을 통해 설정을 합니다.

(이러한 방법 외에도 main 메서드가 존재하는 스프링 부트 애플리케이션의 클래스에 @EnableConfigurationProperties 어노테이션을 설정해주어도 동일하게 작동합니다. 🤯)

 

📝 SiteProperties

import lombok.Getter;
import lombok.ToString;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.ConstructorBinding;
 
@Getter
@ToString
@ConfigurationProperties(prefix = "site")
public class SiteProperties {
 
    private final String authorName;
    private final String authorEmail;
 
    @ConstructorBinding
    public SiteProperties(String authorName, String authorEmail) {
        this.authorName = authorName;
        this.authorEmail = authorEmail;
    }
}
 

실제 .yml의 설정 값이 바인딩될 클래스입니다.

@EnableConfigurationProperties  와 @ConstructorBinding  어노테이션을 추가하여 바인딩합니다.

 

 @EnableConfigurationProperties  의 코드를 살펴보면 주석에 setter를 사용하거나 @ConstructorBinding을 통해 바인딩이 가능하다고 설명되어있습니다.

Setter의 경우 값변경이 가능하여 Immutable한 상태가 아니므로 @ConstructorBinding를 통해 바인딩을 해주었습니다.

• https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-2.2-Release-Notes#configurationproperties-scanning

 

 

📎 Binding 테스트하기

application-site.yml 파일에 작성한 값들에 대해 local, dev 설정을 통해 바인딩이 잘 되는지 테스트해보겠습니다.

 

📝 SitePropertiesTest

package com.fastcompus.springrunner.divelog.config;
 
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
 
import static org.assertj.core.api.Assertions.assertThat;
 
@SpringBootTest
class SitePropertiesTest {
 
    @Test
    void test(@Autowired SiteProperties properties) {
        assertThat(properties.getAuthorName()).isEqualTo("JuHyun-local");
        assertThat(properties.getAuthorEmail()).isEqualTo("a.local@a.com");
    }
 
}

 

📝 SitePropertiesDevTest

package com.fastcompus.springrunner.divelog.config;
 
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.ActiveProfiles;
 
import static org.assertj.core.api.Assertions.assertThat;
 
@ActiveProfiles("dev")
@SpringBootTest
class SitePropertiesDevTest {
 
    @Test
    void test(@Autowired SiteProperties properties) {
        assertThat(properties.getAuthorName()).isEqualTo("JuHyun-dev");
        assertThat(properties.getAuthorEmail()).isEqualTo("a.dev@a.com");
    }
 
}

application.yml 파일에서 기본 profile을 local로 설정했기 때문에 dev profile을 테스트하기 위해  @ActiveProfiles("dev") 를 통해 명시적으로 선언하여 테스트합니다.

 

 

📎 References

• https://fastcampus.co.kr/dev_academy_springrunner201
• https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-2.2-Release-Notes#configurationproperties-scanning
• https://cheese10yun.github.io/immutable-properties/
• http://honeymon.io/tech/2021/01/16/spring-boot-config-data-migration.html
• https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-2.4-Release-Notes
• https://www.baeldung.com/configuration-properties-in-spring-boot