作者：alanshelby

來源：zhuanlan.zhihu.com/p/43260823

「一、前言」

在前面的章節(jié)我們介紹過 Junit 的使用，也了解過 spring-test，今天我們來了解一個新玩意 -- mock 測試。這里僅僅做一個入門，對返回視圖和返回 Json 數(shù)據(jù)的方法進行測試演示，不會把所有的方法都介紹到，具體文檔詳見鏈接：Mock Test，本章節(jié)主要講解以下兩部分內(nèi)容：

1、Mock 測試簡介

2、測試用例演示

二、Mock 測試簡介

1、什么是 mock 測試

在測試過程中，對于某些不容易構(gòu)造或者不容易獲取的對象，用一個「虛擬的對象」來創(chuàng)建以便測試的測試方法，就是 「mock 測試」在測試過程中，對于某些不容易構(gòu)造或者不容易獲取的對象，用一個「虛擬的對象」來創(chuàng)建以便測試的測試方法，就是mock 測試。

• 虛擬的對象就是 mock 對象。
• mock 對象就是真實對象在調(diào)試期間的代替品。

2、為什么使用 mock 測試

• 避免開發(fā)模塊之間的耦合
• 輕量、簡單、靈活

3、MockMVC 介紹

基于 RESTful 風格的 SpringMVC 的測試，我們可以測試完整的 Spring MVC 流程，即從 URL 請求到控制器處理，再到視圖渲染都可以測試。

1）MockMvcBuilder

MockMvcBuilder 是用來構(gòu)造 MockMvc 的構(gòu)造器，其主要有兩個實現(xiàn)：StandaloneMockMvcBuilder 和 DefaultMockMvcBuilder，對于我們來說直接使用「靜態(tài)工廠 MockMvcBuilders 創(chuàng)建」即可。

2）MockMvcBuilders

負責創(chuàng)建 MockMvcBuilder 對象，有兩種創(chuàng)建方式：

standaloneSetup(Object... controllers)：通過參數(shù)指定一組控制器，這樣就不需要從上下文獲取了。

「webAppContextSetup」(WebApplicationContext wac)：指定 WebApplicationContext，將會從該上下文獲取相應的控制器并得到相應的 MockMvc，本章節(jié)下面測試用例均使用這種方式創(chuàng)建 MockMvcBuilder 對象。

3）MockMvc

對于服務器端的 SpringMVC 測試支持主入口點。通過 MockMvcBuilder 構(gòu)造 MockMvcBuilder 由 MockMvcBuilders 建造者的靜態(tài)方法去建造。

核心方法：perform(RequestBuilder rb) -- 執(zhí)行一個 RequestBuilder 請求，會自動執(zhí)行 SpringMVC 的流程并映射到相應的控制器執(zhí)行處理，該方法的返回值是一個 ResultActions。

4）ResultActions

（1）「andExpect」：添加 ResultMatcher 驗證規(guī)則，驗證控制器執(zhí)行完成后結(jié)果是否正確；

（2）「andDo」：添加 ResultHandler 結(jié)果處理器，比如調(diào)試時打印結(jié)果到控制臺；

（3）「andReturn」：最后返回相應的 「MvcResult」；然后進行自定義驗證 / 進行下一步的異步處理；

5）MockMvcRequestBuilders

用來構(gòu)建請求的，其主要有兩個子類 「MockHttpServletRequestBuilder *和」 MockMultipartHttpServletRequestBuilder*（如文件上傳使用），即用來 Mock 客戶端請求需要的所有數(shù)據(jù)。

6）MockMvcResultMatchers

（1）用來匹配執(zhí)行完請求后的「結(jié)果驗證」

（2）如果匹配失敗將拋出相應的異常

（3）包含了很多驗證 API 方法

7）MockMvcResultHandlers

（1）結(jié)果處理器，表示要對結(jié)果做點什么事情

（2）比如此處使用 MockMvcResultHandlers.print() 輸出整個響應結(jié)果信息

8）MvcResult

