Mockito变量未覆盖问题解决方法

本文旨在解决在使用Mockito进行单元测试时，遇到的变量值无法被Mock覆盖的问题。通过分析问题代码，找出根本原因，并提供清晰的示例代码和解决方案，帮助开发者更好地理解和使用Mockito进行有效的单元测试。本文重点阐述了Mockito的正确使用方式，以及如何避免常见的错误配置，从而确保测试的准确性和可靠性。

在使用Mockito进行单元测试时，经常会遇到需要Mock某些方法的返回值，以便模拟不同的场景。但有时会发现，即使使用了when...thenReturn()或doReturn...when()，目标变量的值仍然没有被覆盖，导致测试结果不符合预期。本文将深入探讨这个问题，并提供解决方案。

理解Mockito的工作原理

Mockito是一个Mocking框架，它允许你创建Mock对象，并定义这些Mock对象的行为。在使用Mockito时，需要理解以下几个关键概念：

• Mock对象： 是一个模拟的对象，它实现了接口或继承了类，但其行为完全由你控制。
• Stubbing： 是指定义Mock对象的行为，即当调用Mock对象的某个方法时，应该返回什么值或抛出什么异常。
• Verification： 是指验证Mock对象的某个方法是否被调用，以及被调用了多少次。

常见问题及解决方案

1. 错误的Stubbing对象

最常见的问题是Stubbing了错误的对象。Mockito只能Mock接口和类，而不能Mock对象的属性。在原问题中，尝试直接Mock userEntityTo.getFollowedByEntity() 的返回值是无效的，因为 getFollowedByEntity() 是 userEntityTo 对象的一个方法，而不是一个可以被Mock的对象。

解决方案：

应该Mock userRepository.save(userEntityTo) 方法的返回值，使它返回一个 userEntityTo 对象，该对象的 followedByEntity 属性为 null 或空集合。

2. 代码逻辑问题

另一个常见问题是代码逻辑本身存在问题，导致Mock的返回值没有生效。在原问题中，即使Mock了 userRepository.save(userEntityTo) 的返回值，followUser 方法内部的逻辑仍然会创建 followingRequestEntities 集合，并将其设置到 userEntityTo 对象的 followedByEntity 属性中。因此，userEntityTo.getFollowedByEntity().isEmpty() 永远不会为 true，导致 FollowerNotFoundException 永远不会被抛出。

解决方案：

需要重新审视代码逻辑，确保Mock的返回值能够按照预期影响程序的行为。在本例中，需要修改 followUser 方法的逻辑，或者修改测试用例，使其能够覆盖到 FollowerNotFoundException 被抛出的情况。

3. 正确使用Mockito注解

为了简化Mockito的使用，可以使用Mockito的注解，如 @Mock，@InjectMocks 和 @Spy。

• @Mock: 用于创建Mock对象。
• @InjectMocks: 用于将Mock对象注入到被测试的类中。
• @Spy: 用于创建Spy对象，可以部分Mock真实对象。

示例：

@ExtendWith(MockitoExtension.class)
public class MyTests {
    @Mock
    MyRepository myRepository;

    @InjectMocks
    MyService myService;

    @Test
    public void aTest() {
        when(myRepository.get()).thenReturn("something fake");
        assertEquals("SOMETHING FAKE", myService.doWork());
    }
}

在这个例子中，MyRepository 被Mock，并注入到 MyService 中。在测试方法 aTest 中，定义了当调用 myRepository.get() 方法时，返回 "something fake"。

示例代码

以下是一个完整的示例，展示了如何正确使用Mockito来解决变量值未被覆盖的问题：

import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.junit.jupiter.MockitoExtension;

import java.util.HashSet;
import java.util.Optional;
import java.util.Set;
import java.util.UUID;

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

@ExtendWith(MockitoExtension.class)
public class UserServiceTest {

    @Mock
    private UserRepository userRepository;

    @InjectMocks
    private UserServiceImpl userService;

    @Test
    void testFollowUser_ThrowsExceptionWhenFollowerIsNotFound() {
        UUID userFromId = UUID.randomUUID();
        UUID userToId = UUID.randomUUID();
        UserEntity userEntityFrom = new UserEntity();
        userEntityFrom.setId(userFromId);

        UserEntity userEntityTo = new UserEntity();
        userEntityTo.setId(userToId);
        userEntityTo.setName("new name");

        when(userRepository.findById(userEntityFrom.getId())).thenReturn(Optional.of(userEntityFrom));
        when(userRepository.findById(userEntityTo.getId())).thenReturn(Optional.of(userEntityTo));

        // Mock userRepository.save() 方法，返回一个 followedByEntity 为空的 UserEntity 对象
        UserEntity savedUserEntity = new UserEntity();
        savedUserEntity.setId(userToId);
        savedUserEntity.setName("new name");
        savedUserEntity.setFollowedByEntity(new HashSet<>()); // 设置为空集合

        when(userRepository.save(any())).thenReturn(savedUserEntity);

        FollowerNotFoundException exception =
                assertThrows(FollowerNotFoundException.class, () -> userService.followUser(userFromId, userToId));

        assertEquals("Follower Not Found", exception.getMessage());
    }
}

在这个示例中，userRepository.save(any()) 方法被Mock，返回一个 followedByEntity 为空集合的 UserEntity 对象。这样，userService.followUser() 方法中的 if (userEntityTo.getFollowedByEntity() == null || userEntityTo.getFollowedByEntity().isEmpty()) 条件才能成立，从而抛出 FollowerNotFoundException。

注意事项

• 确保Stubbing的对象是正确的，Mockito只能Mock接口和类。
• 仔细检查代码逻辑，确保Mock的返回值能够按照预期影响程序的行为。
• 合理使用Mockito注解，简化测试代码。
• 避免过度Mock，只Mock必要的依赖，保持测试的简洁性。

总结

在使用Mockito进行单元测试时，遇到变量值未被覆盖的问题，通常是由于错误的Stubbing对象或代码逻辑问题导致的。通过理解Mockito的工作原理，并遵循上述解决方案，可以有效地解决这个问题，编写出高质量的单元测试。记住，Mockito是一个强大的工具，但需要正确的使用才能发挥其作用。