Spring Boot - 嵌套 ConfigurationProperties

Question

Spring Boot 具有许多很酷的功能。我最喜欢的是通过@ConfigurationProperties 和相应的yml/properties 文件的类型安全配置机制。我正在编写一个通过 Datastax Java 驱动程序配置 Cassandra 连接的库。我想让开发人员通过简单地编辑 yml 文件来配置 Cluster 和 Session 对象。这在 spring-boot 中很容易。但我想允许她/他以这种方式配置多个连接。在 PHP 框架 - Symfony 中很简单：

doctrine:
  dbal:
    default_connection: default
    connections:
      default:
        driver:   "%database_driver%"
        host:     "%database_host%"
        port:     "%database_port%"
        dbname:   "%database_name%"
        user:     "%database_user%"
        password: "%database_password%"
        charset:  UTF8
      customer:
        driver:   "%database_driver2%"
        host:     "%database_host2%"
        port:     "%database_port2%"
        dbname:   "%database_name2%"
        user:     "%database_user2%"
        password: "%database_password2%"
        charset:  UTF8

（这个sn-p来自Symfony documentation）

是否可以在 spring-boot 中使用 ConfigurationProperties？我应该嵌套它们吗？

Answer 1

您实际上可以使用类型安全的嵌套 ConfigurationProperties。

@ConfigurationProperties
public class DatabaseProperties {

    private Connection primaryConnection;

    private Connection backupConnection;

    // getter, setter ...

    public static class Connection {

        private String host;

        // getter, setter ...

    }

}

现在您可以设置属性primaryConnection.host。

如果您不想使用内部类，则可以使用 @NestedConfigurationProperty 注释字段。

@ConfigurationProperties
public class DatabaseProperties {

    @NestedConfigurationProperty
    private Connection primaryConnection; // Connection is defined somewhere else

    @NestedConfigurationProperty
    private Connection backupConnection;

    // getter, setter ...

}

另请参阅Reference Guide 和 Configuration Binding Docs。