Mockito 单元测试中 when...thenReturn 不生效的解决方案

本文旨在解决在使用 Mockito 进行单元测试时，when...thenReturn 方法不生效，导致 Mock 对象返回 null 或抛出 UnnecessaryStubbingException 的问题。通过详细的示例代码和步骤，帮助开发者正确地使用 Mockito 进行 Mock 对象的创建和行为模拟。

在进行单元测试时，我们经常需要模拟（Mock）一些依赖的对象，以便隔离被测试代码并专注于其自身的逻辑。Mockito 是一个流行的 Java Mocking 框架，它提供了简洁的 API 来创建和配置 Mock 对象。然而，有时在使用 Mockito 的 when...thenReturn 方法时，会遇到不生效的情况，导致 Mock 对象返回 null 或抛出 UnnecessaryStubbingException。本文将深入探讨这个问题，并提供解决方案。

问题分析

when...thenReturn 不生效的常见原因主要有以下几点：

1. 未初始化 Mock 对象： Mockito 需要正确初始化 Mock 对象才能生效。
2. 错误的 Mock 对象类型： 确保 Mock 的对象类型与实际使用的类型一致。
3. 参数不匹配： when 方法中的参数必须与实际调用时传入的参数完全匹配。
4. 调用了真实对象的方法： 如果直接 new 一个对象，而非使用 Mockito 创建的 Mock 对象，那么 when...thenReturn 就不会生效。
5. Mockito 版本问题： 某些旧版本的 Mockito 可能存在 Bug，建议升级到最新版本。

解决方案

针对以上问题，我们可以采取以下措施来解决 when...thenReturn 不生效的问题：

1. 初始化 Mock 对象

Mockito 提供了多种方式来初始化 Mock 对象。最常用的方式是使用 @Mock 注解和 MockitoAnnotations.initMocks(this) 方法。

• 使用 @Mock 注解： 在测试类中，使用 @Mock 注解声明需要 Mock 的对象。

  @Mock
  LoginDao loginDao;
  
  @Mock
  Admin admin;

  登录后复制

• 使用 MockitoAnnotations.initMocks(this) 方法： 在测试类的 setUp 方法（或使用 JUnit 的 @BeforeEach 注解）中，调用 MockitoAnnotations.initMocks(this) 方法来初始化使用 @Mock 注解声明的 Mock 对象。

  import org.junit.jupiter.api.BeforeEach;
  import org.mockito.MockitoAnnotations;
  
  @BeforeEach
  void setUp() {
      MockitoAnnotations.openMocks(this); // 或者使用 MockitoAnnotations.initMocks(this);
  }

  登录后复制

  注意: 较新的Mockito版本推荐使用MockitoAnnotations.openMocks(this)，它会自动关闭所有打开的Mocks，防止内存泄漏。

2. 确保 Mock 对象类型正确

确保 Mock 的对象类型与实际使用的类型一致。例如，如果 LoginController 类中使用了 LoginDao 接口，那么应该 Mock LoginDao 接口，而不是它的实现类。

3. 参数匹配

青柚面试

简单好用的日语面试辅助工具

57

查看详情

when 方法中的参数必须与实际调用时传入的参数完全匹配。Mockito 提供了多种参数匹配器，可以用于匹配不同类型的参数。

• any()： 匹配任何类型的参数。
• anyString()： 匹配任何字符串类型的参数。
• anyInt()： 匹配任何整数类型的参数。
• eq(value)： 匹配与 value 相等的参数。

例如，如果 loginDao.getAdminDetails(staffId, password) 方法接收两个字符串类型的参数，可以使用 anyString() 来匹配这两个参数。

when(loginDao.getAdminDetails(anyString(), anyString())).thenReturn(admin);

如果需要匹配特定的参数值，可以使用 eq(value)。

when(loginDao.getAdminDetails(eq("uname"), eq("pass"))).thenReturn(admin);

4. 使用 Mock 对象而非真实对象

确保在被测试代码中使用的是 Mockito 创建的 Mock 对象，而不是通过 new 关键字创建的真实对象。如果需要将 Mock 对象注入到被测试类中，可以使用 @InjectMocks 注解。

@InjectMocks
LoginController loginController;

Mockito 会自动将使用 @Mock 注解声明的 Mock 对象注入到使用 @InjectMocks 注解声明的被测试类中。

5. 升级 Mockito 版本

如果使用的是旧版本的 Mockito，建议升级到最新版本，以避免潜在的 Bug。

示例代码

以下是一个完整的示例代码，演示了如何使用 Mockito 进行单元测试，并解决 when...thenReturn 不生效的问题。

import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.springframework.mock.web.MockHttpServletRequest;
import org.springframework.mock.web.MockHttpServletResponse;
import org.springframework.web.servlet.ModelAndView;

import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.mockito.ArgumentMatchers.anyString;
import static org.mockito.Mockito.when;

class LoginControllerTest {

    @InjectMocks
    LoginController loginController;

    @Mock
    LoginDao loginDao;

    @Mock
    Admin admin;

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

    @Test
    void testLogin() throws Exception {
        MockHttpServletRequest request = new MockHttpServletRequest();
        MockHttpServletResponse response = new MockHttpServletResponse();

        request.setParameter("password", "pass");
        request.setParameter("username", "uname");

        when(loginDao.getAdminDetails(anyString(), anyString())).thenReturn(admin);

        ModelAndView modelAndView = loginController.login(request, response);
        assertNotNull(modelAndView);
    }
}

注意事项

• 确保 Mockito 的依赖已正确添加到项目中。
• 仔细检查 when 方法中的参数是否与实际调用时传入的参数匹配。
• 避免在同一个测试方法中 Mock 过多的对象，保持测试的简洁性。
• 使用 Mockito 的验证方法（例如 verify）来确保 Mock 对象的方法被正确调用。

总结

通过正确地初始化 Mock 对象、确保 Mock 对象类型正确、参数匹配、使用 Mock 对象而非真实对象以及升级 Mockito 版本，可以有效地解决 when...thenReturn 不生效的问题。Mockito 是一个强大的单元测试工具，掌握其正确的使用方法可以提高测试效率和代码质量。希望本文能够帮助读者更好地理解和使用 Mockito。

以上就是Mockito 单元测试中 when...thenReturn 不生效的解决方案的详细内容，更多请关注php中文网其它相关文章！