SpringMVC框架整合Junit進行單元測試(案例詳解)

更新時間：2021年05月06日 10:31:12 作者：碼農(nóng)飛哥

本文詳細介紹在SpringMVC任何使用Junit框架。首先介紹了如何引入依賴，接著介紹了編寫一個測試基類，并且對其中涉及的各個注解做了一個詳細說明，感興趣的朋友跟隨小編一起看看吧

本文主要介紹在SpringMVC框架整合Junit框架進行單元測試。閑話少述，讓我們直入主題。

在這里插入圖片描述

系統(tǒng)環(huán)境

軟件	版本
spring-webmvc	4.3.6.RELEASE
spring-test	4.3.6.RELEASE
junit	4.12

引入依賴

<dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>4.12</version>
                <scope>test</scope>
            </dependency>
			  <dependency>
                <groupId>org.springframework</groupId>
                <artifactId>spring-test</artifactId>
                <version>${spring.version}</version>
                <scope>test</scope>
            </dependency>

如上，引入了4個依賴，其中：

junit 是Junit單元測試的基礎(chǔ)依賴，它提供了@RunWith和@Test等單元測試必備的注解。<scope>test</scope> 則指明了該依賴的作用范圍是test階段。
spring-test依賴可以理解成是spring框架與junit框架的橋梁。提供了@WebAppConfiguration等注解。

編寫單元測試基類

@RunWith(SpringJUnit4ClassRunner.class)
@WebAppConfiguration
@ContextConfiguration("file:src/test/java/spring-config.xml")
@ActiveProfiles("dev")
@TransactionConfiguration(transactionManager = "transactionManager", defaultRollback = true)
public abstract class BaseControllerTest  {
    
    protected MockMvc mvc;
    
    @Autowired
    private WebApplicationContext context;
    
   //獲取系統(tǒng)上下文 
    protected WebApplicationContext getCtx() {
        return this.context;
    }
	//初始化方法
    @Before
    public void setup() throws SQLException {
       this.mvc = MockMvcBuilders.webAppContextSetup(this.context).build();
    }
	//封裝返回結(jié)果
    protected String getMockResultStr(MockHttpServletRequestBuilder requestBuilder) {
        try {
            MvcResult mvcResult = this.mockMvc
                    .perform(requestBuilder)
                    .andExpect(status().isOk())
                    .andDo(MockMvcResultHandlers.print())
                    .andReturn();
            MockHttpServletResponse response = mvcResult.getResponse();
            response.setContentType(MediaType.APPLICATION_JSON_UTF8_VALUE);
            return response.getContentAsString();
        } catch (Exception e) {
            e.printStackTrace();
            return null;
        }
    }
}

代碼說明

@RunWith(SpringJUnit4ClassRunner.class) 注解表明使用SpringJUnit4ClassRunner來運行測試用例。
@WebAppConfiguration 注解表明使用的ApplicationContext將是WebApplicationContext類型的；value屬性指定web應(yīng)用的根；同時，他必須與 @ContextConfiguration一同使用。
@ContextConfiguration注解的作用是導入我們需要的配置文件或者類，這里指定了SpringMVC的配置文件
@ActiveProfiles 注解是指定單元測試連接的環(huán)境。
@TransactionConfiguration 注解是用與管理spring事務(wù)的。
MockHttpServletRequest 類為了模擬HttpServletRequest 對象，可以通過它來設(shè)置請求頭，這在需要鑒權(quán)的接口測試中十分實用。
MockMvc 實現(xiàn)了對Http請求的模擬，能夠直接使用網(wǎng)絡(luò)的形式，轉(zhuǎn)換到Controller的調(diào)用，這樣可以使得測試速度快，不依賴網(wǎng)絡(luò)環(huán)境，而且提供了一套驗證的工具，這樣可以使得請求的驗證統(tǒng)一而且很方便。

getMockResultStr 方法是封裝了公共的測試方法以及響應(yīng)參數(shù)。其中：

MvcResult mvcResult = this.mockMvc
                    .perform(requestBuilder)
                    .andExpect(status().isOk())
                    .andDo(MockMvcResultHandlers.print())
                    .andReturn();

perform方法是執(zhí)行一個RequestBuilder請求，調(diào)用Controller的業(yè)務(wù)處理邏輯。
andExpect 方法是添加執(zhí)行完成后的斷言，添加ResultMatcher驗證規(guī)則，驗證控制器執(zhí)行完成后結(jié)果是否正確，此處是驗證狀態(tài)是否是200
andDo 方法是添加一個結(jié)果處理器，比如再此處是andDo(MockMvcResultHandlers.print())輸出整個響應(yīng)結(jié)果信息，可以在調(diào)試的時候使用。
andReturn：方法是執(zhí)行完成后返回相應(yīng)的結(jié)果。

MockMvcRequestBuilders

