如何将YAML中的列表映射到Java List

1. 概述

在这个简短的教程中，咱们将进一步了解如何在Spring Boot中将YAML列表映射到列表中。web

咱们首先介绍一些如何在YAML中定义列表的背景知识。而后，咱们将深刻研究如何将YAML列表绑定到对象列表。微信

2. 快速回顾一下YAML中的列表

简而言之，YAML是一种人类可读的数据序列化标准，它提供了一种简洁而清晰的方式来编写配置文件。YAML的优势是它支持多种数据类型，如列表、映射和标量类型。app

YAML列表中的元素使用“-”字符定义，它们共享相同的缩进级别:编辑器

yamlconfig:
  list:
    - item1
    - item2
    - item3
    - item4

与properties对比:学习

yamlconfig.list[0]=item1
yamlconfig.list[1]=item2
yamlconfig.list[2]=item3
yamlconfig.list[3]=item4

事实上，与属性文件相比，YAML的层次性显著加强了可读性。YAML的另外一个有趣的特性是能够为不一样的Spring配置文件定义不一样的属性。测试

值得一提的是，Spring引导为YAML配置提供了开箱即用的支持。按照设计，Spring引导从应用程序加载配置属性。yml启动，没有任何额外的工做。url

3.将一个YAML列表绑定到一个简单的对象列表

Spring Boot提供了@ConfigurationProperties注释来简化将外部配置数据映射到对象模型的逻辑。spa

在本节中，咱们将使用@ConfigurationProperties将一个YAML列表绑定到list中。.net

咱们首先在application.yml中定义一个简单的列表:设计

application:
  profiles:
    - dev
    - test
    - prod
    - 1
    - 2

而后，咱们将建立一个简单的ApplicationProps POJO来保存将YAML列表绑定到对象列表的逻辑:

@Component
@ConfigurationProperties(prefix = "application")
public class ApplicationProps {

    private List<Object> profiles;

    // getter and setter

}

ApplicationProps类须要用@ConfigurationProperties进行装饰，以表达将全部带有指定前缀的YAML属性映射到ApplicationProps对象的意图。

要绑定profiles列表，咱们只须要定义一个list类型的字段，其他的由@ConfigurationProperties注释处理。

注意，咱们使用@Component将ApplicationProps类注册为一个普通的Spring bean。所以，咱们能够以与任何其余Spring bean相同的方式将其注入到其余类中。

最后，咱们将ApplicationProps bean注入到一个测试类中，并验证咱们的概要文件YAML列表是否被正确注入为list:

@ExtendWith(SpringExtension.class)
@ContextConfiguration(initializers = ConfigFileApplicationContextInitializer.class)
@EnableConfigurationProperties(value = ApplicationProps.class)
class YamlSimpleListUnitTest {

    @Autowired
    private ApplicationProps applicationProps;

    @Test
    public void whenYamlList_thenLoadSimpleList() {
        assertThat(applicationProps.getProfiles().get(0)).isEqualTo("dev");
        assertThat(applicationProps.getProfiles().get(4).getClass()).isEqualTo(Integer.class);
        assertThat(applicationProps.getProfiles().size()).isEqualTo(5);
    }
}

4. 将YAML列表绑定到复杂列表

如今，让咱们进一步了解如何将嵌套的YAML列表注入到复杂的结构化列表中。

首先，让咱们添加一些嵌套列表到application.yml:

application:
  // ...
  props:
    -
      name: YamlList
      url: http://yamllist.dev
      description: Mapping list in Yaml to list of objects in Spring Boot
    -
      ip: 10.10.10.10
      port: 8091
    -
      email: support@yamllist.dev
      contact: http://yamllist.dev/contact
  users:
    -
      username: admin
      password: admin@10@
      roles:
        - READ
        - WRITE
        - VIEW
        - DELETE
    -
      username: guest
      password: guest@01
      roles:
        - VIEW

在这个例子中，咱们将道具属性绑定到一个 List<Map<String, Object>>.。相似地，咱们将把用户映射到User对象列表中。

可是，在用户的状况下，全部的项共享相同的键，因此为了简化它的映射，咱们可能须要建立一个专用的用户类，将键封装为字段:

public class ApplicationProps {

    // ...

    private List<Map<String, Object>> props;
    private List<User> users;

    // getters and setters

    public static class User {

        private String username;
        private String password;
        private List<String> roles;

        // getters and setters

    }
}

如今咱们验证嵌套的YAML列表被正确映射:

@ExtendWith(SpringExtension.class)
@ContextConfiguration(initializers = ConfigFileApplicationContextInitializer.class)
@EnableConfigurationProperties(value = ApplicationProps.class)
class YamlComplexListsUnitTest {

    @Autowired
    private ApplicationProps applicationProps;

    @Test
    public void whenYamlNestedLists_thenLoadComplexLists() {
        assertThat(applicationProps.getUsers().get(0).getPassword()).isEqualTo("admin@10@");
        assertThat(applicationProps.getProps().get(0).get("name")).isEqualTo("YamlList");
        assertThat(applicationProps.getProps().get(1).get("port").getClass()).isEqualTo(Integer.class);
    }

}

5. 结论

在本教程中，咱们学习了如何将YAML列表映射到Java列表。咱们还检查了如何将复杂列表绑定到定制pojo。

本文分享自微信公众号 - Java码农（jarcoder）。
若有侵权，请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”，欢迎正在阅读的你也加入，一块儿分享。