Spring @ConfigurationProperties结合Record与组合的属性绑定问题

原本定义了两个类：

class Base {
    String from;
    // getters/setters
}

@ConfigurationProperties("mine")
class Properties extends Base {
   String to;
   // getters/setters
}

对应的属性配置可以写成：

mine.from = 1
mine.to   = 2

现在想把Properties改成record，但record不支持继承，只能用组合方式实现：

@ConfigurationProperties("mine")
record Properties(String to, Base base) {
}

但这样配置属性时必须写成：

mine.base.from = 1
mine.to        = 2

有没有办法让Spring依然使用mine.from的格式来绑定属性，而不是mine.base.from？

有两种实用的方法可以实现需求：

方法一：重载record构造器 #

利用Spring配置属性对构造器绑定的支持，给record新增一个接收to和from参数的构造器，在构造逻辑里把from封装到Base实例中：

@ConfigurationProperties("mine")
record Properties(String to, Base base) {

    // 重载构造器，直接接收from参数完成封装
    public Properties(String to, String from) {
        this(to, new Base(from));
    }

    // 若需要对外暴露from属性的访问，可添加对应方法
    public String from() {
        return base.from();
    }
}

这样配置时就能继续沿用原来的格式：

mine.from = 1
mine.to   = 2

方法二：静态工厂方法+构造器绑定（适合多属性场景） #

如果Base类包含多个属性，不想在构造器里逐个声明参数，可以用静态工厂方法配合构造器绑定来简化：

@ConfigurationProperties("mine")
@ConstructorBinding
record Properties(String to, Base base) {

    public Properties(String to, String from/* , Base类的其他属性 */) {
        this(to, new Base(from/* , 其他属性参数 */));
    }

    // 静态工厂方法供Spring识别绑定
    public static Properties create(String to, String from/* , Base类其他属性 */) {
        return new Properties(to, from/* , 其他属性参数 */);
    }
}

同样可以使用mine.from的扁平格式配置属性。

内容的提问来源于stack exchange，提问作者Eugene