Spring JUnit Jupiter 测试注解

当与 JUnit Jupiter (即 JUnit 5 中的编程模型) 的 SpringExtension 结合使用时，支持以下注解

@SpringJUnitConfig

@SpringJUnitConfig 是一个组合注解，它将 JUnit Jupiter 的 @ExtendWith(SpringExtension.class) 与 Spring TestContext Framework 的 @ContextConfiguration 结合在一起。它可以在类级别使用，作为 @ContextConfiguration 的直接替代。在配置选项方面，@ContextConfiguration 和 @SpringJUnitConfig 唯一的区别是，组件类可以在 @SpringJUnitConfig 中使用 value 属性声明。

以下示例演示如何使用 @SpringJUnitConfig 注解指定配置类

  • Java

  • Kotlin

@SpringJUnitConfig(TestConfig.class) (1)
class ConfigurationClassJUnitJupiterSpringTests {
	// class body...
}
1 指定配置类。 
@SpringJUnitConfig(TestConfig::class) (1)
class ConfigurationClassJUnitJupiterSpringTests {
	// class body...
}
1 指定配置类。

以下示例演示如何使用 @SpringJUnitConfig 注解指定配置文件的位置

  • Java

  • Kotlin

@SpringJUnitConfig(locations = "/test-config.xml") (1)
class XmlJUnitJupiterSpringTests {
	// class body...
}
1 指定配置文件的位置。 
@SpringJUnitConfig(locations = ["/test-config.xml"]) (1)
class XmlJUnitJupiterSpringTests {
	// class body...
}
1 指定配置文件的位置。

有关更多详细信息，请参阅上下文管理以及 @SpringJUnitConfig 和 @ContextConfiguration 的 javadoc。

@SpringJUnitWebConfig

@SpringJUnitWebConfig 是一个组合注解，它将 JUnit Jupiter 的 @ExtendWith(SpringExtension.class) 与 Spring TestContext Framework 的 @ContextConfiguration 和 @WebAppConfiguration 结合在一起。你可以在类级别使用它，作为 @ContextConfiguration 和 @WebAppConfiguration 的直接替代。在配置选项方面，@ContextConfiguration 和 @SpringJUnitWebConfig 唯一的区别是，你可以在 @SpringJUnitWebConfig 中使用 value 属性声明组件类。此外，你只能通过在 @SpringJUnitWebConfig 中使用 resourcePath 属性来覆盖 @WebAppConfiguration 中的 value 属性。

以下示例演示如何使用 @SpringJUnitWebConfig 注解指定配置类

  • Java

  • Kotlin

@SpringJUnitWebConfig(TestConfig.class) (1)
class ConfigurationClassJUnitJupiterSpringWebTests {
	// class body...
}
1 指定配置类。 
@SpringJUnitWebConfig(TestConfig::class) (1)
class ConfigurationClassJUnitJupiterSpringWebTests {
	// class body...
}
1 指定配置类。

以下示例演示如何使用 @SpringJUnitWebConfig 注解指定配置文件的位置

  • Java

  • Kotlin

@SpringJUnitWebConfig(locations = "/test-config.xml") (1)
class XmlJUnitJupiterSpringWebTests {
	// class body...
}
1 指定配置文件的位置。 
@SpringJUnitWebConfig(locations = ["/test-config.xml"]) (1)
class XmlJUnitJupiterSpringWebTests {
	// class body...
}
1 指定配置文件的位置。

有关更多详细信息，请参阅上下文管理以及 @SpringJUnitWebConfig、@ContextConfiguration 和 @WebAppConfiguration 的 javadoc。

@TestConstructor

@TestConstructor 是一个注解，可以应用于测试类，以配置测试类构造函数的参数如何从测试的 ApplicationContext 中的组件自动装配。

如果测试类上不存在或未元存在 @TestConstructor，则将使用默认的 测试构造函数自动装配模式。有关如何更改默认模式的详细信息，请参阅下面的提示。请注意，构造函数上本地声明的 @Autowired、@jakarta.inject.Inject 或 @javax.inject.Inject 优先于 @TestConstructor 和默认模式。

更改默认测试构造函数自动装配模式

可以通过将 spring.test.constructor.autowire.mode JVM 系统属性设置为 all 来更改默认的 测试构造函数自动装配模式。此外，也可以通过 SpringProperties 机制设置默认模式。

默认模式也可以配置为 JUnit Platform 配置参数。

如果未设置 spring.test.constructor.autowire.mode 属性，则测试类构造函数将不会自动装配。
@TestConstructor 仅支持与 JUnit Jupiter 一起使用的 SpringExtension。请注意，SpringExtension 通常会自动为你注册——例如，当使用 @SpringJUnitConfig 和 @SpringJUnitWebConfig 等注解或 Spring Boot Test 中的各种测试相关注解时。

@NestedTestConfiguration

@NestedTestConfiguration 是一个注解，可以应用于测试类，以配置如何在内部测试类的封闭类层次结构中处理 Spring 测试配置注解。

