如何详细解析Mock测试Spring MVC接口的步骤？

本文共计1139个文字，预计阅读时间需要5分钟。

1. 前言：在Java开发中，许多接触接口的开发者往往不太重视对接口的测试，结果在联调对接口中出现各种问题。也有使用Postman等工具进行测试，但在使用上似乎没有遇到什么问题，一旦接口增加了权限，问题便显现出来。

1. 前言

在Java开发中接触的开发者大多数不太注重对接口的测试，结果在联调对接中出现各种问题。也有的使用Postman等工具进行测试，虽然在使用上没有什么问题，如果接口增加了权限测试起来就比较恶心了。所以建议在单元测试中测试接口，保证在交付前先自测接口的健壮性。今天就来分享一下胖哥在开发中是如何对Spring MVC接口进行测试的。

在开始前请务必确认添加了Spring Boot Test相关的组件，在最新的版本中应该包含以下依赖：

<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> <exclusions> <exclusion> <groupId>org.junit.vintage</groupId> <artifactId>junit-vintage-engine</artifactId> </exclusion> </exclusions> </dependency>

本文是在Spring Boot 2.3.4.RELEASE下进行的。

2. 单独测试控制层

如果我们只需要对控制层接口(Controller)进行测试，且该接口不依赖@Service、@Component等注解声明的Spring Bean时，可以借助@WebMvcTest来启用只针对Web控制层的测试，例如

@WebMvcTest class CustomSpringInjectApplicationTests { @Autowired MockMvc mockMvc; @SneakyThrows @Test void contextLoads() { mockMvc.perform(MockMvcRequestBuilders.get("/foo/map")) .andExpect(ResultMatcher.matchAll(status().isOk(), content().contentType(MediaType.APPLICATION_JSON), jsonPath("$.test", Is.is("hello")))) .andDo(MockMvcResultHandlers.print()); } }

这种方式要快的多，它只加载了应用程序的一小部分。但是如果你涉及到服务层这种方式是不凑效的，我们就需要另一种方式了。

3. 整体测试

大多数Spring Boot下的接口测试是整体而又全面的测试，涉及到控制层、服务层、持久层等方方面面，所以需要加载比较完整的Spring Boot上下文。这时我们可以这样做，声明一个抽象的测试基类：

package cn.felord.custom; 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.test.web.servlet.MockMvc; /** * 测试基类， * @author felord.cn */ @SpringBootTest @AutoConfigureMockMvc abstract class CustomSpringInjectApplicationTests { /** * The Mock mvc. */ @Autowired MockMvc mockMvc; // 其它公共依赖和处理方法 }

只有当@AutoConfigureMockMvc存在时MockMvc才会被注入Spring IoC。

然后针对具体的控制层进行如下测试代码的编写：

package cn.felord.custom; import lombok.SneakyThrows; import org.hamcrest.core.Is; import org.junit.jupiter.api.Test; import org.springframework.github.com/json-path/JsonPath了解。

对响应进行处理

ResultActions#andDo(ResultHandler handler)方法负责对整个请求/响应进行打印或者log输出、流输出，由MockMvcResultHandlers工具类提供这些方法。我们可以通过以上三种途径来查看请求响应的细节。

例如/foo/user接口：

MockHttpServletRequest: HTTP Method = GET Request URI = /foo/user Parameters = {name=[felord.cn], age=[18]} Headers = [Api-Version:"v1"] Body = null Session Attrs = {} Handler: Type = cn.felord.xbean.config.FooController Method = cn.felord.xbean.config.FooController#urlEncode(String, Params) Async: Async started = false Async result = null Resolved Exception: Type = null ModelAndView: View name = null View = null Model = null FlashMap: Attributes = null MockHttpServletResponse: Status = 200 Error message = null Headers = [Content-Type:"application/json"] Content type = application/json Body = {"test":"bar","version":"v1","username":"felord.cn"} Forwarded URL = null Redirected URL = null Cookies = []

获取返回结果

如果你希望进一步处理响应的结果，也可以通过ResultActions#andReturn()拿到MvcResult类型的结果进行进一步的处理。

完整的测试过程

通常andExpect是我们必然会选择的，而andDo和andReturn在某些场景下会有用，它们两个是可选的。我们把上面的连在一起。

@Autowired MockMvc mockMvc; @SneakyThrows @Test void contextLoads() { mockMvc.perform(MockMvcRequestBuilders.get("/foo/user") .param("name", "felord.cn") .param("age", "18") .header("Api-Version", "v1")) .andExpect(ResultMatcher.matchAll(status().isOk(), content().contentType(MediaType.APPLICATION_JSON), jsonPath("$.version", Is.is("v1")))) .andDo(MockMvcResultHandlers.print()); }

这种流式的接口单元测试从语义上看也是比较好理解的，你可以使用各种断言、正例、反例测试你的接口，最终让你的接口更加健壮。

5. 总结

一旦你熟练了这种方式，你编写的接口将更加具有权威性而不会再漏洞百出，甚至有时候你也可以使用Mock来设计接口，使之更加贴合业务。所以CRUD不是完全没有技术含量，高质量高效率的CRUD往往需要这种工程化的单元测试来支撑。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持易盾网络。