SpringBoot 使用 @WebMvcTest 测试 MVC Web Controller

在 SpringBoot 中，我们可以使用 @WebMvcTest 注解来测试 MVC Web Controller。@WebMvcTest 注解提供了一种简单的方式来测试 Spring MVC 控制器，而不需要启动完整的应用程序上下文。本文将详细讲解 SpringBoot 使用 @WebMvcTest 测试 MVC Web Controller 的完整攻略，包括 @WebMvcTest 注解的基本概念、测试方法的编写、MockMvc 的使用等。

@WebMvcTest 注解的基本概念

@WebMvcTest 注解是 SpringBoot 提供的一个测试注解，用于测试 Spring MVC 控制器。使用 @WebMvcTest 注解时，SpringBoot 会自动配置 MockMvc 对象，并将其注入到测试类中。MockMvc 对象可以模拟 HTTP 请求和响应，用于测试 Spring MVC 控制器的行为和输出。

下面是一个简单的示例，演示了如何使用 @WebMvcTest 注解：

@RunWith(SpringRunner.class)
@WebMvcTest(HelloController.class)
public class HelloControllerTest {
  @Autowired
  private MockMvc mockMvc;

  @Test
  public void testHello() throws Exception {
    mockMvc.perform(get("/hello"))
           .andExpect(status().isOk())
           .andExpect(content().string("Hello, World!"));
  }
}

在上面的代码中，我们使用了 @RunWith 注解来指定测试运行器为 SpringRunner。然后，我们使用了 @WebMvcTest 注解来指定要测试的控制器为 HelloController。在测试方法中，我们使用了 mockMvc 对象来模拟 HTTP 请求，并使用了 MockMvcResultMatchers 类来验证响应的状态码和内容。

测试方法的编写

在编写测试方法时，我们需要注意以下几点：

1. 使用 @Autowired 注解将 MockMvc 对象注入到测试类中。
2. 使用 mockMvc 对象来模拟 HTTP 请求，并使用 MockMvcResultMatchers 类来验证响应的状态码和内容。
3. 使用 @Test 注解来标记测试方法。

下面是一个简单的示例，演示了如何编写测试方法：

@RunWith(SpringRunner.class)
@WebMvcTest(HelloController.class)
public class HelloControllerTest {
  @Autowired
  private MockMvc mockMvc;

  @Test
  public void testHello() throws Exception {
    mockMvc.perform(get("/hello"))
           .andExpect(status().isOk())
           .andExpect(content().string("Hello, World!"));
  }
}

在上面的代码中，我们编写了一个测试方法 testHello，用于测试 HelloController 的 hello 方法。在测试方法中，我们使用了 mockMvc 对象来模拟 HTTP 请求，并使用了 MockMvcResultMatchers 类来验证响应的状态码和内容。

MockMvc 的使用

MockMvc 是 Spring Framework 提供的一个用于测试 Spring MVC 控制器的工具类。MockMvc 可以模拟 HTTP 请求和响应，用于测试 Spring MVC 控制器的行为和输出。MockMvc 提供了多种方法来模拟 HTTP 请求，例如 get、post、put、delete 等。

下面是一个简单的示例，演示了如何使用 MockMvc：

@RunWith(SpringRunner.class)
@WebMvcTest(HelloController.class)
public class HelloControllerTest {
  @Autowired
  private MockMvc mockMvc;

  @Test
  public void testHello() throws Exception {
    mockMvc.perform(get("/hello"))
           .andExpect(status().isOk())
           .andExpect(content().string("Hello, World!"));
  }
}

在上面的代码中，我们使用了 mockMvc 对象来模拟 HTTP 请求，并使用了 get 方法来模拟 GET 请求。我们还使用了 andExpect 方法来验证响应的状态码和内容。

示例

下面是一个完整的 SpringBoot 使用 @WebMvcTest 测试 MVC Web Controller 的示例：

@RunWith(SpringRunner.class)
@WebMvcTest(HelloController.class)
public class HelloControllerTest {
  @Autowired
  private MockMvc mockMvc;

  @Test
  public void testHello() throws Exception {
    mockMvc.perform(get("/hello"))
           .andExpect(status().isOk())
           .andExpect(content().string("Hello, World!"));
  }
}

@Controller
public class HelloController {
  @GetMapping("/hello")
  @ResponseBody
  public String hello() {
    return "Hello, World!";
  }
}

在上面的代码中，我们创建了一个 HelloController 类，用于处理 /hello 请求。在测试类中，我们使用了 @WebMvcTest 注解来指定要测试的控制器为 HelloController。在测试方法中，我们使用了 mockMvc 对象来模拟 HTTP 请求，并使用了 MockMvcResultMatchers 类来验证响应的状态码和内容。