上下文缓存

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

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

  • locations(来自 @ContextConfiguration

  • classes(来自 @ContextConfiguration

  • contextInitializerClasses(来自 @ContextConfiguration

  • contextCustomizers(来自 ContextCustomizerFactory) - 这包括 @DynamicPropertySource 方法以及来自 Spring Boot 测试支持的各种功能,例如 @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 将由这两个测试类共享。这意味着加载应用程序上下文的设置成本仅产生一次(每个测试套件),后续的测试执行速度要快得多。

测试套件和分叉进程

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

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

上下文缓存的大小受限于默认最大大小为 32。当达到最大大小时,将使用最近最少使用 (LRU) 驱逐策略来驱逐和关闭陈旧的上下文。您可以通过设置名为 spring.test.context.cache.maxSize 的 JVM 系统属性,从命令行或构建脚本配置最大大小。或者,您可以通过 SpringProperties 机制设置相同的属性。

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

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

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

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

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

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

测试的ApplicationContext可以通过以下几种方式关闭。

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

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

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

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

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