测试元注解支持

你可以将大多数与测试相关的注解用作 元注解 来创建自定义组合注解，并减少整个测试套件中的配置重复。

你可以将以下每个注解与 TestContext 框架 结合使用，作为元注解。

  • @BootstrapWith

  • @ContextConfiguration

  • @ContextHierarchy

  • @ContextCustomizerFactories

  • @ActiveProfiles

  • @TestPropertySource

  • @DirtiesContext

  • @WebAppConfiguration

  • @TestExecutionListeners

  • @Transactional

  • @BeforeTransaction

  • @AfterTransaction

  • @Commit

  • @Rollback

  • @Sql

  • @SqlConfig

  • @SqlMergeMode

  • @SqlGroup

  • @Repeat （仅在 JUnit 4 上受支持）

  • @Timed （仅在 JUnit 4 上受支持）

  • @IfProfileValue （仅在 JUnit 4 上受支持）

  • @ProfileValueSourceConfiguration （仅在 JUnit 4 上受支持）

  • @SpringJUnitConfig （仅在 JUnit Jupiter 上受支持）

  • @SpringJUnitWebConfig （仅在 JUnit Jupiter 上受支持）

  • @TestConstructor （仅在 JUnit Jupiter 上受支持）

  • @NestedTestConfiguration （仅在 JUnit Jupiter 上受支持）

  • @EnabledIf （仅在 JUnit Jupiter 上受支持）

  • @DisabledIf （仅在 JUnit Jupiter 上受支持）

考虑以下示例

  • Java

  • Kotlin

@RunWith(SpringRunner.class)
@ContextConfiguration({"/app-config.xml", "/test-data-access-config.xml"})
@ActiveProfiles("dev")
@Transactional
public class OrderRepositoryTests { }

@RunWith(SpringRunner.class)
@ContextConfiguration({"/app-config.xml", "/test-data-access-config.xml"})
@ActiveProfiles("dev")
@Transactional
public class UserRepositoryTests { }
@RunWith(SpringRunner::class)
@ContextConfiguration("/app-config.xml", "/test-data-access-config.xml")
@ActiveProfiles("dev")
@Transactional
class OrderRepositoryTests { }

@RunWith(SpringRunner::class)
@ContextConfiguration("/app-config.xml", "/test-data-access-config.xml")
@ActiveProfiles("dev")
@Transactional
class UserRepositoryTests { }

如果我们发现我们在 JUnit 4 测试套件中重复了前面的配置，我们可以通过引入一个自定义复合注释来减少重复，该注释集中了 Spring 的常见测试配置，如下所示

  • Java

  • Kotlin

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@ContextConfiguration({"/app-config.xml", "/test-data-access-config.xml"})
@ActiveProfiles("dev")
@Transactional
public @interface TransactionalDevTestConfig { }
@Target(AnnotationTarget.TYPE)
@Retention(AnnotationRetention.RUNTIME)
@ContextConfiguration("/app-config.xml", "/test-data-access-config.xml")
@ActiveProfiles("dev")
@Transactional
annotation class TransactionalDevTestConfig { }

然后，我们可以使用自定义 @TransactionalDevTestConfig 注释来简化基于 JUnit 4 的各个测试类的配置，如下所示

  • Java

  • Kotlin

@RunWith(SpringRunner.class)
@TransactionalDevTestConfig
public class OrderRepositoryTests { }

@RunWith(SpringRunner.class)
@TransactionalDevTestConfig
public class UserRepositoryTests { }
@RunWith(SpringRunner::class)
@TransactionalDevTestConfig
class OrderRepositoryTests

@RunWith(SpringRunner::class)
@TransactionalDevTestConfig
class UserRepositoryTests

如果我们编写使用 JUnit Jupiter 的测试，我们可以进一步减少代码重复，因为 JUnit 5 中的注释也可以用作元注释。考虑以下示例

  • Java

  • Kotlin

@ExtendWith(SpringExtension.class)
@ContextConfiguration({"/app-config.xml", "/test-data-access-config.xml"})
@ActiveProfiles("dev")
@Transactional
class OrderRepositoryTests { }

@ExtendWith(SpringExtension.class)
@ContextConfiguration({"/app-config.xml", "/test-data-access-config.xml"})
@ActiveProfiles("dev")
@Transactional
class UserRepositoryTests { }
@ExtendWith(SpringExtension::class)
@ContextConfiguration("/app-config.xml", "/test-data-access-config.xml")
@ActiveProfiles("dev")
@Transactional
class OrderRepositoryTests { }

@ExtendWith(SpringExtension::class)
@ContextConfiguration("/app-config.xml", "/test-data-access-config.xml")
@ActiveProfiles("dev")
@Transactional
class UserRepositoryTests { }

如果我们发现我们在基于 JUnit Jupiter 的测试套件中重复了前面的配置，我们可以通过引入一个自定义复合注释来减少重复，该注释集中了 Spring 和 JUnit Jupiter 的常见测试配置，如下所示

  • Java

  • Kotlin

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@ExtendWith(SpringExtension.class)
@ContextConfiguration({"/app-config.xml", "/test-data-access-config.xml"})
@ActiveProfiles("dev")
@Transactional
public @interface TransactionalDevTestConfig { }
@Target(AnnotationTarget.TYPE)
@Retention(AnnotationRetention.RUNTIME)
@ExtendWith(SpringExtension::class)
@ContextConfiguration("/app-config.xml", "/test-data-access-config.xml")
@ActiveProfiles("dev")
@Transactional
annotation class TransactionalDevTestConfig { }

然后，我们可以使用自定义 @TransactionalDevTestConfig 注释来简化基于 JUnit Jupiter 的各个测试类的配置，如下所示

  • Java

  • Kotlin

@TransactionalDevTestConfig
class OrderRepositoryTests { }

@TransactionalDevTestConfig
class UserRepositoryTests { }
@TransactionalDevTestConfig
class OrderRepositoryTests { }

@TransactionalDevTestConfig
class UserRepositoryTests { }

由于 JUnit Jupiter 支持将 @Test、@RepeatedTest、ParameterizedTest 等用作元注释，因此您还可以在测试方法级别创建自定义复合注释。例如，如果我们希望创建一个复合注释，将 JUnit Jupiter 中的 @Test 和 @Tag 注释与 Spring 中的 @Transactional 注释结合起来，我们可以创建一个 @TransactionalIntegrationTest 注释，如下所示

  • Java

  • Kotlin

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Transactional
@Tag("integration-test") // org.junit.jupiter.api.Tag
@Test // org.junit.jupiter.api.Test
public @interface TransactionalIntegrationTest { }
@Target(AnnotationTarget.TYPE)
@Retention(AnnotationRetention.RUNTIME)
@Transactional
@Tag("integration-test") // org.junit.jupiter.api.Tag
@Test // org.junit.jupiter.api.Test
annotation class TransactionalIntegrationTest { }

然后我们可以使用我们的自定义 @TransactionalIntegrationTest 注解来简化基于 JUnit Jupiter 的各个测试方法的配置，如下所示

  • Java

  • Kotlin

@TransactionalIntegrationTest
void saveOrder() { }

@TransactionalIntegrationTest
void deleteOrder() { }
@TransactionalIntegrationTest
fun saveOrder() { }

@TransactionalIntegrationTest
fun deleteOrder() { }

有关更多详细信息，请参阅 Spring 注解编程模型 wiki 页面。