SpringMVC框架整合Junit进行单元测试（案例详解）

SpringMVC框架整合Junit进⾏单元测试（案例详解）本⽂主要介绍在SpringMVC框架整合Junit框架进⾏单元测试。闲话少述，让我们直⼊主题。系统环境软件版本spring-webmvc4.3.6.RELEASEspring-test4.3.6.RELEASEjunit4.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个依赖，其中：1.junit是Junit单元测试的基础依赖，它提供了@RunWith和@Test等单元测试必备的注解。<scope>test</scope>则指明了该依赖的作⽤范围是test阶段。2.spring-test依赖可以理解成是spring框架与junit框架的桥梁。提供了@WebAppConfiguration等注解。编写单元测试基类@RunWith(SpringJUnit4ClassRunner.class)@WebAppConfiguration@ContextConfiguration("file:src/test/java/spring-config.xml")@ActiveProfiles("dev")@TransactionConfiguration(transactionManager="transactionManager",defaultRollback=true)publicabstractclassBaseControllerTest{protectedMockMvcmvc;@AutowiredprivateWebApplicationContextcontext;//获取系统上下⽂protectedWebApplicationContextgetCtx(){returnthis.context;}//初始化⽅法@Beforepublicvoidsetup()throwsSQLException{this.mvc=MockMvcBuilders.webAppContextSetup(this.context).build();}//封装返回结果protectedStringgetMockResultStr(MockHttpServletRequestBuilderrequestBuilder){try{MvcResultmvcResult=this.mockMvc.perform(requestBuilder).andExpect(status().isOk()).andDo(MockMvcResultHandlers.print()).andReturn();MockHttpServletResponseresponse=mvcResult.getResponse();response.setContentType(MediaType.APPLICATION_JSON_UTF8_VALUE);returnresponse.getContentAsString();}catch(Exceptione){e.printStackTrace();returnnull;}}}代码说明1.@RunWith(SpringJUnit4ClassRunner.class)注解表明使⽤SpringJUnit4ClassRunner来运⾏测试⽤例。2.@WebAppConfiguration注解表明使⽤的ApplicationContext将是WebApplicationContext类型的；value属性指定web应⽤的根；同时，他必须与@ContextConfiguration⼀同使⽤。3.@ContextConfiguration注解的作⽤是导⼊我们需要的配置⽂件或者类，这⾥指定了SpringMVC的配置⽂件4.@ActiveProfiles注解是指定单元测试连接的环境。5.@TransactionConfiguration注解是⽤与管理spring事务的。6.MockHttpServletRequest类为了模拟HttpServletRequest对象，可以通过它来设置请求头，这在需要鉴权的接⼝测试中⼗分实⽤。7.MockMvc实现了对Http请求的模拟，能够直接使⽤⽹络的形式，转换到Controller的调⽤，这样可以使得测试速度快，不依赖⽹络环境，⽽且提供了⼀套验证的⼯具，这样可以使得请求的验证统⼀⽽且很⽅便。getMockResultStr⽅法是封装了公共的测试⽅法以及响应参数。其中：MvcResultmvcResult=this.mockMvc.perform(requestBuilder).andExpect(status().isOk()).andDo(MockMvcResultHandlers.print()).andReturn();1.perform⽅法是执⾏⼀个RequestBuilder请求，调⽤Controller的业务处理逻辑。2.andExpect⽅法是添加执⾏完成后的断⾔，添加ResultMatcher验证规则，验证控制器执⾏完成后结果是否正确，此处是验证状态是否是2003.andDo⽅法是添加⼀个结果处理器，⽐如再此处是andDo(MockMvcResultHandlers.print())输出整个响应结果信息，可以在调试的时候使⽤。4.andReturn：⽅法是执⾏完成后返回相应的结果。MockMvcRequestBuildersRequestBuilder是⽤来构建请求的。其提供了⼀个⽅法buildRequest(ServletContextservletContext)⽤于构建MockHttpServletRequest；其主要有两个⼦类MockHttpServletRequestBuilder和MockMultipartHttpServletRequestBuilder（⽂件上传时使⽤），即⽤来mock客户端请求需要的所有数据。主要API有MockHttpServletRequestBuilder.get(StringurlTemplate,Object…urlVariables)：根据uri模板和uri变量值得到⼀个GET请求⽅式的RequestBuilder，如果在controller的⽅法中method选择的是RequestMethod.GET，那在controllerTest中对应就要使⽤MockMvcRequestBuilders.get。MockHttpServletRequestBuilder.post(StringurlTemplate,Object…urlVariables)：同get类似，但是是post⽅法，通过param⽅法来设置请求参数。返回结果的content-type是application/json的请求的单元测试get请求测试get请求的测试就是调⽤MockMvcRequestBuilders的get⽅法，在该⽅法中传⼊接⼝地址。MockHttpServletRequestBuilderrequestBuilder=MockMvcRequestBuilders.get("/v1/works/lineup/set").param("id","123").param("first_flag",String.valueOf(true));Stringresult=getMockResultStr(requestBuilder);post请求测试post请求的测试就是调⽤MockMvcRequestBuilders的post⽅法，在该⽅法中传⼊接⼝地址。MockHttpServletRequestBuilderrequestBuilder=MockMvcRequestBuilders.post("/v1/blockly/copy").param("id","1211");success(requestBuilder);⽂件上传测试⽂件上传的测试就是调⽤MockMvcRequestBuilders的multipart⽅法，在该⽅法中传⼊接⼝地址。Filefile=newFile(RestArmWorksControllerTest.class.getClassLoader().getResource("20201102172053.png").toURI());MockMultipartFilemockMultipartFile=newMockMultipartFile("file","20201102172053.png","",newFileInputStream(file));MockMultipartHttpServletRequestBuilderservletRequestBuilder=MockMvcRequestBuilders.multipart("/creation/fileUpload.do").file(mockMultipartFile);Stringresult=getMockResultStr(servletRequestBuilder);发送⼀个json格式的数据到Controller层StringrequestJson=JSONObject.toJSONString(folderInfo);MockHttpServletRequestBuilderrequestBuilder=MockMvcRequestBuilders.post("//v1/works/save").contentType(MediaType.APPLICATION_JSON).content(requestJson)；返回结果是视图请求的单元测试那么，问题来了，如果⼀个接⼝的返回结果是视图，那么这个接⼝的单元测试该如何写呢？⽐如下⾯这个接⼝：@RequestMapping(value="/edit")publicStringedit(ModelMapmodel,HttpServletRequestrequest,HttpServletResponseresponse){LongscriptId=null;if(StringUtils.isNotBlank(request.getParameter("scriptId"))){scriptId=Long.parseLong(request.getParameter("scriptId"));}if(scriptId!=null){MallSuperscriptmallSuperscript=superScriptService.getScriptById(scriptId);model.addAttribute("superScript",mallSuperscript);}model.addAttribute("scriptTypeMap",ScriptType.toMap());("⾓标编辑页⾯返回成功");return"manage/superScript/edit";}这个接⼝返回的是⼀个视图，就是名称为edit.jsp页⾯。它的测试⽅法可以像下⾯这样写。@TestpublicvoidtestEdit()throwsException{MvcResultmvcResult=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层的接⼝，那么如果要测试⼀个