【Spring Boot 入门五】Spring Boot中的测试 - 确保应用质量

🕗 发布于 2024-11-12 06:15 spring boot log4j 后端

在这里插入图片描述

一、引言

在前面的文章中，我们已经深入探讨了Spring Boot的诸多方面，从构建第一个应用，到配置文件的管理、数据库集成以及安全机制的构建。然而，一个高质量的应用离不开全面的测试。测试在软件开发过程中扮演着至关重要的角色，它能够帮助我们在早期发现错误，确保各个组件的功能正确性，以及验证整个系统的集成性。Spring Boot为测试提供了丰富的支持，使得开发者能够方便地对应用进行各种类型的测试。

二、单元测试的基础知识

单元测试的概念和目标
- 单元测试是对软件中的最小可测试单元进行检查和验证。在面向对象编程中，通常是一个方法或者一个类。进行单元测试的主要目的是隔离代码的各个部分，以便能够独立地验证每个部分的正确性。这样做可以提高代码的可维护性和可扩展性，因为当我们修改代码时，可以通过单元测试快速地确定修改是否引入了新的错误。
- 例如，在一个简单的数学计算类中，有一个计算两个数之和的方法。单元测试可以确保这个方法在各种输入情况下都能正确计算结果，而不受其他代码的干扰。
在Spring Boot中编写单元测试
- 使用JUnit 5（或JUnit 4）
  - JUnit是Java中最流行的单元测试框架。JUnit 5相较于JUnit 4有了许多改进，例如更灵活的测试结构和注解。在Spring Boot项目中，我们可以很方便地引入JUnit 5依赖。
- 测试类的结构和注解
  - 一个典型的JUnit 5测试类结构如下：

import org.junit.jupiter.api.Test;

class MyUnitTest {
    @Test
    void myTestMethod() {
        // 测试逻辑
    }
}

`@Test`注解用于标识一个方法是测试方法。`@BeforeEach`注解可以用于在每个测试方法执行之前执行一些初始化操作，例如初始化测试对象或者设置一些测试环境变量。

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

class MyUnitTest {
    private MyClass myObject;

    @BeforeEach
    void setup() {
        myObject = new MyClass();
    }

    @Test
    void myTestMethod() {
        // 使用myObject进行测试
    }
}

`@AfterEach`注解则是在每个测试方法执行之后执行一些清理操作，比如关闭数据库连接或者释放资源。

测试简单的方法
- 假设我们有一个简单的工具类，其中有一个方法用于判断一个整数是否为偶数：

class MathUtils {
    public static boolean isEven(int num) {
        return num % 2 == 0;
    }
}

我们可以编写如下单元测试：

import org.junit.jupiter.api.Test;

import static org.junit.jupiter.api.Assertions.*;

class MathUtilsTest {
    @Test
    void testIsEven() {
        assertTrue(MathUtils.isEven(2));
        assertFalse(MathUtils.isEven(3));
    }
}

三、测试Spring Boot组件

测试控制器（Controller）
- 使用@WebMvcTest注解
  - 在Spring Boot中，@WebMvcTest注解专门用于测试Spring MVC控制器。它会自动配置Spring MVC的相关组件，例如DispatcherServlet等，以便我们能够方便地测试控制器中的方法。
- 模拟HTTP请求和响应
  - 我们可以使用MockMvc来模拟HTTP请求并验证控制器的响应。例如，我们有一个简单的HelloController：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {
    @GetMapping("/hello")
    public String sayHello() {
        return "Hello, World!";
    }
}

对应的测试类如下：

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
import org.springframework.test.web.servlet.MockMvc;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

@WebMvcTest(HelloController.class)
public class HelloControllerTest {
    @Autowired
    private MockMvc mockMvc;

    @Test
    public void testSayHello() throws Exception {
        mockMvc.perform(get("/hello"))
              .andExpect(status().isOk())
              .andExpect(content().string("Hello, World!"));
    }
}

测试控制器中的方法逻辑和返回值
- 除了验证状态码和简单的返回值，我们还可以测试更复杂的逻辑。例如，如果控制器方法根据不同的输入返回不同的值，我们可以通过改变请求参数来测试各种情况。

测试服务层（Service）
- 使用@SpringBootTest注解的部分功能
  - 当测试服务层时，我们可以使用@SpringBootTest注解。虽然这个注解通常用于集成测试，但我们也可以利用它的部分功能来测试服务层。它会启动整个Spring Boot上下文，使得我们能够注入服务层的依赖。
- 注入依赖并测试服务方法
  - 假设我们有一个UserService，它依赖于一个UserRepository来获取用户信息。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class UserService {
    private final UserRepository userRepository;

    @Autowired
    public UserService(UserRepository userRepository) {
        this.userRepository = userRepository;
    }

    public User getUserById(Long id) {
        return userRepository.findById(id).orElse(null);
    }
}

对应的测试类如下：

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import static org.junit.jupiter.api.Assertions.*;

@SpringBootTest
public class UserServiceTest {
    @Autowired
    private UserService userService;

