使用测试属性源进行上下文配置

Spring 框架对环境的概念提供了强大的支持，其中包含一个层次化的属性源，您可以使用特定于测试的属性源配置集成测试。与在 @Configuration 类上使用的 @PropertySource 注解不同，您可以在测试类上声明 @TestPropertySource 注解来声明测试属性文件的资源位置或内联属性。这些测试属性源将添加到为带注释的集成测试加载的 ApplicationContext 的 Environment 中的 PropertySources 集合中。

您可以将 @TestPropertySource 与 SmartContextLoader SPI 的任何实现一起使用，但 @TestPropertySource 不支持旧的 ContextLoader SPI 的实现。

SmartContextLoader 的实现可以通过 MergedContextConfiguration 中的 getPropertySourceDescriptors() 和 getPropertySourceProperties() 方法访问合并的测试属性源值。

声明测试属性源

您可以使用 @TestPropertySource 的 locations 或 value 属性来配置测试属性文件。

默认情况下，支持传统的和基于 XML 的 java.util.Properties 文件格式 - 例如，"classpath:/com/example/test.properties" 或 "file:///path/to/file.xml"。从 Spring Framework 6.1 开始，您可以通过 @TestPropertySource 中的 factory 属性配置自定义 PropertySourceFactory，以支持其他文件格式，例如 JSON、YAML 等。

每个路径都被解释为 Spring Resource。普通路径（例如，"test.properties"）被视为相对于定义测试类的包的类路径资源。以斜杠开头的路径被视为绝对类路径资源（例如："/org/example/test.xml"）。引用 URL 的路径（例如，以 classpath:、file: 或 http: 为前缀的路径）使用指定的资源协议加载。

路径中的属性占位符（例如 ${…​}）将根据 Environment 解析。

从 Spring Framework 6.1 开始，也支持资源位置模式 - 例如，"classpath*:/config/*.properties"。

以下示例使用测试属性文件

  • Java

  • Kotlin

@ContextConfiguration
@TestPropertySource("/test.properties") (1)
class MyIntegrationTests {
	// class body...
}
1 指定具有绝对路径的属性文件。 
@ContextConfiguration
@TestPropertySource("/test.properties") (1)
class MyIntegrationTests {
	// class body...
}
1 指定具有绝对路径的属性文件。

您可以使用 @TestPropertySource 的 properties 属性配置内联属性，以键值对的形式，如以下示例所示。所有键值对都将作为单个测试 PropertySource 添加到封闭的 Environment 中，并具有最高优先级。

键值对支持的语法与 Java 属性文件中条目定义的语法相同

  • key=value

  • key:value

  • key value

虽然可以使用上述任何语法变体和键值之间任意数量的空格来定义属性，但建议您在测试套件中使用一种语法变体和一致的间距 - 例如，考虑始终使用 key = value 而不是 key= value、key=value 等。类似地，如果您使用文本块定义内联属性，则应在整个测试套件中始终如一地使用文本块来定义内联属性。

原因是您提供的精确字符串将用于确定上下文缓存的键。因此，为了从上下文缓存中获益，您必须确保一致地定义内联属性。

以下示例设置两个内联属性

  • Java

  • Kotlin

@ContextConfiguration
@TestPropertySource(properties = {"timezone = GMT", "port = 4242"}) (1)
class MyIntegrationTests {
	// class body...
}
1 通过字符串数组设置两个属性。 
@ContextConfiguration
@TestPropertySource(properties = ["timezone = GMT", "port = 4242"]) (1)
class MyIntegrationTests {
	// class body...
}
1 通过字符串数组设置两个属性。

从 Spring Framework 6.1 开始，您可以使用文本块在一个 String 中定义多个内联属性。以下示例使用文本块设置两个内联属性

  • Java

  • Kotlin

@ContextConfiguration
@TestPropertySource(properties = """
	timezone = GMT
	port = 4242
	""") (1)
class MyIntegrationTests {
	// class body...
}
1 通过文本块设置两个属性。 
@ContextConfiguration
@TestPropertySource(properties = ["""
	timezone = GMT
	port = 4242
	"""]) (1)
class MyIntegrationTests {
	// class body...
}
1 通过文本块设置两个属性。

从 Spring Framework 5.2 开始，@TestPropertySource 可以用作可重复注解。这意味着您可以在单个测试类上声明多个 @TestPropertySource 注解，来自后面 @TestPropertySource 注解的 locations 和 properties 会覆盖来自前面 @TestPropertySource 注解的那些。

