在SpringBoot環(huán)境中使用Mockito進行單元測試的示例詳解

更新時間：2024年01月03日 08:45:57 作者：一只愛擼貓的程序猿

Mockito特別適用于在Spring Boot環(huán)境中進行單元測試,因為它能夠輕松模擬Spring應(yīng)用中的服務(wù)、存儲庫、客戶端和其他組件,通過使用Mockito,開發(fā)者可以模擬外部依賴,從而使單元測試更加獨立和可靠,本文給大家介紹了在Spring Boot環(huán)境中使用Mockito進行單元測試

引言
示例 1: 模擬服務(wù)層中的方法
示例 2: 模擬Web層（控制器）
示例 3: 模擬異常情況
示例 4: 使用Mockito對REST客戶端進行模擬
示例 5: 參數(shù)捕獲和驗證
示例 6: 模擬靜態(tài)方法
示例 7: 模擬連續(xù)調(diào)用
示例 8: 使用ArgumentMatchers
示例 9: 模擬返回void的方法
示例 10: 模擬泛型方法
示例 11: 使用@Spy注解
示例 12: 使用InOrder
總結(jié)

引言

Mockito是一個流行的Java mocking框架，它允許開發(fā)者以簡單直觀的方式創(chuàng)建和使用模擬對象（mocks）。Mockito特別適用于在Spring Boot環(huán)境中進行單元測試，因為它能夠輕松模擬Spring應(yīng)用中的服務(wù)、存儲庫、客戶端和其他組件。通過使用Mockito，開發(fā)者可以模擬外部依賴，從而使單元測試更加獨立和可靠。這不僅有助于減少測試時對真實系統(tǒng)狀態(tài)的依賴，而且還允許開發(fā)者模擬各種場景，包括異常情況和邊緣情況。

示例 1: 模擬服務(wù)層中的方法

假設(shè)你有一個服務(wù) BookService，它依賴于一個DAO（數(shù)據(jù)訪問對象） BookRepository。你可以使用Mockito來模擬 BookRepository 的行為。

@SpringBootTest
public class BookServiceTest {

    @Mock
    private BookRepository bookRepository;

    @InjectMocks
    private BookService bookService;

    @BeforeEach
    public void setup() {
        MockitoAnnotations.openMocks(this);
    }

    @Test
    public void testFindBookById() {
        Book mockBook = new Book(1L, "Mockito in Action", "John Doe");
        when(bookRepository.findById(1L)).thenReturn(Optional.of(mockBook));

        Book result = bookService.findBookById(1L);

        assertEquals("Mockito in Action", result.getTitle());
    }
}

示例 2: 模擬Web層（控制器）

如果你想測試一個控制器，你可以使用Mockito來模擬服務(wù)層的方法，并使用 MockMvc 來模擬HTTP請求。

@WebMvcTest(BookController.class)
public class BookControllerTest {

    @MockBean
    private BookService bookService;

    @Autowired
    private MockMvc mockMvc;

    @Test
    public void testGetBook() throws Exception {
        Book mockBook = new Book(1L, "Mockito for Beginners", "Jane Doe");
        when(bookService.findBookById(1L)).thenReturn(mockBook);

        mockMvc.perform(get("/books/1"))
               .andExpect(status().isOk())
               .andExpect(jsonPath("$.title").value("Mockito for Beginners"));
    }
}

示例 3: 模擬異常情況

你還可以使用Mockito來測試異常情況。

@SpringBootTest
public class BookServiceTest {

    @Mock
    private BookRepository bookRepository;

    @InjectMocks
    private BookService bookService;

    @Test
    public void testBookNotFound() {
        when(bookRepository.findById(1L)).thenReturn(Optional.empty());

        assertThrows(BookNotFoundException.class, () -> {
            bookService.findBookById(1L);
        });
    }
}

示例 4: 使用Mockito對REST客戶端進行模擬

如果你的服務(wù)層使用了REST客戶端來調(diào)用外部API，你可以使用Mockito來模擬這些調(diào)用。

@SpringBootTest
public class ExternalServiceTest {

    @Mock
    private RestTemplate restTemplate;

    @InjectMocks
    private ExternalService externalService;

    @Test
    public void testGetExternalData() {
        String response = "{\"key\":\"value\"}";
        when(restTemplate.getForObject("http://external-api.com/data", String.class))
                .thenReturn(response);

        String result = externalService.getExternalData();

        assertEquals("{\"key\":\"value\"}", result);
    }
}

示例 5: 參數(shù)捕獲和驗證

在某些情況下，你可能想要驗證服務(wù)層調(diào)用了DAO的正確方法并且傳遞了正確的參數(shù)。Mockito的參數(shù)捕獲功能可以用于這種場景。

@SpringBootTest
public class UserServiceTest {

    @Mock
    private UserRepository userRepository;

    @InjectMocks
    private UserService userService;

