使用 MockMvc 在 @BeforeAll 静态方法中进行测试

在 Spring Boot 集成测试中，我们经常需要在测试开始前进行一些初始化操作，例如创建测试数据。@BeforeAll 注解可以帮助我们在所有测试方法执行前执行一次初始化方法。 然而，在使用 MockMvc 在 @BeforeAll 方法中发送 API 请求时，可能会遇到一些问题。本文将详细介绍如何正确地使用 MockMvc 在 @BeforeAll 方法中进行测试。

首先，需要明确的是，@BeforeAll 注解的方法必须是非私有的 (non-private)。这是 JUnit 5 的一个限制。 如果方法被声明为 private，JUnit 5 将无法识别并执行该方法。

以下是一个示例：

import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.MediaType;
import org.springframework.test.context.ActiveProfiles;
import org.springframework.test.web.servlet.MockMvc;
import com.google.gson.Gson;
import java.util.HashMap;
import java.util.Map;

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@SpringBootTest
@AutoConfigureMockMvc
@ActiveProfiles("test")
public class ExampleResourceTest {

    @Autowired
    private MockMvc mockMvc;

    private static MockMvc staticMockMvc;

    @BeforeAll
    static void setup(@Autowired MockMvc mockMvc) throws Exception {
        staticMockMvc = mockMvc;
        Map requestBody = new HashMap<>();

        requestBody.put("email", "test@example.com");
        requestBody.put("username", "example");
        requestBody.put("firstName", "Example");
        requestBody.put("lastName", "Name");
        requestBody.put("password", "@password123");

        Gson gson = new Gson();

        String json = gson.toJson(requestBody);

        staticMockMvc.perform(
                    post("/api/v1/resourcename")
                            .contentType(MediaType.APPLICATION_JSON)
                            .content(json))
                .andExpect(status().isOk()); // 假设返回 200 OK
    }

    @Test
    void someTest() throws Exception {
        // 使用 staticMockMvc 进行后续测试
        staticMockMvc.perform(post("/api/v1/anotherResource"))
                .andExpect(status().isOk());
    }
}

注意事项：

1. @BeforeAll 方法必须是 static 的。 由于 static 方法不能直接访问实例变量，我们需要将 MockMvc 声明为 static，并在 @BeforeAll 方法中进行初始化。
2. 依赖注入： 使用 @Autowired 将 MockMvc 注入到 @BeforeAll 方法的参数中。这样可以确保在静态方法中可以使用 MockMvc。
3. 异常处理： 在 @BeforeAll 方法中，需要处理可能抛出的异常，例如 Exception。
4. 状态码验证： 在发送 API 请求后，应该验证返回的状态码是否符合预期，以确保请求成功。

总结：

通过将 @BeforeAll 方法设置为 static 且非私有，并将 MockMvc 通过依赖注入的方式传递到该方法中，我们可以成功地在测试初始化阶段使用 MockMvc 发送 API 请求。 确保在发送请求后进行状态码验证，以确保请求成功。这种方法可以帮助我们更好地组织和管理集成测试，提高测试效率。