在 Spring Boot Web 项目中将 yaml 文件加载到 Map（不是环境配置文件）的最佳方法是什么？

Question

在我的数据框架层，我想从src/main/resources 读取一个 yaml。 文件名为mapconfigure.yaml。它与业务数据相关联，而不仅仅是环境配置数据。

它的内容是这样的：

person1: 
  name: aaa
  addresses: 
    na: jiang
    sb: su
person2: 
  name: bbb
  addresses: 
    to: jiang
    bit: su

我想将此信息存储到 HashMap 中。

是不是要使用@ConfigurationProperties之类的spring注解？ 具体如何实现？

另外，我不能更改文件名。这意味着我必须使用mapconfigure.yaml 作为文件名，而不是application.yml 或application.properties。

我的HashMap的结构如下：

HashMap<String, Setting>

@Data
public class Setting{
  private String name;
  private HashMap<String, String> addresses
}

我的预期的HashMap如下：

{person1={name=aaa, addresses={na=jiang, sb=su}}, person2={name=bbb, addresses={to=jiang, bit=su}}}

我不确定是否可以使用YamlMapFactoryBean 类来执行此操作。

YamlMapFactoryBean类中getObject方法的返回类型是Map<String, Object>，不是泛型类型，如Map<String, T>。

Spring boot doc刚才说了

Spring Framework 提供了两个方便的类，可用于加载 YAML 文档。 YamlPropertiesFactoryBean 将 YAML 作为 Properties 加载，YamlMapFactoryBean 将 YAML 作为 Map 加载。

但是没有详细的例子。

更新：

在 github 中，我创建了一个示例。 It's Here。 在此示例中，我想将 myconfig.yaml 加载到 theMapProperties 类中的 SamplePropertyLoadingTest 对象。 Spring Boot 版本是 1.5.1，所以我不能使用@ConfigurationProperties 的location 属性。 如何做到这一点？

Answer 1

您确实可以使用 @ConfigurationProperties 实现这一点。

从 Spring Boot 1.5.x 开始（缺少 @ConfigurationProperies 位置属性）：

new SpringApplicationBuilder(Application.class)
    .properties("spring.config.name=application,your-filename")
    .run(args);

@Component
@ConfigurationProperties
public class TheProperties {
    private Map<String, Person> people;
    // getters and setters are omitted for brevity
}

在 Spring Boot 1.3.x 中：

@Component
@ConfigurationProperties(locations = "classpath:your-filename.yml")
public class TheProperties {
    private Map<String, Person> people;
    // getters and setters are omitted for brevity
}

上述示例的 Person 类如下所示：

public class Person {
    private String name;
    private Map<String, String> addresses;
    // getters and setters are omitted for brevity
}

我已经使用以下文件测试了代码：your-filename.yml 在 src/main/resources 中定义，内容：

people:
  person1:
    name: "aaa"
    addresses:
      na: "jiang"
      sb: "su"
  person2:
    name: "bbb"
    addresses:
      to: "jiang"
      bit: "su"

如果您需要任何进一步的帮助，请告诉我。

Answer 2

试试这个

 YamlPropertySourceLoader loader = new YamlPropertySourceLoader();
        try {
            PropertySource<?> applicationYamlPropertySource = loader.load(
                "properties", new ClassPathResource("application.yml"), null);// null indicated common properties for all profiles.
            Map source = ((MapPropertySource) applicationYamlPropertySource).getSource();
            Properties properties = new Properties();
            properties.putAll(source);
            return properties;
        } catch (IOException e) {
            LOG.error("application.yml file cannot be found.");
        }