🎓博主介绍：Java、Python、js全栈开发 “多面手”，精通多种编程语言和技术，痴迷于人工智能领域。秉持着对技术的热爱与执着，持续探索创新，愿在此分享交流和学习，与大家共进步。
📖DeepSeek-行业融合之万象视界(附实战案例详解100+)
📖全栈开发环境搭建运行攻略：多语言一站式指南(环境搭建+运行+调试+发布+保姆级详解)
👉感兴趣的可以先收藏起来，希望帮助更多的人

SpringBoot单元测试完全手册：Mockito+JUnit5最佳实践

一、引言

在软件开发过程中，单元测试是确保代码质量、提高代码可维护性和稳定性的重要手段。Spring Boot作为一款流行的Java开发框架，结合Mockito和JUnit 5可以为开发者提供强大而灵活的单元测试解决方案。本文将详细介绍如何在Spring Boot项目中使用Mockito和JUnit 5进行单元测试，分享最佳实践和实用技巧。

二、JUnit 5简介

2.1 JUnit 5概述

JUnit 5是JUnit框架的下一代版本，它由多个模块组成，包括JUnit Platform、JUnit Jupiter和JUnit Vintage。JUnit 5支持参数化测试、动态测试、嵌套测试等新特性，为开发者提供了更丰富的测试方式。

2.2 JUnit 5依赖配置

在Spring Boot项目中，引入JUnit 5依赖非常简单。只需要在pom.xml文件中添加以下依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>

Spring Boot Starter Test已经包含了JUnit 5的相关依赖。

2.3 JUnit 5基本注解

JUnit 5提供了一系列注解来简化测试代码的编写，常用注解如下：

• @Test：标记一个方法为测试方法。
• @BeforeEach：在每个测试方法执行之前执行。
• @AfterEach：在每个测试方法执行之后执行。
• @BeforeAll：在所有测试方法执行之前执行，必须是静态方法。
• @AfterAll：在所有测试方法执行之后执行，必须是静态方法。

示例代码如下：

import org.junit.jupiter.api.*;

public class JUnit5ExampleTest {

    @BeforeAll
    static void setUpAll() {
        System.out.println("Before all tests");
    }

    @BeforeEach
    void setUp() {
        System.out.println("Before each test");
    }

    @Test
    void testExample() {
        System.out.println("Running test");
    }

    @AfterEach
    void tearDown() {
        System.out.println("After each test");
    }

    @AfterAll
    static void tearDownAll() {
        System.out.println("After all tests");
    }
}

三、Mockito简介

3.1 Mockito概述

Mockito是一个流行的Java模拟框架，用于创建和管理模拟对象。在单元测试中，我们经常需要模拟外部依赖，如数据库、网络服务等，以隔离测试环境，提高测试效率。Mockito可以帮助我们轻松地创建模拟对象、设置方法返回值、验证方法调用等。

3.2 Mockito依赖配置

同样，Spring Boot Starter Test已经包含了Mockito的依赖，无需额外添加。

3.3 Mockito基本用法

3.3.1 创建模拟对象

使用Mockito.mock()方法可以创建一个模拟对象。示例代码如下：

import org.junit.jupiter.api.Test;
import org.mockito.Mockito;

import java.util.List;

public class MockitoExampleTest {

    @Test
    void testMockObject() {
        List<String> mockList = Mockito.mock(List.class);
        Mockito.when(mockList.size()).thenReturn(10);
        System.out.println(mockList.size()); // 输出 10
    }
}

3.3.2 设置方法返回值

使用Mockito.when()方法可以设置模拟对象的方法返回值。示例代码如下：

import org.junit.jupiter.api.Test;
import org.mockito.Mockito;

public class MockitoReturnValueTest {

    @Test
    void testReturnValue() {
        MyService mockService = Mockito.mock(MyService.class);
        Mockito.when(mockService.getMessage()).thenReturn("Hello, Mockito!");
        System.out.println(mockService.getMessage()); // 输出 Hello, Mockito!
    }

