如何将@ConfigurationProperties 与记录一起使用？

如何解决如何将@ConfigurationProperties 与记录一起使用？

Java 16 引入了 Records，这有助于在编写携带不可变数据的类时减少样板代码。当我尝试如下使用 Record as @ConfigurationProperties bean 时，我收到以下错误消息：

@ConfigurationProperties("demo")
public record MyConfigurationProperties(
        String myProperty
) {
}

***************************
APPLICATION Failed TO START
***************************

Description:

Parameter 0 of constructor in com.example.demo.MyConfigurationProperties required a bean of type 'java.lang.String' that Could not be found.

如何将记录用作 @ConfigurationProperties？

解决方法

回答我自己的问题。

上述错误是由于 Spring Boot 由于缺少无参数构造函数而无法构造 bean 引起的。记录隐式地为每个成员声明了一个带有参数的构造函数。

Spring Boot 允许我们使用 @ConstructorBinding 注释通过构造函数而不是 setter 方法启用属性绑定（如 the docs 和 this question 的答案中所述）。这也适用于记录，所以这是有效的：

@ConfigurationProperties("demo")
@ConstructorBinding
public record MyConfigurationProperties(
        String myProperty
) {
}

,

如果您需要以编程方式声明默认值：

@ConfigurationProperties("demo")
public record MyConfigurationProperties(String myProperty) { 
    
    @ConstructorBinding
    public MyConfigurationProperties(String myProperty) {
        this.myProperty = Optional.ofNullable(myProperty).orElse("default");
    }
}

java.util.Optional 属性：

@ConfigurationProperties("demo")
public record MyConfigurationProperties(Optional<String> myProperty) {

    @ConstructorBinding
    public MyConfigurationProperties(String myProperty) {
        this(Optional.ofNullable(myProperty));
    }
}

@Validated 和 java.util.Optional 的组合：

@Validated
@ConfigurationProperties("demo")
public record MyConfigurationProperties(@NotBlank String myRequiredProperty,Optional<String> myProperty) {

    @ConstructorBinding
    public MyConfigurationProperties(String myRequiredProperty,String myProperty) {
        this(myRequiredProperty,Optional.ofNullable(myProperty));
    }
}

基于此Spring Boot issue。