RequestBuilder是用來構(gòu)建請求的。其提供了一個方法buildRequest(ServletContext servletContext) 用于構(gòu)建MockHttpServletRequest；其主要有兩個子類MockHttpServletRequestBuilder和MockMultipartHttpServletRequestBuilder（文件上傳時使用），即用來mock客戶端請求需要的所有數(shù)據(jù)。
主要API有MockHttpServletRequestBuilder.get(String urlTemplate, Object… urlVariables)：根據(jù)uri模板和uri變量值得到一個GET請求方式的RequestBuilder，如果在controller的方法中method選擇的是RequestMethod.GET，那在controllerTest中對應(yīng)就要使用MockMvcRequestBuilders.get。
MockHttpServletRequestBuilder.post(String urlTemplate, Object… urlVariables)：同get類似，但是是post方法，通過param 方法來設(shè)置請求參數(shù)。

返回結(jié)果的content-type是application/json的請求的單元測試

get請求測試

get請求的測試就是調(diào)用MockMvcRequestBuilders的get方法，在該方法中傳入接口地址。

 MockHttpServletRequestBuilder requestBuilder = MockMvcRequestBuilders.get("/v1/works/lineup/set")
                .param("id", "123")
                .param("first_flag", String.valueOf(true));
      String result = getMockResultStr(requestBuilder);

post請求測試

post請求的測試就是調(diào)用MockMvcRequestBuilders的post方法，在該方法中傳入接口地址。

MockHttpServletRequestBuilder requestBuilder = MockMvcRequestBuilders.post("/v1/blockly/copy")
                .param("id", "1211");
        success(requestBuilder);

文件上傳測試

文件上傳的測試就是調(diào)用MockMvcRequestBuilders的multipart方法，在該方法中傳入接口地址。

File file = new File(RestArmWorksControllerTest.class.getClassLoader().getResource("20201102172053.png").toURI());
        MockMultipartFile mockMultipartFile = new MockMultipartFile("file", "20201102172053.png", "", new FileInputStream(file));
        MockMultipartHttpServletRequestBuilder servletRequestBuilder = MockMvcRequestBuilders.multipart("/creation/fileUpload.do")
                .file(mockMultipartFile);
        String result = getMockResultStr(servletRequestBuilder);

發(fā)送一個json格式的數(shù)據(jù)到Controller層

String requestJson = JSONObject.toJSONString(folderInfo);
      MockHttpServletRequestBuilder requestBuilder = MockMvcRequestBuilders.post("http://v1/works/save").contentType(MediaType.APPLICATION_JSON).content(requestJson)；

返回結(jié)果是視圖請求的單元測試

那么，問題來了，如果一個接口的返回結(jié)果是視圖，那么這個接口的單元測試該如何寫呢？比如下面這個接口：

 @RequestMapping(value = "/edit")
   public String edit(ModelMap model, HttpServletRequest request, HttpServletResponse response) {
       Long scriptId = null;
       if (StringUtils.isNotBlank(request.getParameter("scriptId"))) {
           scriptId = Long.parseLong(request.getParameter("scriptId"));
       }
       if (scriptId != null) {
           MallSuperscript mallSuperscript = superScriptService.getScriptById(scriptId);
           model.addAttribute("superScript", mallSuperscript);
       }
       model.addAttribute("scriptTypeMap", ScriptType.toMap());
       logger.info("角標編輯頁面返回成功");
       return "manage/superScript/edit";

   }

這個接口返回的是一個視圖，就是名稱為edit.jsp頁面。它的測試方法可以像下面這樣寫。

@Test
    public void testEdit() throws Exception {

        MvcResult mvcResult = mvc
                .perform(
                        get("/manage/tab2/superScript/edit").sessionAttr("adminid", "1111")
                                .sessionAttr("platformid", 1001L).param("scriptId", "1111"))
                .andExpect(status().isOk()).andDo(print()).andReturn();
       
        assertEquals("manage/superScript/edit", mvcResult.getModelAndView().getViewName());
    }

通過mvcResult.getModelAndView().getViewName()獲取視圖的名稱。

直接測試一個service的方法

上面的那些測試針對的都是Controller層的接口，那么如果要測試一個service層的方法，該如何處理呢？

public class MallMailJobTest extends BaseControllerTest {

    private MallMailJob mallMailJob;

    @Override
    @Before
    public void setup() throws SQLException {
        super.setup();
        mallMailJob = getCtx().getBean(MallMailJob.class);
    }

    /**
     * 
     * @throws Exception
     */
    @Test
    public void testExecute() throws Exception {
        mallMailJob.execute();
    }

被測試的MallMailJob類也可以通過@Autowired 注解直接注入進Spring IOC容器中。拿到被測試類的實例之后就可以直接調(diào)用被測試的方法，是不是灰常的簡單呀。