Spring YAML 配置文件配置

Posted

技术标签:

【中文标题】Spring YAML 配置文件配置【英文标题】:Spring YAML profile configuration 【发布时间】:2016-02-05 04:32:38 【问题描述】:

我不确定我是否充分了解 Spring 配置文件如何与 yaml 和属性文件一起使用。 我试图混合这两种类型的配置(这两个文件不共享任何配置)但是我在从 yaml 配置中读取配置文件时遇到了问题。

我正在使用 Spring 4.1.1

这里是代码。 这是上下文:property-placeholder 配置:

<context:property-placeholder location="classpath:/job-config.properties" order="1" 
ignore-unresolvable="true" ignore-resource-not-found="false"/>


<context:property-placeholder properties-ref="yamlProperties" order="2"
ignore-resource-not-found="false" ignore-unresolvable="true"/>

其中 yamlProperties 是以下 bean

    <bean id="yamlProperties" 
    class="org.springframework.beans.factory.config.YamlPropertiesFactoryBean">
                <property name="resources" 
value="file:$catalina.home/properties/test.yml"/>
            </bean>

这里是 test.yml

spring:
  profiles.default: default
---
spring:
  profiles: default
db:
  url: jdbc:oracle:thin:@##hostname##:##port##:##SID##
  usr: ##USER##
  pwd: ##PWD##
---
spring:
  profiles: development
db:
  url: jdbc:oracle:thin:@##hostname##:##port##:##SID_DEVELOPMENT##
  usr: ##USER_DEVELOPMENT##
  pwd: ##PWD_DEVELOPMENT##

我的问题是,当我尝试通过这样做来配置(通过 xml)我的数据源时:

<property name="url" value="$db.url"/>
<property name="username" value="$db.usr"/>
<property name="password" value="$db.pwd"/>

Spring 总是使用 YAML 文件中的最后一个配置,忽略配置文件。我试图通过 web.xml 中的 contex-parameter 或直接将活动配置文件传递给 JVM(我实现了一个实现 EnvironmentAware 接口的 bean 以获取活动/默认配置文件,并且它是正确的),这似乎一切都很好,但是,当试图注入配置文件被忽略的值。

我相信使用属性占位符上下文(带有订单)我得到一个属性占位符,它是 PropertySourcesPlaceholderConfigurer 的一个实例,因此可以访问环境,但我不明白为什么配置文件被忽略并且 spring 获取最后一个 yaml 文件配置。

我在第 63.6 节中添加了对文档 (spring-boot) 的引用 http://docs.spring.io/spring-boot/docs/current/reference/html/howto-properties-and-configuration.html

提前致谢

【问题讨论】:

我通过实现自己的 PropertiesFactory 来解决。我从 Spring Boot 核心(不是来自 Spring 核心)和 SpringProfileDocumentMatcher 导入 YamlProcessor。我的班级还实现了 EnvironmentAware。我更改了 createProperties() 方法以读取活动配置文件并设置正确的 DocumentMatcher。 这里是代码 String [] activeProfiles = env.getActiveProfiles(); if(activeProfiles.length==0) this.setMatchDefault(true); this.setDocumentMatchers(new SpringProfileDocumentMatcher()); else this.setMatchDefault(false); SpringProfileDocumentMatcher 匹配器 = 新 SpringProfileDocumentMatcher(); for(String profile : activeProfiles) matcher.addActiveProfiles(profile); this.setDocumentMatchers(matcher); 我遇到了类似的问题。这是我解决它的方法:***.com/questions/47717871/… 【参考方案1】:

目前不确定这是否有帮助,但这是我所做的。

我使用 SpringProfileDocumentMatcher 类 [by Dave Syer from spring boot] 作为我的基本匹配器,并实现了 EnvironmentAware 来获取活动配置文件并将这个 bean 传递给 YamlPropertiesFactoryBean bean。 代码如下:

applicationContext.xml

<bean id="yamlProperties" class="org.springframework.beans.factory.config.YamlPropertiesFactoryBean">
<property name="resources" value="classpath:application.yml" />
<property name="documentMatchers">
  <bean class="com.vivastream.quant.spring.SpringProfileDocumentMatcher" />
</property>

SpringProfileDocumentMatcher.java

public class SpringProfileDocumentMatcher implements DocumentMatcher, EnvironmentAware 

private static final String[] DEFAULT_PROFILES = new String[] 
        "^\\s*$"
;

private String[] activeProfiles = new String[0];

public SpringProfileDocumentMatcher() 


@Override
public void setEnvironment(Environment environment) 
    if (environment != null) 
        addActiveProfiles(environment.getActiveProfiles());
    


public void addActiveProfiles(String... profiles) 
    LinkedHashSet<String> set = new LinkedHashSet<String>(Arrays.asList(this.activeProfiles));
    Collections.addAll(set, profiles);
    this.activeProfiles = set.toArray(new String[set.size()]);


@Override
public MatchStatus matches(Properties properties) 
    String[] profiles = this.activeProfiles;
    if (profiles.length == 0) 
        profiles = DEFAULT_PROFILES;
    
    return new ArrayDocumentMatcher("spring.profiles", profiles).matches(properties);

【讨论】:

感谢 Gustavo,基本上我采用了类似的解决方案。再次感谢 ArrayDocumentMatcher,应该从哪里取?

以上是关于Spring YAML 配置文件配置的主要内容,如果未能解决你的问题,请参考以下文章

Spring Boot项目的Logback配置文件使用yaml格式

Spring boot 配置文件读取和yaml结构

Spring Boot 无法从配置文件特定的 yaml 文件中读取

spring boot 配置文件properties和YAML详解

如何使用 spring boot + .yaml 创建配置文件?

如何使用 spring boot + .yaml 创建配置文件?