加载WebApplicationContext

要指示 TestContext 框架加载 WebApplicationContext 而不是标准 ApplicationContext，您可以使用 @WebAppConfiguration 注解相应的测试类。

在您的测试类中存在 @WebAppConfiguration 会指示 TestContext 框架 (TCF) 为您的集成测试加载 WebApplicationContext (WAC)。在后台，TCF 会确保创建一个 MockServletContext 并将其提供给您的测试的 WAC。默认情况下，您的 MockServletContext 的基本资源路径设置为 src/main/webapp。这被解释为相对于 JVM 根目录的路径（通常是您项目的路径）。如果您熟悉 Maven 项目中 Web 应用程序的目录结构，您就会知道 src/main/webapp 是 WAR 根目录的默认位置。如果您需要覆盖此默认值，可以为 @WebAppConfiguration 注解提供一个备用路径（例如，@WebAppConfiguration("src/test/webapp")）。如果您希望从类路径而不是文件系统引用基本资源路径，可以使用 Spring 的 classpath: 前缀。

请注意，Spring 对 WebApplicationContext 实现的测试支持与对标准 ApplicationContext 实现的测试支持相当。在使用 WebApplicationContext 进行测试时，您可以自由地使用 @ContextConfiguration 声明 XML 配置文件、Groovy 脚本或 @Configuration 类。您也可以自由地使用任何其他测试注释，例如 @ActiveProfiles、@TestExecutionListeners、@Sql、@Rollback 等。

本节中剩余的示例展示了加载 WebApplicationContext 的各种配置选项。以下示例展示了 TestContext 框架对约定优于配置的支持

  • 约定

  • Kotlin

@ExtendWith(SpringExtension.class)

// defaults to "file:src/main/webapp"
@WebAppConfiguration

// detects "WacTests-context.xml" in the same package
// or static nested @Configuration classes
@ContextConfiguration
class WacTests {
	//...
}
@ExtendWith(SpringExtension::class)

// defaults to "file:src/main/webapp"
@WebAppConfiguration

// detects "WacTests-context.xml" in the same package
// or static nested @Configuration classes
@ContextConfiguration
class WacTests {
	//...
}

如果您使用 @WebAppConfiguration 注释测试类，但未指定资源基路径，则资源路径实际上默认为 file:src/main/webapp。类似地，如果您声明 @ContextConfiguration 但未指定资源 locations、组件 classes 或上下文 initializers，Spring 会尝试使用约定来检测您的配置是否存在（即，与 WacTests 类位于同一包中的 WacTests-context.xml 或静态嵌套的 @Configuration 类）。

以下示例展示了如何使用 @WebAppConfiguration 显式声明资源基路径，并使用 @ContextConfiguration 声明 XML 资源位置

  • 默认资源语义

  • Kotlin

@ExtendWith(SpringExtension.class)

// file system resource
@WebAppConfiguration("webapp")

// classpath resource
@ContextConfiguration("/spring/test-servlet-config.xml")
class WacTests {
	//...
}
@ExtendWith(SpringExtension::class)

// file system resource
@WebAppConfiguration("webapp")

// classpath resource
@ContextConfiguration("/spring/test-servlet-config.xml")
class WacTests {
	//...
}

这里需要注意的是，这两个注释的路径具有不同的语义。默认情况下，@WebAppConfiguration 资源路径基于文件系统，而 @ContextConfiguration 资源位置基于类路径。

以下示例展示了，我们可以通过指定 Spring 资源前缀来覆盖这两个注释的默认资源语义

  • 显式资源语义

  • Kotlin

@ExtendWith(SpringExtension.class)

// classpath resource
@WebAppConfiguration("classpath:test-web-resources")

// file system resource
@ContextConfiguration("file:src/main/webapp/WEB-INF/servlet-config.xml")
class WacTests {
	//...
}
@ExtendWith(SpringExtension::class)

// classpath resource
@WebAppConfiguration("classpath:test-web-resources")

// file system resource
@ContextConfiguration("file:src/main/webapp/WEB-INF/servlet-config.xml")
class WacTests {
	//...
}

将此示例中的注释与上一个示例中的注释进行对比。