Spring Boot单元测试全指南：使用Mockito和AssertJ

在现代软件开发实践中，单元测试是不可或缺的一环，它帮助我们确保代码的可靠性和稳定性。对于使用Spring Boot构建的应用，编写单元测试不仅可以验证业务逻辑的正确性，还可以确保服务的健壮性。本文将详细介绍如何在Spring Boot项目中进行单元测试，包括使用Mockito进行依赖模拟和使用AssertJ进行断言。

1. 添加测试依赖

在开始编写测试之前，我们需要确保项目中包含了Spring Boot的测试依赖。这些依赖包括JUnit（测试框架）、Mockito（模拟框架）和AssertJ（断言库）。以下是Maven的依赖配置示例：

<dependencies>
    <!-- Spring Boot Test Starter -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
        <exclusions>
            <exclusion>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
            </exclusion>
        </exclusions>
    </dependency>
    <!-- JUnit 5 dependency -->
    <dependency>
        <groupId>org.junit.jupiter</groupId>
        <artifactId>junit-jupiter-api</artifactId>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>org.junit.jupiter</groupId>
        <artifactId>junit-jupiter-engine</artifactId>
        <scope>test</scope>
    </dependency>
    <!-- Mockito dependency -->
    <dependency>
        <groupId>org.mockito</groupId>
        <artifactId>mockito-core</artifactId>
        <scope>test</scope>
    </dependency>
    <!-- AssertJ dependency -->
    <dependency>
        <groupId>org.assertj</groupId>
        <artifactId>assertj-core</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

2. 编写服务类

假设我们有一个MyService服务类，它处理一些业务逻辑，并依赖于AnotherService。

package com.example.service;

import org.springframework.stereotype.Service;

@Service
public class MyService {
    private final AnotherService anotherService;

    public MyService(AnotherService anotherService) {
        this.anotherService = anotherService;
    }

    public String doSomething(String input) {
        // 假设这个方法处理输入，并依赖anotherService
        String processedInput = anotherService.processInput(input);
        return "Result: " + processedInput;
    }
}

3. 创建测试类

创建一个名为MyServiceTest的测试类，并使用@SpringBootTest注解来标记这是一个Spring Boot的测试类。这将启动Spring应用上下文，允许我们注入真正的Spring Beans。

package com.example.service;

import org.junit.jupiter.api.Test;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import static org.mockito.Mockito.when;
import static org.assertj.core.api.Assertions.assertThat;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class MyServiceTest {

    @Mock
    private AnotherService anotherService;

    @InjectMocks
    private MyService myService;

    @Test
    void testDoSomething() {
        // Arrange
        String input = "test";
        String expectedOutput = "Result: test processed";
        String processedInput = "test processed";
        when(anotherService.processInput(input)).thenReturn(processedInput);

        // Act
        String result = myService.doSomething(input);

        // Assert
        assertThat(result).isEqualTo(expectedOutput);
    }

    // 初始化Mockito注解
    @Test
    void init() {
        MockitoAnnotations.openMocks(this);
    }
}

在MyServiceTest类中，我们使用@Mock注解创建了一个AnotherService的模拟对象，并通过@InjectMocks注解将其注入到MyService中。在testDoSomething测试方法中，我们模拟了processInput方法的返回值，并调用了doSomething方法来验证结果是否符合预期。

4. 运行测试

运行测试方法，可以使用IDE的测试运行功能，或者使用Maven/Gradle命令行工具。例如，在Maven项目中，你可以使用以下命令来运行测试：

mvn test

5. 结语

通过上述步骤，我们可以在Spring Boot项目中编写和运行单元测试。使用Mockito和AssertJ，我们可以方便地模拟依赖和验证结果，确保代码的正确性和稳定性。记住，良好的测试习惯是持续交付高质量软件的关键。通过编写单元测试，我们可以在代码变更时快速发现问题，提高开发效率，同时也为未来的代码维护打下坚实的基础。

打赏