从 application.yml 读取属性时忽略 Spring 配置文件

Posted 2023-02-26

【中文标题】从 application.yml 读取属性时忽略 Spring 配置文件

【英文标题】：Spring profile is ignored when reading properties from application.yml

【发布时间】：2019-04-06 15:13:27

【问题描述】：

我有这个扫描 Spring 上下文的代码：

public void scan() 
    AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();

    context.register(SomeConfig.class);
    context.refresh();

我需要从application.yml 文件中读取属性，所以在SomeConfig 类中，我有这个：

@Configuration
@PropertySource(value = "classpath:application.yml", factory = YamlPropertyLoaderFactory.class)
public class SomeConfig 
  //some beans

（我从here复制了YamlPropertyLoaderFactory类）

application.yml 是一个典型的 Spring Boot 文件，具有一些按配置文件的属性，以及一个默认配置文件：

spring:
  profiles:
    active: p1

---

spring:
   profiles: p1

file: file1.txt

---

spring:
   profiles: p2

file: file2.txt

在某些 bean 中，我正在使用 @Value 读取 file 属性。

当我运行我的应用程序时，我传递了-Dspring.profiles.active=p1 变量，但我收到了一个错误：

无法解析值“$file”中的占位符“文件”

（即使我没有通过任何配置文件，它也应该可以工作，因为 application.yml 的默认配置文件设置为 p1）

如果我从application.yml 中删除所有配置文件配置，它可以正常工作：

file: file1.txt

所以，这意味着上下文扫描没有读取配置文件变量。

另外，如果我“以编程方式”设置活动配置文件，它也不会解析属性：

context.getEnvironment().setActiveProfiles("p1");

【问题讨论】：

您是否在日志中检查了所需的配置文件确实被激活了？

@J-Alex 是的，确实如此。但它不能解析变量。

@Héctor 你有什么春季版本？你是否使用弹簧靴？

你使用maven/gradle构建吗？

【参考方案1】：

要仅为特定配置文件设置属性，正确的缩进是：

spring:
   profiles: p1
   file: file1.txt

在上述情况下，您可以使用$spring.file EL 访问file1.txt。

【讨论】：

file 是自定义属性，与spring 或spring.profiles 无关

@AndrewTobilko OP 说：“典型的 Spring Boot 文件，其中包含一些配置文件的属性”，因此文件属性分别绑定到 p1 和 p2 - 至少这是我所理解的。不然为什么file会出现两次？

您不应将自定义属性添加到 spring 前缀

【参考方案2】：

你指的YamlPropertyLoaderFactory有如下代码：

public class YamlPropertyLoaderFactory extends DefaultPropertySourceFactory 
    @Override
    public PropertySource<?> createPropertySource(String name, EncodedResource resource) throws IOException 
        if (resource == null)
            return super.createPropertySource(name, resource);
        

        return new YamlPropertySourceLoader().load(resource.getResource().getFilename(), resource.getResource(), null);
    

YamlPropertySourceLoader.load() 方法的第三个参数实际上是您想要属性的配置文件名称。由于此示例传入 null，它仅返回 yml 文件中的属性集，而不是特定配置文件的属性集。

即

spring:
  profiles:
    active: p1

---

我认为在YamlPropertyLoaderFactory 中获取活动的个人资料名称并不容易，尽管您可以尝试类似...

public class YamlPropertyLoaderFactory extends DefaultPropertySourceFactory 
    @Override
    public PropertySource<?> createPropertySource(String name, EncodedResource resource) throws IOException 
        if (resource == null)
            return super.createPropertySource(name, resource);
        

        String activeProfile = System.getProperty("spring.profiles.active");
        return new YamlPropertySourceLoader().load(resource.getResource().getFilename(), resource.getResource(), activeProfile);
    

或者，当您在 yml 文件中有活动配置文件名称时，您可以使用 null 调用 YamlPropertySourceLoader().load 以获取 spring.profiles.active 属性，然后再次调用它以加载您想要的 yml 文件的实际部分。

public class YamlPropertyLoaderFactory extends DefaultPropertySourceFactory 
    @Override
    public PropertySource<?> createPropertySource(String name, EncodedResource resource) throws IOException 
        if (resource == null)
            return super.createPropertySource(name, resource);
        
        PropertySource<?> source = new YamlPropertySourceLoader().load(resource.getResource().getFilename(), resource.getResource(), null);
        String activeProfile = source.getProperty("spring.profiles.active");
        return new YamlPropertySourceLoader().load(resource.getResource().getFilename(), resource.getResource(), activeProfile);
    

YamlPropertySourceLoader 于 2018 年 2 月改回 (YamlPropertySourceLoader blame view in Git repo)。它现在返回一个 propertySource 列表，并且在 load 方法上没有第三个参数。

如果您在 yml 文件中有 spring.profiles.active 属性，您就可以使用较新版本的 YamlPropertySourceLoader 执行以下操作

public class YamlPropertyLoaderFactory extends DefaultPropertySourceFactory 

    @Override
    public PropertySource<?> createPropertySource(String name, EncodedResource resource) throws IOException 
        if (resource == null)
            return super.createPropertySource(name, resource);
        
        List<PropertySource<?>> sources = new YamlPropertySourceLoader().load(resource.getResource().getFilename(), resource.getResource());
        for (PropertySource<?> checkSource : sources) 
            if (checkSource.containsProperty("spring.profiles.active")) 
                String activeProfile = (String) checkSource.getProperty("spring.profiles.active");
                for (PropertySource<?> source : sources) 
                    if (activeProfile.trim().equals(source.getProperty("spring.profiles"))) 
                        return source; 
                    
                
            
        
        return sources.get(0);
    

【讨论】：

非常感谢。我解决了我的问题，这对我理解属性源在 Spring 中的工作方式有很大帮助，

如果resource 参数为空，无论如何都会抛出NullPointerException。那么，if (resource == null) ... 守卫真的有用吗？

@Kruschenstein 正如你所说，它没有任何用处。 OP 发布了一个指向他们遇到问题的来源的链接。问题是关于从 yaml 为特定配置文件加载属性。当我回答时，我只是专注于问题。

@pcoates 是的，我明白了！我更喜欢通知以完成答案（您的代码确实帮助了我^^）

【参考方案3】：

@pcoates 我尝试使用较新版本的 YamlPropertySourceLoader 仍然无法加载配置文件。

总是在以下条件下失败，源返回 2 个没有源“spring.profiles.active”的元素，

if (checkSource.containsProperty("spring.profiles.active"))

下面是我的 yaml 和 yaml 属性加载器的配置

  profiles: dev
  excelPath :  /data/excel
  excecutionPath: http://localhost:8080/server/execute
  memberIP: localhost
  profilerPortNum: 3031

--- 

spring:
  profiles: uat
  excelPath :  /data/uat/excel
  excecutionPath: http://localhost:8080/server/execute
  memberIP: localhost
  profilerPortNum: 3032```

@Configuration
@PropertySource(value = "classpath:application.yml", factory = YamlPropertyLoaderFactory.class)
public class ReadYamlProperties 

【讨论】：

使用@Component解决@ConfigurationProperties("spring") public String getExcelPath() return excelPath; public void setExcelPath(String excelPath) this.excelPath = excelPath;