springboot~在單元測試中使用Mock

在 Java 中，使用 Mock 對象進行單元測試是一種常見的實踐，尤其是在需要隔離被測試組件時。Mock 可以幫助我們模擬依賴對象的行為，從而專注于測試特定的邏輯，而不必依賴于外部系統或復雜的對象。

1. 使用 Mock 的好處

• 隔離測試：通過 Mock 依賴項，可以確保測試只關注被測試類的邏輯。
• 控制行為：可以設定 Mock 對象在特定條件下的返回值或拋出異常。
• 提高測試速度：避免了實際調用外部服務、數據庫等的開銷。
• 驗證交互：可以驗證被測試對象與其依賴之間的交互是否符合預期（如方法是否被調用）。

2. 使用 Mockito 創建 Mock 對象

Mockito 是一個流行的 Java Mocking 框架，它提供了簡單易用的 API 來創建和管理 Mock 對象。

示例：使用 Mockito 進行單元測試

假設我們有一個簡單的服務類 UserService，它依賴于一個 UserRepository 接口來獲取用戶信息。我們將使用 Mock 來測試 UserService 的行為。

2.1 定義接口和實現

// UserRepository.java
public interface UserRepository {
    User findById(Long id);
}

// UserService.java
public class UserService {
    private final UserRepository userRepository;

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

    public User getUser(Long id) {
        User user = userRepository.findById(id);
        if (user == null) {
            throw new IllegalArgumentException("User not found");
        }
        return user;
    }
}

// User.java
public class User {
    private Long id;
    private String name;

    // Constructors, getters and setters
}

2.2 編寫單元測試

接下來，我們編寫 UserService 的單元測試，使用 Mockito 來 Mock UserRepository：

import static org.mockito.Mockito.*;
import static org.junit.jupiter.api.Assertions.*;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;

public class UserServiceTest {

    @Mock
    private UserRepository userRepository; // Mock UserRepository

    @InjectMocks
    private UserService userService; // 被測試的 UserService

    @BeforeEach
    void setUp() {
        MockitoAnnotations.openMocks(this); // 初始化 Mock 對象
    }

    @Test
    void testGetUser_Success() {
        // Arrange
        User mockUser = new User(1L, "Alice");
        when(userRepository.findById(1L)).thenReturn(mockUser); // 設置 Mock 行為

        // Act
        User user = userService.getUser(1L);

        // Assert
        assertEquals("Alice", user.getName());
        verify(userRepository).findById(1L); // 驗證交互
    }

    @Test
    void testGetUser_UserNotFound() {
        // Arrange
        when(userRepository.findById(1L)).thenReturn(null); // 設置 Mock 行為

        // Act & Assert
        Exception exception = assertThrows(IllegalArgumentException.class, () -> {
            userService.getUser(1L);
        });
        assertEquals("User not found", exception.getMessage());
    }
}

3. 代碼解析

• Mock 對象：通過 @Mock 注解創建 UserRepository 的 Mock 實例。
• Inject Mocks：通過 @InjectMocks 注解將 Mock 對象注入到 UserService 中。
• 設置 Mock 行為：使用 when(...).thenReturn(...) 方法定義 Mock 對象在特定輸入下的返回值。
• 驗證行為：使用 verify(...) 方法檢查 Mock 對象的方法是否被調用，以及調用的次數。

4. 總結

在這個示例中，我們展示了如何使用 Mockito 創建 Mock 對象，并通過單元測試驗證業務邏輯。使用 Mock 的好處包括：

• 能夠獨立于外部依賴測試 UserService 的邏輯。
• 可以輕松控制 UserRepository 的行為，以測試不同場景（如成功找到用戶和未找到用戶）。
• 提高了測試的可讀性和可維護性。

通過這種方式，您可以確保您的代碼在不同情況下表現正常，且不會受到外部依賴的影響。