Spring如何指定外部配置路径填充ConfigurationProperties数据类

@PropertySource 注解默认仅支持解析 .properties 格式配置文件，无法直接加载YAML文件，这是配置加载失效的核心诱因。直接用该注解指定yml路径时，自定义配置文件不会被正确解析，要么出现配置绑定失败导致应用启动报错，要么配置源未注册成功，应用始终读取application.yml中的原有配置。
另外你使用了@ConstructorBinding构造器绑定，这类配置类的实例化时机早于普通Bean，若自定义配置源的注册逻辑执行时机滞后，也会触发绑定异常。

根据你使用的Spring Boot版本二选一即可，不需要修改现有配置类的字段定义。

方案1：Spring Boot 2.4+ 版本（推荐） #

该版本开始官方提供了spring.config.import配置导入机制，无需编写自定义扩展代码，是官方推荐的配置拆分方案：

1. 将merchant-connection前缀下的所有配置从application.yml迁移到独立配置文件，例如存放在resources/config/merchant-connection.yml
2. 在application.yml中添加一行配置，直接导入独立配置文件：

spring:
  config:
    import: classpath:config/merchant-connection.yml

3. 配置类无需添加@PropertySource注解，保留原有的@ConstructorBinding、@ConfigurationProperties(prefix = "merchant-connection")注解即可，通过@ConfigurationPropertiesScan或@EnableConfigurationProperties完成配置类注册即可正常加载。

注意：必须删除application.yml中原有的merchant-connection配置段，否则同前缀配置会出现覆盖，导致仍读取旧配置的问题。

方案2：Spring Boot 2.4以下版本 #

低版本没有配置导入机制，需要自定义YAML属性源工厂，替换@PropertySource默认的解析逻辑：

1. 自定义YAML配置源工厂实现：

import org.springframework.boot.env.YamlPropertiesFactoryBean
import org.springframework.core.env.PropertiesPropertySource
import org.springframework.core.env.PropertySource
import org.springframework.core.io.support.EncodedResource
import org.springframework.core.io.support.PropertySourceFactory

class YamlPropertySourceFactory : PropertySourceFactory {
    override fun createPropertySource(name: String?, resource: EncodedResource): PropertySource<*> {
        val factory = YamlPropertiesFactoryBean()
        factory.setResources(resource.resource)
        factory.afterPropertiesSet()
        val properties = factory.`object` ?: throw IllegalArgumentException("YAML配置文件加载失败: ${resource.resource.filename}")
        return PropertiesPropertySource(name ?: resource.resource.filename!!, properties)
    }
}

2. 在配置类的@PropertySource注解中指定自定义工厂，以及独立配置文件路径：

import org.springframework.boot.context.properties.ConfigurationProperties
import org.springframework.boot.context.properties.ConstructorBinding
import org.springframework.context.annotation.PropertySource
import java.time.Duration

@ConstructorBinding
@ConfigurationProperties(prefix = "merchant-connection")
@PropertySource(
    value = ["classpath:config/merchant-connection.yml"],
    factory = YamlPropertySourceFactory::class
)
data class ConnectionsProfileProperties(
    val connectionProfiles: Map<String, ConnectionProperties>
) {

    data class ConnectionProperties(
        val smser: SmserProperties,
        val two: TwoProperties,
        val masterPass: MasterPassProperties,
        val priority: PriorityProperties
    ) {
        data class SmserProperties(
            val host: String,
            val port: Int,
            val version: Int,
            val priority: Int,
            val dstHost: Int,
            val srcHost: Int,
            val phoneSrc: String,
            val socketTimeout: Duration
        )

        data class TwoProperties(
            val host: String,
            val port: Int,
            val useProxy: Boolean,
            val proxyHost: String?,
            val proxyPort: Int,
            val clerk: String,
            val password: String,
            val product: String,
            val retAddress: String,
            val version: String,
            val needDict: Int,
            val allVendors: Int,
            val avoidSession: Int,
            val readTimeout: Duration,
            val connectionTimeout: Duration
        )

        data class MasterPassProperties(
            val baseUrl: String,
            val consumerKey: String,
            val keyStorePath: String,
            val keyStorePassword: String,
            val keyAlias: String,
            val readTimeout: Duration,
            val connectionTimeout: Duration,
            val sessionTimeout: Duration,
            val needSendPhoneCheckDate: Boolean,
            val useSpecLogicMlccof: Boolean?
        )

        data class PriorityProperties(
            val regCardPriorityCof: CofName,
            val cardMatchPriorityCof: CofName,
            val sortCardPriorityCof: CofName,
            val delCardPriorityCof: CofName,
            val getCardInfoCof: CofName
        )
    }
}

• 使用@ConstructorBinding时，不要给配置类添加@Component等自动注册注解，否则会触发构造器绑定失败，统一用@ConfigurationPropertiesScan或@EnableConfigurationProperties注册即可
• 如果独立配置文件存放在项目外部路径，将路径前缀classpath:替换为file:即可，例如file:./config/merchant-connection.yml
• 多环境场景下可以在spring.config.import中指定多个配置文件，按书写顺序加载，后加载的配置会覆盖先加载的同key配置

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