此外，您可以在测试类上声明多个组合注解，这些注解都用 @TestPropertySource 进行元注解，所有这些 @TestPropertySource 声明都将为您的测试属性源做出贡献。

直接存在的 @TestPropertySource 注解始终优先于元存在的 @TestPropertySource 注解。换句话说，来自直接存在的 @TestPropertySource 注解的 locations 和 properties 将覆盖来自用作元注解的 @TestPropertySource 注解的 locations 和 properties。

默认属性文件检测

如果 @TestPropertySource 被声明为一个空注解（即，没有为 locations 或 properties 属性指定显式值），则会尝试检测相对于声明该注解的类的默认属性文件。例如，如果带注解的测试类是 com.example.MyTest，则相应的默认属性文件是 classpath:com/example/MyTest.properties。如果无法检测到默认值，则会抛出 IllegalStateException。

优先级

测试属性优先于操作系统环境、Java 系统属性或应用程序通过使用 @PropertySource 声明性地或以编程方式添加的属性源中定义的属性。因此，测试属性可用于有选择地覆盖从系统和应用程序属性源加载的属性。此外，内联属性优先于从资源位置加载的属性。但是请注意，通过 @DynamicPropertySource 注册的属性优先于通过 @TestPropertySource 加载的属性。

在下面的示例中，timezone 和 port 属性以及在 "/test.properties" 中定义的任何属性都将覆盖在系统和应用程序属性源中定义的相同名称的任何属性。此外，如果 "/test.properties" 文件为 timezone 和 port 属性定义了条目，则这些条目将被使用 properties 属性声明的内联属性覆盖。以下示例展示了如何在文件和内联中指定属性

  • Java

  • Kotlin

@ContextConfiguration
@TestPropertySource(
	locations = "/test.properties",
	properties = {"timezone = GMT", "port = 4242"}
)
class MyIntegrationTests {
	// class body...
}
@ContextConfiguration
@TestPropertySource("/test.properties",
		properties = ["timezone = GMT", "port = 4242"]
)
class MyIntegrationTests {
	// class body...
}

继承和覆盖测试属性源

@TestPropertySource 支持布尔型 inheritLocations 和 inheritProperties 属性，它们表示是否应该继承超类声明的属性文件资源位置和内联属性。这两个标志的默认值为 true。这意味着测试类会继承任何超类声明的位置和内联属性。具体来说，测试类的位置和内联属性将附加到超类声明的位置和内联属性。因此，子类可以选择扩展位置和内联属性。请注意，后面出现的属性会遮蔽（即覆盖）前面出现的相同名称的属性。此外，上述优先级规则也适用于继承的测试属性源。

如果 @TestPropertySource 中的 inheritLocations 或 inheritProperties 属性设置为 false，则测试类的位置或内联属性将分别遮蔽并有效地替换超类定义的配置。

从 Spring Framework 5.3 开始，测试配置也可以从封闭类继承。有关详细信息，请参阅 @Nested 测试类配置。

在下面的示例中，BaseTest 的 ApplicationContext 仅使用 base.properties 文件作为测试属性源加载。相反，ExtendedTest 的 ApplicationContext 使用 base.properties 和 extended.properties 文件作为测试属性源位置加载。以下示例展示了如何使用 properties 文件在子类及其超类中定义属性。

  • Java

  • Kotlin

@TestPropertySource("base.properties")
@ContextConfiguration
class BaseTest {
	// ...
}

@TestPropertySource("extended.properties")
@ContextConfiguration
class ExtendedTest extends BaseTest {
	// ...
}
@TestPropertySource("base.properties")
@ContextConfiguration
open class BaseTest {
	// ...
}

@TestPropertySource("extended.properties")
@ContextConfiguration
class ExtendedTest : BaseTest() {
	// ...
}

在下面的示例中，BaseTest 的 ApplicationContext 仅使用内联 key1 属性加载。相反，ExtendedTest 的 ApplicationContext 使用内联 key1 和 key2 属性加载。以下示例展示了如何使用内联属性在子类及其超类中定义属性。

  • Java

  • Kotlin

@TestPropertySource(properties = "key1 = value1")
@ContextConfiguration
class BaseTest {
	// ...
}

@TestPropertySource(properties = "key2 = value2")
@ContextConfiguration
class ExtendedTest extends BaseTest {
	// ...
}
@TestPropertySource(properties = ["key1 = value1"])
@ContextConfiguration
open class BaseTest {
	// ...
}

@TestPropertySource(properties = ["key2 = value2"])
@ContextConfiguration
class ExtendedTest : BaseTest() {
	// ...
}