为何Gradle集成测试任务的Spring Profiles配置被覆盖？

问题描述 #

我在build.gradle中定义了如下集成测试任务：

task integrationTest(type: Test) {
  systemProperty "spring.profiles.active", "postgres"
  testLogging {
      events = ["passed", "failed", "skipped"]
  }
  filter {
      includeTestsMatching "foo.bar.integration.*"
  }
  useJUnitPlatform()
}

期望执行./gradlew integrationTest时Spring应用使用postgres环境配置文件，但实际运行时却使用了test配置文件。请问是什么原因导致Gradle覆盖了我的Spring Profiles设置？

常见原因 #

• Spring Boot Gradle插件的默认行为
  如果项目引入了Spring Boot插件，它会自动为所有Test类型的任务添加spring.profiles.active=test系统属性。且插件的配置逻辑通常晚于自定义任务的配置，会直接覆盖你设置的postgres值。

• 测试类的硬编码配置
  检查集成测试类，若类上标注了@ActiveProfiles("test")注解，该注解优先级高于系统属性，会强制启用test环境。

• Gradle配置阶段的顺序问题
  你在任务配置块中设置的系统属性，可能被后续执行的其他插件配置（比如Spring Boot的默认配置）覆盖——配置阶段的代码按顺序执行，后执行的设置会覆盖先设置的值。

解决办法 #

1. 移到执行阶段设置系统属性 #

把systemProperty的设置放到doFirst块中，任务执行时才生效，优先级高于配置阶段的默认值：

task integrationTest(type: Test) {
  testLogging {
      events = ["passed", "failed", "skipped"]
  }
  filter {
      includeTestsMatching "foo.bar.integration.*"
  }
  useJUnitPlatform()
  
  doFirst {
      systemProperty "spring.profiles.active", "postgres"
  }
}

2. 让Spring Boot插件跳过该任务 #

如果使用Spring Boot Gradle插件，配置让它不为integrationTest任务添加默认的test profile：

springBoot {
  test {
      excludeTasks = ["integrationTest"]
  }
}

3. 检查并修改测试类注解 #

若测试类有@ActiveProfiles("test")，要么删除该注解，要么改成@ActiveProfiles("postgres")，也可以用动态占位符兼容系统属性：

@ActiveProfiles("${spring.profiles.active:postgres}")

这样会优先使用系统属性的值，无系统属性时默认用postgres。

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