使用MockMvc测试 Controller

概述

  对模块进行集成测试时，希望能够通过输入URL对Controller进行测试，如果通过启动服务器，建立http client进行测试，这样会使得测试变得很麻烦，比如，启动速度慢，测试验证不方便，依赖网络环境等，这样会导致测试无法进行，为了可以对Controller进行测试，可以通过引入MockMVC进行解决。

简介

  MockMvc实现了对Http请求的模拟，能够直接使用网络的形式，转换到Controller的调用，这样可以使得测试速度快、不依赖网络环境，而且提供了一套验证的工具，这样可以使得请求的验证统一而且很方便。

运行配置

用到的注解
1. RunWith(SpringJUnit4ClassRunner.class): 表示使用Spring Test组件进行单元测试;
2. @WebAppConfiguration: 使用这个Annotate会在跑单元测试的时候真实的启一个web服务，然后开始调用Controller的Rest API，待单元测试跑完之后再将web服务停掉;
3. @ContextConfiguration(locations{"classpath:/config/applicationContext.xml"}）:
指定Bean的配置文件信息，可以有多种方式，这个例子使用的是文件路径形式，如果有多个配置文件，可以将括号中的信息配置为一个字符串数组来表示;

基本框架

@RunWith(SpringJUnit4ClassRunner.class)   
@ContextConfiguration(locations = {"classpath:/config/applicationContext.xml","classpath:/config/spring-mvc.xml"})  //指定Bean的配置文件信息
@WebAppConfiguration  
public class MocPostTest {
    protected MockMvc mockMvc;

    @Autowired
    protected WebApplicationContext wac;

    @Before()  //这个方法在每个方法执行之前都会执行一遍
    public void setup()
    {
        mockMvc = MockMvcBuilders.webAppContextSetup(wac).build();  //初始化MockMvc对象
    }

    @Test
    public void getAllCategoryTest() throws Exception
    {

    }
}

测试接口的代码写在getAllCategoryTest方法中

 public void getAllCategoryTest() throws Exception
    {
        String responseString = mockMvc.perform
                (
                        MockMvcRequestBuilders.post("http://127.0.0.1:8888/login")          //请求的url,请求的方法是post
                                //get("/user/showUser2")          //请求的url,请求的方法是get
                                .contentType(MediaType.APPLICATION_FORM_URLENCODED)//发送数据的格式
                                .param("username","hyh")   //添加参数(可以添加多个)
                        .param("password","123")   //添加参数(可以添加多个)
                )
                //.andExpect(status().isOk())    //返回的状态是200
                .andDo(print())         //打印出请求和相应的内容
                .andReturn().getResponse().getContentAsString(); //将相应的数据转换为字符串
        System.out.println("-----返回的json = " + responseString);
    }

过程

1、mockMvc.perform执行一个请求；
2、MockMvcRequestBuilders.post(“http://127.0.0.1:8888/login“)构造一个请求
3、ResultActions.andExpect添加执行完成后的断言
4、ResultActions.andDo添加一个结果处理器，表示要对结果做点什么事情，比如此处使用MockMvcResultHandlers.print()输出整个响应结果信息。
5、ResultActions.andReturn表示执行完成后返回相应的结果。

详细描述

RequestBuilder/MockMvcRequestBuilders

从名字可以看出，RequestBuilder用来构建请求的，其提供了一个方法buildRequest(ServletContext servletContext)用于构建MockHttpServletRequest；其主要有两个子类MockHttpServletRequestBuilder和MockMultipartHttpServletRequestBuilder（如文件上传使用），即用来Mock客户端请求需要的所有数据。

1.MockMvcRequestBuilders主要API

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

• MockHttpServletRequestBuilder post(String urlTemplate, Object… urlVariables)：同get类似，但是是POST方法；
  提供自己的Http请求方法及uri模板和uri变量，如上API都是委托给这个API；

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

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

• MockHttpServletRequestBuilder和MockMultipartHttpServletRequestBuilder API
  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)：指定要上传的文件；

ResultActions

调用MockMvc.perform(RequestBuilder requestBuilder)后将得到ResultActions，通过ResultActions完成如下三件事：

• ResultActions andExpect(ResultMatcher matcher) ：添加验证断言来判断执行请求后的结果是否是预期的；
• ResultActions andDo(ResultHandler handler) ：添加结果处理器，用于对验证成功后执行的动作，如输出下请求/结果信息用于调试；
• MvcResult andReturn() ：返回验证成功后的MvcResult；用于自定义验证/下一步的异步处理；
• 
  ResultMatcher/MockMvcResultMatchers
  

  ResultMatcher用来匹配执行完请求后的结果验证，其就一个match(MvcResult result)断言方法，如果匹配失败将抛出相应的异常；spring mvc测试框架提供了很多***ResultMatchers来满足测试需求。注意这些***ResultMatchers并不是ResultMatcher的子类，而是返回ResultMatcher实例的。Spring mvc测试框架为了测试方便提供了MockMvcResultMatchers静态工厂方法方便操作；

具体的API如下：

• 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\

一些常用的测试

1.测试普通控制器

mockMvc.perform(get("/user/{id}", 1)) //执行请求  
            .andExpect(model().attributeExists("user")) //验证存储模型数据  
            .andExpect(view().name("user/view")) //验证viewName  
            .andExpect(forwardedUrl("/WEB-INF/jsp/user/view.jsp"))//验证视图渲染时forward到的jsp  
            .andExpect(status().isOk())//验证状态码  
            .andDo(print()); //输出MvcResult到控制台

2.得到MvcResult自定义验证

MvcResult result = mockMvc.perform(get("/user/{id}", 1))//执行请求 
        .andReturn(); //返回MvcResult 
Assert.assertNotNull(result.getModelAndView().getModel().get("user")); //自定义断言

3.验证请求参数绑定到模型数据及Flash属性

mockMvc.perform(post("/user").param("name", "zhang")) //执行传递参数的POST请求(也可以post("/user?name=zhang"))  
            .andExpect(handler().handlerType(UserController.class)) //验证执行的控制器类型  
            .andExpect(handler().methodName("create")) //验证执行的控制器方法名  
            .andExpect(model().hasNoErrors()) //验证页面没有错误  
            .andExpect(flash().attributeExists("success")) //验证存在flash属性  
            .andExpect(view().name("redirect:/user")); //验证视图 

4.文件上传

byte[] bytes = new byte[] {1, 2}; 
mockMvc.perform(fileUpload("/user/{id}/icon", 1L).file("icon", bytes)) //执行文件上传  
        .andExpect(model().attribute("icon", bytes)) //验证属性相等性  
        .andExpect(view().name("success")); //验证视图 
5.JSON请求/响应验证
String requestBody = "{\"id\":1, \"name\":\"zhang\"}"; 
    mockMvc.perform(post("/user")  
            .contentType(MediaType.APPLICATION_JSON).content(requestBody)  
            .accept(MediaType.APPLICATION_JSON)) //执行请求  
            .andExpect(content().contentType(MediaType.APPLICATION_JSON)) //验证响应contentType  
            .andExpect(jsonPath("$.id").value(1)); //使用Json path验证JSON 请参考http://goessner.net/articles/JsonPath/ 
    String errorBody = "{id:1, name:zhang}"; 
    MvcResult result = mockMvc.perform(post("/user")  
            .contentType(MediaType.APPLICATION_JSON).content(errorBody)  
            .accept(MediaType.APPLICATION_JSON)) //执行请求  
            .andExpect(status().isBadRequest()) //400错误请求  
            .andReturn(); 
    Assert.assertTrue(HttpMessageNotReadableException.class.isAssignableFrom(result.getResolvedException().getClass()));//错误的请求内容体

6.异步测试
　　//Callable

 MvcResult result = mockMvc.perform(get("/user/async1?id=1&name=zhang")) //执行请求  
            .andExpect(request().asyncStarted())  
            .andExpect(request().asyncResult(CoreMatchers.instanceOf(User.class))) //默认会等10秒超时  
            .andReturn(); 

    mockMvc.perform(asyncDispatch(result))  
            .andExpect(status().isOk())  
            .andExpect(content().contentType(MediaType.APPLICATION_JSON))  
            .andExpect(jsonPath("$.id").value(1)); 


最后说明一点就是该测试是基于项目环境的，就是说只能测试这个项目的接口，不能测试其他的接口！