Spring Boot 进行 MockMvc 单元测试的实例

2024-01-14 14:44
文章标签 java 进行 spring 实例 boot 单元测试 mockmvc

本文主要是介绍Spring Boot 进行 MockMvc 单元测试的实例，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

在Spring Boot应用程序中，使用MockMvc进行单元测试是一种有效的方式，可以验证控制器的行为和API的正确性。在这篇博客中，我们将介绍如何使用MockMvc对用户控制器（UserController）进行测试，该控制器涉及用户信息的增删改查操作。

UserController测试类

package com.lfsun.mockmvc;import com.fasterxml.jackson.databind.ObjectMapper;
import com.lfsun.mockmvc.entity.User;
import com.lfsun.mockmvc.service.UserService;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.MediaType;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;import java.util.Arrays;
import java.util.List;import static org.mockito.Mockito.when;
import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;@RunWith(SpringRunner.class)
@SpringBootTest
@AutoConfigureMockMvc
public class UserControllerTest {@Autowiredprivate MockMvc mockMvc;@Autowiredprivate UserService userService;@Autowiredprivate ObjectMapper objectMapper;@Beforepublic void setUp() {// 在测试前初始化一些数据，或者使用Mockito进行一些mock设置}@Testpublic void getAllUsersTest() throws Exception {mockMvc.perform(MockMvcRequestBuilders.get("/user/getAllUsers")).andExpect(status().isOk()).andExpect(jsonPath("$").isArray()).andExpect(jsonPath("$.length()").value(userService.getAllUsers().size())).andDo(print());}@Testpublic void getUserByIdTest() throws Exception {Long userId = 1L;mockMvc.perform(MockMvcRequestBuilders.get("/user/getUserById/{userId}", userId)).andExpect(status().isOk()).andExpect(jsonPath("$.userId").value(userId)).andDo(print());}@Testpublic void addUserTest() throws Exception {User user = new User();user.setUsername("testUser");user.setEmail("test@lfsun.com");mockMvc.perform(MockMvcRequestBuilders.post("/user/addUser").contentType(MediaType.APPLICATION_JSON).content(objectMapper.writeValueAsString(user))).andExpect(status().isOk()).andExpect(jsonPath("$.username").value("testUser")).andExpect(jsonPath("$.email").value("test@lfsun.com")).andDo(print());}@Testpublic void updateUserTest() throws Exception {Long userId = 1L;User updatedUser = new User();updatedUser.setUserId(userId);updatedUser.setUsername("updatedUser");updatedUser.setEmail("updated@lfsun.com");mockMvc.perform(MockMvcRequestBuilders.put("/user/updateUser").contentType(MediaType.APPLICATION_JSON).content(objectMapper.writeValueAsString(updatedUser))).andExpect(status().isOk()).andExpect(jsonPath("$.userId").value(userId)).andExpect(jsonPath("$.username").value("updatedUser")).andExpect(jsonPath("$.email").value("updated@lfsun.com")).andDo(print());}@Testpublic void deleteUserTest() throws Exception {Long userId = 1L;mockMvc.perform(MockMvcRequestBuilders.delete("/user/deleteUser/{userId}", userId)).andExpect(status().isOk()).andDo(print());}
}

解释和注意事项

