本文旨在帮助开发者理解并解决在使用Mockito进行单元测试时，遇到的变量值未被Mock覆盖的问题。我们将通过分析问题代码、提供示例，并深入探讨Mockito的工作原理，帮助读者掌握正确的Mock使用方法，编写出更可靠的单元测试。
在单元测试中，Mockito是一个强大的Mocking框架，允许我们模拟依赖项的行为，从而隔离被测代码。然而，不当的使用会导致Mock失效，变量值未被覆盖，从而导致测试结果不符合预期。本文将深入探讨这个问题，并提供解决方案。
理解Mockito的工作原理
Mockito通过动态代理或字节码操作来创建Mock对象。当我们使用when(...).thenReturn(...)或doReturn(...).when(...)等方法时，实际上是在定义Mock对象的行为，即当调用特定方法时，Mock对象应该返回什么值。
关键在于，Mockito只能Mock接口或类的public和protected方法。对于private方法或final方法，Mockito无法直接Mock。此外，Mockito的行为定义是针对Mock对象本身的，而不是针对真实对象。
分析问题代码
原始问题中，开发者尝试Mock userRepository.save(userEntityTo) 方法，使其返回一个userEntityTo 对象，该对象的followedByEntity 属性为null，从而触发FollowerNotFoundException。然而，测试结果显示followedByEntity 属性始终不为null，导致测试失败。
问题代码的关键部分如下：
userEntityTo = userRepository.save(userEntityTo);
if (userEntityTo.getFollowedByEntity() == null || userEntityTo.getFollowedByEntity().isEmpty()) {
throw new FollowerNotFoundException("Follower Not Found");
}以及测试代码：
doReturn(userEntityTo).when(userRepository).save(any()); userEntityTo.setFollowerOfEntity(null); userEntityTo.setFollowedByEntity(null);
问题在于，虽然测试代码中设置了userEntityTo.setFollowedByEntity(null)，但这只是修改了测试代码中的userEntityTo对象，而userRepository.save(userEntityTo) 方法返回的仍然是原始的、followedByEntity 不为null的userEntityTo对象。
解决方案
解决此问题的关键在于确保Mock对象返回的是期望的值。以下是几种可能的解决方案：
-
正确设置Mock对象的返回值：
确保userRepository.save(userEntityTo) 方法返回的是一个followedByEntity 为null的UserEntity 对象。可以使用以下代码：
UserEntity userEntityToWithNullFollowers = getUserEntity(); // Create a new UserEntity userEntityToWithNullFollowers.setId(userToId); userEntityToWithNullFollowers.setName("new name"); userEntityToWithNullFollowers.setFollowedByEntity(null); // Set followedByEntity to null when(userRepository.save(any())).thenReturn(userEntityToWithNullFollowers);这样，userRepository.save(userEntityTo) 方法将返回一个followedByEntity 为null的UserEntity 对象，从而触发异常。
-
检查业务逻辑：
仔细检查followUser 方法的业务逻辑。如答案中提到，followingRequestEntities 始终包含一个元素，因此userEntityTo.getFollowedByEntity().isEmpty() 永远不会为true。这意味着即使followedByEntity 为null，异常也不会被抛出。需要重新审视业务逻辑，确保异常条件能够被满足。
-
使用Spy进行部分Mock：
如果只需要Mock save 方法，可以使用@Spy 注解来创建一个UserServiceImpl 的Spy对象。Spy对象会调用真实方法，除非显式地Mock了某个方法。
@Spy @InjectMocks UserServiceImpl userService; @Test void testFollowUser_ThrowsExceptionWhenFollowerIsFound() { // ... UserEntity userEntityTo = getUserEntity(); userEntityTo.setId(userToId); userEntityTo.setName("new name"); userEntityTo.setFollowedByEntity(null); when(userRepository.save(any())).thenReturn(userEntityTo); FollowerNotFoundException exception = assertThrows(FollowerNotFoundException.class, () -> userService.followUser(userFromId, userToId)); assertEquals("Follower Not Found", exception.getMessage()); }需要注意的是，使用Spy时要谨慎，避免过度Mock，导致测试失去意义。
-
考虑测试策略：
在某些情况下，直接测试if 语句可能不是最佳策略。可以考虑测试userRepository.save() 方法是否被调用，以及是否使用了正确的参数。
代码示例
以下是一个完整的示例，展示了如何使用Mockito正确Mock userRepository.save() 方法：
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.Optional;
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)
class UserServiceImplTest {
@Mock
private UserRepository userRepository;
@InjectMocks
private UserServiceImpl userService;
@Test
void testFollowUser_ThrowsExceptionWhenFollowerIsNotFound() {
// Arrange
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");
UserEntity userEntityToWithNullFollowers = new UserEntity();
userEntityToWithNullFollowers.setId(userToId);
userEntityToWithNullFollowers.setName("new name");
userEntityToWithNullFollowers.setFollowedByEntity(null);
when(userRepository.findById(userFromId)).thenReturn(Optional.of(userEntityFrom));
when(userRepository.findById(userToId)).thenReturn(Optional.of(userEntityTo));
when(userRepository.save(any())).thenReturn(userEntityToWithNullFollowers);
// Act & Assert
FollowerNotFoundException exception = assertThrows(FollowerNotFoundException.class, () -> userService.followUser(userFromId, userToId));
assertEquals("Follower Not Found", exception.getMessage());
}
}注意事项：
- 确保Mockito的版本与项目兼容。
- 避免过度Mock，尽量保持测试的真实性。
- 仔细阅读Mockito的文档，了解其工作原理和使用方法。
- 使用debug工具，可以帮助理解代码的执行流程和变量的值。
总结
在使用Mockito进行单元测试时，理解其工作原理至关重要。要确保Mock对象的行为与预期一致，才能编写出可靠的测试。本文通过分析问题代码、提供示例和注意事项，希望能帮助读者解决Mockito使用中遇到的变量值未被覆盖的问题，并编写出更高质量的单元测试。 记住，单元测试的目的是验证代码的正确性，因此要选择合适的测试策略，并保持测试的简洁性和可读性。
