Spring Boot에서 구성 설정(Configuration) 관리하기: `application.yml`과 프로필 기반 설정 완벽 가이드

 

Spring Boot 애플리케이션을 개발할 때 환경별 설정 관리 는 필수적입니다. 개발, 테스트, 운영 환경마다 다른 설정 이 필요하기 때문에, 효율적인 구성 관리 가 중요합니다. 이번 포스팅에서는 application.properties 와 application.yml 파일 활용법 , 환경별 설정을 위한 프로필 관리( @Profile ) , 그리고 @ConfigurationProperties 로 설정 주입 하는 방법을 다룹니다.

 

---

 

 

목차

1. application.properties와 application.yml의 차이점
2. 프로필( @Profile )을 사용한 환경별 설정 분리
3. @ConfigurationProperties로 설정 주입하기
4. 구성 설정의 최신 트렌드와 모범 사례
5. 실습 코드와 활용 예제

 

---

 

1. application.properties와 application.yml의 차이점

Spring Boot에서는 application.properties 와 application.yml 파일을 통해 애플리케이션의 설정을 관리할 수 있습니다. 이 두 가지 방식은 동일한 역할을 하지만, 구조적인 표현 방식 에 차이가 있습니다.

비교 항목	application.properties	application.yml
파일 형식	키-값 쌍 (Key-Value)	계층적 구조 (YAML)
가독성	복잡한 설정일 경우 가독성이 떨어질 수 있음	계층 구조로 설정이 간결하고 명확함
주로 사용되는 경우	간단한 설정	복잡한 설정 관리

application.properties 사용 예제

server.port=8080
spring.datasource.url=jdbc:mysql://localhost:3306/mydb
spring.datasource.username=root
spring.datasource.password=1234

application.yml 사용 예제

server:
  port: 8080

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydb
    username: root
    password: 1234

• application.yml 은 계층적 표현 이 가능해 복잡한 설정을 더 간결하게 표현할 수 있습니다.

 

---

 

2. 프로필( @Profile )을 사용한 환경별 설정 분리

Spring Boot는 환경별로 다른 설정을 관리 할 수 있도록 프로필(Profile) 기능을 제공합니다. 예를 들어, 개발 환경과 운영 환경에서 서버 포트나 데이터베이스 URL 이 다를 수 있습니다. 이를 위해 @Profile 애너테이션 과 프로필 기반 설정 파일 을 활용할 수 있습니다.

1. 프로필별 설정 파일 작성

• application-dev.yml (개발 환경)

server:
  port: 8081

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/devdb
    username: devuser
    password: devpass

• application-prod.yml (운영 환경)

server:
  port: 8080

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/proddb
    username: produser
    password: prodpass

2. 프로필 활성화 (application.yml)

spring:
  profiles:
    active: dev

• spring.profiles.active : 현재 사용 중인 프로필을 지정합니다. 개발 환경에서는 dev , 운영 환경에서는 prod 로 설정합니다.

3. @Profile 애너테이션 사용 예제

package com.example.demo.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;

@Configuration
public class DataSourceConfig {

    @Bean
    @Profile("dev")
    public String devDataSource() {
        System.out.println("개발 환경 데이터소스 설정");
        return "Development DataSource";
    }

    @Bean
    @Profile("prod")
    public String prodDataSource() {
        System.out.println("운영 환경 데이터소스 설정");
        return "Production DataSource";
    }
}

• @Profile("dev") : 개발 환경에서만 해당 빈이 활성화됩니다.
• @Profile("prod") : 운영 환경에서만 해당 빈이 활성화됩니다.

 

---

 

3. @ConfigurationProperties로 설정 주입하기

@ConfigurationProperties 는 설정 파일에 정의된 설정 값을 객체에 바인딩 할 때 사용됩니다. 이를 통해 여러 설정 값을 하나의 클래스에 묶어 관리 할 수 있습니다.

1. 의존성 추가 (pom.xml)

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

2. 설정 클래스 생성 (AppConfig.java)

package com.example.demo.config;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "app")
public class AppConfig {

    private String name;
    private String version;

    // Getter, Setter 생략

    public String getInfo() {
        return "애플리케이션 이름: " + name + ", 버전: " + version;
    }
}

• @ConfigurationProperties : 설정 파일의 값을 클래스 필드에 바인딩합니다.
• prefix : 해당 접두사로 시작하는 모든 설정이 바인딩됩니다.

3. 설정 파일 (application.yml)

app:
  name: MySpringApp
  version: 1.0.0

4. 설정 클래스 사용 예제

package com.example.demo.controller;

import com.example.demo.config.AppConfig;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class AppController {

    private final AppConfig appConfig;

    public AppController(AppConfig appConfig) {
        this.appConfig = appConfig;
    }

    @GetMapping("/info")
    public String getAppInfo() {
        return appConfig.getInfo();
    }
}

 

---

 

4. 구성 설정의 최신 트렌드와 모범 사례

• Spring Cloud Config : 설정 파일을 중앙 집중식으로 관리 할 수 있습니다.
• 환경 변수와 외부 설정 활용 : 도커나 클라우드 환경에서는 환경 변수 를 통해 설정을 주입합니다.
• 암호화된 설정 관리 : 민감한 정보를 암호화 하고, Vault 와 같은 도구를 활용해 보안을 강화합니다.
• 프로필 자동 전환 : CI/CD 파이프라인에서 자동으로 프로필을 전환 해 운영 환경에 맞는 설정을 적용합니다.

 

---

 

관련 링크

 

Spring Boot 공식 문서👆

Spring Cloud Config 사용법👆

YAML vs Properties 파일 비교👆

Spring @Profile 가이드👆

@ConfigurationProperties 사용법👆

Vault로 설정 관리하기👆

 

---

 

FAQ

 

1. application.properties와 application.yml 중 무엇을 선택해야 하나요?

• 간단한 설정은 properties 로 충분하지만, 복잡한 계층형 설정 은 yml 파일이 더 적합합니다.

2. 여러 프로필을 동시에 사용할 수 있나요?

• 네, 쉼표(,) 로 구분해 여러 프로필을 활성화할 수 있습니다. 예: spring.profiles.active=dev,prod

3. 환경 변수로 설정을 오버라이드할 수 있나요?

• 네, 환경 변수를 사용해 파일 설정을 덮어쓸 수 있습니다.

4. Spring Cloud Config는 언제 사용하나요?

• 여러 애플리케이션에서 동일한 설정을 사용할 때, 중앙 집중식 설정 관리 가 필요합니다.

5. 민감한 정보는 어떻게 보호하나요?

• Vault 나 AWS Parameter Store 와 같은 도구로 암호화된 설정 을 관리합니다.

 

---

 

마무리

이번 포스팅에서는 Spring Boot에서 구성 설정을 효율적으로 관리하는 방법 을 다뤘습니다. application.yml 과 프로필 기반 설정 을 통해 환경별로 구분된 설정을 적용하고, @ConfigurationProperties 를 사용해 설정 값을 객체에 바인딩하는 방법을 배웠습니다.

이제 여러분의 프로젝트에서 구성 관리의 효율성 을 극대화해보세요! 🚀