  1. MockMvc的注入： @Autowired 注解用于将MockMvc实例注入测试类中。
  2. 数据初始化： 使用 @Before 注解的 setUp 方法，可以在测试前进行一些数据初始化或使用Mockito进行一些mock设置。
  3. 测试方法： 每个测试方法使用MockMvc执行相应的HTTP请求，并使用断言验证控制器的响应是否符合预期。
  4. 数据序列化： ObjectMapper 负责将对象序列化为JSON，以便在POST和PUT请求中传递。

以下附上完整代码

controller：

package com.lfsun.mockmvc.controller;import com.lfsun.mockmvc.entity.User;
import com.lfsun.mockmvc.service.UserService;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.*;import java.util.List;/*** 用户 Controller** @author CL*/
@RestController
@RequestMapping(value = "/user")
@RequiredArgsConstructor
public class UserController {private final UserService userService;// 查询所有用户@GetMapping("/getAllUsers")public List<User> getAllUsers() {return userService.getAllUsers();}// 根据用户ID查询用户@GetMapping("/getUserById/{userId}")public User getUserById(@PathVariable Long userId) {return userService.getUserById(userId);}// 添加用户@PostMapping("/addUser")public User addUser(@RequestBody User user) {return userService.addUser(user);}// 更新用户信息@PutMapping("/updateUser")public User updateUser(@RequestBody User user) {return userService.updateUser(user);}// 根据用户ID删除用户@DeleteMapping("/deleteUser/{userId}")public void deleteUser(@PathVariable Long userId) {userService.deleteUser(userId);}
}

service、serviceimpl

package com.lfsun.mockmvc.service;import com.lfsun.mockmvc.entity.User;import java.util.List;/*** 用户 Service 接口*/
public interface UserService {// 查询所有用户List<User> getAllUsers();// 根据用户ID查询用户User getUserById(Long userId);// 添加用户User addUser(User user);// 更新用户信息User updateUser(User user);// 根据用户ID删除用户void deleteUser(Long userId);
}

package com.lfsun.mockmvc.service.impl;import com.lfsun.mockmvc.entity.User;
import com.lfsun.mockmvc.mapper.UserMapper;
import com.lfsun.mockmvc.service.UserService;
import lombok.AllArgsConstructor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;import java.util.List;/*** 用户 Service 实现类*/
@Service
@AllArgsConstructor  // Lombok 自动生成构造函数
public class UserServiceImpl implements UserService {private final UserMapper userMapper;@Overridepublic List<User> getAllUsers() {return userMapper.getAllUsers();}@Overridepublic User getUserById(Long userId) {return userMapper.getUserById(userId);}@Overridepublic User addUser(User user) {userMapper.addUser(user);return user;}@Overridepublic User updateUser(User user) {userMapper.updateUser(user);return user;}@Overridepublic void deleteUser(Long userId) {userMapper.deleteUser(userId);}
}

mapper

package com.lfsun.mockmvc.mapper;import com.lfsun.mockmvc.entity.User;
import org.apache.ibatis.annotations.*;import java.util.List;/*** 用户 Mapper 接口*/
@Mapper
public interface UserMapper {List<User> getAllUsers();User getUserById(Long userId);void addUser(User user);void updateUser(User user);void deleteUser(Long userId);
}

实体类：

package com.lfsun.mockmvc.entity;import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {private Long userId;private String username;private String email;}

xml

<!DOCTYPE mapperPUBLIC "-//mybatis.org//DTD Mapper 3.0//EN""http://mybatis.org/dtd/mybatis-3-mapper.dtd"><mapper namespace="com.lfsun.mockmvc.mapper.UserMapper"><resultMap id="BaseResultMap" type="com.lfsun.mockmvc.entity.User"><id column="user_id" property="userId" jdbcType="BIGINT"/><result column="username" property="username" jdbcType="VARCHAR"/><result column="email" property="email" jdbcType="VARCHAR"/></resultMap><!-- 查询所有用户 --><select id="getAllUsers" resultMap="BaseResultMap">SELECT *FROM user;</select><!-- 根据用户ID查询用户 --><select id="getUserById" resultMap="BaseResultMap" parameterType="java.lang.Long">SELECT *FROM userWHERE user_id = #{userId};</select><!-- 添加用户 --><insert id="addUser" parameterType="com.lfsun.mockmvc.entity.User">INSERT INTO user (username, email)VALUES (#{username}, #{email});</insert><!-- 更新用户信息 --><update id="updateUser" parameterType="com.lfsun.mockmvc.entity.User">UPDATE userSET username = #{username},email    = #{email}WHERE user_id = #{userId};</update><!-- 根据用户ID删除用户 --><delete id="deleteUser" parameterType="java.lang.Long">DELETEFROM userWHERE user_id = #{userId};</delete></mapper>

配置

spring:datasource:driver-class-name: com.mysql.cj.jdbc.Driverurl: jdbc:mysql://127.0.0.1:3306/mockmvc?useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=UTC&rewriteBatchedStatements=trueusername: rootpassword: 123321mybatis:mapper-locations: classpath:/mapper/*.xml  # 指定 MyBatis mapper 文件的位置configuration:map-underscore-to-camel-case: true  # 配置驼峰命名规则

maven

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"><modelVersion>4.0.0</modelVersion><parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.7.14</version><relativePath/> <!-- lookup parent from repository --></parent><groupId>com.lfsun</groupId><artifactId>lfsun-study-mockmvc</artifactId><version>0.0.1-SNAPSHOT</version><name>lfsun-study-mockmvc</name><description>lfsun-study-mockmvc</description><properties><java.version>17</java.version></properties><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter</artifactId></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><scope>provided</scope></dependency><dependency><groupId>junit</groupId><artifactId>junit</artifactId><scope>test</scope></dependency><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>8.0.23</version><scope>compile</scope></dependency><dependency><groupId>org.mybatis.spring.boot</groupId><artifactId>mybatis-spring-boot-starter</artifactId><version>1.3.2</version></dependency></dependencies><build><plugins><plugin><groupId>org.springframework.boot</groupId><artifactId>spring-boot-maven-plugin</artifactId></plugin></plugins></build></project>

这篇关于Spring Boot 进行 MockMvc 单元测试的实例的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/605531。

相关文章

springboot集成easypoi导出word换行处理过程

springboot集成easypoi导出word换行处理过程

《springboot集成easypoi导出word换行处理过程》SpringBoot集成Easypoi导出Word时,换行符n失效显示为空格,解决方法包括生成段落或替换模板中n为回车,同时需确... 目录项目场景问题描述解决方案第一种：生成段落的方式第二种：替换模板的情况，换行符替换成回车总结项目场景s
阅读更多...
SpringBoot集成redisson实现延时队列教程

SpringBoot集成redisson实现延时队列教程

《SpringBoot集成redisson实现延时队列教程》文章介绍了使用Redisson实现延迟队列的完整步骤,包括依赖导入、Redis配置、工具类封装、业务枚举定义、执行器实现、Bean创建、消费... 目录1、先给项目导入Redisson依赖2、配置redis3、创建 RedissonConfig 配
阅读更多...
SpringBoot中@Value注入静态变量方式

SpringBoot中@Value注入静态变量方式

《SpringBoot中@Value注入静态变量方式》SpringBoot中静态变量无法直接用@Value注入,需通过setter方法,@Value(${})从属性文件获取值,@Value(#{})用... 目录项目场景解决方案注解说明1、@Value("${}")使用示例2、@Value("#{}"php
阅读更多...
SpringBoot分段处理List集合多线程批量插入数据方式

SpringBoot分段处理List集合多线程批量插入数据方式

《SpringBoot分段处理List集合多线程批量插入数据方式》文章介绍如何处理大数据量List批量插入数据库的优化方案：通过拆分List并分配独立线程处理,结合Spring线程池与异步方法提升效率... 目录项目场景解决方案1.实体类2.Mapper3.spring容器注入线程池bejsan对象4.创建
阅读更多...
线上Java OOM问题定位与解决方案超详细解析

线上Java OOM问题定位与解决方案超详细解析

《线上JavaOOM问题定位与解决方案超详细解析》OOM是JVM抛出的错误,表示内存分配失败,：本文主要介绍线上JavaOOM问题定位与解决方案的相关资料,文中通过代码介绍的非常详细,需要的朋... 目录一、OOM问题核心认知1.1 OOM定义与技术定位1.2 OOM常见类型及技术特征二、OOM问题定位工具
阅读更多...
基于 Cursor 开发 Spring Boot 项目详细攻略

基于 Cursor 开发 Spring Boot 项目详细攻略

《基于Cursor开发SpringBoot项目详细攻略》Cursor是集成GPT4、Claude3.5等LLM的VSCode类AI编程工具,支持SpringBoot项目开发全流程,涵盖环境配... 目录cursor是什么？基于 Cursor 开发 Spring Boot 项目完整指南1. 环境准备2. 创建
阅读更多...
Spring Security简介、使用与最佳实践

Spring Security简介、使用与最佳实践

《SpringSecurity简介、使用与最佳实践》SpringSecurity是一个能够为基于Spring的企业应用系统提供声明式的安全访问控制解决方案的安全框架,本文给大家介绍SpringSec... 目录一、如何理解 Spring Security？—— 核心思想二、如何在 Java 项目中使用？——
阅读更多...
SpringBoot+RustFS 实现文件切片极速上传的实例代码

SpringBoot+RustFS 实现文件切片极速上传的实例代码

《SpringBoot+RustFS实现文件切片极速上传的实例代码》本文介绍利用SpringBoot和RustFS构建高性能文件切片上传系统,实现大文件秒传、断点续传和分片上传等功能,具有一定的参考... 目录一、为什么选择 RustFS + SpringBoot？二、环境准备与部署2.1 安装 RustF
阅读更多...
springboot中使用okhttp3的小结

springboot中使用okhttp3的小结

《springboot中使用okhttp3的小结》OkHttp3是一个JavaHTTP客户端,可以处理各种请求类型,比如GET、POST、PUT等,并且支持高效的HTTP连接池、请求和响应缓存、以及异... 在 Spring Boot 项目中使用 OkHttp3 进行 HTTP 请求是一个高效且流行的方式。
阅读更多...
java.sql.SQLTransientConnectionException连接超时异常原因及解决方案

java.sql.SQLTransientConnectionException连接超时异常原因及解决方案

《java.sql.SQLTransientConnectionException连接超时异常原因及解决方案》：本文主要介绍java.sql.SQLTransientConnectionExcep... 目录一、引言二、异常信息分析三、可能的原因3.1 连接池配置不合理3.2 数据库负载过高3.3 连接泄漏
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2