多模块SpringBoot项目：如何让@SpringBootTest读取外部config配置文件？

问题背景 #

你的多模块项目中，主应用能正常读取外部config/application.properties，但测试类运行时无法加载该配置，之前的复制任务会覆盖classpath中的默认配置，导致未在外部配置中定义的属性丢失。下面提供几种无需合并文件即可实现配置叠加的方案：

方案一：利用Spring Boot配置优先级，直接指定额外配置位置（推荐） #

Spring Boot原生支持通过spring.config.additional-location参数加载额外配置，加载顺序是先读取classpath内的默认配置，再读取指定路径的外部配置，外部配置的同名属性会覆盖默认值，未定义的属性保留默认值，完美满足需求。

修改application/build.gradle.kts中的test任务：

tasks.test {
    // 给测试JVM添加启动参数，指定外部config目录为额外配置源
    jvmArgs("-Dspring.config.additional-location=file:../config/")
}

方案二：通过Gradle任务合并配置文件 #

如果需要在构建阶段生成合并后的配置文件（比如测试环境需要固定的合并配置），可以编写Gradle任务实现属性合并，而非简单复制覆盖：

在application/build.gradle.kts中添加以下任务：

// 注册合并配置的任务
tasks.register<Copy>("mergeTestConfig") {
    val defaultConfig = file("src/main/resources/application.properties")
    val externalConfig = file("../config/application.properties")
    
    // 先创建测试资源目录
    val targetDir = file("$buildDir/resources/test")
    into(targetDir)
    
    doLast {
        // 加载两个配置文件，外部配置覆盖默认配置的同名属性
        val mergedProps = java.util.Properties().apply {
            load(defaultConfig.inputStream())
            load(externalConfig.inputStream())
        }
        // 将合并后的属性写入目标文件
        mergedProps.store(File(targetDir, "application.properties").outputStream(), "Merged test configuration")
    }
}

// 让测试任务依赖合并配置任务，并将合并后的目录加入类路径
tasks.test {
    dependsOn("mergeTestConfig")
    classpath += files("$buildDir/resources/test")
}

方案三：在测试类中直接指定配置位置 #

无需修改Gradle配置，直接在测试类上通过注解指定额外配置路径：

import org.springframework.boot.test.context.SpringBootTest

@SpringBootTest(properties = ["spring.config.additional-location=file:../config/"])
class ApplicationTests {
    // 你的测试代码
}

或者使用@PropertySource（需添加ignoreResourceNotFound避免外部配置不存在时报错）：

import org.springframework.context.annotation.PropertySource
import org.springframework.boot.test.context.SpringBootTest

@PropertySource(
    value = ["classpath:application.properties", "file:../config/application.properties"],
    ignoreResourceNotFound = true
)
@SpringBootTest
class ApplicationTests {
    // 你的测试代码
}

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