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。

相关文章

JVM 的类初始化机制

JVM 的类初始化机制

前言 当你在 Java 程序中new对象时，有没有考虑过 JVM 是如何把静态的字节码（byte code）转化为运行时对象的呢，这个问题看似简单，但清楚的同学相信也不会太多，这篇文章首先介绍 JVM 类初始化的机制，然后给出几个易出错的实例来分析，帮助大家更好理解这个知识点。 JVM 将字节码转化为运行时对象分为三个阶段，分别是：loading 、Linking、initialization
阅读更多...
Spring Security 基于表达式的权限控制

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权，允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true （Spring security默认会带有ROLE_前缀）,去
阅读更多...
浅析Spring Security认证过程

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程，特意画了如下的类图，包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口，接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti
阅读更多...
Spring Security--Architecture Overview

Spring Security--Architecture Overview

1 核心组件 这一节主要介绍一些在Spring Security中常见且核心的Java类，它们之间的依赖，构建起了整个框架。想要理解整个架构，最起码得对这些类眼熟。 1.1 SecurityContextHolder SecurityContextHolder用于存储安全上下文（security context）的信息。当前操作的用户是谁，该用户是否已经被认证，他拥有哪些角色权限…这些都被保
阅读更多...
Spring Security基于数据库验证流程详解

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明（认真看哦） AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证，则会调用 #attemptAuthentica
阅读更多...
Spring Security 从入门到进阶系列教程

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门（一）：登录与退出》 《Spring-Security-入门（二）：基于数据库验证》 《Spring-Security-入门（三）：密码加密》 《Spring-Security-入门（四）：自定义-Filter》 《Spring-Security-入门（五）：在 Sprin
阅读更多...
Java架构师知识体认识

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物
阅读更多...
Java进阶13讲__第12讲_1/2

Java进阶13讲__第12讲_1/2

多线程、线程池 1.  线程概念 1.1  什么是线程 1.2  线程的好处 2.   创建线程的三种方式 注意事项 2.1  继承Thread类 2.1.1 认识  2.1.2  编码实现  package cn.hdc.oop10.Thread;import org.slf4j.Logger;import org.slf4j.LoggerFactory
阅读更多...
JAVA智听未来一站式有声阅读平台听书系统小程序源码

JAVA智听未来一站式有声阅读平台听书系统小程序源码

智听未来，一站式有声阅读平台听书系统 🌟&nbsp;开篇：遇见未来，从“智听”开始 在这个快节奏的时代，你是否渴望在忙碌的间隙，找到一片属于自己的宁静角落？是否梦想着能随时随地，沉浸在知识的海洋，或是故事的奇幻世界里？今天，就让我带你一起探索“智听未来”——这一站式有声阅读平台听书系统，它正悄悄改变着我们的阅读方式，让未来触手可及！ 📚&nbsp;第一站：海量资源，应有尽有 走进“智听
阅读更多...
【Prometheus】PromQL向量匹配实现不同标签的向量数据进行运算

【Prometheus】PromQL向量匹配实现不同标签的向量数据进行运算

✨✨ 欢迎大家来到景天科技苑✨✨ 🎈🎈 养成好习惯，先赞后看哦~🎈🎈 🏆 作者简介：景天科技苑 🏆《头衔》：大厂架构师，华为云开发者社区专家博主，阿里云开发者社区专家博主，CSDN全栈领域优质创作者，掘金优秀博主，51CTO博客专家等。 🏆《博客》：Python全栈，前后端开发，小程序开发，人工智能，js逆向，App逆向，网络系统安全，数据分析，Django，fastapi
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2