使用MockMvc来代替RestTemplate对Controller进行单元测试

最新推荐文章于 2025-04-15 15:44:19 发布

Alphathur

最新推荐文章于 2025-04-15 15:44:19 发布

阅读量1.3w

点赞数 2

CC 4.0 BY-SA版权

分类专栏： Java基础

本文链接：https://blog.youkuaiyun.com/mryang125/article/details/94023499

Java基础专栏收录该内容

15 篇文章

订阅专栏

本文探讨了在Java Spring框架下，使用MockMvc和RestTemplate进行Controller单元测试的区别。重点在于事务控制的有效性，指出MockMvc能有效利用@Transactional进行事务回滚，而RestTemplate则无法做到。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

对Controller进行单元测试可以通过RestTemplat发送一个http请求来实现。也可以通过MockMvc来实现，二者还是有很大区别的，参考Difference between MockMvc and RestTemplate in integration tests

简单来说，二者的直接区别是：

使用MockMvc，通常是设置一个完整的Web应用程序上下文，来模拟HTTP请求和响应，它创建的是一个假的DispatcherServlet来模拟MVC堆栈的运行方式，没有真正的网络连接。

使用RestTemplate，部署的是一个实际的Web服务器来监听您发送的HTTP请求，并响应结果。

但是二者还有个非常重要的差异：

使用MockMvc可以对Controller进行事务控制，即@Transactional在MockMvc的单元测试中是有效的。但是使用RestTemplate创建网络连接的测试，无法对Controller进行事务控制，即@Transactional在RestTemplate的单元测试中是无效的。

以下是代码演示：

原始的Controller：

@RestController
@RequestMapping("card")
public class CardController {

  private final CardCollectService cardCollectService;

  @PostMapping("collects")
  public HyCardCollect createCollect(@RequestBody HyCardCollect cardCollect) {
    return cardCollectService.createHyCardCollect(cardCollect);
  }

}

使用RestTemplate对Controller做单元测试：

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT)
@Transactional
@Slf4j
public class CardControllerRestTest {

  @Autowired
  private TestRestTemplate testRestTemplate;

  @Test
  public void testCardCollect() {
    ResponseEntity<PageInfo<HyCardSearchResult>> res = Utils
        .getRootLoginTemplate(testRestTemplate)
        .exchange("/card/collects", HttpMethod.POST,
            new HttpEntity<>(ImmutableMap.of("cardId", 20, "userId", 1, "companyId", "123")),
            new ParameterizedTypeReference<PageInfo<HyCardSearchResult>>() {
            });
    log.debug("resp status={}", res.getStatusCode());
    Assert.assertEquals(res.getStatusCode(), HttpStatus.OK);
  }
}

也可以使用MockMvc对Controller做单元测试，下面是个标准的范例：

@RunWith(SpringRunner.class)
@SpringBootTest
@Transactional
@Slf4j
public class CardControllerMockmvcTest {

  @Autowired
  private WebApplicationContext context;
  private MockMvc mvc;

  @Before
  public void setUp() throws Exception {
    mvc = MockMvcBuilders.webAppContextSetup(context).build();//å»ºè®®ä½¿ç¨è¿ç§
  }

  @Test
  public void testCardCollect() throws Exception {
    HyCardCollect collect = new HyCardCollect();
    collect.setCardId(20);
    collect.setUserId(1);
    collect.setCompanyId("123");

    MockHttpServletResponse response = mvc.perform(MockMvcRequestBuilders.post("/card/collects")
        .contentType(MediaType.APPLICATION_JSON_VALUE)
        .content(JSON.toJSONString(collect)))
        .andDo(MockMvcResultHandlers.print())
        .andReturn()
        .getResponse();
    Assert.assertEquals(HttpStatus.OK.value(), response.getStatus());
  }
}

执行CardControllerRestTest，运行结果：