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

刺骨的言语ヽ痛彻心扉 2022-06-10 06:58 128阅读 0赞

转自：http://jinnianshilongnian.iteye.com/blog/2004660

随着RESTful Web Service的流行，测试对外的Service是否满足期望也变的必要的。从Spring 3.2开始Spring了Spring Web测试框架，如果版本低于3.2，请使用[spring-test-mvc][]项目（合并到spring3.2中了）。

Spring MVC测试框架提供了对服务器端和客户端（基于RestTemplate的客户端）提供了支持。

对于服务器端：在Spring 3.2之前，我们测试时一般都是直接new控制器，注入依赖，然后判断返回值。但是我们无法连同Spring MVC的基础设施（如DispatcherServlet调度、类型转换、数据绑定、拦截器等）一起测试，另外也没有现成的方法测试如最终渲染的视图（@ResponseBody生成的JSON/XML、JSP、Velocity等）内容是否正确。从Spring 3.2开始这些事情都可以完成了。而且可以测试完整的Spring MVC流程，即从URL请求到控制器处理，再到视图渲染都可以测试。

对于客户端：不需要启动服务器即可测试我们的RESTful 服务。

# 1 服务器端测试 #

我的环境：JDK7、Maven3、spring4、Servlet3

## 首先添加依赖 ##

如下是spring-context和spring-webmvc依赖：

Java代码   ![收藏代码][icon_star.png]

1.  <dependency>  
2.      <groupId>org.springframework</groupId>  
3.      <artifactId>spring-context</artifactId>  
4.      <version>$\{spring.version\}</version>  
5.  </dependency>  
6.    
7.  <dependency>  
8.      <groupId>org.springframework</groupId>  
9.      <artifactId>spring-webmvc</artifactId>  
10.     <version>$\{spring.version\}</version>  
11. </dependency>

版本信息：<spring.version>4.0.0.RELEASE</spring.version>

如下是测试相关的依赖（junit、hamcrest、mockito、spring-test）：

Java代码   ![收藏代码][icon_star.png]

1.  <dependency>  
2.      <groupId>junit</groupId>  
3.      <artifactId>junit</artifactId>  
4.      <version>$\{junit.version\}</version>  
5.      <scope>test</scope>  
6.  </dependency>  
7.    
8.  <dependency>  
9.      <groupId>org.hamcrest</groupId>  
10.     <artifactId>hamcrest-core</artifactId>  
11.     <version>$\{hamcrest.core.version\}/version>  
12.     <scope>test</scope>  
13. </dependency>  
14. <dependency>  
15.     <groupId>org.mockito</groupId>  
16.     <artifactId>mockito-core</artifactId>  
17.     <version>$\{mockito.core.version\}</version>  
18.     <scope>test</scope>  
19. </dependency>  
20.   
21. <dependency>  
22.     <groupId>org.springframework</groupId>  
23.     <artifactId>spring-test</artifactId>  
24.     <version>$\{spring.version\}</version>  
25.     <scope>test</scope>  
26. </dependency>

版本信息：<junit.version>4.11</junit.version>、<hamcrest.core.version>1.3</hamcrest.core.version>、<mockito.core.version>1.9.5</mockito.core.version>

## 然后准备测试相关配置 ##

### 实体： ###

Java代码   ![收藏代码][icon_star.png]

1.  **package** com.sishuok.mvc.entity;  
2.  **import** java.io.Serializable;  
3.  **public** **class** User **implements** Serializable \{  
4.      **private** Long id;  
5.      **private** String name;  
6.      //省略getter/setter等  
7.  \}

## ##

### 控制器： ###

Java代码   ![收藏代码][icon_star.png]

1.  **package** com.sishuok.mvc.controller;  
2.  //省略import  
3.  @Controller  
4.  @RequestMapping("/user")  
5.  **public** **class** UserController \{  
6.    
7.      @RequestMapping("/\{id\}")  
8.      **public** ModelAndView view(@PathVariable("id") Long id, HttpServletRequest req) \{  
9.          User user = **new** User();  
10.         user.setId(id);  
11.         user.setName("zhang");  
12.   
13.         ModelAndView mv = **new** ModelAndView();  
14.         mv.addObject("user", user);  
15.         mv.setViewName("user/view");  
16.         **return** mv;  
17.     \}  
18. \}

