上下文缓存

一旦 TestContext 框架为测试加载了 ApplicationContext(或 WebApplicationContext),该上下文将被缓存并重新用于所有在同一测试套件中声明相同唯一上下文配置的后续测试。要了解缓存的工作原理,重要的是要理解 “唯一” 和 “测试套件” 的含义。

ApplicationContext 可以通过用于加载它的配置参数组合来唯一标识。因此,配置参数的唯一组合用于生成缓存上下文的键。TestContext 框架使用以下配置参数来构建上下文缓存键:

  • locations(来自 @ContextConfiguration

  • classes(来自 @ContextConfiguration

  • contextInitializerClasses(来自 @ContextConfiguration

  • contextCustomizers(来自 ContextCustomizerFactory)——这包括 @DynamicPropertySource 方法以及来自 Infra App 测试支持的各种功能,如 @MockBean@SpyBean

  • contextLoader(来自 @ContextConfiguration

  • parent(来自 @ContextHierarchy

  • activeProfiles(来自 @ActiveProfiles

  • propertySourceDescriptors(来自 @TestPropertySource

  • propertySourceProperties(来自 @TestPropertySource

  • resourceBasePath(来自 @WebAppConfiguration

例如,如果 TestClassA@ContextConfigurationlocations(或 value)属性指定了 {"app-config.xml", "test-config.xml"},TestContext 框架将加载相应的 ApplicationContext 并将其存储在 static 上下文缓存中,键仅基于这些位置。因此,如果 TestClassB 也为其位置定义了 {"app-config.xml", "test-config.xml"}(显式定义或通过继承隐式定义),但没有定义 @WebAppConfiguration、不同的 ContextLoader、不同的活动配置文件、不同的上下文初始化器、不同的测试属性源或不同的父上下文,则两个测试类将共享同一个 ApplicationContext。这意味着加载应用程序上下文的设置成本仅产生一次(每个测试套件),随后的测试执行速度要快得多。

测试套件和分叉进程

Infra TestContext 框架将应用程序上下文存储在静态缓存中。这意味着上下文实际上存储在 static 变量中。换句话说,如果测试在单独的进程中运行,静态缓存将在每次测试执行之间清除,这实际上禁用了缓存机制。

为了从缓存机制中受益,所有测试必须在同一进程或测试套件中运行。这可以通过在 IDE 中将所有测试作为一个组执行来实现。同样,当使用 Ant、Maven 或 Gradle 等构建框架执行测试时,确保构建框架不在测试之间分叉非常重要。例如,如果 Maven Surefire 插件的 forkMode 设置为 alwayspertest,TestContext 框架无法在测试类之间缓存应用程序上下文,导致构建过程运行速度明显变慢。

上下文缓存的大小是有限的,默认最大大小为 32。每当达到最大大小时,将使用最近最少使用(LRU)驱逐策略来驱逐并关闭陈旧的上下文。你可以通过设置名为 infra.test.context.cache.maxSize 的 JVM 系统属性,从命令行或构建脚本配置最大大小。作为替代方案,你可以通过 InfraProperties 机制设置相同的属性。

由于在给定的测试套件中加载大量应用程序上下文可能会导致套件运行时间不必要地长,因此确切知道已加载和缓存了多少上下文通常是有益的。要查看底层上下文缓存的统计信息,可以将 infra.test.context.cache 日志类别的日志级别设置为 DEBUG

在极少数情况下,如果测试破坏了应用程序上下文并需要重新加载(例如,通过修改 bean 定义或应用程序对象的状态),你可以使用 @DirtiesContext 标注你的测试类或测试方法(请参阅 Infra 测试注解 中关于 @DirtiesContext 的讨论)。这指示 Infra 从缓存中移除上下文,并在运行下一个需要相同应用程序上下文的测试之前重建应用程序上下文。请注意,@DirtiesContext 注解的支持由 DirtiesContextBeforeModesTestExecutionListenerDirtiesContextTestExecutionListener 提供,它们默认是启用的。

ApplicationContext 生命周期和控制台日志记录

当你需要调试使用 Infra TestContext 框架执行的测试时,分析控制台输出(即输出到 SYSOUTSYSERR 流)可能很有用。一些构建工具和 IDE 能够将控制台输出与给定的测试相关联;然而,一些控制台输出无法轻易地与给定的测试相关联。

关于由 TODAY Framework 本身或在 ApplicationContext 中注册的组件触发的控制台日志记录,了解由 Infra TestContext 框架在测试套件中加载的 ApplicationContext 的生命周期非常重要。

测试的 ApplicationContext 通常在准备测试类的实例时加载——例如,为了对测试实例的 @Autowired 字段执行依赖注入。这意味着在 ApplicationContext 初始化期间触发的任何控制台日志记录通常无法与单个测试方法相关联。但是,如果根据 @DirtiesContext 语义在测试方法执行之前立即关闭上下文,则将在执行测试方法之前加载上下文的新实例。在后一种情况下,IDE 或构建工具可能会将控制台日志记录与单个测试方法相关联。

测试的 ApplicationContext 可以通过以下场景之一关闭。

  • 根据 @DirtiesContext 语义关闭上下文。

  • 上下文因为根据 LRU 驱逐策略被自动从缓存中驱逐而关闭。

  • 当测试套件的 JVM 终止时,通过 JVM 关闭钩子关闭上下文。

如果根据 @DirtiesContext 语义在特定测试方法之后关闭上下文,IDE 或构建工具可能会将控制台日志记录与单个测试方法相关联。如果根据 @DirtiesContext 语义在测试类之后关闭上下文,则在 ApplicationContext 关闭期间触发的任何控制台日志记录都无法与单个测试方法相关联。同样,通过 JVM 关闭钩子在关闭阶段触发的任何控制台日志记录也无法与单个测试方法相关联。

当 Infra ApplicationContext 通过 JVM 关闭钩子关闭时,在关闭阶段执行的回调在名为 ContextShutdownHook 的线程上执行。因此,如果你希望禁用通过 JVM 关闭钩子关闭 ApplicationContext 时触发的控制台日志记录,你可以向日志框架注册一个自定义过滤器,以允许你忽略由该线程发起的任何日志记录。