Junit學習筆記之五：MockMVC
1.1 安裝測試環境
spring mvc測試框架提供了兩種方式，獨立安裝和整合Web環境測試（此種方式並不會整合真正的web環境，而是通過相應的Mock API進行模擬測試，無須啟動伺服器）。
獨立測試方式
Java程式碼
- public class UserControllerStandaloneSetupTest {
- private MockMvc mockMvc;
- @Before
- public void setUp() {
-
UserController userController = newUserController();
- mockMvc = MockMvcBuilders.standaloneSetup(userController).build();
- }
- }
1、首先自己建立相應的控制器，注入相應的依賴
2、通過MockMvcBuilders.standaloneSetup模擬一個Mvc測試環境，通過build得到一個MockMvc
3、MockMvc：是我們以後測試時經常使用的API，後邊介紹
整合Web環境方式
Java程式碼
- //XML風格
-
@RunWith(SpringJUnit4ClassRunner.class)
- @WebAppConfiguration(value = "src/main/webapp")
- @ContextHierarchy({
- @ContextConfiguration(name = "parent", locations = "classpath:spring-config.xml"),
- @ContextConfiguration(name = "child", locations = "classpath:spring-mvc.xml")
- })
- //註解風格
-
//@RunWith(SpringJUnit4ClassRunner.class)
- //@WebAppConfiguration(value = "src/main/webapp")
- //@ContextHierarchy({
- // @ContextConfiguration(name = "parent", classes = AppConfig.class),
- // @ContextConfiguration(name = "child", classes = MvcConfig.class)
- //})
- public class UserControllerWebAppContextSetupTest {
- @Autowired
- private WebApplicationContext wac;
- private MockMvc mockMvc;
- @Before
- public void setUp() {
- mockMvc = MockMvcBuilders.webAppContextSetup(wac).build();
- }
- }
1、@WebAppConfiguration：測試環境使用，用來表示測試環境使用的ApplicationContext將是WebApplicationContext型別的；value指定web應用的根；
2、@ContextHierarchy：指定容器層次，即spring-config.xml是父容器，而spring-mvc.xml是子容器
3、通過@Autowired WebApplicationContext wac：注入web環境的ApplicationContext容器；
4、然後通過MockMvcBuilders.webAppContextSetup(wac).build()建立一個MockMvc進行測試；
到此測試環境就搭建完成了，根據需要選擇使用哪種方式即可。
1.2、HelloWorld
Java程式碼
- @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"));
- }
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、解除安裝測試環境
1.4、瞭解測試API
Spring mvc測試框架提供了測試MVC需要的API，主要包括Servlet/JSP Mock、MockMvcBuilder、MockMvc、RequestBuilder、ResultMatcher、ResultHandler、MvcResult等。另外提供了幾個靜態工廠方法便於測試：MockMvcBuilders、MockMvcRequestBuilders、MockMvcResultMatchers、MockMvcResultHandlers。在使用時請使用靜態方法匯入方便測試，如：
Java程式碼
- import static org.springframework.test.web.servlet.setup.MockMvcBuilders.*;
- import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*;
- import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.*;
- 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程式碼
- MvcResult result = mockMvc.perform(MockMvcRequestBuilders.get("/user/1"))
- .andExpect(MockMvcResultMatchers.view().name("user/view"))
- .andExpect(MockMvcResultMatchers.model().attributeExists("user"))
- .andDo(MockMvcResultHandlers.print())
- .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程式碼
- //測試普通控制器
- 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到控制檯
測試普通控制器，但是URL錯誤，即404
Java程式碼
- //找不到控制器，404測試
- MvcResult result = mockMvc.perform(get("/user2/{id}", 1)) //執行請求
- .andDo(print())
- .andExpect(status().isNotFound()) //驗證控制器不存在
- .andReturn();
- Assert.assertNull(result.getModelAndView()); //自定義斷言
得到MvcResult自定義驗證
Java程式碼
- MvcResult result = mockMvc.perform(get("/user/{id}", 1))//執行請求
- .andReturn(); //返回MvcResult