MockMVC
基于RESTful风格的SpringMVC的测试
对于前后端分离的项目而言,无法直接从前端静态代码中测试接口的正确性,因此可以通过MockMVC来模拟HTTP请求。基于RESTful风格的SpringMVC的测试,我们可以测试完整的Spring MVC流程,即从URL请求到控制器处理,再到视图渲染都可以测试。
入门示例
@RunWith(SpringRunner.class)
@SpringBootTest
@AutoConfigureMockMvc
public class CourseControllerTest {
@Autowired
private MockMvc mockMvc;
public void helloTest() throws Exception{
mockMvc.perform(
//构造一个post请求
MockMvcRequestBuilders.post("/hello")
.contentType(MediaType.APPLICATION_JSON_UTF8)
//andExpect,添加ResultMathcers验证规则,验证控制器执行完成后结果是否正确,【这是一个断言】
.andExpect(MockMvcResultMatchers.status().is(200))
.andExpect(MockMvcResultMatchers.content().contentType(MediaType.APPLICATION_JSON_UTF8))
//假定返回的结果中,期望为hello,并给出期望值和实际值
.andExpect(MockMvcResultMatchers.content().string("hello"))
//添加ResultHandler结果处理器,比如调试时 打印结果(print方法)到控制台
.andDo(print())
//返回相应的MvcResult
.andReturn();
}
MockMvcBuilder
MockMvcBuilder是用来构造MockMvc的构造器,其主要有两个实现:StandaloneMockMvcBuilder和DefaultMockMvcBuilder,分别对应两种测试方式,即独立安装和集成Web环境测试(此种方式并不会集成真正的web环境,而是通过相应的Mock API进行模拟测试,无须启动服务器)。对于我们来说直接使用静态工厂MockMvcBuilders创建即可。
1、集成web环境方式
public class MockMvcTest {
@Autowired
private WebApplicationContext webApplicationContext;
private MockMvc mockMvc;
@Before
public void setUp() {
this.mockMvc = MockMvcBuilders.webAppContextSetup(this.webApplicationContext).build(); //构造MockMvc
}
@Test
public void courseListTest() throws Exception{
MvcResult name= mockMvc.perform(MockMvcRequestBuilders.get("/hello"))
.andExpect(status().isOk())
.andExpect(MockMvcResultMatchers.content().string("hello"))
.andDo(print())
.andReturn();
}
}
2、独立测试方式
MockMvcBuilders.standaloneSetup(Object... controllers):通过参数指定一组控制器,这样就不需要从上下文获取了;
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
}
...
}
主要是两个步骤:
(1)首先自己创建相应的控制器,注入相应的依赖
(2)通过MockMvcBuilders.standaloneSetup模拟一个Mvc测试环境,通过build得到一个MockMvc
MockMvc
使用规范:
- 准备测试环境
- 通过MockMvc执行请求
- 添加验证断言
- 添加结果处理器
- 得到MvcResult进行自定义断言/进行下一步的异步请求
- 卸载测试环境
常用的API:
- mockMvc.perform : 执行一个请求;
- MockMvcRequestBuilders.get("/user/1") : 构造一个请求
- ResultActions.andExpect : 添加执行完成后的断言
- ResultActions.andDo : 添加一个结果处理器,表示要对结果做点什么事情,比如此处使用print()输出整个响应结果信息。
- ResultActions.andReturn : 表示执行完成后返回相应的结果,通过MvcResult接收响应数据
@Test
public void courseListTest() throws Exception{
MvcResult mvcResult= mockMvc.perform(MockMvcRequestBuilders.get("/hello"))
.andExpect(status().isOk())
.andExpect(MockMvcResultMatchers.content().string("hello"))
.andDo(print())
.andReturn();
System.out.println(mvcResult.getResponse().getContentAsString());
}
控制台结果
RequestBuilder
- 从名字可以看出,RequestBuilder用来构建请求的,其提供了一个方法buildRequest(ServletContext servletContext)用于构建MockHttpServletRequest;
- 其主要有两个子类, 即用来Mock客户端请求需要的所有数据。
- MockHttpServletRequestBuilder
- MockMultipartHttpServletRequestBuilder(如文件上传使用)
通过抽象类MockMvcRequestBuilders提供方法生成MockHttpServletRequestBuilder
- 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提供的API
// 继承自MockHttpServletRequestBuilder,又提供了如下API
MockMultipartHttpServletRequestBuilder file(String name, byte[] content)/MockMultipartHttpServletRequestBuilder file(MockMultipartFile file) //指定要上传的文件;
ResultActions
调用MockMvc.perform(RequestBuilder requestBuilder)后将得到ResultActions
ResultActions提供了如下API
ResultActions andExpect(ResultMatcher matcher) // 添加验证断言来判断执行请求后的结果是否是预期的;
ResultActions andDo(ResultHandler handler) // 添加结果处理器,用于对验证成功后执行的动作,如输出下请求/结果信息用于调试;
MvcResult andReturn() // 返回验证成功后的MvcResult;用于自定义验证/下一步的异步处理;
ResultMatcher 验证器
ResultMatcher用来匹配执行完请求后的结果验证,其就一个match(MvcResult result)断言方法,如果匹配失败将抛出相应的异常;spring mvc测试框架提供了很多***ResultMatchers来满足测试需求。注意这些***ResultMatchers并不是ResultMatcher的子类,而是返回ResultMatcher实例的。Spring mvc测试框架为了测试方便提供了MockMvcResultMatchers静态工厂方法方便操作;
MockMvcResultMatchers提供的API
andlerResultMatchers 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)
ResultHandler
ResultHandler用于对处理的结果进行相应处理的,Spring mvc测试框架提供了MockMvcResultHandlers静态工厂方法
MockMvcResultHandlers的API
ResultHandler log()
ResultHandler print()
ResultHandler print(OutputStream stream)
ResultHandler print(Writer writer)
关系梳理
- MockMvcBuilder——>通过MockMvcBuilders工厂方法生成MockMvcBuilder
- MockMvc——>通过MockMvc的perform方法接收RequestBuilder生成ResultActions
- RequestBuilder ——>通过MockMvcRequestBuilders工厂get、post…方法生成RequestBuilder
- ResultActions——>andExpect()、andDo()返回ResultActions,链式操作;andReturn()产生MvcResult对象
- ResultMatcher——>ResultActions的andExpect()方法接收ResultMatcher,进行结果校验
- ResultHandler——>ResultActions的andDo()方法接收ResultHandler,对结果进行处理