不可变@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() { .. }
}

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

• 使用两个构造函数创建MyProps类的@Bean
  • 提供两个构造函数：空和需要属性参数
  • bean是用new MyProps（）
  创建的
  • 结果字段为null
  • 导致BeanInstantiationException-

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

Answer 1

最后，如果你想要一个不可变的对象，你也可以“破解”设置器

@ConfigurationProperties(prefix = "myapp")
public class ApplicationProperties {
    private String someProperty;

    // ... other properties and getters

    public String getSomeProperty() {
       return someProperty;
    }

    public String setSomeProperty(String someProperty) {
      if (someProperty == null) {
        this.someProperty = someProperty;
      }       
    }
}

显然，如果属性不仅仅是一个字符串，也就是一个可变对象，事情就更复杂了，但这是另一回事。

更好的是，您可以创建一个配置容器

@ConfigurationProperties(prefix = "myapp")
public class ApplicationProperties {
   private final List<MyConfiguration> configurations  = new ArrayList<>();

   public List<MyConfiguration> getConfigurations() {
      return configurations
   }
}

其中，现在的配置是一个没有

public class MyConfiguration {
    private String someProperty;

    // ... other properties and getters

    public String getSomeProperty() {
       return someProperty;
    }

    public String setSomeProperty(String someProperty) {
      if (this.someProperty == null) {
        this.someProperty = someProperty;
      }       
    }
}

和应用。yml as

myapp:
  configurations:
    - someProperty: one
    - someProperty: two
    - someProperty: other

Answer 2

我必须经常解决这个问题，我使用了一种不同的方法，它允许我在类中使用最终变量。

首先，我将所有配置保存在一个地方（类），例如，称为Application ationProperties。该类具有具有特定前缀的@ConfigurationProperties注释。它还列在针对配置类（或主类）的@EnableConfigurationProperties注释中。

然后，我提供我的ApplicationProperties作为构造函数参数，并对构造函数中的final字段执行赋值。

示例：

主要类别：

@SpringBootApplication
@EnableConfigurationProperties(ApplicationProperties.class)
public class Application {
    public static void main(String... args) throws Exception {
        SpringApplication.run(Application.class, args);
    }
}

应用程序属性类

@ConfigurationProperties(prefix = "myapp")
public class ApplicationProperties {

    private String someProperty;

    // ... other properties and getters

   public String getSomeProperty() {
       return someProperty;
   }
}

和一个具有最终属性的类

@Service
public class SomeImplementation implements SomeInterface {
    private final String someProperty;

    @Autowired
    public SomeImplementation(ApplicationProperties properties) {
        this.someProperty = properties.getSomeProperty();
    }

    // ... other methods / properties 
}

出于许多不同的原因，我更喜欢这种方法，例如，如果我必须在构造函数中设置更多属性，那么我的构造函数参数列表并不“庞大”，因为我总是有一个参数（ApplicationProperties）；如果需要添加更多的final属性，我的构造函数将保持不变（只有一个参数）-这可能会减少其他地方的更改数量等。

我希望这会有帮助

Answer 3

从SpringBoot2.2开始，最终可以定义一个用@ConfigurationProperties修饰的不可变类
文档显示了一个示例
您只需使用要绑定的字段（而不是setter方式）声明一个构造函数，并在类级别添加@ConstructorBinding注释，以指示应使用构造函数绑定
因此，没有任何setter的实际代码现在就可以了：

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

  private final String neededProperty;

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

  public String getNeededProperty() { .. }
}