### XML风格配置： ###

**[spring-config.xml][]：加载非web层组件**

Java代码   ![收藏代码][icon_star.png]

**[spring-mvc.xml][]：加载和配置web层组件**

Java代码   ![收藏代码][icon_star.png]

1.  <?xml version="1.0" encoding="UTF-8"?>  
2.  <beans xmlns="http://www.springframework.org/schema/beans"  
3.         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
4.         xmlns:context="http://www.springframework.org/schema/context"  
5.         xmlns:mvc="http://www.springframework.org/schema/mvc"  
6.         xsi:schemaLocation="  
7.         http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd  
8.         http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd  
9.         http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd  
10.        ">  
11.       
12.       
13.     <context:component-scan base-**package**="com.sishuok.mvc" use-**default**\-filters="false">  
14.         <context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>  
15.     </context:component-scan>  
16.     <mvc:annotation-driven/>  
17.     <bean id="viewResolver" **class**="org.springframework.web.servlet.view.InternalResourceViewResolver">  
18.         <property name="prefix" value="/WEB-INF/jsp/"/>  
19.         <property name="suffix" value=".jsp"/>  
20.     </bean>  
21. </beans>

[**web.xml配置**][web.xml]：此处就不贴了，请前往github查看。

对于context:component-scan注意事项请参考《[context:component-scan扫描使用上的容易忽略的use-default-filters][context_component-scan_use-default-filters]》和《[第三章 DispatcherServlet详解 ——跟开涛学SpringMVC][DispatcherServlet_ _SpringMVC]》。

### 等价的注解风格配置：** ** ###

**[AppConfig.java][]**：等价于spring-config.xml

Java代码   ![收藏代码][icon_star.png]

1.  **package** com.sishuok.config;  
2.    
3.  **import** org.springframework.context.annotation.ComponentScan;  
4.  **import** org.springframework.context.annotation.Configuration;  
5.  **import** org.springframework.context.annotation.FilterType;  
6.  **import** org.springframework.stereotype.Controller;  
7.    
8.  @Configuration  
9.  @ComponentScan(basePackages = "com.sishuok.mvc", excludeFilters = \{  
10.         @ComponentScan.Filter(type = FilterType.ANNOTATION, value = \{Controller.**class**\})  
11. \})  
12. **public** **class** AppConfig \{  
13. \}

**[MvcConfig.java][]**：等价于spring-mvc.xml

Java代码   ![收藏代码][icon_star.png]

1.  **package** com.sishuok.config;  
2.    
3.  **import** org.springframework.context.annotation.Bean;  
4.  **import** org.springframework.context.annotation.ComponentScan;  
5.  **import** org.springframework.context.annotation.Configuration;  
6.  **import** org.springframework.context.annotation.FilterType;  
7.  **import** org.springframework.stereotype.Controller;  
8.  **import** org.springframework.web.servlet.ViewResolver;  
9.  **import** org.springframework.web.servlet.config.annotation.EnableWebMvc;  
10. **import** org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;  
11. **import** org.springframework.web.servlet.view.InternalResourceViewResolver;  
12.   
13. @Configuration  
14. @EnableWebMvc  
15. @ComponentScan(basePackages = "com.sishuok.mvc", useDefaultFilters = **false**, includeFilters = \{  
16.         @ComponentScan.Filter(type = FilterType.ANNOTATION, value = \{Controller.**class**\})  
17. \})  
18. **public** **class** MvcConfig **extends** WebMvcConfigurationSupport \{  
19.   
20.     @Bean  
21.     **public** ViewResolver viewResolver() \{  
22.         InternalResourceViewResolver viewResolver = **new** InternalResourceViewResolver();  
23.         viewResolver.setPrefix("/WEB-INF/jsp/");  
24.         viewResolver.setSuffix(".jsp");  
25.         **return** viewResolver;  
26.     \}  
27.   
28. \}

**[WebInitializer.java][]**：注册相应的web.xml中的组件

Java代码   ![收藏代码][icon_star.png]

