SpringMVC单元测试-MockMvc

一 简介

 MockMvc实现对Http请求的模拟，能够方便对Controller进行测试，使得测试速度快、不依赖网络环境，并且提供验证的工具，使得请求的验证统一并且很方便。

 

二 常见使用方式

1 MockMvcBuilder构造MockMvc的构造器

2 MockMvcRequestBuilders建立请求request

3 mockMvc调用perform，执行一个request请求，调用controller的业务处理逻辑，返回ResultActions

4 能够经过ResultActions, MockMvcResultMatchers对结果进行验证

示例：

@RunWith(SpringRunner.class)
@SpringBootTest
@TestExecutionListeners({ MockitoTestExecutionListener.class}) // 使用@MockBean, @SpyBean
public abstract class AbstractBaseTest extends AbstractJUnit4SpringContextTests {
    protected static final Logger LOG = LogUtils.get();
}
  
public class MockMvcDemo extends AbstractBaseTest {
    private MockMvc mvc;
 
    @Before
    public void setUp() {
        mvc = MockMvcBuilders.standaloneSetup(new AccountController()).build();
    }
 
    @Test
    public void test() throws Exception {
        // 构建请求
        MockHttpServletRequestBuilder request = MockMvcRequestBuilders.get("/account/info")
                .contentType("text/html")
                .accept(MediaType.APPLICATION_JSON);
 
        // 发送请求，获取请求结果
        ResultActions perform = mvc.perform(request);
 
        // 请求结果校验
        perform.andExpect(MockMvcResultMatchers.status().isOk());
 
        MvcResult mvcResult = perform.andReturn();
        MockHttpServletResponse response = mvcResult.getResponse();
 
        // 校验类：org.springframework.test.web.servlet.result.MockMvcResultMatchers
    }
}

　　

1 MockMvcBuilder

MockMvcBuilder是MockMvc的构造器，主要有两个实现：StandaloneMockMvcBuilder和DefaultMockMvcBuilder。

① MockMvcBuilders.webAppContextSetup(WebApplicationContext context)：集成Web环境方式，指定WebApplicationContext，将会从该上下文获取相应的控制器并获得相应的MockMvc；

② MockMvcBuilders.standaloneSetup(Object... controllers)：独立测试方式，经过参数指定一组控制器，这样就不须要从上下文获取了，好比this.mockMvc =MockMvcBuilders.standaloneSetup(new AccountController()).build();

 

2 MockMvcRequestBuilders

MockMvcRequestBuilders用于构建请求，返回MockHttpServletRequestBuilder / MockMultipartHttpServletRequestBuilder ，

MockMvcRequestBuilders经常使用API：

MockHttpServletRequestBuilder get(String urlTemplate, Object... urlVariables)：根据uri模板和uri变量值获得一个GET请求方式的MockHttpServletRequestBuilder；如get(/user/{id}, 1L)；

MockHttpServletRequestBuilder post(String urlTemplate, Object... urlVariables)：同get相似，可是是POST方法；

MockHttpServletRequestBuilder put(String urlTemplate, Object... urlVariables)：同get相似，可是是PUT方法；

MockHttpServletRequestBuilder delete(String urlTemplate, Object... urlVariables) ：同get相似，可是是DELETE方法；

MockHttpServletRequestBuilder options(String urlTemplate, Object... urlVariables)：同get相似，可是是OPTIONS方法；

MockHttpServletRequestBuilder request(HttpMethod httpMethod, String urlTemplate, Object... urlVariables)： 提供本身的Http请求方法及uri模板和uri变量，如上API都是委托给这个API；

MockMultipartHttpServletRequestBuilder fileUpload(String urlTemplate, Object... urlVariables)：提供文件上传方式的请求，获得MockMultipartHttpServletRequestBuilder；

RequestBuilder asyncDispatch(final MvcResult mvcResult)：建立一个从启动异步处理的请求的MvcResult进行异步分派的RequestBuilder；

MockHttpServletRequestBuilder经常使用API：

MockHttpServletRequestBuilder header(String name, Object... values)/MockHttpServletRequestBuilder headers(HttpHeaders httpHeaders)：添加头信息；

MockHttpServletRequestBuilder contentType(MediaType mediaType)：指定请求的contentType头信息；

MockHttpServletRequestBuilder accept(MediaType... mediaTypes)/MockHttpServletRequestBuilder accept(String... mediaTypes)：指定请求的Accept头信息；

MockHttpServletRequestBuilder content(byte[] content)/MockHttpServletRequestBuilder content(String content)：指定请求Body体内容；

MockHttpServletRequestBuilder cookie(Cookie... cookies)：指定请求的Cookie；

MockHttpServletRequestBuilder locale(Locale locale)：指定请求的Locale；

MockHttpServletRequestBuilder characterEncoding(String encoding)：指定请求字符编码；

MockHttpServletRequestBuilder requestAttr(String name, Object value) ：设置请求属性数据；

