TestContext 框架支持类

本节描述了在 JUnit 和 TestNG 中支持 Spring TestContext 框架的各种类。

用于 JUnit Jupiter 的 SpringExtension

Spring TestContext 框架与 JUnit 5 中引入的 JUnit Jupiter 测试框架提供了完全集成。通过使用 @ExtendWith(SpringExtension.class) 注解测试类，您可以实现标准的基于 JUnit Jupiter 的单元和集成测试， 同时获得 TestContext 框架的好处，例如支持加载应用程序上下文、测试实例的依赖注入、事务性测试方法执行等。

此外，由于 JUnit Jupiter 丰富的扩展 API，Spring 提供了以下超出 Spring 对 JUnit 4 和 TestNG 支持的功能集：

  • 测试构造函数、测试方法和测试生命周期回调方法的依赖注入。 有关更多详细信息，请参阅 使用 SpringExtension 进行依赖注入。

  • 基于 SpEL 表达式、环境变量、系统属性等，对 条件测试执行 的强大支持。有关更多详细信息和示例，请参阅 Spring JUnit Jupiter 测试注解 中 @EnabledIf 和 @DisabledIf 的文档。

  • 结合 Spring 和 JUnit Jupiter 注解的自定义组合注解。有关更多详细信息，请参阅 测试元注解支持 中 @TransactionalDevTestConfig 和 @TransactionalIntegrationTest 示例。

以下代码清单显示了如何配置测试类以结合 @ContextConfiguration 使用 SpringExtension：

  • Java

  • Kotlin

// 指示 JUnit Jupiter 使用 Spring 支持扩展测试。
@ExtendWith(SpringExtension.class)
// 指示 Spring 从 TestConfig.class 加载 ApplicationContext
@ContextConfiguration(classes = TestConfig.class)
class SimpleTests {

	@Test
	void testMethod() {
		// test logic...
	}
}
// 指示 JUnit Jupiter 使用 Spring 支持扩展测试。
@ExtendWith(SpringExtension::class)
// 指示 Spring 从 TestConfig::class 加载 ApplicationContext
@ContextConfiguration(classes = [TestConfig::class])
class SimpleTests {

	@Test
	fun testMethod() {
		// test logic...
	}
}

由于您还可以在 JUnit 5 中将注解用作元注解，Spring 提供了 @SpringJUnitConfig 和 @SpringJUnitWebConfig 组合注解来简化测试 ApplicationContext 和 JUnit Jupiter 的配置。

以下示例使用 @SpringJUnitConfig 来减少上一个示例中使用的配置量：

  • Java

  • Kotlin

// 指示 Spring 向 JUnit Jupiter 注册 SpringExtension
// 并从 TestConfig.class 加载 ApplicationContext
@SpringJUnitConfig(TestConfig.class)
class SimpleTests {

	@Test
	void testMethod() {
		// test logic...
	}
}
// 指示 Spring 向 JUnit Jupiter 注册 SpringExtension
// 并从 TestConfig.class 加载 ApplicationContext
@SpringJUnitConfig(TestConfig::class)
class SimpleTests {

	@Test
	fun testMethod() {
		// test logic...
	}
}

类似地，以下示例使用 @SpringJUnitWebConfig 创建一个 WebApplicationContext 以与 JUnit Jupiter 一起使用：

  • Java

  • Kotlin

// 指示 Spring 向 JUnit Jupiter 注册 SpringExtension
// 并从 TestWebConfig.class 加载 WebApplicationContext
@SpringJUnitWebConfig(TestWebConfig.class)
class SimpleWebTests {

	@Test
	void testMethod() {
		// test logic...
	}
}
// 指示 Spring 向 JUnit Jupiter 注册 SpringExtension
// 并从 TestWebConfig.class 加载 WebApplicationContext
@SpringJUnitWebConfig(TestWebConfig::class)
class SimpleWebTests {

	@Test
	fun testMethod() {
		// test logic...
	}
}

有关更多详细信息，请参阅 Spring JUnit Jupiter 测试注解 中 @SpringJUnitConfig 和 @SpringJUnitWebConfig 的文档。

使用 SpringExtension 进行依赖注入