1.  **package** com.sishuok.config;  
2.    
3.  **import** org.springframework.web.WebApplicationInitializer;  
4.  **import** org.springframework.web.context.ContextLoaderListener;  
5.  **import** org.springframework.web.context.support.AnnotationConfigWebApplicationContext;  
6.  **import** org.springframework.web.filter.CharacterEncodingFilter;  
7.  **import** org.springframework.web.servlet.DispatcherServlet;  
8.    
9.  **import** javax.servlet.DispatcherType;  
10. **import** javax.servlet.FilterRegistration;  
11. **import** javax.servlet.ServletException;  
12. **import** javax.servlet.ServletRegistration;  
13. **import** java.util.EnumSet;  
14.   
15. **public** **class** WebInitializer **implements** WebApplicationInitializer \{  
16.   
17.     @Override  
18.     **public** **void** onStartup(javax.servlet.ServletContext sc) **throws** ServletException \{  
19.   
20.         AnnotationConfigWebApplicationContext rootContext = **new** AnnotationConfigWebApplicationContext();  
21.         rootContext.register(AppConfig.**class**);  
22.         sc.addListener(**new** ContextLoaderListener(rootContext));  
23.   
24.         //2、springmvc上下文  
25.         AnnotationConfigWebApplicationContext springMvcContext = **new** AnnotationConfigWebApplicationContext();  
26.         springMvcContext.register(MvcConfig.**class**);  
27.         //3、DispatcherServlet  
28.         DispatcherServlet dispatcherServlet = **new** DispatcherServlet(springMvcContext);  
29.         ServletRegistration.Dynamic dynamic = sc.addServlet("dispatcherServlet", dispatcherServlet);  
30.         dynamic.setLoadOnStartup(1);  
31.         dynamic.addMapping("/");  
32.   
33.         //4、CharacterEncodingFilter  
34.         CharacterEncodingFilter characterEncodingFilter = **new** CharacterEncodingFilter();  
35.         characterEncodingFilter.setEncoding("utf-8");  
36.         FilterRegistration filterRegistration =  
37.                 sc.addFilter("characterEncodingFilter", characterEncodingFilter);  
38.         filterRegistration.addMappingForUrlPatterns(EnumSet.of(DispatcherType.REQUEST), **false**, "/");  
39.   
40.     \}  
41. \}

对于WebInitializer，请参考《[Spring4新特性——Groovy Bean定义DSL][Spring4_Groovy Bean_DSL]》

到此基本的配置就搞定了，接下来看看如何测试吧。

## 1.1 以前的测试方式 ##

Java代码   ![收藏代码][icon_star.png]

1.  **package** com.sishuok.mvc.controller;  
2.  //省略import  
3.  **public** **class** UserControllerTest \{  
4.    
5.      **private** UserController userController;  
6.    
7.      @Before  
8.      **public** **void** setUp() \{  
9.          userController = **new** UserController();  
10.         //安装userCtroller依赖 比如userService  
11.     \}  
12.   
13.     @Test  
14.     **public** **void** testView() \{  
15.         MockHttpServletRequest req = **new** MockHttpServletRequest();  
16.         ModelAndView mv = userController.view(1L, req);  
17.   
18.         ModelAndViewAssert.assertViewName(mv, "user/view");  
19.         ModelAndViewAssert.assertModelAttributeAvailable(mv, "user");  
20.   
21.     \}  
22. \}

**准备控制器**：我们通过new方式创建一个，然后手工查找依赖注入进去（比如从spring容器获取/new的）；

**Mock Request**：此处使用Spring提供的Mock API模拟一个HttpServletRequest，其他的Servlet API也提供了相应的Mock类，具体请查看Javadoc；

**访问控制器方法**：通过直接调用控制器方法进行访问，此处无法验证Spring MVC框架的类型转换、数据验证等是否正常；

**ModelAndViewAssert**：通过这个Assert API验证我们的返回值是否正常；

对于单元测试步骤请参考：[加速Java应用开发速度3——单元/集成测试+CI][Java_3_CI]

这种方式的缺点已经说过了，如不能走Spring MVC完整流程（不能走Servlet的过滤器链、SpringMVC的类型转换、数据验证、数据绑定、拦截器等等），如果做基本的测试没问题，这种方式就是纯粹的单元测试，我们想要的功能其实是一种集成测试，不过后续部分不区分。

## 1.2 安装测试环境 ##

