• -------------------------------------------------------------
  • ====================================

SpringMVC 测试 mockMVC

技能 dewbay 5年前 (2019-08-20) 1708次浏览 已收录 1个评论 扫描二维码

SpringMVC 测试框架

基于 RESTful 风格的 SpringMVC 的测试,我们可以测试完整的 Spring MVC 流程,即从 URL 请求到控制器处理,再到视图渲染都可以测试。

一 MockMvcBuilder

MockMvcBuilder 是用来构造 MockMvc 的构造器,其主要有两个实现:StandaloneMockMvcBuilder 和 DefaultMockMvcBuilder,分别对应两种测试方式,即独立安装和集成 Web 环境测试(此种方式并不会集成真正的 web 环境,而是通过相应的 Mock API 进行模拟测试,无须启动服务器)。对于我们来说直接使用静态工厂 MockMvcBuilders 创建即可。

1.集成 Web 环境方式

MockMvcBuilders.webAppContextSetup(WebApplicationContext context):指定 WebApplicationContext,将会从该上下文获取相应的控制器并得到相应的 MockMvc;

SpringMVC 测试 mockMVC
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration("classpath:config/IncotermsRestServiceTest-context.xml")
@WebAppConfiguration
public class IncotermsRestServiceTest {
    @Autowired
    private WebApplicationContext wac;
    private MockMvc mockMvc;
    @Before
    public void setup() {
        this.mockMvc = MockMvcBuilders.webAppContextSetup(this.wac).build();   //构造 MockMvc
    }
    ...
}
SpringMVC 测试 mockMVC

注意:
(1)@WebAppConfiguration:测试环境使用,用来表示测试环境使用的 ApplicationContext 将是 WebApplicationContext 类型的;value 指定 web 应用的根;
(2)通过@Autowired WebApplicationContext wac:注入 web 环境的 ApplicationContext 容器;
(3)然后通过 MockMvcBuilders.webAppContextSetup(wac).build()创建一个 MockMvc 进行测试;

2.独立测试方式

MockMvcBuilders.standaloneSetup(Object… controllers):通过参数指定一组控制器,这样就不需要从上下文获取了;

SpringMVC 测试 mockMVC
public class PricingExportResultsRestServiceTest {
    @InjectMocks
    private PricingExportResultsRestService pricingExportResultsRestService;
    @Mock
    private ExportRateScheduleService exportRateScheduleService;
    @Mock
    private PricingUrlProvider pricingUrlProvider;

    private MockMvc mockMvc;

    @Before
    public void setup() {
        MockitoAnnotations.initMocks(this);
        mockMvc = MockMvcBuilders.standaloneSetup(pricingExportResultsRestService).build();  //构造 MockMvc
    }
    ...
}
SpringMVC 测试 mockMVC

主要是两个步骤:
(1)首先自己创建相应的控制器,注入相应的依赖
(2)通过 MockMvcBuilders.standaloneSetup 模拟一个 Mvc 测试环境,通过 build 得到一个 MockMvc

 

二 MockMvc

先看一个测试例子 1:

SpringMVC 测试 mockMVC
  @Test
    public void createIncotermSuccess() throws Exception {
        IncotermTo createdIncoterm = new IncotermTo();
        createdIncoterm.setId(new IncotermId(UUID.fromString("6305ff33-295e-11e5-ae37-54ee7534021a")));
        createdIncoterm.setCode("EXW");
        createdIncoterm.setDescription("code exw");
        createdIncoterm.setLocationQualifier(LocationQualifier.DEPARTURE);

        when(inventoryService.create(any(IncotermTo.class))).thenReturn(createdIncoterm);

        mockMvc.perform(post("/secured/resources/incoterms/create").accept(MediaType.APPLICATION_JSON).contentType(MediaType.APPLICATION_JSON)
                .content("{\"code\" : \"EXW\", \"description\" : \"code exw\", \"locationQualifier\" : \"DEPARTURE\"}".getBytes()))
                //.andDo(print())
                .andExpect(status().isOk())
                .andExpect(jsonPath("id.value").exists())
                .andExpect(jsonPath("id.value").value("6305ff33-295e-11e5-ae37-54ee7534021a"))
                .andExpect(jsonPath("code").value("EXW"));
    }
SpringMVC 测试 mockMVC

perform:执行一个 RequestBuilder 请求,会自动执行 SpringMVC 的流程并映射到相应的控制器执行处理;
andExpect:添加 ResultMatcher 验证规则,验证控制器执行完成后结果是否正确;
andDo:添加 ResultHandler 结果处理器,比如调试时打印结果到控制台;
andReturn:最后返回相应的 MvcResult;然后进行自定义验证/进行下一步的异步处理;

 

看一个具体的例子 2:

SpringMVC 测试 mockMVC
    @Test  
    public void testView() throws Exception {  
        MvcResult result = mockMvc.perform(MockMvcRequestBuilders.get("/user/1"))  
                .andExpect(MockMvcResultMatchers.view().name("user/view"))  
                .andExpect(MockMvcResultMatchers.model().attributeExists("user"))  
                .andDo(MockMvcResultHandlers.print())  
                .andReturn();  
          
        Assert.assertNotNull(result.getModelAndView().getModel().get("user"));  
    }
SpringMVC 测试 mockMVC

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

整个测试过程非常有规律:
1、准备测试环境
2、通过 MockMvc 执行请求
3.1、添加验证断言
3.2、添加结果处理器
3.3、得到 MvcResult 进行自定义断言/进行下一步的异步请求
4、卸载测试环境

 

三 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 方法;
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;

2.MockHttpServletRequestBuilder 和 MockMultipartHttpServletRequestBuilder API

(1)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):请求的后处理器,用于自定义一些请求处理的扩展点;

(2)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

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

2.具体的 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<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);

 

六 一些常用的测试

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 请求/响应验证

SpringMVC 测试 mockMVC
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()));//错误的请求内容体
SpringMVC 测试 mockMVC

 

6.异步测试

SpringMVC 测试 mockMVC
  //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));
SpringMVC 测试 mockMVC

 

7.全局配置

SpringMVC 测试 mockMVC
mockMvc = webAppContextSetup(wac)  
            .defaultRequest(get("/user/1").requestAttr("default", true)) //默认请求 如果其是 Mergeable 类型的,会自动合并的哦 mockMvc.perform 中的 RequestBuilder  
            .alwaysDo(print())  //默认每次执行请求后都做的动作  
            .alwaysExpect(request().attribute("default", true)) //默认每次执行后进行验证的断言  
            .build();  
      
    mockMvc.perform(get("/user/1"))  
            .andExpect(model().attributeExists("user"));
SpringMVC 测试 mockMVC

露水湾 , 版权所有丨如未注明 , 均为原创丨本网站采用BY-NC-SA协议进行授权
转载请注明原文链接:SpringMVC 测试 mockMVC
喜欢 (0)
[]
分享 (0)
关于作者:
发表我的评论
取消评论

表情 贴图 加粗 删除线 居中 斜体 签到

Hi,您需要填写昵称和邮箱!

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址
(1)个小伙伴在吐槽
  1. 测试一下评论
    dewbay2020-10-23 15:33 回复 Windows 10 | Chrome 86.0.4240.75