Spring JUnit Jupiter 测试注解

以下注解在与 SpringExtension 和 JUnit Jupiter（即 JUnit 5 中的编程模型）结合使用时受支持。

@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 平台配置参数。

如果未设置 spring.test.constructor.autowire.mode 属性，则不会自动自动装配测试类构造函数。
@TestConstructor 仅在与 SpringExtension 结合使用以用于 JUnit Jupiter 时受支持。请注意，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 表达式语言 (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用于指示被注解的 JUnit Jupiter 测试类或测试方法被禁用，并且如果提供的expression计算结果为true，则不应运行。具体来说，如果表达式的计算结果为Boolean.TRUE或等于true的String（忽略大小写），则测试将被禁用。当在类级别应用时，该类中的所有测试方法也会自动禁用。

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

  • Spring 表达式语言 (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支持，请确保从正确的包中导入注解类型。