[Spring Boot] YAML 파일 매핑하기 (Feat. @ConfigurationProperties)

💡 YAML 파일이란?

 

위키 참조

YAML은 XML, C, 파이썬, 펄, RFC2822에서 정의된 e-mail 양식에서 개념을 얻어 만들어진 '사람이 쉽게 읽을 수 있는' 데이터 직렬화 양식이다. 2001년에 클라크 에반스가 고안했고, Ingy dot Net 및 Oren Ben-Kiki와 함께 디자인했다.

YAML이라는 이름은 "YAML은 마크업 언어가 아니다 (YAML Ain't Markup Language)” 라는 재귀적인 이름에서 유래되었다. 원래 YAML의 뜻은 “또 다른 마크업 언어 (Yet Another Markup Language)”였으나, YAML의 핵심은 문서 마크업이 아닌 데이터 중심에 있다는 것을 보여주기 위해 이름을 바꾸었다. 오늘날 XML과 JSON이 데이터 직렬화에 주로 쓰이기 시작하면서, 많은 사람들이 YAML을 '가벼운 마크업 언어'로 사용하려 하고 있다.

 

• 사람이 쉽게 읽을 수 있는 데이터 직렬화 양식
• 마크업 언어가 아님을 지향한 언어
• 다른 언어보다 상대적으로 문법을 이해하기 쉽고, 가독성이 좋으며, 고급 컴퓨터에 적합
• XML과 거의 비슷한 언어

⚔️ 형식 비교 (properties vs yml)

 

✏️ application.properties

server.port : 8080

✏️ application.yml

server:
	port: 8080

 

🔎 application.yml 매핑 하기

 

매핑 방식은 기존에 존재하던 application.properties와 동일하다.

@Value와 @ConfigurationProperties을 사용해 매핑을 할 수 있다.

 

이때 @Value는 메타데이터 지원과 유연한 바인딩이 불가능한 반면

@ConfigurationProperties는 가능해 이 어노테이션으로 쉽게 매핑을 해볼 수 있다.

 

가장 무난한 List, Map 자료구조로 매핑

 

1. application.yml에 fruit를 키 값으로 하는 리스트형의 테스트 데이터 저장

fruit:
  list:
    - name : banana
      color : yellow
    - name : apple
      color : red
    - name : water melon
      color : green

 

2. @ConfigurationProperties에 fruit 객체를 바인딩

@Data
@Component
@ConfigurationProperties("fruit")
public class FruitProperty {
    private List<Fruit> list;

}

@Data : Lombok이 제공하는 어노테이션으로, Getter, Setter 메소드를 자동으로 생성시켜 준다.

@Component : @ConfigurationProperties를 사용하기 위해 이를 선언해줘야 의존성 주입이 가능하다.

 

3. Test를 해보자

@RunWith(SpringRunner.class)
@SpringBootTest
class DemoApplicationTests {

    @Autowired
    FruitProperty fruitProperty;

    @Test
    public void test() {
        List<Fruit> fruitData = fruitProperty.getList();

        assertThat(fruitData.get(0).getName(), is("banana"));
    }

}

@Autowired : 참고 -> https://withseungryu.tistory.com/65

[Spring] @Autowired vs @Resource vs @Inject

🔎 결과 

테스트 성공 했음을 볼 수 있다.

 

🔍 @ConfigurationProperties - 유연한 바인딩

 

프로퍼티 값을 객체에 바인딩할 경우에 Camel Case로 선언하여도, 프로퍼티의 키는 다양한 형식(낙타, 케밥, 언더바)으로 선언할 수 있다.

 

(예시)

public class FruitProperties{
	private String colorName;
}

fruit.colorname ( x )fruit.color-name ( 케밥 )fruit.color_name ( 언더, 스네이크 )fruit.colorName ( 낙타, 카멜 )