如果在测试类本身、其超类层次结构或其封闭类层次结构中不存在或未元存在 @NestedTestConfiguration，则将使用默认的 封闭配置继承模式。有关如何更改默认模式的详细信息，请参阅下面的提示。

更改默认封闭配置继承模式

默认的 封闭配置继承模式 是 INHERIT，但可以通过将 spring.test.enclosing.configuration JVM 系统属性设置为 OVERRIDE 来更改。此外，也可以通过 SpringProperties 机制设置默认模式。

Spring TestContext Framework 遵循以下注解的 @NestedTestConfiguration 语义。

@NestedTestConfiguration 的使用通常仅在与 JUnit Jupiter 中的 @Nested 测试类结合使用时才有意义；但是，可能存在其他支持 Spring 和嵌套测试类的测试框架使用了此注解。

有关示例和更多详细信息，请参阅@Nested 测试类配置。

@EnabledIf

@EnabledIf 用于表示如果提供的 expression 计算结果为 true，则带注解的 JUnit Jupiter 测试类或测试方法将被启用并应运行。具体来说，如果表达式计算结果为 Boolean.TRUE 或与 true 相等（不区分大小写）的 String，则测试被启用。当应用于类级别时，默认情况下，该类中的所有测试方法也会自动启用。

表达式可以是以下任何一种

  • Spring Expression Language (SpEL) 表达式。例如：@EnabledIf("#{systemProperties['os.name'].toLowerCase().contains('mac')}")

  • Spring Environment 中可用属性的占位符。例如：@EnabledIf("${smoke.tests.enabled}")

  • 文本字面量。例如：@EnabledIf("true")

但请注意，不是动态解析属性占位符结果的文本字面量没有任何实际价值，因为 @EnabledIf("false") 等同于 @Disabled，而 @EnabledIf("true") 在逻辑上没有意义。

你可以使用 @EnabledIf 作为元注解创建自定义组合注解。例如，你可以按如下方式创建自定义 @EnabledOnMac 注解

  • Java

  • Kotlin

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@EnabledIf(
	expression = "#{systemProperties['os.name'].toLowerCase().contains('mac')}",
	reason = "Enabled on Mac OS"
)
public @interface EnabledOnMac {}
@Target(AnnotationTarget.TYPE, AnnotationTarget.FUNCTION)
@Retention(AnnotationRetention.RUNTIME)
@EnabledIf(
		expression = "#{systemProperties['os.name'].toLowerCase().contains('mac')}",
		reason = "Enabled on Mac OS"
)
annotation class EnabledOnMac {}

@EnabledOnMac 仅作为可能性的一个示例。如果你有完全相同的用例，请使用 JUnit Jupiter 内置的 @EnabledOnOs(MAC) 支持。

从 JUnit 5.7 开始，JUnit Jupiter 也具有名为 @EnabledIf 的条件注解。因此，如果你希望使用 Spring 的 @EnabledIf 支持，请确保从正确的包导入注解类型。

@DisabledIf

@DisabledIf 用于表示如果提供的 expression 计算结果为 true，则带注解的 JUnit Jupiter 测试类或测试方法将被禁用且不应运行。具体来说，如果表达式计算结果为 Boolean.TRUE 或与 true 相等（不区分大小写）的 String，则测试被禁用。当应用于类级别时，该类中的所有测试方法也会自动禁用。

表达式可以是以下任何一种

  • Spring Expression Language (SpEL) 表达式。例如：@DisabledIf("#{systemProperties['os.name'].toLowerCase().contains('mac')}")

  • Spring Environment 中可用属性的占位符。例如：@DisabledIf("${smoke.tests.disabled}")

  • 文本字面量。例如：@DisabledIf("true")

但请注意，不是动态解析属性占位符结果的文本字面量没有任何实际价值，因为 @DisabledIf("true") 等同于 @Disabled，而 @DisabledIf("false") 在逻辑上没有意义。

你可以使用 @DisabledIf 作为元注解创建自定义组合注解。例如，你可以按如下方式创建自定义 @DisabledOnMac 注解

  • Java

  • Kotlin

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@DisabledIf(
	expression = "#{systemProperties['os.name'].toLowerCase().contains('mac')}",
	reason = "Disabled on Mac OS"
)
public @interface DisabledOnMac {}
@Target(AnnotationTarget.TYPE, AnnotationTarget.FUNCTION)
@Retention(AnnotationRetention.RUNTIME)
@DisabledIf(
		expression = "#{systemProperties['os.name'].toLowerCase().contains('mac')}",
		reason = "Disabled on Mac OS"
)
annotation class DisabledOnMac {}

@DisabledOnMac 仅作为可能性的一个示例。如果你有完全相同的用例，请使用 JUnit Jupiter 内置的 @DisabledOnOs(MAC) 支持。

从 JUnit 5.7 开始，JUnit Jupiter 也具有名为 @DisabledIf 的条件注解。因此，如果你希望使用 Spring 的 @DisabledIf 支持，请确保从正确的包导入注解类型。