@Test
被注解的方法是一个测试方法。
@Test注解的public void方法将会被当做测试用例 JUnit每次都会创建一个新的测试实例,然后调用@Test注解方法
任何异常的抛出都会认为测试失败 @Test注解提供2个参数:
“expected”,定义测试方法应该抛出的异常,如果测试方法没有抛出异常或者抛出了一个不同的异常,测试失败
“timeout”,如果测试运行时间长于该定义时间,测试失败(单位为毫秒)
@BeforeClass
被注解的(静态)方法将在当前类中的所有 @Test 方法前执行一次。
使用@BeforeClass注解一个public static
void 方法,并且该方法不带任何参数,会使该方法在所有测试方法被执行前执行一次,并且只执行一次
父类的@BeforeClass注解方法会在子类的@BeforeClass注解方法执行前执行
@Before
被注解的方法将在当前类中的每个 @Test 方法前执行。
使用@Before注解一个public void 方法会使该方法在@Test注解方法被执行前执行(那么就可以在该方法中创建相同的对象)
父类的@Before注解方法会在子类的@Before注解方法执行前执行
@After
被注解的方法将在当前类中的每个 @Test 方法后执行。
如果在@Before注解方法中分配了额外的资源,那么在测试执行完后,需要释放分配的资源。 使用@After注解一个public
void方法会使该方法在@Test注解方法执行后被执行
即使在@Before注解方法、@Test注解方法中抛出了异常,所有的@After注解方法依然会被执行
父类中的@After注解方法会在子类@After注解方法执行后被执行
@AfterClass
被注解的(静态)方法将在当前类中的所有 @Test 方法后执行一次。
如果在@BeforeClass注解方法中分配了代价高昂的额外的资源,那么在测试类中的所有测试方法执行完后,需要释放分配的资源。
使用@AfterClass注解一个public static void方法会使该方法在测试类中的所有测试方法执行完后被执行
即使在@BeforeClass注解方法中抛出了异常,所有的@AfterClass注解方法依然会被执行
父类中的@AfterClass注解方法会在子类@AfterClass注解方法执行后被执行
@Ignore
被注解的方法不会执行(将被跳过),但会报告为已执行。
对包含测试类的类或@Test注解方法使用@Ignore注解将使被注解的类或方法不会被当做测试执行 JUnit执行结果中会报告被忽略的测试数
MockMvcRequestBuilders
MockHttpServletRequestBuilder get(String urlTemplate, Object... urlVariables)
根据uri模板和uri变量值得到一个GET请求方式的 MockHttpServletRequestBuilder;如get(/user/{id}, 1L);
MockHttpServletRequestBuilder post(String urlTemplate, Object... urlVariables)
同get类似,但是是POST方法;
MockHttpServletRequestBuilderput(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;
RequestBuilder asyncDispatch(final MvcResult mvcResult)
创建一个从启动异步处理的请求的MvcResult进行异步分派的RequestBuilder;
MockMultipartHttpServletRequestBuilder fileUpload(String urlTemplate, Object... urlVariables)
提供文件上传方式的请求,得到MockMultipartHttpServletRequestBuilder;
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)
指定要上传的文件;
调用MockMvc.perform(RequestBuilder requestBuilder)后将得到ResultActions,通过ResultActions完成如下三件事:
ResultActions andExpect(ResultMatcher matcher) :添加验证断言来判断执行请求后的结果是否是预期的;
ResultActions andDo(ResultHandler handler)
添加结果处理器,用于对验证成功后执行的动作,如输出下请求/结果信息用于调试;
MvcResult andReturn()
返回验证成功后的MvcResult;用于自定义验证/下一步的异步处理;
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<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);
测试普通控制器
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到控制台
得到MvcResult自定义验证
MvcResult result = mockMvc.perform(get("/user/{id}", 1))//执行请求
.andReturn(); //返回MvcResult
Assert.assertNotNull(result.getModelAndView().getModel().get("user")); //自定义断言
验证请求参数绑定到模型数据及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")); //验证视图
文件上传
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")); //验证视图
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()));//错误的请求内容体
异步测试
//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));
全局配置
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"));