[Spring Boot] Properties와 YAML 설정 파일 작성 가이드

 

 

스프링부트에서 설정파일을 작성하는 방식을 살펴보자

📌 서론

스프링 부트는 컨벤션을 통한 설정을 지향하며, 다양한 설정 파일을 지원하여 개발자가 손쉽게 애플리케이션을 구성할 수 있도록 돕는다. Properties 파일과 YAML 파일은 스프링 부트에서 가장 널리 사용되는 설정 파일 형식으로, 각각의 장단점과 사용 용도가 있다. 올바른 설정 파일을 선택하고 효율적으로 사용하는 방법을 이해하면, 애플리케이션의 유지보수성과 확장성을 크게 향상시킬 수 있다.

 

1. Properties 파일 설정

Properties 파일 소개

• Properties 파일은 key=value 형식으로 구성 정보를 저장하는 텍스트 파일이다. 스프링 부트에서는 주로 application.properties 파일을 사용하여 애플리케이션의 기본 설정을 관리한다. 간단한 구조와 직관적인 문법으로 인해 초보자에게 친숙하며, 다양한 설정 옵션을 지원한다.
  
  

프로퍼티(Properties) 파일 작성 방법

• Properties 파일은 다음과 같은 규칙을 따른다.
• 키-값 쌍: 각 설정은 key=value 형태로 작성된다.
• 주석: # 또는 ! 기호를 사용하여 주석을 작성할 수 있다.
• 계층 구조: 점(.)을 사용하여 계층 구조를 표현한다.

예시: application.properties

# 애플리케이션 기본 설정
app.name=MySpringApp
app.version=1.0.0
app.author=John Doe

# 서버 설정
server.port=8080

# 데이터베이스 설정
spring.datasource.url=jdbc:mysql://localhost:3306/mydb
spring.datasource.username=root
spring.datasource.password=secret

Properties 파일 사용 예제

• 스프링 부트 애플리케이션에서 Properties 파일의 값을 주입받아 사용하는 방법에는 @Value 어노테이션과 Environment 객체를 사용하는 방법이 있다.

@Value 어노테이션 사용

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class MyComponent {

    @Value("${app.name}")
    private String appName;

    @Value("${app.version}")
    private String appVersion;

    public void printAppInfo() {
        System.out.println("Application Name: " + appName);
        System.out.println("Version: " + appVersion);
    }
    
}

Environment 객체 사용

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;

@Component
public class MyEnvironmentComponent {

    @Autowired
    private Environment env;

    public void printDatabaseUrl() {
        String dbUrl = env.getProperty("spring.datasource.url");
        System.out.println("Database URL: " + dbUrl);
    }
    
}

 

2. YAML 파일 설정

YAML 파일 소개

• YAML (YAML Ain't Markup Language)은 데이터 직렬화를 위한 인간이 읽기 쉬운 형식으로, 스프링 부트에서는 주로 application.yml 파일을 사용하여 설정을 관리한다. YAML은 계층적 구조를 자연스럽게 표현할 수 있어 복잡한 설정을 보다 직관적으로 작성할 수 있다.
  
  

YAML 파일 작성 방법

• YAML 파일은 들여 쓰기를 통해 계층 구조를 표현하며, key: value 형식으로 작성됩니다. 들여 쓰기는 공백(스페이스)을 사용하며, 탭은 사용하지 않습니다.

예시: application.yml

# 애플리케이션 기본 설정
app:
  name: MySpringApp
  version: 1.0.0
  author: John Doe

# 서버 설정
server:
  port: 8080

# 데이터베이스 설정
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydb
    username: root
    password: secret

YAML 파일 사용 예제

• YAML 파일의 값을 주입받아 사용하는 방법에는 @ConfigurationProperties 어노테이션을 주로 사용합니다. 이를 통해 계층적 설정을 객체에 쉽게 바인딩할 수 있습니다.

@ConfigurationProperties 어노테이션 사용

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

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

    private String name;
    private String version;
    private String author;

    // Getters and Setters

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getVersion() {
        return version;
    }

    public void setVersion(String version) {
        this.version = version;
    }

    public String getAuthor() {
        return author;
    }

    public void setAuthor(String author) {
        this.author = author;
    }
    
}

사용 예제

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Component
public class MyYAMLComponent {
    
    // 생성자 주입이 더 권장되는 방법이지만 간단히 이해하기 위해 Autowired 사용
    @Autowired
    private MyAppProperties appProperties;

    public void printAppDetails() {
        System.out.println("Application Name: " + appProperties.getName());
        System.out.println("Version: " + appProperties.getVersion());
        System.out.println("Author: " + appProperties.getAuthor());
    }
    
}

 

3. Properties vs YAML: 비교 및 선택 가이드

스프링 부트는 application.properties와 application.yml 파일을 모두 지원하며, 필요에 따라 둘 중 하나를 선택하여 사용할 수 있다.

 

두 형식의 주요 차이점과 장단점을 비교해보자.

항목	Properties 파일	YAML 파일
문법	key=value 형식	key: value 형식 및 계층적 구조 표현
가독성	단순하지만 복잡한 설정에는 다소 불편	계층적 설정을 자연스럽게 표현하여 가독성 우수
구조 표현	점(.)을 사용하여 계층 구조 표현	들여쓰기를 통해 명확한 계층 구조 표현
주석 작성	# 또는 ! 기호 사용	# 기호 사용
복잡한 데이터 구조 지원	제한적 (배열이나 맵 표현 시 복잡해질 수 있음)	배열, 맵 등 복잡한 데이터 구조를 간결하게 표현 가능
지원 여부	모든 스프링 부트 프로젝트에서 기본 지원	모든 스프링 부트 프로젝트에서 기본 지원

 

선택 가이드

• 간단한 설정: 단순한 설정을 관리할 때는 Properties 파일이 적합하다.
• 복잡한 설정: 계층적 구조나 복잡한 데이터를 다룰 때는 YAML 파일이 더 효율적이다.
• 가독성 중시: 코드의 가독성을 높이고자 할 때는 YAML 파일이 유리하다.

 

4. 결론

스프링 부트에서 Properties 파일과 YAML 파일은 애플리케이션의 설정을 관리하는 강력한 도구다. 각 형식의 장단점을 이해하고, 프로젝트의 요구 사항에 맞는 설정 방식을 선택함으로써 코드의 가독성과 유지보수성을 크게 향상시킬 수 있다.

 

• Properties 파일은 단순한 설정에 적합하며, 직관적인 key=value 형식으로 쉽게 작성할 수 있다.
• YAML 파일은 계층적 구조와 복잡한 데이터 표현에 유리하며, 가독성이 뛰어나고 유지보수가 용이하다.

 

또한, @Value 어노테이션과 @ConfigurationProperties 어노테이션을 활용하여 설정 값을 효과적으로 주입받고 관리할 수 있다.

프로파일별 설정 관리를 통해 다양한 환경에 유연하게 대응할 수 있으며, 고급 설정 기법을 통해 애플리케이션의 설정을 체계적으로 관리할 수 있다.