测试执行事件

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

  • BeforeTestClassEvent

  • PrepareTestInstanceEvent

  • BeforeTestMethodEvent

  • BeforeTestExecutionEvent

  • AfterTestExecutionEvent

  • AfterTestMethodEvent

  • AfterTestClassEvent

这些事件可能会出于各种原因而被使用,例如重置模拟 bean 或跟踪测试执行。使用测试执行事件而不是实现自定义 TestExecutionListener 的一个优点是,任何注册在测试 ApplicationContext 中的 Spring bean 都可以使用测试执行事件,并且此类 bean 可以直接受益于依赖注入和 ApplicationContext 的其他功能。相比之下,TestExecutionListener 不是 ApplicationContext 中的 bean。

EventPublishingTestExecutionListener 默认注册;但是,它仅在 已加载 ApplicationContext 的情况下才发布事件。这可以防止 ApplicationContext 被不必要地或过早地加载。

因此,在另一个 TestExecutionListener 加载 ApplicationContext 之后,才会发布 BeforeTestClassEvent。例如,使用默认注册的 TestExecutionListener 实现集,对于使用特定测试 ApplicationContext 的第一个测试类,将不会发布 BeforeTestClassEvent,但是对于同一测试套件中使用相同测试 ApplicationContext 的任何后续测试类,将会 发布 BeforeTestClassEvent,因为在后续测试类运行时,上下文将已被加载(只要上下文尚未通过 @DirtiesContext 或最大大小驱逐策略从 ContextCache 中删除)。

如果你希望确保始终为每个测试类发布 BeforeTestClassEvent,则需要注册一个 TestExecutionListener,该监听器

同样,如果在给定测试类中的最后一个测试方法之后使用 @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。