SpringExtension 实现了 JUnit Jupiter 的 ParameterResolver 扩展 API，这使得 Spring 可以为测试构造函数、测试方法和测试生命周期回调方法提供依赖注入。

具体来说，SpringExtension 可以将测试 ApplicationContext 中的依赖项注入到测试构造函数和方法中， 这些方法使用 Spring 的 @BeforeTransaction 和 @AfterTransaction 或 JUnit 的 @BeforeAll、 @AfterAll、@BeforeEach、@AfterEach、@Test、@RepeatedTest、@ParameterizedTest 等注解。

构造函数注入

如果 JUnit Jupiter 测试类构造函数中的特定参数是 ApplicationContext 类型（或其子类型）， 或者使用 @Autowired、@Qualifier 或 @Value 注解或元注解，Spring 会将该特定参数的值与 测试 ApplicationContext 中相应的 bean 或值注入。

如果构造函数被认为是 可自动装配的，Spring 也可以配置为自动装配测试类构造函数的所有参数。 如果满足以下条件之一（按优先级顺序），则构造函数被认为是可自动装配的。

  • 构造函数被 @Autowired 注解。

  • @TestConstructor 存在于测试类上或元存在于测试类上，并且 autowireMode 属性设置为 ALL。

  • 默认的 测试构造函数自动装配模式 已更改为 ALL。

有关 @TestConstructor 的使用以及如何更改全局 测试构造函数自动装配模式 的详细信息，请参阅 @TestConstructor。

如果测试类的构造函数被认为是 可自动装配的，Spring 将承担解析构造函数中所有参数的责任。 因此，注册到 JUnit Jupiter 的其他 ParameterResolver 都无法解析此类构造函数的参数。

如果 @DirtiesContext 用于在测试方法之前或之后关闭测试的 ApplicationContext， 则测试类的构造函数注入不能与 JUnit Jupiter 的 @TestInstance(PER_CLASS) 支持结合使用。 原因是 @TestInstance(PER_CLASS) 指示 JUnit Jupiter 在测试方法调用之间缓存测试实例。 因此，测试实例将保留对最初从已关闭的 ApplicationContext 注入的 bean 的引用。 由于在这种情况下测试类的构造函数只会被调用一次，因此依赖注入不会再次发生， 并且后续测试将与已关闭的 ApplicationContext 中的 bean 交互，这可能会导致错误。 要将 @DirtiesContext 与“测试方法之前”或“测试方法之后”模式结合 @TestInstance(PER_CLASS) 使用， 必须将 Spring 的依赖项配置为通过字段或 setter 注入提供，以便它们可以在测试方法调用之间重新注入。

在以下示例中，Spring 将从 TestConfig.class 加载的 ApplicationContext 中的 OrderService bean 注入到 OrderServiceIntegrationTests 构造函数中。

  • Java

  • Kotlin

@SpringJUnitConfig(TestConfig.class)
class OrderServiceIntegrationTests {

	private final OrderService orderService;

	@Autowired
	OrderServiceIntegrationTests(OrderService orderService) {
		this.orderService = orderService;
	}

	// tests that use the injected OrderService
}
@SpringJUnitConfig(TestConfig::class)
class OrderServiceIntegrationTests @Autowired constructor(private val orderService: OrderService){
	// tests that use the injected OrderService
}

请注意，此功能允许测试依赖项是 final 的，因此是不可变的。

如果 spring.test.constructor.autowire.mode 属性设置为 all （请参阅 @TestConstructor）， 我们可以在上一个示例中省略构造函数上的 @Autowired 声明，结果如下。

  • Java

  • Kotlin

@SpringJUnitConfig(TestConfig.class)
class OrderServiceIntegrationTests {

	private final OrderService orderService;

	OrderServiceIntegrationTests(OrderService orderService) {
		this.orderService = orderService;
	}

	// tests that use the injected OrderService
}
@SpringJUnitConfig(TestConfig::class)
class OrderServiceIntegrationTests(val orderService:OrderService) {
	// tests that use the injected OrderService
}

方法注入

