测试执行事件

EventPublishingTestExecutionListener 提供了一种实现自定义 TestExecutionListener 的替代方法。测试的 ApplicationContext 中的组件可以监听由 EventPublishingTestExecutionListener 发布的以下事件，每个事件都对应于 TestExecutionListener API 中的一个方法。

  • BeforeTestClassEvent

  • PrepareTestInstanceEvent

  • BeforeTestMethodEvent

  • BeforeTestExecutionEvent

  • AfterTestExecutionEvent

  • AfterTestMethodEvent

  • AfterTestClassEvent

这些事件可以出于各种原因被消费，例如重置 mock bean 或跟踪测试执行。消费测试执行事件而不是实现自定义 TestExecutionListener 的一个优点是，测试执行事件可以由注册在测试 ApplicationContext 中的任何 Spring bean 消费，并且这些 bean 可以直接受益于依赖注入和 ApplicationContext 的其他特性。相比之下，TestExecutionListener 不是 ApplicationContext 中的 bean。

EventPublishingTestExecutionListener 默认是注册的；但是，它只在 ApplicationContext *已经被加载*后才发布事件。这可以防止 ApplicationContext 被不必要地或过早地加载。

因此，BeforeTestClassEvent 不会发布，直到 ApplicationContext 被另一个 TestExecutionListener 加载后才会发布。例如，对于默认注册的 TestExecutionListener 实现集合，使用特定测试 ApplicationContext 的第一个测试类不会发布 BeforeTestClassEvent，但对于使用相同测试 ApplicationContext 的同一测试套件中的任何后续测试类，*将*发布 BeforeTestClassEvent，因为在后续测试类运行时，上下文已经加载（前提是上下文没有通过 @DirtiesContext 或最大大小逐出策略从 ContextCache 中移除）。

如果你希望确保 BeforeTestClassEvent 总是为每个测试类发布，你需要注册一个在 beforeTestClass 回调中加载 ApplicationContext 的 TestExecutionListener，并且该 TestExecutionListener 必须注册在 EventPublishingTestExecutionListener *之前*。

类似地，如果在给定测试类的最后一个测试方法之后使用 @DirtiesContext 从上下文缓存中移除 ApplicationContext，则不会为该测试类发布 AfterTestClassEvent。

为了监听测试执行事件，Spring bean 可以选择实现 org.springframework.context.ApplicationListener 接口。或者，可以使用 @EventListener 注解标记监听器方法，并配置为监听上述特定事件类型之一（参见 基于注解的事件监听器）。由于这种方法的流行，Spring 提供了以下专用的 @EventListener 注解来简化测试执行事件监听器的注册。这些注解位于 org.springframework.test.context.event.annotation 包中。

  • @BeforeTestClass

  • @PrepareTestInstance

  • @BeforeTestMethod

  • @BeforeTestExecution

  • @AfterTestExecution

  • @AfterTestMethod

  • @AfterTestClass

异常处理

默认情况下，如果测试执行事件监听器在消费事件时抛出异常，该异常将传播到底层使用的测试框架（例如 JUnit 或 TestNG）。例如，如果消费 BeforeTestMethodEvent 导致异常，则相应的测试方法将因此失败。相比之下，如果异步测试执行事件监听器抛出异常，该异常不会传播到底层测试框架。有关异步异常处理的更多详细信息，请查阅 @EventListener 的类级别 javadoc。

异步监听器

如果你希望某个特定的测试执行事件监听器异步处理事件，你可以使用 Spring 的常规 @Async 支持。有关更多详细信息，请查阅 @EventListener 的类级别 javadoc。