    static class MyService {
        public String getMessage() {
            return null;
        }
    }
}

3.3.3 验证方法调用

使用Mockito.verify()方法可以验证模拟对象的方法是否被调用。示例代码如下：

import org.junit.jupiter.api.Test;
import org.mockito.Mockito;

import java.util.List;

public class MockitoVerifyTest {

    @Test
    void testVerifyMethodCall() {
        List<String> mockList = Mockito.mock(List.class);
        mockList.add("test");
        Mockito.verify(mockList).add("test");
    }
}

四、Spring Boot中使用Mockito和JUnit 5进行单元测试

4.1 测试Spring Bean

在Spring Boot项目中，我们经常需要测试Spring Bean。可以使用@MockBean注解来创建模拟的Spring Bean，使用@Autowired注解注入要测试的Bean。示例代码如下：

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

import static org.mockito.Mockito.when;
import static org.junit.jupiter.api.Assertions.assertEquals;

@SpringBootTest
public class SpringBeanTest {

    @Autowired
    private MyService myService;

    @MockBean
    private MyRepository myRepository;

    @Test
    void testSpringBean() {
        when(myRepository.getData()).thenReturn("Mocked Data");
        String result = myService.processData();
        assertEquals("Processed: Mocked Data", result);
    }

    static class MyService {
        private final MyRepository myRepository;

        public MyService(MyRepository myRepository) {
            this.myRepository = myRepository;
        }

        public String processData() {
            String data = myRepository.getData();
            return "Processed: " + data;
        }
    }

    static class MyRepository {
        public String getData() {
            return null;
        }
    }
}

4.2 测试Controller

在测试Spring Boot的Controller时，可以使用MockMvc来模拟HTTP请求。示例代码如下：

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.boot.test.mock.mockito.MockBean;
import org.springframework.test.web.servlet.MockMvc;

import static org.mockito.Mockito.when;
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(MyController.class)
public class ControllerTest {

    @Autowired
    private MockMvc mockMvc;

    @MockBean
    private MyService myService;

    @Test
    void testController() throws Exception {
        when(myService.getMessage()).thenReturn("Hello, World!");
        mockMvc.perform(get("/hello"))
               .andExpect(status().isOk())
               .andExpect(content().string("Hello, World!"));
    }

    static class MyController {
        private final MyService myService;

        public MyController(MyService myService) {
            this.myService = myService;
        }

        @org.springframework.web.bind.annotation.GetMapping("/hello")
        public String hello() {
            return myService.getMessage();
        }
    }

    static class MyService {
        public String getMessage() {
            return null;
        }
    }
}

五、最佳实践和技巧

5.1 保持测试独立性

每个测试方法应该是独立的，不依赖于其他测试方法的执行结果。这样可以确保测试的可重复性和稳定性。

5.2 合理使用Mock对象

只对必要的外部依赖进行Mock，避免过度Mock。如果一个依赖的实现比较简单，并且不涉及外部资源，可以直接使用真实对象进行测试。

5.3 编写清晰的测试用例

测试用例应该具有清晰的命名和明确的测试目的。可以使用@DisplayName注解为测试方法添加更具描述性的名称。示例代码如下：

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

public class ClearTestExample {

    @Test
    @DisplayName("Test addition of two numbers")
    void testAddition() {
        // 测试代码
    }
}

5.4 异常处理测试

在测试中，需要考虑异常情况的处理。可以使用assertThrows()方法来验证方法是否抛出了预期的异常。示例代码如下：

import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertThrows;

public class ExceptionTestExample {

    @Test
    void testException() {
        assertThrows(IllegalArgumentException.class, () -> {
            throw new IllegalArgumentException("Invalid argument");
        });
    }
}

六、总结

本文详细介绍了在Spring Boot项目中使用Mockito和JUnit 5进行单元测试的方法和最佳实践。通过JUnit 5的丰富注解和Mockito的强大模拟功能，我们可以高效地编写独立、可维护的单元测试代码。希望本文能帮助开发者更好地掌握Spring Boot单元测试的技巧，提高代码质量和开发效率。