spring boot集成MockMvc进行集成测试小案例

我也是第一次接触这个mock，之所以会接触是因为实习考核中的小demo中需要对自己写的controller接口进行集成测试，，因为自己之前没有学过，，所以就开始在网上疯狂查找资料，，，，不过查询到的文章质量也是一言难尽，，，，。

简单介绍一下集成测试：

我们使用的junit单元测试只是针对简单的领域对象，即所有的 Controller、Service、dao都只是基于单个领域对象的增删改查，而集成测试是可以将 Controller->Service->dao->Database 视为一个整体来进行测试。 因为我们交付给用户最终的入口就是Controller，所以在 Controller 进行测试是对项目代码质量的最低要求。

可以优先参考这篇文章，里面对于这个mock集成测试的介绍也是比较清楚的，不过可能boot依赖的版本有点低：SpringBoot集成Mock进行接口测试_柒仟易的博客-CSDN博客_springboot集成mock

其次就是这一篇：为什么要 Java 集成测试呢？_HyZhan丶丶的博客-CSDN博客_java集成测试

最后自己通过查询资料写的接口测试小案例如下：（在网上查找资料的时候一定要注意自己依赖包的版本，很多文章使用到的boot版本可能是比较旧的，，然后你自己的开发环境是比较新的boot依赖，这就会导致你自己点不出来文章中相关的方法。。。。）

我下面的案例演示是基于springBoot 2.5.8。

对应的controller接口：service的实现就不放在这里了。

/**
 * @author lijingming
 * @create 2022/7/28
 */
@RestController
@RequestMapping("/student")
public class PracticeStudentController {

    @Autowired
    PracticeStudentService practiceStudentService;

    /**
     * 新增学生
     * @param createPracticeStudentRequestDTO
     * @return
     */
    @PostMapping("/save")
    public ResponseEntity<String> saveStudent(@RequestBody CreatePracticeStudentRequestDTO createPracticeStudentRequestDTO){
        if (createPracticeStudentRequestDTO == null){
            return ResponseEntity.badRequest().body("传入的数据为空,新增学生信息失败");
        }
        String id = createPracticeStudentRequestDTO.getId();
        String name = createPracticeStudentRequestDTO.getName();
        Long age = createPracticeStudentRequestDTO.getAge();
        String cardnum = createPracticeStudentRequestDTO.getCardnum();
        if (age < 0 || age > 150){
            return ResponseEntity.badRequest().body("年龄不合法");
        }
        if (name == null){
            return ResponseEntity.badRequest().body("name不能为null");
        }
        if (cardnum == null){
            return ResponseEntity.badRequest().body("cardnum 不能为null");
        }
        practiceStudentService.createPracticeStudent(createPracticeStudentRequestDTO);
        return ResponseEntity.badRequest().body("学生信息新增成功");
    }



    /**
     * 修改学生信息
     * @param practiceStudentDto
     * @return 操作是否成功的字符串说明
     */
    @PutMapping("/update")
    public ResponseEntity<String> updateStudent(@RequestBody UpdatePracticeStudentRequestDTO practiceStudentDto){


        if (practiceStudentDto == null){
            return ResponseEntity.badRequest().body("传入数据为空");
        }
        Long age = practiceStudentDto.getAge();
        if (age < 0 || age > 150){
            return ResponseEntity.badRequest().body("年龄异常,请重新输入");
        }
        String id = practiceStudentDto.getId();
        if (id == null){
            return ResponseEntity.badRequest().body("修改学生的id不能为null");
        }
        String name = practiceStudentDto.getName();
        if (name == null || name.length() > 30){
            return ResponseEntity.badRequest().body("name不能为null或者是长度不能超过30");
        }
        String cardnum = practiceStudentDto.getCardnum();
        if (cardnum == null){
            return ResponseEntity.badRequest().body("cardnum 不能为null");
        }
        //通过save这个方法也可以实现学生信息的修改，有主键就是修改没主键那就是新增
        practiceStudentService.updatePracticeStudent(practiceStudentDto);
        return ResponseEntity.ok().body("学生信息修改成功");
    }



}

测试类的编写：

/**
 * @create 2022/7/28
 * 注意在使用boot进行测试的时候，@SpringBootTest这里必须指定这个boot程序的入口，否则会报奇怪的异常的，，，当然可能也不报错，，这就看你其他地方是怎么配置的了，还有就是这个包或者是文件的命名不要使用java开头，否则会被类加载器捕获，从而报非法命名的。
 */
@SpringBootTest(classes = SinoGearPracticeApp.class) 
@AutoConfigureMockMvc
public class PracticeStudentControllerTest {

    @Autowired
    private WebApplicationContext context;

    @Autowired
    private ObjectMapper mapper;

    private static final Logger LOGGER = LoggerFactory.getLogger(PracticeStudentControllerTest.class);


    @Autowired
    private MockMvc mvc;

    @Before
    public void setUp () throws Exception{
        LOGGER.debug("DictResourceTest test started.");
        mvc = MockMvcBuilders.webAppContextSetup(context).build();

    }


    @Test
    public void updateStudentSuccessTest() throws Exception{
        //修改数据库的该条记录
        PracticeStudent student = new PracticeStudent();
        student.setId("6bda7583-f086-4ccc-9096-73f7e23a6098");
        student.setAge(27l);
        student.setLoves("游戏机");
        student.setName("测试小孩");
        student.setCardnum("123456");

        //初始化RequestBuilder请求对象
        MockHttpServletRequestBuilder requestBuilder = MockMvcRequestBuilders.put("http://127.0.0.1:8080/student/update")
            .content(mapper.writeValueAsString(student))
            .contentType(MediaType.APPLICATION_JSON) //只用设置这一个为json格式就行，设置多了可能会出现乱码
            ;

        mvc.perform(requestBuilder)
            .andDo(MockMvcResultHandlers.print())
            .andExpect(MockMvcResultMatchers.status().isOk())
            .andExpect(MockMvcResultMatchers.jsonPath("$.errMsg").doesNotExist())
            .andReturn().getResponse()
            .getContentAsString()
        ;
    }

    //进行修改失败的测试，因为这个age是超过了我们的判定范围的
    @Test
    public void updateStudentFailTest() throws Exception{
        //修改数据库的该条记录
        PracticeStudent student = new PracticeStudent();
        student.setId("6bda7583-f086-4ccc-9096-73f7e23a6098");
        student.setAge(260l);
        student.setLoves("游戏机");
        student.setName("测试小孩");
        student.setCardnum("56789");

        //初始化RequestBuilder请求对象
        MockHttpServletRequestBuilder requestBuilder = MockMvcRequestBuilders.put("http://127.0.0.1:8080/student/update")
            .content(mapper.writeValueAsString(student))
            .contentType(MediaType.APPLICATION_JSON)
            ;

        mvc.perform(requestBuilder)
            .andDo(MockMvcResultHandlers.print())
            .andExpect(MockMvcResultMatchers.status().isOk())
            .andExpect(MockMvcResultMatchers.jsonPath("$.errMsg").doesNotExist())
            .andReturn().getResponse()
            .getContentAsString()
        ;
    }


}

测试结果：一个通过一个失败；