Mockito测试变量无法覆盖排查与解决方法

本文旨在帮助开发者解决在使用Mockito进行单元测试时，遇到的变量值无法被Mock覆盖的问题。通过分析常见原因和提供详细示例，我们将深入探讨Mockito的使用方法，确保测试的准确性和可靠性。重点关注Mockito的正确使用姿势，以及如何避免在测试中出现预期之外的结果。

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

常见原因分析

1. Mockito的作用域理解错误: Mockito主要用于Mock依赖的外部组件，例如Repository、Service等。它不能直接Mock对象内部的属性，除非通过方法调用来间接控制。

2. 方法调用顺序问题: 确保Mock的方法在实际代码执行时被调用到。如果代码逻辑没有执行到Mock的方法，那么Mock的返回值自然不会生效。

3. any()匹配器使用不当: 如果使用了any()等匹配器，需要确保它能够匹配到实际的参数。否则，Mock的返回值可能不会被返回。

4. 对象状态问题: 在某些情况下，对象的内部状态可能在Mock生效之前就已经被修改，导致Mock的返回值被覆盖。

5. 测试逻辑错误: 最常见的原因是测试逻辑本身存在问题，例如断言错误、参数设置错误等。

解决方案与示例

下面通过一个实际的例子来演示如何使用Mockito以及如何解决变量值无法覆盖的问题。

假设我们有一个UserService，它依赖于UserRepository来查询和保存用户数据。

// UserService.java
public class UserService {

    private final UserRepository userRepository;

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

    public UserEntity followUser(UUID fromId, UUID toId) throws UserNotFoundException, FollowerNotFoundException {
        Optional userEntityOptionalFrom = userRepository.findById(fromId);
        Optional userEntityOptionalTo = userRepository.findById(toId);

        if (userEntityOptionalFrom.isEmpty() || userEntityOptionalTo.isEmpty()) {
            throw new UserNotFoundException("No user found with this id");
        }

        UserEntity userEntityTo = userEntityOptionalTo.get();
        UserEntity userEntityFrom = userEntityOptionalFrom.get();

        Set followingRequestEntities = new HashSet<>();
        FollowingRequestEntity followingRequestEntity = FollowingRequestEntity.builder().userSenderEntity(userEntityFrom).userReceiverEntity(userEntityTo).build();
        followingRequestEntities.add(followingRequestEntity);

        userEntityTo.setFollowedByEntity(followingRequestEntities);

        userEntityTo = userRepository.save(userEntityTo);

        if (userEntityTo.getFollowedByEntity() == null || userEntityTo.getFollowedByEntity().isEmpty()) {
            throw new FollowerNotFoundException("Follower Not Found");
        }

        return userEntityTo;
    }
}

// UserRepository.java
public interface UserRepository {
    Optional findById(UUID id);
    UserEntity save(UserEntity userEntity);
}

// UserEntity.java
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class UserEntity {
    private UUID id;
    private String name;
    private Set followedByEntity;
}

// FollowingRequestEntity.java
@Data
@Builder
public class FollowingRequestEntity {
    private UserEntity userSenderEntity;
    private UserEntity userReceiverEntity;
}

// UserNotFoundException.java
public class UserNotFoundException extends Exception {
    public UserNotFoundException(String message) {
        super(message);
    }
}

// FollowerNotFoundException.java
public class FollowerNotFoundException extends Exception {
    public FollowerNotFoundException(String message) {
        super(message);
    }
}

现在我们想要测试UserService的followUser方法，并且模拟userRepository.save方法返回一个followedByEntity为空的UserEntity，以触发FollowerNotFoundException。

正确的测试代码如下：

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)
public class UserServiceTest {

    @Mock
    private UserRepository userRepository;

    @InjectMocks
    private UserService userService;

    @Test
    void testFollowUser_ThrowsExceptionWhenFollowerIsNotFound() {
        // Given
        UUID userFromId = UUID.randomUUID();
        UUID userToId = UUID.randomUUID();
        UserEntity userEntityFrom = UserEntity.builder().id(userFromId).name("From User").build();
        UserEntity userEntityTo = UserEntity.builder().id(userToId).name("To User").build();
        UserEntity userEntityToWithoutFollowers = UserEntity.builder().id(userToId).name("To User").followedByEntity(null).build();

        when(userRepository.findById(userFromId)).thenReturn(Optional.of(userEntityFrom));
        when(userRepository.findById(userToId)).thenReturn(Optional.of(userEntityTo));
        when(userRepository.save(any(UserEntity.class))).thenReturn(userEntityToWithoutFollowers);

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

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

代码解释:

• @ExtendWith(MockitoExtension.class): 启用Mockito扩展，简化Mock对象的创建和注入。
• @Mock: 用于创建UserRepository的Mock对象。
• @InjectMocks: 用于创建UserService对象，并将UserRepository的Mock对象注入到UserService中。
• when(userRepository.findById(userFromId)).thenReturn(Optional.of(userEntityFrom)): Mock userRepository.findById方法，当传入userFromId时，返回包含userEntityFrom的Optional对象。
• when(userRepository.findById(userToId)).thenReturn(Optional.of(userEntityTo)): Mock userRepository.findById方法，当传入userToId时，返回包含userEntityTo的Optional对象。
• when(userRepository.save(any(UserEntity.class))).thenReturn(userEntityToWithoutFollowers): Mock userRepository.save方法，当传入任何UserEntity对象时，返回userEntityToWithoutFollowers对象，该对象的followedByEntity属性为null。
• assertThrows(FollowerNotFoundException.class, () -> userService.followUser(userFromId, userToId)): 断言调用userService.followUser方法时，会抛出FollowerNotFoundException异常。
• assertEquals("Follower Not Found", exception.getMessage()): 断言抛出的异常的message属性为"Follower Not Found"。

注意事项:

• 确保Mock的方法被实际调用。
• 使用正确的匹配器，例如any()、eq()等。
• 理解Mockito的作用域，避免直接Mock对象内部的属性。
• 仔细检查测试逻辑，确保断言正确。

其他技巧

• 使用verify()方法验证Mock对象的方法是否被调用:

  import static org.mockito.Mockito.verify;
  
  // ...
  
  verify(userRepository).save(userEntityTo);

• 使用spy()方法部分Mock对象:

  import static org.mockito.Mockito.spy;
  import static org.mockito.Mockito.doReturn;
  
  // ...
  
  UserService userService = spy(new UserService(userRepository));
  doReturn(userEntityToWithoutFollowers).when(userService).someMethod(any(UserEntity.class));

  spy()方法可以创建一个真实对象的副本，并允许你Mock其中的部分方法。

总结

通过本文的分析和示例，我们了解了Mockito测试中变量值无法覆盖的常见原因和解决方案。掌握Mockito的正确使用方法，可以帮助我们编写更准确、更可靠的单元测试，提高代码质量。在实际开发中，需要根据具体情况选择合适的Mock策略，并仔细检查测试逻辑，确保测试结果的正确性。