    @Test
    public void testCreateUser() {
        User user = new User("JohnDoe", "john@doe.com");

        userService.createUser(user);

        ArgumentCaptor<User> userArgumentCaptor = ArgumentCaptor.forClass(User.class);
        verify(userRepository).save(userArgumentCaptor.capture());
        User capturedUser = userArgumentCaptor.getValue();

        assertEquals("JohnDoe", capturedUser.getUsername());
    }
}

示例 6: 模擬靜態(tài)方法

從Mockito 3.4.0開始，你可以模擬靜態(tài)方法。這在測試使用了靜態(tài)工具方法的代碼時特別有用。

@SpringBootTest
public class UtilityServiceTest {

    @Test
    public void testStaticMethod() {
        try (MockedStatic<UtilityClass> mockedStatic = Mockito.mockStatic(UtilityClass.class)) {
            mockedStatic.when(() -> UtilityClass.staticMethod("input")).thenReturn("mocked output");

            String result = UtilityService.callStaticMethod("input");

            assertEquals("mocked output", result);
        }
    }
}

示例 7: 模擬連續(xù)調(diào)用

有時你需要模擬一個方法在連續(xù)調(diào)用時返回不同的值或拋出異常。

@SpringBootTest
public class ProductServiceTest {

    @Mock
    private ProductRepository productRepository;

    @InjectMocks
    private ProductService productService;

    @Test
    public void testProductAvailability() {
        when(productRepository.checkAvailability(anyInt()))
                .thenReturn(true)
                .thenReturn(false);

        assertTrue(productService.isProductAvailable(123));
        assertFalse(productService.isProductAvailable(123));
    }
}

示例 8: 使用ArgumentMatchers

在某些情況下，你可能不關(guān)心傳遞給mock方法的確切參數(shù)值。在這種情況下，可以使用Mockito的ArgumentMatchers。

@SpringBootTest
public class NotificationServiceTest {

    @Mock
    private EmailClient emailClient;

    @InjectMocks
    private NotificationService notificationService;

    @Test
    public void testSendEmail() {
        notificationService.sendEmail("hello@example.com", "Hello");

        verify(emailClient).sendEmail(anyString(), eq("Hello"));
    }
}

示例 9: 模擬返回void的方法

如果需要模擬一個返回void的方法，可以使用doNothing()、doThrow()等。

@SpringBootTest
public class AuditServiceTest {

    @Mock
    private AuditLogger auditLogger;

    @InjectMocks
    private UserService userService;

    @Test
    public void testUserCreationWithAudit() {
        doNothing().when(auditLogger).log(anyString());

        userService.createUser(new User("JaneDoe", "jane@doe.com"));

        verify(auditLogger).log(contains("User created:"));
    }
}

示例 10: 模擬泛型方法

當(dāng)需要模擬泛型方法時，可以使用any()方法來表示任意類型的參數(shù)。

@SpringBootTest
public class CacheServiceTest {

    @Mock
    private CacheManager cacheManager;

    @InjectMocks
    private ProductService productService;

    @Test
    public void testCaching() {
        Product mockProduct = new Product("P123", "Mock Product");

        when(cacheManager.getFromCache(any(), any())).thenReturn(mockProduct);

        Product result = productService.getProduct("P123");

        assertEquals("Mock Product", result.getName());
    }
}

示例 11: 使用@Spy注解

有時你可能需要部分模擬一個對象。在這種情況下，可以使用@Spy注解。

@SpringBootTest
public class OrderServiceTest {

    @Spy
    private OrderProcessor orderProcessor;

    @InjectMocks
    private OrderService orderService;

    @Test
    public void testOrderProcessing() {
        Order order = new Order("O123", 100.0);
        doReturn(true).when(orderProcessor).validateOrder(order);

        boolean result = orderService.processOrder(order);

        assertTrue(result);
    }
}

示例 12: 使用InOrder

如果你需要驗證mock對象上的方法調(diào)用順序，可以使用InOrder。

@SpringBootTest
public class TransactionServiceTest {

    @Mock
    private Database database;

    @InjectMocks
    private TransactionService transactionService;

    @Test
    public void testTransactionOrder() {
        transactionService.performTransaction();

        InOrder inOrder = inOrder(database);
        inOrder.verify(database).beginTransaction();
        inOrder.verify(database).commitTransaction();
    }
}

總結(jié)

通過使用Mockito，可以模擬服務(wù)層、存儲庫、REST客戶端等組件，而無需依賴實際的實現(xiàn)。這樣不僅可以減少測試對外部系統(tǒng)的依賴，還可以模擬異常情況和邊緣用例，從而確保代碼在各種環(huán)境下的穩(wěn)健性。此外，Mockito的靈活性使得它可以輕松集成到現(xiàn)有的Spring Boot項目中，無論是對于簡單的單元測試還是更復(fù)雜的集成測試。總而言之，Mockito是Spring Boot開發(fā)者的強大工具，它可以提高測試的有效性和效率，從而幫助構(gòu)建更健壯、可靠的Spring應(yīng)用。

以上就是在SpringBoot環(huán)境中使用Mockito進行單元測試的示例詳解的詳細內(nèi)容，更多關(guān)于SpringBoot Mockito單元測試的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: