배경

  • Spring Boot의 자동-구성을 사용하지 않으니 @Value("\${...}") 어노테이션으로 property가 가져와지지 않았다.

원인

  • PropertySourcesPlaceholderConfigurer: bean 정의 프로퍼티 값이나 @Value를 Spring 내 Environment와 PropertySource의 집합으로 처리해주는 클래스이다.
    • Spring Boot로 실행시에는 자동-구성으로 bean으로 등록된다.
  • Environment: 현재 실행 중인 Spring 애플리케이션의 환경을 나타내는 인터페이스. 가지고 있는 데이터로 profile과 properties로 나눌 수 있다.
    • profile: 특정 프로필이 활성화 된 경우에만 bean이 등록되도록 사용할 수 있다.
    • properties: properties 파일, JVM 시스템 properties, 시스템 환경 변수 등을 출처로 가져온다. Environment는 property source를 구성하고 사용자가 편하게 property를 확인할 수 있도록 해준다.
  • PropertySource는 프로퍼티 데이터와 해당 소스의 이름을 관리하는 추상 클래스다.
  • @PropertySource 어노테이션을 통해, 프로퍼티를 가져올 수 있는데 기본적으로 properties와 xml 파일만 처리해주고 yaml 파일은 가져오지 못한다.
  • 따라서 yaml 파일을 가져오도록 해주는 factory 클래스를 만들어서 사용해야 된다.
class YamlPropertySourceFactory : PropertySourceFactory {  
  
    override fun createPropertySource(name: String?, encodedResource: EncodedResource): PropertiesPropertySource {  
       val factory = YamlPropertiesFactoryBean()  
       factory.setResources(encodedResource.resource)  
  
       val properties = factory.getObject()  
  
       return PropertiesPropertySource(encodedResource.resource.filename.toString(), properties ?: Properties())  
    }  
}

@PropertySource("classpath:/application.yml", factory = YamlPropertySourceFactory::class)
class SomeConfig {
	// ...
}
  • 위와 같이 구성하면 최종적으로 application.yml 파일에서 프로퍼티를 가져와 @Value로 값을 불러올 수 있게된다.

참고 자료