    @Test
    public void testGetUserById() {
        Long userId = 1L;
        User user = userService.getUserById(userId);
        assertEquals(userId, user.getId());
    }
}

处理服务层中的业务逻辑和异常
- 如果服务层方法可能抛出异常，我们也需要在测试中进行处理。例如，如果UserRepository在查找用户时抛出EntityNotFoundException，我们的UserService应该正确地处理这个异常。

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import static org.junit.jupiter.api.Assertions.*;

@SpringBootTest
public class UserServiceTest {
    @Autowired
    private UserService userService;

    @Test
    public void testGetUserByIdWhenNotFound() {
        Long nonExistentUserId = 999L;
        assertNull(userService.getUserById(nonExistentUserId));
    }
}

四、集成测试

集成测试的概念和范围
- 集成测试是对多个组件组合在一起后的功能进行测试。与单元测试不同，单元测试侧重于单个组件的隔离测试，而集成测试关注的是组件之间的交互是否正确。例如，在一个Web应用中，集成测试可能会测试控制器、服务层和数据库访问层之间的交互是否能正确地处理用户请求并返回正确的结果。
在Spring Boot中进行集成测试
- 完整的@SpringBootTest注解的使用
  - @SpringBootTest注解用于在集成测试中启动整个Spring Boot应用上下文。这使得我们能够测试整个应用的功能，包括各个组件之间的集成。例如：

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
public class ApplicationIntegrationTest {
    @Autowired
    private SomeService someService;

    @Test
    public void testServiceIntegration() {
        // 调用服务方法并验证结果
    }
}

测试多个组件之间的交互
- 假设我们有一个订单处理系统，其中OrderController接收订单请求，OrderService处理订单逻辑，OrderRepository负责将订单数据持久化到数据库。我们可以编写集成测试来验证整个订单处理流程：

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import static org.junit.jupiter.api.Assertions.*;

@SpringBootTest
public class OrderProcessingIntegrationTest {
    @Autowired
    private OrderController orderController;
    @Autowired
    private OrderService orderService;
    @Autowired
    private OrderRepository orderRepository;

    @Test
    public void testOrderPlacement() {
        // 模拟订单数据
        Order order = new Order();
        // 通过控制器提交订单
        orderController.placeOrder(order);
        // 验证服务层逻辑
        assertTrue(orderService.isOrderProcessed(order));
        // 验证数据是否持久化到数据库
        assertNotNull(orderRepository.findById(order.getId()));
    }
}

数据库集成测试（使用测试数据库，如H2）
- 在进行数据库集成测试时，我们通常使用内存数据库，如H2。首先，我们需要在pom.xml（如果使用Maven）中添加H2数据库的依赖：

<dependency>
    <groupId>com.h2database</groupId>
    <artifactId>h2</artifactId>
    <scope>test</scope>
</dependency>

然后，在配置文件中配置数据库连接为H2数据库：

spring.datasource.url=jdbc:h2:mem:testdb;DB_CLOSE_DELAY=-1
spring.datasource.driverClassName=org.h2.Driver
spring.datasource.username=sa
spring.datasource.password=

我们可以编写测试来验证数据库操作。例如，测试向数据库中插入一条用户记录并查询出来：

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.transaction.annotation.Transactional;

import static org.junit.jupiter.api.Assertions.*;

@SpringBootTest
@Transactional
public class UserRepositoryIntegrationTest {
    @Autowired
    private UserRepository userRepository;

    @Test
    public void testUserInsertAndQuery() {
        User user = new User("John", "Doe");
        userRepository.save(user);
        User retrievedUser = userRepository.findByFirstName("John");
        assertNotNull(retrievedUser);
        assertEquals("Doe", retrievedUser.getLastName());
    }
}

五、测试数据的准备

使用测试数据构建器（Builder）模式
- 创建测试数据对象的便捷方法
  - 假设我们有一个User实体类：

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

@Entity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String firstName;
    private String lastName;
    private int age;

    // 构造函数、getter和setter方法
    public User(String firstName, String lastName, int age) {
        this.firstName = firstName;
        this.lastName = lastName;
        this.age = age;
    }
    //...
}

我们可以创建一个测试数据构建器来方便地生成`User`对象：

public class UserBuilder {
    private String firstName = "John";
    private String lastName = "Doe";
    private int age = 30;

    public UserBuilder withFirstName(String firstName) {
        this.firstName = firstName;
        return this;
    }

    public UserBuilder withLastName(String lastName) {
        this.lastName = lastName;
        return this;
    }

    public UserBuilder withAge(int age) {
        this.age = age;
        return this;
    }

    public User build() {
        return new User(firstName, lastName, age);
    }
}

在测试中，我们可以这样使用：

import org.junit.jupiter.api.Test;

import static org.junit.jupiter.api.Assertions.*;

class UserServiceTest {
    @Test
    void testUserService() {
        User user = new UserBuilder().withFirstName("Jane").build();
        // 使用user进行测试
    }
}

在测试中使用数据初始化方法
- 例如在测试类的@BeforeEach方法中初始化数据
  - 继续以上面的UserService测试为例，如果我们需要在每个测试方法之前初始化一些用户数据到数据库中，我们可以这样做：

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import static org.junit.jupiter.api.Assertions.*;

