如何在Kotlin中以不可变字符串形式读取配置属性

问题背景 #

在Kotlin中读取配置属性时，用lateinit var虽能满足初始化需求，但变量是可变的，存在被意外篡改的风险。我们希望实现类似不存在的lateinit val的效果，或者将@Value注解与by lazy结合，简化代码同时保证属性不可变。

解决方案 #

方案1：构造注入（推荐） #

利用Spring的构造注入，直接将配置属性注入到不可变的val字段中，再结合by lazy封装业务对象：

@Component
class SecretsManagerConfig(
    @Value("\${aws.secretsManager.region}") private val region: String
) {
    private val awsRegion: Region by lazy { Region.of(region) }

    @Bean(name = ["secretsManagerClient"])
    fun secretsManagerClient(): SecretsManagerClient {
        return SecretsManagerClient.builder()
            .region(awsRegion)
            .build()
    }
}

• region通过构造注入直接赋值为不可变的val，从根源避免篡改风险
• awsRegion通过by lazy延迟初始化，仅在首次使用时生成Region实例

方案2：通过Environment直接获取 #

注入Spring的Environment对象，在lazy块中直接读取配置属性，省去中间变量：

@Component
class SecretsManagerConfig {
    @Autowired
    private lateinit var environment: Environment

    private val awsRegion: Region by lazy {
        val region = environment.getProperty("aws.secretsManager.region")
            ?: throw IllegalArgumentException("配置项aws.secretsManager.region未设置")
        Region.of(region)
    }

    @Bean(name = ["secretsManagerClient"])
    fun secretsManagerClient(): SecretsManagerClient {
        return SecretsManagerClient.builder()
            .region(awsRegion)
            .build()
    }
}

• 直接从Environment读取配置，无需额外的lateinit var字段
• 增加空值判断，提前暴露配置缺失问题

方案3：自定义委托（进阶） #

如果需要复用这种注入逻辑，可以自定义一个Kotlin委托类，实现@Value与lazy的结合：

class LazyValueDelegate<T>(private val valueExpression: String) : ReadOnlyProperty<Any?, T> {
    private val lazyValue by lazy {
        val resolver = ApplicationContextProvider.applicationContext.getBean(Environment::class.java)
        resolver.resolvePlaceholders(valueExpression) as T
    }

    override fun getValue(thisRef: Any?, property: KProperty<*>): T {
        return lazyValue
    }
}

// 辅助类获取ApplicationContext
@Component
class ApplicationContextProvider : ApplicationContextAware {
    companion object {
        lateinit var applicationContext: ApplicationContext
    }

    override fun setApplicationContext(context: ApplicationContext) {
        applicationContext = context
    }
}

// 使用方式
@Component
class SecretsManagerConfig {
    private val region: String by LazyValueDelegate("\${aws.secretsManager.region}")
    private val awsRegion: Region by lazy { Region.of(region) }

    @Bean(name = ["secretsManagerClient"])
    fun secretsManagerClient(): SecretsManagerClient {
        return SecretsManagerClient.builder()
            .region(awsRegion)
            .build()
    }
}

• 自定义委托封装了配置读取和延迟初始化逻辑，代码更简洁
• 适合在多个类中复用相同的注入方式

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