如果 JUnit Jupiter 测试方法或测试生命周期回调方法中的参数是 ApplicationContext 类型（或其子类型）， 或者使用 @Autowired、@Qualifier 或 @Value 注解或元注解，Spring 会将该特定参数的值与 测试 ApplicationContext 中相应的 bean 注入。

在以下示例中，Spring 将从 TestConfig.class 加载的 ApplicationContext 中的 OrderService 注入到 deleteOrder() 测试方法中：

  • Java

  • Kotlin

@SpringJUnitConfig(TestConfig.class)
class OrderServiceIntegrationTests {

	@Test
	void deleteOrder(@Autowired OrderService orderService) {
		// use orderService from the test's ApplicationContext
	}
}
@SpringJUnitConfig(TestConfig::class)
class OrderServiceIntegrationTests {

	@Test
	fun deleteOrder(@Autowired orderService: OrderService) {
		// use orderService from the test's ApplicationContext
	}
}

由于 JUnit Jupiter 中 ParameterResolver 支持的健壮性，您还可以将多个依赖项注入到单个方法中， 不仅来自 Spring，还可以来自 JUnit Jupiter 本身或其他第三方扩展。

以下示例显示了如何同时让 Spring 和 JUnit Jupiter 将依赖项注入到 placeOrderRepeatedly() 测试方法中。

  • Java

  • Kotlin

@SpringJUnitConfig(TestConfig.class)
class OrderServiceIntegrationTests {

	@RepeatedTest(10)
	void placeOrderRepeatedly(RepetitionInfo repetitionInfo,
			@Autowired OrderService orderService) {

		// use orderService from the test's ApplicationContext
		// and repetitionInfo from JUnit Jupiter
	}
}
@SpringJUnitConfig(TestConfig::class)
class OrderServiceIntegrationTests {

	@RepeatedTest(10)
	fun placeOrderRepeatedly(repetitionInfo:RepetitionInfo, @Autowired orderService:OrderService) {

		// use orderService from the test's ApplicationContext
		// and repetitionInfo from JUnit Jupiter
	}
}

请注意，使用 JUnit Jupiter 的 @RepeatedTest 允许测试方法访问 RepetitionInfo。

@Nested 测试类配置

Spring TestContext 框架 支持在 JUnit Jupiter 的 @Nested 测试类上使用与测试相关的注解， 包括对从封闭类继承测试类配置的一流支持，并且此类配置将默认继承。 要将默认的 INHERIT 模式更改为 OVERRIDE 模式，您可以为单个 @Nested 测试类添加 @NestedTestConfiguration(EnclosingConfiguration.OVERRIDE) 注解。 显式的 @NestedTestConfiguration 声明将应用于带注解的测试类及其任何子类和嵌套类。 因此，您可以为顶级测试类添加 @NestedTestConfiguration 注解，它将递归地应用于其所有嵌套测试类。

如果您正在开发一个与 Spring TestContext 框架集成的组件，并且需要支持封闭类层次结构中的注解继承， 则必须使用 TestContextAnnotationUtils 中提供的注解搜索实用程序，以遵循 @NestedTestConfiguration 语义。

为了允许开发团队将默认值更改为 OVERRIDE —— 例如，为了与 Spring Framework 5.0 到 5.2 兼容 —— 可以通过 JVM 系统属性或类路径根目录下的 spring.properties 文件全局更改默认模式。 有关详细信息，请参阅 "更改默认封闭配置继承模式" 注释。

尽管以下“Hello World”示例非常简单，但它展示了如何在顶级类上声明通用配置， 该配置由其 @Nested 测试类继承。在此特定示例中，只继承了 TestConfig 配置类。 每个嵌套测试类都提供自己的一组活动配置文件，从而为每个嵌套测试类生成一个不同的 ApplicationContext （有关详细信息，请参阅 上下文缓存）。 请查阅 支持的注解 列表， 以查看哪些注解可以在 @Nested 测试类中继承。

  • Java

  • Kotlin

@SpringJUnitConfig(TestConfig.class)
class GreetingServiceTests {

	@Nested
	@ActiveProfiles("lang_en")
	class EnglishGreetings {

		@Test
		void hello(@Autowired GreetingService service) {
			assertThat(service.greetWorld()).isEqualTo("Hello World");
		}
	}