spring mvc测试框架提供了两种方式，独立安装和集成Web环境测试（此种方式并不会集成真正的web环境，而是通过相应的Mock API进行模拟测试，无须启动服务器）。

### 独立测试方式 ###

Java代码   ![收藏代码][icon_star.png]

1.  **public** **class** UserControllerStandaloneSetupTest \{  
2.      **private** MockMvc mockMvc;  
3.      @Before  
4.      **public** **void** setUp() \{  
5.          UserController userController = **new** UserController();  
6.          mockMvc = MockMvcBuilders.standaloneSetup(userController).build();  
7.      \}  
8.  \}

1、首先自己创建相应的控制器，注入相应的依赖

2、通过MockMvcBuilders.standaloneSetup模拟一个Mvc测试环境，通过build得到一个MockMvc

3、MockMvc：是我们以后测试时经常使用的API，后边介绍

### 集成Web环境方式 ###

Java代码   ![收藏代码][icon_star.png]

1.  //XML风格  
2.  @RunWith(SpringJUnit4ClassRunner.**class**)  
3.  @WebAppConfiguration(value = "src/main/webapp")  
4.  @ContextHierarchy(\{  
5.          @ContextConfiguration(name = "parent", locations = "classpath:spring-config.xml"),  
6.          @ContextConfiguration(name = "child", locations = "classpath:spring-mvc.xml")  
7.  \})  
8.    
9.  //注解风格  
10. //@RunWith(SpringJUnit4ClassRunner.class)  
11. //@WebAppConfiguration(value = "src/main/webapp")  
12. //@ContextHierarchy(\{   
13. //        @ContextConfiguration(name = "parent", classes = AppConfig.class),  
14. //        @ContextConfiguration(name = "child", classes = MvcConfig.class)  
15. //\})  
16. **public** **class** UserControllerWebAppContextSetupTest \{  
17.   
18.     @Autowired  
19.     **private** WebApplicationContext wac;  
20.     **private** MockMvc mockMvc;  
21.   
22.     @Before  
23.     **public** **void** setUp() \{  
24.         mockMvc = MockMvcBuilders.webAppContextSetup(wac).build();  
25.     \}  
26. \}

1、@WebAppConfiguration：测试环境使用，用来表示测试环境使用的ApplicationContext将是WebApplicationContext类型的；value指定web应用的根；

2、@ContextHierarchy：指定容器层次，即spring-config.xml是父容器，而spring-mvc.xml是子容器，请参考《[第三章 DispatcherServlet详解 ——跟开涛学SpringMVC][DispatcherServlet_ _SpringMVC]》

3、通过@Autowired WebApplicationContext wac：注入web环境的ApplicationContext容器；

4、然后通过MockMvcBuilders.webAppContextSetup(wac).build()创建一个MockMvc进行测试；

到此测试环境就搭建完成了，根据需要选择使用哪种方式即可。相关配置请前往[github查看][github]。

## 1.3、HelloWorld ##

Java代码   ![收藏代码][icon_star.png]

1.  @Test  
2.  **public** **void** testView() **throws** Exception \{  
3.      MvcResult result = mockMvc.perform(MockMvcRequestBuilders.get("/user/1"))  
4.              .andExpect(MockMvcResultMatchers.view().name("user/view"))  
5.              .andExpect(MockMvcResultMatchers.model().attributeExists("user"))  
6.              .andDo(MockMvcResultHandlers.print())  
7.              .andReturn();  
8.        
9.      Assert.assertNotNull(result.getModelAndView().getModel().get("user"));  
10. \}

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、卸载测试环境

对于单元测试步骤请参考：[加速Java应用开发速度3——单元/集成测试+CI][Java_3_CI]。

## 1.4、了解测试API ##

Spring mvc测试框架提供了测试MVC需要的API，主要包括Servlet/JSP Mock、MockMvcBuilder、MockMvc、RequestBuilder、ResultMatcher、ResultHandler、MvcResult等。另外提供了几个静态工厂方法便于测试：MockMvcBuilders、MockMvcRequestBuilders、MockMvcResultMatchers、MockMvcResultHandlers。在使用时请使用静态方法导入方便测试，如：

Java代码   ![收藏代码][icon_star.png]

