是否可以在没有 @DirtiesContext 的情况下测试 Spring REST 控制器？

Question

我正在开发一个 Spring-Boot Web 应用程序。编写集成测试的常用方法是：

@Test
@Transactional
@Rollback(true)
public void myTest() {
    // ...
}

只要只有 一个线程 工作，它就可以很好地工作。如果有多个线程，@Rollback 将无法工作。

但是，当使用 Spring REST 模板测试 @RestController 类时，总是多个线程（按设计）：

• 作为客户端运行 REST 模板的测试线程
• 接收和处理请求的服务器线程

因此，您不能在 REST 测试中使用 @Rollback。问题是：您改用什么来使测试可重复并让它们在测试套件中很好地发挥作用？

@DirtiesContext 有效，但这是一个糟糕的选择，因为在每个 REST 测试方法之后重新启动 Spring 应用程序上下文会使套件的执行速度非常慢；每个测试需要几毫秒才能运行，但重新启动上下文需要几秒钟。

Answer 1

首先，使用 Spring 上下文测试控制器不是单元测试。您应该考虑通过对依赖项使用模拟并创建standalone mock MVC 来为控制器编写单元测试：

public class MyControllerTest {
  @InjectMocks
  private MyController tested;
  // add @Mock annotated members for all dependencies used by the controller here
  private MockMvc mvc;

  // add your tests here using mvc.perform()
  @Test
  public void getHealthReturnsStatusAsJson() throws Exception {
    mvc.perform(get("/health"))
      .andExpect(status().isOk())
      .andExpect(content().contentTypeCompatibleWith(MediaType.APPLICATION_JSON))
      .andExpect(jsonPath("$.status", is("OK")));
  }

  @Before
  public void createControllerWithMocks() {
    MockitoAnnotations.initMocks(this);
    MockMvcBuilders.standaloneSetup(controller).build()
  }
}

如果您使用外部 @ControllerAdvice 进行错误处理等，这甚至可以通过在 MVC 构建器上调用 setControllerAdvice() 来实现。

这样的测试并行运行没有问题，而且速度更快，根本不需要设置 Spring 上下文。

您描述的部分集成测试对于确保使用正确的接线以及所有测试单元按预期协同工作也很有用。但我会更多地进行更通用的集成测试，包括多个/所有端点检查它们是否正常工作（不检查边缘情况）并模拟只接触外部的服务（如内部 REST 客户端，用内存中的一个替换数据库, ...)。通过此设置，您可以从一个新的数据库开始，甚至可能不需要回滚任何事务。这当然是使用像Liquibase 这样的数据库迁移框架最舒服的方法，它可以即时设置您的内存数据库。