Jak używać YamlPropertiesFactoryBean do ładowania plików YAML przy użyciu Spring Framework 4.1?

Question

Mam aplikację źródłową, która obecnie używa plików * .properties i chcę ją używać w zamian za pliki YAML.

Znalazłem klasę YamlPropertiesFactoryBean, która wydaje się być zdolna do zrobienia tego, czego potrzebuję.

Mój problem polega na tym, że nie jestem pewien, jak używać tej klasy w mojej aplikacji Spring (która korzysta z konfiguracji opartej na adnotacjach). Wygląda na to, że powinienem skonfigurować go w metodzie PropertySourcesPlaceholderConfigurer za pomocą metody setBeanFactory.

Wcześniej byłem ładowania plików własności używając @PropertySource następująco:

@Configuration 
@PropertySource("classpath:/default.properties") 
public class PropertiesConfig { 

    @Bean 
    public static PropertySourcesPlaceholderConfigurer placeholderConfigurer() { 
     return new PropertySourcesPlaceholderConfigurer(); 
    } 
} 

Jak mogę włączyć YamlPropertiesFactoryBean w PropertySourcesPlaceholderConfigurer tak, że mogę załadować pliki YAML bezpośrednio? A może jest inny sposób robienia tego?

Dzięki.

Moja aplikacja używa konfiguracji opartej na adnotacjach i używam Spring Framework 4.1.4. Znalazłem trochę informacji, ale zawsze wskazywało to na Spring Boot, takie jak this one.

Answer 1

XML config Używam tego konstruktu:

<context:annotation-config/> 

<bean id="yamlProperties" class="org.springframework.beans.factory.config.YamlPropertiesFactoryBean"> 
    <property name="resources" value="classpath:test.yml"/> 
</bean> 

<context:property-placeholder properties-ref="yamlProperties"/> 

Oczywiście trzeba mieć zależność snakeyaml na ścieżce klas wykonawczego.

Preferuję konfigurację XML przez konfigurację java, ale muszę się przekonać, że nie powinno być trudno ją przekonwertować.

edit:
java config dla kompletności sake

@Bean 
public static PropertySourcesPlaceholderConfigurer properties() { 
    PropertySourcesPlaceholderConfigurer propertySourcesPlaceholderConfigurer = new PropertySourcesPlaceholderConfigurer(); 
    YamlPropertiesFactoryBean yaml = new YamlPropertiesFactoryBean(); 
    yaml.setResources(new ClassPathResource("default.yml")); 
    propertySourcesPlaceholderConfigurer.setProperties(yaml.getObject()); 
    return propertySourcesPlaceholderConfigurer; 
} 

Answer 2

Aby przeczytać .yml plik wiosną można użyć następnego podejścia.

Na przykład masz ten plik .yml:

section1: 
    key1: "value1" 
    key2: "value2" 
section2: 
    key1: "value1" 
    key2: "value2" 

następnie zdefiniować 2 Java POJOs:

@Configuration 
@EnableConfigurationProperties 
@ConfigurationProperties(prefix = "section1") 
public class MyCustomSection1 { 
    private String key1; 
    private String key2; 

    // define setters and getters. 
} 

@Configuration 
@EnableConfigurationProperties 
@ConfigurationProperties(prefix = "section2") 
public class MyCustomSection1 { 
    private String key1; 
    private String key2; 

    // define setters and getters. 
} 

Teraz można autowire te ziarna w komponencie. Na przykład:

@Component 
public class MyPropertiesAggregator { 

    @Autowired 
    private MyCustomSection1 section; 
} 

W przypadku korzystania Wiosna Boot wszystko zostanie automatycznie skanowane i wystąpienia:

@SpringBootApplication 
public class MainBootApplication { 
    public static void main(String[] args) { 
     new SpringApplicationBuilder() 
      .sources(MainBootApplication.class) 
      .bannerMode(OFF) 
      .run(args); 
    } 
} 

Jeśli you'are użyciu JUnit jest podstawowa konfiguracja test ładowania pliku YAML:

@RunWith(SpringJUnit4ClassRunner.class) 
@SpringApplicationConfiguration(MainBootApplication.class) 
public class MyJUnitTests { 
    ... 
} 

Jeśli używasz TestNG jest próbka konfiguracji testowej:

@SpringApplicationConfiguration(MainBootApplication.class) 
public abstract class BaseITTest extends AbstractTestNGSpringContextTests { 
    .... 
}