1.  **import** **static** org.springframework.test.web.servlet.setup.MockMvcBuilders.\*;  
2.  **import** **static** org.springframework.test.web.servlet.request.MockMvcRequestBuilders.\*;  
3.  **import** **static** org.springframework.test.web.servlet.result.MockMvcResultMatchers.\*;  
4.  **import** **static** org.springframework.test.web.servlet.result.MockMvcResultHandlers.\*;

### Servlet/JSP API Mock  ###

提供了对Servlet 3 相应API的Mock，如：

MockServletContext

MockHttpServletRequest

MockHttpServletResponse

……

具体请查看spring-test模块的org.springframework.mock.web包。

### MockMvcBuilder/MockMvcBuilders ###

MockMvcBuilder是用来构造MockMvc的构造器，其主要有两个实现：StandaloneMockMvcBuilder和DefaultMockMvcBuilder，分别对应之前的两种测试方式。对于我们来说直接使用静态工厂MockMvcBuilders创建即可：

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

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

其中DefaultMockMvcBuilder还提供了如下API：

addFilters(Filter... filters)/addFilter(Filter filter, String... urlPatterns)：添加javax.servlet.Filter过滤器

defaultRequest(RequestBuilder requestBuilder)：默认的RequestBuilder，每次执行时会合并到自定义的RequestBuilder中，即提供公共请求数据的；

alwaysExpect(ResultMatcher resultMatcher)：定义全局的结果验证器，即每次执行请求时都进行验证的规则；

alwaysDo(ResultHandler resultHandler)：定义全局结果处理器，即每次请求时都进行结果处理；

dispatchOptions：DispatcherServlet是否分发OPTIONS请求方法到控制器；

StandaloneMockMvcBuilder继承了DefaultMockMvcBuilder，又提供了如下API：

setMessageConverters(HttpMessageConverter<?>...messageConverters)：设置HTTP消息转换器；

setValidator(Validator validator)：设置验证器；

setConversionService(FormattingConversionService conversionService)：设置转换服务；

addInterceptors(HandlerInterceptor... interceptors)/addMappedInterceptors(String\[\] pathPatterns, HandlerInterceptor... interceptors)：添加spring mvc拦截器；

setContentNegotiationManager(ContentNegotiationManager contentNegotiationManager)：设置内容协商管理器；

setAsyncRequestTimeout(long timeout)：设置异步超时时间；

setCustomArgumentResolvers(HandlerMethodArgumentResolver... argumentResolvers)：设置自定义控制器方法参数解析器；

setCustomReturnValueHandlers(HandlerMethodReturnValueHandler... handlers)：设置自定义控制器方法返回值处理器；

setHandlerExceptionResolvers(List<HandlerExceptionResolver> exceptionResolvers)/setHandlerExceptionResolvers(HandlerExceptionResolver... exceptionResolvers)：设置异常解析器；

setViewResolvers(ViewResolver...resolvers)：设置视图解析器；

setSingleView(View view)：设置单个视图，即视图解析时总是解析到这一个（仅适用于只有一个视图的情况）；

setLocaleResolver(LocaleResolver localeResolver)：设置Local解析器；

setFlashMapManager(FlashMapManager flashMapManager)：设置FlashMapManager，如存储重定向数据；

setUseSuffixPatternMatch(boolean useSuffixPatternMatch)：设置是否是后缀模式匹配，如“/user”是否匹配"/user.\*"，默认真即匹配；

setUseTrailingSlashPatternMatch(boolean useTrailingSlashPatternMatch)：设置是否自动后缀路径模式匹配，如“/user”是否匹配“/user/”，默认真即匹配；

addPlaceHolderValue(String name, String value) ：添加request mapping中的占位符替代；

因为StandaloneMockMvcBuilder不会加载Spring MVC配置文件，因此就不会注册我们需要的一些组件，因此就提供了如上API用于注册我们需要的相应组件。

### MockMvc ###

使用之前的MockMvcBuilder.build()得到构建好的MockMvc；这个是mvc测试的核心API，对于该API的使用方式如下：

Java代码   ![收藏代码][icon_star.png]

1.  MvcResult result = mockMvc.perform(MockMvcRequestBuilders.get("/user/1"))  
2.         .andExpect(MockMvcResultMatchers.view().name("user/view"))  
3.         .andExpect(MockMvcResultMatchers.model().attributeExists("user"))  
4.         .andDo(MockMvcResultHandlers.print())  
5.         .andReturn();