	@Nested
	@ActiveProfiles("lang_de")
	class GermanGreetings {

		@Test
		void hello(@Autowired GreetingService service) {
			assertThat(service.greetWorld()).isEqualTo("Hallo Welt");
		}
	}
}
@SpringJUnitConfig(TestConfig::class)
class GreetingServiceTests {

	@Nested
	@ActiveProfiles("lang_en")
	inner class EnglishGreetings {

		@Test
		fun hello(@Autowired service:GreetingService) {
			assertThat(service.greetWorld()).isEqualTo("Hello World")
		}
	}

	@Nested
	@ActiveProfiles("lang_de")
	inner class GermanGreetings {

		@Test
		fun hello(@Autowired service:GreetingService) {
			assertThat(service.greetWorld()).isEqualTo("Hallo Welt")
		}
	}
}

JUnit 4 支持

Spring JUnit 4 运行器

Spring TestContext 框架通过自定义运行器（支持 JUnit 4.12 或更高版本）与 JUnit 4 提供了完全集成。 通过使用 @RunWith(SpringJUnit4ClassRunner.class) 或更短的 @RunWith(SpringRunner.class) 变体注解测试类， 开发人员可以实现标准的基于 JUnit 4 的单元和集成测试，同时获得 TestContext 框架的好处， 例如支持加载应用程序上下文、测试实例的依赖注入、事务性测试方法执行等。 如果您想将 Spring TestContext 框架与替代运行器（例如 JUnit 4 的 Parameterized 运行器） 或第三方运行器（例如 MockitoJUnitRunner）一起使用，您可以选择使用 Spring 对 JUnit 规则的支持 代替。

以下代码清单显示了配置测试类以使用自定义 Spring Runner 运行的最低要求：

  • Java

  • Kotlin

@RunWith(SpringRunner.class)
@TestExecutionListeners({})
public class SimpleTest {

	@Test
	public void testMethod() {
		// test logic...
	}
}
@RunWith(SpringRunner::class)
@TestExecutionListeners
class SimpleTest {

	@Test
	fun testMethod() {
		// test logic...
	}
}

在前面的示例中，@TestExecutionListeners 配置了一个空列表，以禁用默认侦听器， 否则默认侦听器将需要通过 @ContextConfiguration 配置 ApplicationContext。

Spring JUnit 4 规则

org.springframework.test.context.junit4.rules 包提供了以下 JUnit 4 规则 （支持 JUnit 4.12 或更高版本）：

  • SpringClassRule

  • SpringMethodRule

SpringClassRule 是一个 JUnit TestRule，支持 Spring TestContext 框架的类级别功能， 而 SpringMethodRule 是一个 JUnit MethodRule，支持 Spring TestContext 框架的实例级别和方法级别功能。

与 SpringRunner 相比，Spring 基于规则的 JUnit 支持的优点是不依赖于任何 org.junit.runner.Runner 实现，因此可以与现有的替代运行器（例如 JUnit 4 的 Parameterized） 或第三方运行器（例如 MockitoJUnitRunner）结合使用。

要支持 TestContext 框架的全部功能，您必须将 SpringClassRule 与 SpringMethodRule 结合使用。 以下示例显示了在集成测试中声明这些规则的正确方法：

  • Java

  • Kotlin

// 可选地通过 @RunWith(...) 指定非 Spring 运行器
@ContextConfiguration
public class IntegrationTest {

	@ClassRule
	public static final SpringClassRule springClassRule = new SpringClassRule();

	@Rule
	public final SpringMethodRule springMethodRule = new SpringMethodRule();

	@Test
	public void testMethod() {
		// test logic...
	}
}
// 可选地通过 @RunWith(...) 指定非 Spring 运行器
@ContextConfiguration
class IntegrationTest {

	@Rule
	val springMethodRule = SpringMethodRule()

	@Test
	fun testMethod() {
		// test logic...
	}

	companion object {
		@ClassRule
		val springClassRule = SpringClassRule()
	}
}

JUnit 4 基类

org.springframework.test.context.junit4 包为基于 JUnit 4 的测试用例 （支持 JUnit 4.12 或更高版本）提供了以下支持类：

  • AbstractJUnit4SpringContextTests

  • AbstractTransactionalJUnit4SpringContextTests

