迁移到带有命名冲突的@ConfigurationProperties

Question

我有一个带有应用程序的Spring Boot应用程序。属性如下所示的文件：

setting.mode = a # Can be either `a` or `b`
setting.mode.a.subsetting1 = abc
setting.mode.a.subsetting2 = def
setting.mode.b.subsetting1 = ghi
setting.mode.b.subsetting2 = jkl

我们过去常常使用@Value注释来读取这些值，因此字符串设置的名称并不重要。模式与“子设置”的前缀相同。

我的任务是清理这个应用程序，我想使用与属性文件内容相匹配的大型配置对象来使用@ConfigurationProperties，以使代码更易于使用。

我认为configuration类的结构应该是这样的（Kotlin示例，但这并不重要）：

@Component
@ConfigurationProperties("setting")
class MyProperties {

    // Has the value either `a` or `b` to tell us which component to use
    lateinit var mode: String

    // THE PROBLEM IS HERE
    // -------------------
    //
    // The two classes below need to be under the `mode`
    // prefix, but they can't be because it is already used
    // to get its String value above.

    val a = A()

    val b = B()

    class A {
        lateinit var subsetting1: String
        lateinit var subsetting2: String
    }

    class B {
        lateinit var subsetting1: String
        lateinit var subsetting2: String
    }
}

请注意，设置的值。模式也用于决定注册哪个bean：

@Bean
@ConditionalOnProperty(name = ["setting.mode"], havingValue = "a")
fun a(properties: MyProperties): CommonInterface {
    return A(properties.mode.a)
}

@Bean
@ConditionalOnProperty(name = ["setting.mode"], havingValue = "b")
fun b(properties: MyProperties): CommonInterface {
    return B(properties.mode.b)
}

如何设置此配置（无需重写application.properties以消除此应用程序所有实例的命名问题）？

Answer 1

正确的方法是不要使用一个包含所有嵌套类的ConfigurationProperties类来构建整个结构，因为这意味着您不必要地填充了您知道不会使用的部分，因为它们对应的bean没有注册。

执行此操作的最佳方法是将配置类A和B如下所示：

@Component
@ConfigurationProperties("setting.mode.a")
class AProperties {
    lateinit var subsetting1: String
    lateinit var subsetting2: String
}

@Component
@ConfigurationProperties("setting.mode.b")
class BProperties {
    lateinit var subsetting1: String
    lateinit var subsetting2: String
}

然后更改@Bean定义以直接使用这些类，而不是调用整个配置对象：

@Bean
@ConditionalOnProperty(name = ["setting.mode"], havingValue = "a")
fun a(properties: AProperties): CommonInterface {
    return A(properties)
}

@Bean
@ConditionalOnProperty(name = ["setting.mode"], havingValue = "b")
fun b(properties: BProperties): CommonInterface {
    return B(properties)
}