perform：执行一个RequestBuilder请求，会自动执行SpringMVC的流程并映射到相应的控制器执行处理；

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

andDo：添加ResultHandler结果处理器，比如调试时打印结果到控制台；

andReturn：最后返回相应的MvcResult；然后进行自定义验证/进行下一步的异步处理；

另外还提供了以下API：

setDefaultRequest：设置默认的RequestBuilder，用于在每次perform执行相应的RequestBuilder时自动把该默认的RequestBuilder合并到perform的RequestBuilder中；

setGlobalResultMatchers：设置全局的预期结果验证规则，如我们通过MockMvc测试多个控制器时，假设它们都想验证某个规则时，就可以使用这个；

setGlobalResultHandlers：设置全局的ResultHandler结果处理器；

### RequestBuilder/MockMvcRequestBuilders ###

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

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和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<T> 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）；

得到相应的\*\*\*ResultMatchers后，接着再调用其相应的API得到ResultMatcher，如ModelResultMatchers.attributeExists(final String... names)判断Model属性是否存在。具体请查看相应的API。再次就不一一列举了。

**ResultHandler/MockMvcResultHandlers**

ResultHandler用于对处理的结果进行相应处理的，比如输出整个请求/响应等信息方便调试，Spring mvc测试框架提供了MockMvcResultHandlers静态工厂方法，该工厂提供了ResultHandler print()返回一个输出MvcResult详细信息到控制台的ResultHandler实现。

**MvcResult**

即执行完控制器后得到的整个结果，并不仅仅是返回值，其包含了测试时需要的所有信息，如：

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

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

Object getHandler()：得到执行的处理器，一般就是控制器；

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

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

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

FlashMap getFlashMap()：得到FlashMap；

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

## 1.5 测试示例 ##

### 测试普通控制器  ###

Java代码   ![收藏代码][icon_star.png]

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

## ##

### 测试普通控制器，但是URL错误，即404 ###

Java代码   ![收藏代码][icon_star.png]

1.  //找不到控制器，404测试  
2.  MvcResult result = mockMvc.perform(get("/user2/\{id\}", 1)) //执行请求  
3.          .andDo(print())  
4.          .andExpect(status().isNotFound()) //验证控制器不存在  
5.          .andReturn();  
6.  Assert.assertNull(result.getModelAndView()); //自定义断言

## ##

### 得到MvcResult自定义验证     ###

Java代码   ![收藏代码][icon_star.png]

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

## ##

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

Java代码   ![收藏代码][icon_star.png]

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

## ##

### 验证请求参数验证失败出错   ###

Java代码   ![收藏代码][icon_star.png]

1.  mockMvc.perform(post("/user").param("name", "admin")) //执行请求  
2.          .andExpect(model().hasErrors()) //验证模型有错误  
3.          .andExpect(model().attributeDoesNotExist("name")) //验证存在错误的属性  
4.          .andExpect(view().name("showCreateForm")); //验证视图

## ##

### 文件上传  ###

Java代码   ![收藏代码][icon_star.png]

1.  //文件上传  
2.  **byte**\[\] bytes = **new** **byte**\[\] \{ 1, 2\};  
3.  mockMvc.perform(fileUpload("/user/\{id\}/icon", 1L).file("icon", bytes)) //执行文件上传  
4.          .andExpect(model().attribute("icon", bytes)) //验证属性相等性  
5.          .andExpect(view().name("success")); //验证视图

## ##

### JSON请求/响应验证 ###

测试时需要安装jackson Json和JsonPath依赖：

Java代码   ![收藏代码][icon_star.png]

1.  <dependency>  
2.      <groupId>com.fasterxml.jackson.core</groupId>  
3.      <artifactId>jackson-databind</artifactId>  
4.      <version>$\{jackson2.version\}</version>  
5.  </dependency>  
6.    
7.  <dependency>  
8.      <groupId>com.jayway.jsonpath</groupId>  
9.      <artifactId>json-path</artifactId>  
10.     <version>$\{jsonpath.version\}</version>  
11.     <scope>test</scope>  
12. </dependency>

版本：<jsonpath.version>0.9.0</jsonpath.version>、<jackson2.version>2.2.3</jackson2.version>

