如何将复杂的YAML解析成Java对象层次结构（spring boot配置）

Question

我需要定义服务连接属性，这些属性将用于配置用于对spring boot服务进行RESTendpoint调用的resttemplate。

注意：将来可能会涉及到服务发现机制，但我被指示暂时不要使用该方法。

服务连接属性：

• 连接方案-HTTP/HTTPS
• 主机名
• 主机端口
• 连接超时
• 请求超时
• 套接字超时
• 默认保持活动状态
• 每路由默认最大连接数
• 最大连接总数

可能的配置(YAML)：

services-config:
  global:
    scheme: http|https
    connectionTimeout: <timeout ms>
    requestTimeout: <timeout ms>
    socketTimeout: <timeout ms>
    defaultKeepAlive: <timeout ms>
    defaultMaxConnPerRoute: <count>
    maxTotalConnections: <count>
  services:
    - id: <ID>          [?]
      name: <name>      [?]
      host: localhost|<host>
      port: <port>
    - id: <ID>          [?]
      name: <name>      [?]
      host: localhost|<host>
      port: <port>
    ...

目的是将这些信息放入application.yml文件中，以便在spring应用程序中访问这些信息。

有没有办法将这些信息以YAML格式拉到Java对象层次结构中，如下所示：

class : ServicesConfig
  global : GlobalConnectionProperties
  services : map<String, ServiceConnectionProperties>

class : GlobalConnectionProperties
  scheme : String (maybe enum instead)
  connectionTimeout : int
  requestTimeout : int
  socketTimeout : int
  defaultKeepAlive : int
  defaultMaxConnPerRoute : int
  maxTotalConnections : int

class : ServiceConnectionProperties
  id : String
  name : String
  host : String
  port : int

更新：

尝试了以下操作并取得了部分成功：

ServiceConfiguration.java

@Configuration
public class ServiceConfiguration {

  private ServicesConfig servicesConfig;

  @Autowired
  public ServiceConfiguration(ServicesConfig servicesConfig) {
    this.servicesConfig = servicesConfig;
    System.out.println(servicesConfig);
  }

}

servicesConfig.java：

@ConfigurationProperties(value = "services-config")
@EnableConfigurationProperties(
    value = {GlobalConnectionProperties.class, ServiceConnectionProperties.class})
public class ServicesConfig {

  private GlobalConnectionProperties               globalProps;
  private Map<String, ServiceConnectionProperties> services;

  public GlobalConnectionProperties getGlobalProps() {
    return globalProps;
  }

  public void setGlobalProps(GlobalConnectionProperties globalProps) {
    this.globalProps = globalProps;
  }

  public Map<String, ServiceConnectionProperties> getServices() {
    return services;
  }

  public void setServices(Map<String, ServiceConnectionProperties> services) {
    this.services = services;
  }

  @Override
  public String toString() {
    return "ServicesConfig [globalProps=" + globalProps + ", services=" + services + "]";
  }

}

application.yml：

services-config:
  global:
    scheme: http
    connectionTimeout: 30000
    requestTimeout: 30000
    socketTimeout: 60000
    defaultKeepAlive: 20000
    defaultMaxConnPerRoute: 10
    maxTotalConnections: 200
  services:
    - id: foo
      name: foo service
      host: 192.168.56.101
      port: 8090
    - id: bar
      name: bar service
      host: 192.168.56.102
      port: 9010

省略了GlobalConnectionProperties和ServiceConnectionProperties类，因为它们只包含属性、getter/setter方法和toString（）。

当我运行服务时,控制台上会出现以下内容：

ServicesConfig [globalProps=null, services={0=ServiceConnectionProperties [id=foo, name=foo service, host=192.168.56.101, port=8090], 1=ServiceConnectionProperties [id=bar, name=bar service, host=192.168.56.102, port=9010]}]

我实际上很惊讶列表项被解析并插入到映射中。我希望“id”是关键字，而不是默认的整数。奇怪的是，“全局”属性并没有进入地图。

要读取全局对象项，我需要更正什么？

有没有一种方法通过项目“id”属性来关键映射条目？

Answer 1

要读取全局对象项，我需要更正什么？

属性的绑定遵循Java Bean约定，因此在servicesconfig中，您需要将字段和getters/setter从globalprops重命名为global。

https://docs.spring.io/spring-boot/docs/current/reference/html/spring-boot-features.html#boot-features-external-config-typesafe-configuration-properties如注释中链接的更多信息。

有没有一种方法通过项目“id”属性来关键映射条目？

对于映射条目，yaml语法不正确。请参阅https://bitbucket.org/asomov/snakeyaml/wiki/documentation#markdown-header-type-safe-collections中使用:和？的语法。你的地图

services:
  ? foo
  : { id: foo,
      name: foo service,
      host: 192.168.56.101,
      port: 8090 }
  ? bar
  : { id: bar,
      name: bar service,
      host: 192.168.56.102,
      port: 9010}