如何对记录使用@ConfigurationProperties？

Question

Java16引入了记录，这有助于在编写携带不可变数据的类时减少样板代码。当我尝试将记录用作@ConfigurationPropertiesbean时，我得到以下错误消息：

@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？

Answer 1

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

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

java.util.可选属性：

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

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

@已验证和java。util。组合中的可选：

@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问题。

Answer 2

回答我自己的问题。

上面的错误是由于SpringBoot由于缺少无参数构造函数而无法构造bean引起的。记录隐式声明一个构造函数，每个成员都有一个参数。

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

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

更新：从Spring Boot 2.6开始，当记录有一个单独的构造函数时，不再需要使用开箱即用的记录和@构造绑定。请参阅发行说明。