Java代码   ![收藏代码][icon_star.png]

1.  String requestBody = "\{\\"id\\":1, \\"name\\":\\"zhang\\"\}";  
2.  mockMvc.perform(post("/user")  
3.              .contentType(MediaType.APPLICATION\_JSON).content(requestBody)  
4.              .accept(MediaType.APPLICATION\_JSON)) //执行请求  
5.          .andExpect(content().contentType(MediaType.APPLICATION\_JSON)) //验证响应contentType  
6.          .andExpect(jsonPath("$.id").value(1)); //使用Json path验证JSON 请参考http://goessner.net/articles/JsonPath/  
7.    
8.  String errorBody = "\{id:1, name:zhang\}";  
9.  MvcResult result = mockMvc.perform(post("/user")  
10.         .contentType(MediaType.APPLICATION\_JSON).content(errorBody)  
11.         .accept(MediaType.APPLICATION\_JSON)) //执行请求  
12.         .andExpect(status().isBadRequest()) //400错误请求  
13.         .andReturn();  
14.   
15. Assert.assertTrue(HttpMessageNotReadableException.**class**.isAssignableFrom(result.getResolvedException().getClass()));//错误的请求内容体

## ##

### XML请求/响应验证 ###

测试时需要安装spring oxm和xstream依赖：

Java代码   ![收藏代码][icon_star.png]

1.  <dependency>  
2.      <groupId>com.thoughtworks.xstream</groupId>  
3.      <artifactId>xstream</artifactId>  
4.      <version>$\{xsream.version\}</version>  
5.      <scope>test</scope>  
6.  </dependency>  
7.    
8.  <dependency>  
9.      <groupId>org.springframework</groupId>  
10.     <artifactId>spring-oxm</artifactId>  
11.     <version>$\{spring.version\}</version>  
12.     <scope>test</scope>  
13. </dependency>

版本：<xstream.version>1.4.4</xstream.version>

Java代码   ![收藏代码][icon_star.png]

1.  //XML请求/响应  
2.  String requestBody = "<user><id>1</id><name>zhang</name></user>";  
3.  mockMvc.perform(post("/user")  
4.          .contentType(MediaType.APPLICATION\_XML).content(requestBody)  
5.          .accept(MediaType.APPLICATION\_XML)) //执行请求  
6.          .andDo(print())  
7.          .andExpect(content().contentType(MediaType.APPLICATION\_XML)) //验证响应contentType  
8.          .andExpect(xpath("/user/id/text()").string("1")); //使用XPath表达式验证XML 请参考http://www.w3school.com.cn/xpath/  
9.    
10. String errorBody = "<user><id>1</id><name>zhang</name>";  
11. MvcResult result = mockMvc.perform(post("/user")  
12.         .contentType(MediaType.APPLICATION\_XML).content(errorBody)  
13.         .accept(MediaType.APPLICATION\_XML)) //执行请求  
14.         .andExpect(status().isBadRequest()) //400错误请求  
15.         .andReturn();  
16.   
17. Assert.assertTrue(HttpMessageNotReadableException.**class**.isAssignableFrom(result.getResolvedException().getClass()));//错误的请求内容体

## ##

### 异常处理   ###

Java代码   ![收藏代码][icon_star.png]

1.  //异常处理  
2.  MvcResult result = mockMvc.perform(get("/user/exception")) //执行请求  
3.          .andExpect(status().isInternalServerError()) //验证服务器内部错误  
4.          .andReturn();  
5.    
6.  Assert.assertTrue(IllegalArgumentException.**class**.isAssignableFrom(result.getResolvedException().getClass()));

## ##

### 静态资源  ###

Java代码   ![收藏代码][icon_star.png]

1.  //静态资源  
2.  mockMvc.perform(get("/static/app.js")) //执行请求  
3.          .andExpect(status().isOk()) //验证状态码200  
4.          .andExpect(content().string(CoreMatchers.containsString("var")));//验证渲染后的视图内容包含var  
5.    
6.  mockMvc.perform(get("/static/app1.js")) //执行请求  
7.          .andExpect(status().isNotFound());  //验证状态码404

### **异步测试 ** ###

Java代码   ![收藏代码][icon_star.png]