（1）單元測試執(zhí)行結(jié)果，可以針對執(zhí)行結(jié)果進行「自定義驗證邏輯」。

三、測試用例演示

1、添加依賴

org.springframeworkspring-test5.0.7.RELEASEjunitjunit4.12com.jayway.jsonpathjson-path2.2.0

前兩個 jar 依賴我們都已經(jīng)接觸過了，對于返回視圖方法的測試這兩個 jar 依賴已經(jīng)足夠了，第三個 jar 依賴是用于處理返回 Json 數(shù)據(jù)方法的，這里要明白每個 jar 的具體作用。

2、被測試的方法

@RequestMapping(value = "editItem")
public String editItem(Integer id, Model model) {
 Item item = itemService.getItemById(id);
 model.addAttribute("item", item); return "itemEdit";
}

@RequestMapping(value = "getItem")
@ResponseBody
public Item getItem(Integer id) {
 Item item = itemService.getItemById(id); return item;
}

這里我們提供了兩個方法，一個是返回視圖的方法，另一個是返回 Json 數(shù)據(jù)的方法，下面我們會給出測試類，分別對這兩個方法進行測試。

3、測試類：ItemMockTest

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = "classpath:spring/*.xml")
@WebAppConfiguration
public class ItemMockTest {

    @Autowired
    private WebApplicationContext context;

    private MockMvc mockMvc;

    @Before
    public void init() {
        mockMvc = MockMvcBuilders.webAppContextSetup(context).build();
    }
}

這里前兩個注解就不再解釋了，我們在學習 Spring 與 Junit 整合的時候已經(jīng)講解過了，這里說一下第三個注解：@WebAppConfiguration：可以在單元測試的時候，不用啟動 Servlet 容器，就可以獲取一個 Web 應用上下文。

1）返回視圖方法測試

@Test
public void test() throws Exception {
 MvcResult result = mockMvc.perform(MockMvcRequestBuilders.get("/editItem").param("id", "1"))
   .andExpect(MockMvcResultMatchers.view().name("itemEdit"))
   .andExpect(MockMvcResultMatchers.status().isOk())
   .andDo(MockMvcResultHandlers.print())
   .andReturn();
 Assert.assertNotNull(result.getModelAndView().getModel().get("item"));
}

img

這三句代碼是我們對結(jié)果的期望，最后打印出了結(jié)果，說明執(zhí)行成功，所有期望都達到了，否則會直接報錯。從結(jié)果中我們就可以看到這個請求測試的情況。

2、返回 Json 數(shù)據(jù)方法

@Test
public void test1() throws Exception {
 mockMvc.perform(MockMvcRequestBuilders.get("/getItem")
   .param("id", "1")
   .accept(MediaType.APPLICATION_JSON))
   .andExpect(MockMvcResultMatchers.status().isOk())
   .andExpect(MockMvcResultMatchers.content().contentTypeCompatibleWith(MediaType.APPLICATION_JSON))
   .andExpect(MockMvcResultMatchers.jsonPath("$.id").value(1))
   .andExpect(MockMvcResultMatchers.jsonPath("$.name").value("IPhone X"))
   .andDo(MockMvcResultHandlers.print())
   .andReturn();
}

img

在這個方法中比較特殊的就是設置 MediaType 類型，因為都是使用 Json 格式，所以設置了 MediaType.APPLICATION_JSON，jsonPath 用于比對期望的數(shù)據(jù)是否與返回的結(jié)果一致，這里需要注意的是 "$.id" 這 key 的種形式。

四、小結(jié)

這里只是用到了 MockMvc 很小一部分知識，更加深入學習會使你養(yǎng)成一種良好編寫單元測試的習慣，這是十分難得的一種好習慣，推薦去看官方文檔，然后動手去測試一下，為你編寫的每一個 Controller 方法進行測試，保證他們的可靠性。

免責聲明：本文內(nèi)容由21ic獲得授權后發(fā)布，版權歸原作者所有，本平臺僅提供信息存儲服務。文章僅代表作者個人觀點，不代表本平臺立場，如有問題，請聯(lián)系我們，謝謝！