MockHttpServletRequestBuilder sessionAttr(String name, Object value)/MockHttpServletRequestBuilder sessionAttrs(Map<string, object=""> sessionAttributes)：设置请求session属性数据；

MockHttpServletRequestBuilder flashAttr(String name, Object value)/MockHttpServletRequestBuilder flashAttrs(Map<string, object=""> flashAttributes)：指定请求的flash信息，好比重定向后的属性信息；

MockHttpServletRequestBuilder session(MockHttpSession session) ：指定请求的Session；

MockHttpServletRequestBuilder principal(Principal principal) ：指定请求的Principal；

MockHttpServletRequestBuilder contextPath(String contextPath) ：指定请求的上下文路径，必须以“/”开头，且不能以“/”结尾；

MockHttpServletRequestBuilder pathInfo(String pathInfo) ：请求的路径信息，必须以“/”开头；

MockHttpServletRequestBuilder secure(boolean secure)：请求是否使用安全通道；

MockHttpServletRequestBuilder with(RequestPostProcessor postProcessor)：请求的后处理器，用于自定义一些请求处理的扩展点；

MockMultipartHttpServletRequestBuilder继承自MockHttpServletRequestBuilder，又提供了以下API：

MockMultipartHttpServletRequestBuilder file(String name, byte[] content)/MockMultipartHttpServletRequestBuilder file(MockMultipartFile file)：指定要上传的文件；

示例：

MockHttpServletRequestBuilder request = MockMvcRequestBuilders.get("/account/info")
.contentType("text/html")
.accept(MediaType.APPLICATION_JSON);

 

3 ResultActions

MockMvc.perform(RequestBuilder requestBuilder)调用后返回ResultActions：

ResultActions.andExpect：添加执行完成后的断言。添加ResultMatcher验证规则，验证控制器执行完成后结果是否正确；

ResultActions.andDo：添加一个结果处理器，好比此处使用.andDo(MockMvcResultHandlers.print())输出整个响应结果信息，能够在调试的时候使用；

ResultActions.andReturn：表示执行完成后返回相应的结果，用于自定义验证/下一步的异步处理；

 

4 ResultMatchers

ResultMatcher验证匹配执行完请求后的结果，只有一个match(MvcResult result)断言方法，若是匹配失败将抛出相应的异常。

spring mvc测试框架提供了不少***ResultMatchers来知足测试需求，能够经过MockMvcResultMatchers查看内置ResultMatcher。（注意：***ResultMatchers不是ResultMatcher的实现子类）

HandlerResultMatchers handler()：请求的Handler验证器，好比验证处理器类型/方法名；此处的Handler其实就是处理请求的控制器；

RequestResultMatchers request()：获得RequestResultMatchers验证器；

ModelResultMatchers model()：获得模型验证器；

ViewResultMatchers view()：获得视图验证器；

FlashAttributeResultMatchers flash()：获得Flash属性验证；

StatusResultMatchers status()：获得响应状态验证器；

HeaderResultMatchers header()：获得响应Header验证器；

CookieResultMatchers cookie()：获得响应Cookie验证器；

ContentResultMatchers content()：获得响应内容验证器；

JsonPathResultMatchers jsonPath(String expression, Object ... args)/ResultMatcher jsonPath(String expression, Matcher matcher)：获得Json表达式验证器；

XpathResultMatchers xpath(String expression, Object... args)/XpathResultMatchers xpath(String expression, Map<string, string=""> namespaces, Object... args)：获得Xpath表达式验证器；

ResultMatcher forwardedUrl(final String expectedUrl)：验证处理完请求后转发的url（绝对匹配）；

ResultMatcher forwardedUrlPattern(final String urlPattern)：验证处理完请求后转发的url（Ant风格模式匹配，@since spring4）；

ResultMatcher redirectedUrl(final String expectedUrl)：验证处理完请求后重定向的url（绝对匹配）；

ResultMatcher redirectedUrlPattern(final String expectedUrl)：验证处理完请求后重定向的url（Ant风格模式匹配，@since spring4）；

 

5 MvcResult

MvcResult为执行完控制器后获得的整个结果，并不单单是返回值，其包含了测试时须要的全部信息。

MockHttpServletRequest getRequest()：获得执行的请求；

MockHttpServletResponse getResponse()：获得执行后的响应；

Object getHandler()：获得执行的处理器，通常就是控制器；

HandlerInterceptor[] getInterceptors()：获得对处理器进行拦截的拦截器；

ModelAndView getModelAndView()：获得执行后的ModelAndView；

Exception getResolvedException()：获得HandlerExceptionResolver解析后的异常；

FlashMap getFlashMap()：获得FlashMap；

Object getAsyncResult()/Object getAsyncResult(long timeout)：获得异步执行的结果；

 

四 相关连接

官方文档

Spring MVC测试框架详解——服务端测试

SpringMVC 测试 mockMVC