1.  //Callable  
2.  MvcResult result = mockMvc.perform(get("/user/async1?id=1&name=zhang")) //执行请求  
3.          .andExpect(request().asyncStarted())  
4.          .andExpect(request().asyncResult(CoreMatchers.instanceOf(User.**class**))) //默认会等10秒超时  
5.          .andReturn();  
6.    
7.  mockMvc.perform(asyncDispatch(result))  
8.          .andExpect(status().isOk())  
9.          .andExpect(content().contentType(MediaType.APPLICATION\_JSON))  
10.         .andExpect(jsonPath("$.id").value(1));

Java代码   ![收藏代码][icon_star.png]

1.  //DeferredResult  
2.  result = mockMvc.perform(get("/user/async2?id=1&name=zhang")) //执行请求  
3.          .andExpect(request().asyncStarted())  
4.          .andExpect(request().asyncResult(CoreMatchers.instanceOf(User.**class**)))  //默认会等10秒超时  
5.          .andReturn();  
6.    
7.  mockMvc.perform(asyncDispatch(result))  
8.          .andExpect(status().isOk())  
9.          .andExpect(content().contentType(MediaType.APPLICATION\_JSON))  
10.         .andExpect(jsonPath("$.id").value(1));

此处请在第一次请求时加上 andExpect(request().asyncResult(CoreMatchers.instanceOf(User.class)))这样会等待结果返回/超时，无须自己设置线程等待了；此处注意request().asyncResult一定是在第一次请求发出；然后第二次通过asyncDispatch进行异步请求。

## ##

### 添加自定义过滤器 ###

Java代码   ![收藏代码][icon_star.png]

1.  mockMvc = webAppContextSetup(wac).addFilter(**new** MyFilter(), "/\*").build();  
2.  mockMvc.perform(get("/user/1"))  
3.          .andExpect(request().attribute("filter", **true**));

## ##

### 全局配置  ###

Java代码   ![收藏代码][icon_star.png]

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

以上代码请参考 [我的github][github]。更多参考示例请 [前往Spring github][Spring github]。

**只要记住测试步骤，按照步骤操作，整个测试过程是非常容易理解的：**

1、准备测试环境

2、通过MockMvc执行请求

3.1、添加验证断言

3.2、添加结果处理器

3.3、得到MvcResult进行自定义断言/进行下一步的异步请求

4、卸载测试环境

[spring-test-mvc]: https://github.com/spring-projects/spring-test-mvc
[icon_star.png]: /images/20220610/91eb096fbda147a6b7c5efbaaf3d428a.png
[spring-config.xml]: https://github.com/zhangkaitao/spring4-showcase/blob/master/spring-mvc-test/src/main/resources/spring-config.xml
[spring-mvc.xml]: https://github.com/zhangkaitao/spring4-showcase/blob/master/spring-mvc-test/src/main/resources/spring-mvc.xml
[web.xml]: https://github.com/zhangkaitao/spring4-showcase/blob/master/spring-mvc-test/src/main/webapp/WEB-INF/web.xml
[context_component-scan_use-default-filters]: http://jinnianshilongnian.iteye.com/blog/1762632
[DispatcherServlet_ _SpringMVC]: http://jinnianshilongnian.iteye.com/blog/1602617
[AppConfig.java]: https://github.com/zhangkaitao/spring4-showcase/blob/master/spring-mvc-test/src/main/java/com/sishuok/config/AppConfig.java
[MvcConfig.java]: https://github.com/zhangkaitao/spring4-showcase/blob/master/spring-mvc-test/src/main/java/com/sishuok/config/MvcConfig.java
[WebInitializer.java]: https://github.com/zhangkaitao/spring4-showcase/blob/master/spring-mvc-test/src/main/java/com/sishuok/config/WebInitializer.java
[Spring4_Groovy Bean_DSL]: http://jinnianshilongnian.iteye.com/blog/1991830
[Java_3_CI]: http://jinnianshilongnian.iteye.com/blog/1893135
[github]: https://github.com/zhangkaitao/spring4-showcase/tree/master/spring-mvc-test/src/test/java/com/sishuok/mvc/controller
[Spring github]: https://github.com/SpringSource/spring-framework/tree/master/spring-test/src/test/java/org/springframework/test/web/servlet/samples