@SpringBootTest
public class UserServiceTest {
    @Autowired
    private UserService userService;
    @Autowired
    private UserRepository userRepository;

    @BeforeEach
    void setup() {
        User user1 = new UserBuilder().build();
        User user2 = new UserBuilder().withFirstName("Alice").build();
        userRepository.save(user1);
        userRepository.save(user2);
    }

    @Test
    public void testUserService() {
        // 测试逻辑，此时数据库中已经有初始化的用户数据
    }
}

六、总结与展望

在这篇文章中，我们深入探讨了Spring Boot中的测试。从单元测试的基础知识开始，我们学习了如何使用JUnit 5编写单元测试，包括测试类的结构和常用注解。然后，我们研究了如何测试Spring Boot的组件，如控制器和服务层。对于控制器测试，@WebMvcTest注解和MockMvc是非常有用的工具；而对于服务层测试，@SpringBootTest注解可以帮助我们注入依赖并测试服务方法。集成测试方面，@SpringBootTest注解可以启动整个Spring Boot上下文，让我们能够测试多个组件之间的交互，并且我们还介绍了如何使用测试数据库（如H2）进行数据库集成测试。最后，我们讨论了测试数据的准备，包括测试数据构建器模式和在@BeforeEach方法中初始化数据。

在下一篇文章中，我们将深入研究Spring Boot的高级特性，如缓存机制、异步处理、微服务架构以及Actuator的监控与管理功能等。这些高级特性将帮助我们构建高性能和可扩展的Spring Boot应用。

原文地址：https://blog.csdn.net/qq_27362017/article/details/143682827

免责声明：本站文章内容转载自网络资源，如本站内容侵犯了原著者的合法权益，可联系本站删除。更多内容请关注自学内容网（zxcms.com）！

上一篇：前端知识点---Javascript中检测数据类型函数总结
下一篇：IOT物联网低代码可视化大屏解决方案汇总

web前端开发--盒子属性
学院介绍
阅读更多2024-11-18
深度学习基础—Seq2Seq模型
decoder网络和编号4的语言模型几乎一模一样，机器翻译模型其实和语言模型非常相似，不同在于语言模型总是以零向量开始，而encoder网络会计算出一系列向量来表示输入的句子。假设输入猫咪图片，经过预
阅读更多2024-11-18
【第三章】Kubernetes资源与对象
文章目录1. Kubernetes资源介绍1.1 Pod1.2 Deployment1.3 Service1.4 Namespace2. Kubernetes资源实践2.1 部署应用2.2 访问应用2
阅读更多2024-11-18
SRT拥塞控制分析
在慢启动阶段，发送端会逐渐增加发送速率，直到网络出现丢包，这时会触发拥塞控制机制，减少发送速率。在拥塞控制中，如果网络出现丢包，发送端可能会增加数据包发送间隔，以减少网络拥塞。：拥塞窗口的大小，用于控
阅读更多2024-11-18
小红书内容推荐算法开发：利用API打造个性化用户体验
小红书，作为国内领先的内容分享社区，其丰富的用户生成内容（UGC）和独特的社区氛围，为推荐算法的开发提供了肥沃的土壤。通过小红书API获取的数据，我们可以构建用户兴趣画像和内容特征，进而实现个性化推荐
阅读更多2024-11-18
详解八大排序（一）------（插入排序，选择排序，冒泡排序，希尔排序）
在日常生活中，我们常常要将各种各样的数据进行排序，例如我要将班上的学生按照数学成绩从大到小的排序，像这种一般情况，编译器自带的sort函数就能满足我们的要求。但是，假如我要将班上姓刘的学生按照数学成绩
阅读更多2024-11-18
量化交易系统开发-实时行情自动化交易-3.4.3.2.期货交易数据
交易数据（Trade Ticks）是进行高频交易策略和市场情绪分析的核心数据之一，通过获取逐笔交易的数据，交易者可以识别大资金动向、市场参与者的行为，以及短时间内的市场动态。以下是通过 Python
阅读更多2024-11-18
Rust：AtomicI8 还是 Mutex＜u8＞?
提供的原子操作（如加载、存储等）在硬件层面得到支持，这些操作是不可分割的，即一旦开始执行，就不会被其他线程的操作打断。如果需要在多个线程之间安全地传递复杂的数据结构或进行复杂的同步操作，那么可能需要考
阅读更多2024-11-18
小程序-基于java+SpringBoot+Vue的智能小程序商城设计与实现
智能小程序商城是一个基于Java和Spring Boot框架开发的电子商务平台，利用微信小程序技术提供便捷的购物体验。系统支持商品浏览、购物车管理、订单处理、用户信息管理等功能，旨在为用户打造一个简洁
阅读更多2024-11-18
华为Ensp模拟器配置OSPF路由协议
开放式最短路径优先 (OSPF) 协议深度解析简介开放式最短路径优先（Open Shortest Path First, OSPF）是一种内部网关协议（IGP），用于在自治系统（AS）内进行动态路由选
阅读更多2024-11-18