AbstractJUnit4SpringContextTests 是一个抽象基测试类，它将 Spring TestContext 框架与 JUnit 4 环境中的显式 ApplicationContext 测试支持集成。当您扩展 AbstractJUnit4SpringContextTests 时， 您可以访问一个 protected 的 applicationContext 实例变量，您可以使用它来执行显式 bean 查找 或测试整个上下文的状态。

AbstractTransactionalJUnit4SpringContextTests 是 AbstractJUnit4SpringContextTests 的抽象事务扩展， 它增加了一些方便的 JDBC 访问功能。此期望在 ApplicationContext 中定义一个 javax.sql.DataSource bean 和一个 PlatformTransactionManager bean。当您扩展 AbstractTransactionalJUnit4SpringContextTests 时， 您可以访问一个 protected 的 jdbcTemplate 实例变量，您可以使用它来运行 SQL 语句以查询数据库。 您可以使用此类查询来确认在运行数据库相关应用程序代码之前和之后的数据库状态， 并且 Spring 确保此类查询在与应用程序代码相同的事务范围内运行。 与 ORM 工具结合使用时，请务必避免 假阳性。 如 JDBC 测试支持 中所述， AbstractTransactionalJUnit4SpringContextTests 还提供了方便的方法， 这些方法通过使用前面提到的 jdbcTemplate 委托给 JdbcTestUtils 中的方法。 此外，AbstractTransactionalJUnit4SpringContextTests 提供了一个 executeSqlScript(..) 方法， 用于针对配置的 DataSource 运行 SQL 脚本。

这些类是扩展的便利。如果您不想将测试类绑定到 Spring 特定的类层次结构， 您可以使用 @RunWith(SpringRunner.class) 或 Spring 的 JUnit 规则 来配置自己的自定义测试类，并通过 TestContextManager 手动检测您的测试类。 有关如何检测测试类的示例，请参阅 AbstractTestNGSpringContextTests 的源代码。

TestNG 支持

org.springframework.test.context.testng 包为基于 TestNG 的测试用例提供了以下支持类：

  • AbstractTestNGSpringContextTests

  • AbstractTransactionalTestNGSpringContextTests

AbstractTestNGSpringContextTests 是一个抽象基测试类，它将 Spring TestContext 框架与 TestNG 环境中的显式 ApplicationContext 测试支持集成。当您扩展 AbstractTestNGSpringContextTests 时， 您可以访问一个 protected 的 applicationContext 实例变量，您可以使用它来执行显式 bean 查找 或测试整个上下文的状态。

AbstractTransactionalTestNGSpringContextTests 是 AbstractTestNGSpringContextTests 的抽象事务扩展， 它增加了一些方便的 JDBC 访问功能。此期望在 ApplicationContext 中定义一个 javax.sql.DataSource bean 和一个 PlatformTransactionManager bean。当您扩展 AbstractTransactionalTestNGSpringContextTests 时， 您可以访问一个 protected 的 jdbcTemplate 实例变量，您可以使用它来运行 SQL 语句以查询数据库。 您可以使用此类查询来确认在运行数据库相关应用程序代码之前和之后的数据库状态， 并且 Spring 确保此类查询在与应用程序代码相同的事务范围内运行。 与 ORM 工具结合使用时，请务必避免 假阳性。 如 JDBC 测试支持 中所述， AbstractTransactionalTestNGSpringContextTests 还提供了方便的方法， 这些方法通过使用前面提到的 jdbcTemplate 委托给 JdbcTestUtils 中的方法。 此外，AbstractTransactionalTestNGSpringContextTests 提供了一个 executeSqlScript(..) 方法， 用于针对配置的 DataSource 运行 SQL 脚本。

这些类是扩展的便利。如果您不想将测试类绑定到 Spring 特定的类层次结构， 您可以使用 @ContextConfiguration、@TestExecutionListeners 等来配置自己的自定义测试类， 并通过 TestContextManager 手动检测您的测试类。 有关如何检测测试类的示例，请参阅 AbstractTestNGSpringContextTests 的源代码。