java - 不可变的@ConfigurationProperties

Question

Spring Boot 的 @ConfigurationProperties 是否可以拥有不可变(最终)字段？注解？下面的例子

@ConfigurationProperties(prefix = "example")
public final class MyProps {

  private final String neededProperty;

  public MyProps(String neededProperty) {
    this.neededProperty = neededProperty;
  }

  public String getNeededProperty() { .. }
}

到目前为止我尝试过的方法:

1. 创建 @Bean的MyProps具有两个构造函数的类
   • 提供两个构造函数:empty 和 with neededProperty论据
   • bean 是使用 new MyProps() 创建的
   • 字段中的结果为 null
2. 使用 @ComponentScan和 @Component提供MyProps bean 。
   • 结果为 BeanInstantiationException -> NoSuchMethodException: MyProps.<init>()

我让它工作的唯一方法是为每个非最终字段提供 getter/setter。

Answer 1

从 Spring Boot 2.2 开始，终于可以定义一个用 @ConfigurationProperties 修饰的不可变类了。
The documentation显示一个例子。
您只需要声明一个带有要绑定(bind)的字段的构造函数(而不是 setter 方式)并添加 @ConstructorBinding类级别的注解，指示应该使用构造函数绑定(bind)。
所以你没有任何 setter 的实际代码现在很好:

@ConstructorBinding
@ConfigurationProperties(prefix = "example")
public final class MyProps {

  private final String neededProperty;

  public MyProps(String neededProperty) {
    this.neededProperty = neededProperty;
  }

  public String getNeededProperty() { .. }
}