当使用 Mockito.spy() 模拟被另一个方法调用的方法时，为什么会出现 UnnecessaryStubbingException？

Question

我有以下class-

public class A {
    int a;

    public A() {
        this.a = 67;
    }
    
    public int get_a() {
        return this.a;
    }
    
    public boolean is_a_even() {
        if(this.get_a() % 2 == 0) {
            return true;

        } else{
            return false;
        }
    }
}

我想模拟 get_a() 函数，使其 returns 成为我想要的值，所以我编写了以下测试-

@ExtendWith(MockitoExtension.class)
class ATest {

    @Test
    public void testing_if_call_from_another_function_is_mocked() {
        A obj = new A();

        A mock = Mockito.spy(obj);

        Mockito.doReturn(2).when(mock).get_a();

        assertTrue(obj.is_a_even());

    }
}

但是当我运行这个时，我得到以下异常-

org.mockito.exceptions.misusing.UnnecessaryStubbingException: 
Unnecessary stubbings detected.
Clean & maintainable test code requires zero unnecessary code.
Following stubbings are unnecessary (click to navigate to relevant line of code):
  1. -> at com.example.demo.ATest.testing_if_call_from_another_function_is_mocked(ATest.java:19)
Please remove unnecessary stubbings or use 'lenient' strictness. More info: javadoc for UnnecessaryStubbingException class.

    at org.mockito.junit.jupiter.MockitoExtension.afterEach(MockitoExtension.java:186)
    at org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.lambda$invokeAfterEachCallbacks(TestMethodTestDescriptor.java:253)
    at org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.lambda$invokeAllAfterMethodsOrCallbacks(TestMethodTestDescriptor.java:269)
    at org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73)
    at org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.lambda$invokeAllAfterMethodsOrCallbacks(TestMethodTestDescriptor.java:269)
    at java.base/java.util.ArrayList.forEach(ArrayList.java:1511)
    at org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.invokeAllAfterMethodsOrCallbacks(TestMethodTestDescriptor.java:268)
    at org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.invokeAfterEachCallbacks(TestMethodTestDescriptor.java:252)
    at org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.execute(TestMethodTestDescriptor.java:137)
    at org.junit.jupiter.engine.descriptor.TestMethodTestDescriptor.execute(TestMethodTestDescriptor.java:65)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively(NodeTestTask.java:139)
    at org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively(NodeTestTask.java:129)
    at org.junit.platform.engine.support.hierarchical.Node.around(Node.java:137)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively(NodeTestTask.java:127)
    at org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.executeRecursively(NodeTestTask.java:126)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.execute(NodeTestTask.java:84)
    at java.base/java.util.ArrayList.forEach(ArrayList.java:1511)
    at org.junit.platform.engine.support.hierarchical.SameThreadHierarchicalTestExecutorService.invokeAll(SameThreadHierarchicalTestExecutorService.java:38)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively(NodeTestTask.java:143)
    at org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively(NodeTestTask.java:129)
    at org.junit.platform.engine.support.hierarchical.Node.around(Node.java:137)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively(NodeTestTask.java:127)
    at org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.executeRecursively(NodeTestTask.java:126)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.execute(NodeTestTask.java:84)
    at java.base/java.util.ArrayList.forEach(ArrayList.java:1511)
    at org.junit.platform.engine.support.hierarchical.SameThreadHierarchicalTestExecutorService.invokeAll(SameThreadHierarchicalTestExecutorService.java:38)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively(NodeTestTask.java:143)
    at org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively(NodeTestTask.java:129)
    at org.junit.platform.engine.support.hierarchical.Node.around(Node.java:137)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.lambda$executeRecursively(NodeTestTask.java:127)
    at org.junit.platform.engine.support.hierarchical.ThrowableCollector.execute(ThrowableCollector.java:73)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.executeRecursively(NodeTestTask.java:126)
    at org.junit.platform.engine.support.hierarchical.NodeTestTask.execute(NodeTestTask.java:84)
    at org.junit.platform.engine.support.hierarchical.SameThreadHierarchicalTestExecutorService.submit(SameThreadHierarchicalTestExecutorService.java:32)
    at org.junit.platform.engine.support.hierarchical.HierarchicalTestExecutor.execute(HierarchicalTestExecutor.java:57)
    at org.junit.platform.engine.support.hierarchical.HierarchicalTestEngine.execute(HierarchicalTestEngine.java:51)
    at org.junit.platform.launcher.core.EngineExecutionOrchestrator.execute(EngineExecutionOrchestrator.java:108)
    at org.junit.platform.launcher.core.EngineExecutionOrchestrator.execute(EngineExecutionOrchestrator.java:88)
    at org.junit.platform.launcher.core.EngineExecutionOrchestrator.lambda$execute[=13=](EngineExecutionOrchestrator.java:54)
    at org.junit.platform.launcher.core.EngineExecutionOrchestrator.withInterceptedStreams(EngineExecutionOrchestrator.java:67)
    at org.junit.platform.launcher.core.EngineExecutionOrchestrator.execute(EngineExecutionOrchestrator.java:52)
    at org.junit.platform.launcher.core.DefaultLauncher.execute(DefaultLauncher.java:96)
    at org.junit.platform.launcher.core.DefaultLauncher.execute(DefaultLauncher.java:75)
    at com.intellij.junit5.JUnit5IdeaTestRunner.startRunnerWithArgs(JUnit5IdeaTestRunner.java:71)
    at com.intellij.rt.junit.IdeaTestRunner$Repeater.startRunnerWithArgs(IdeaTestRunner.java:33)
    at com.intellij.rt.junit.JUnitStarter.prepareStreamsAndStart(JUnitStarter.java:221)
    at com.intellij.rt.junit.JUnitStarter.main(JUnitStarter.java:54)

这是否意味着对 get_a() 的方法调用没有被模拟，如果是这样，我该如何模拟将要从另一个方法调用的方法？

Answer 1

你得到 UnnecessaryStubbingException 因为 mock.get_a() 从未被调用。

这是因为你打电话给

assertTrue(obj.is_a_even());

而不是：

assertTrue(mock.is_a_even());

因此在is_a_even方法中this指向obj，而不是mock

其他备注：

坚持 JavaBean 命名约定 - getA() 而不是 get_a()。这很普遍，很多工具都依赖它。
替换被测系统的一部分是一种高级工具 - 请谨慎使用。如果可能，模拟 SUT 的合作者，而不是 SUT 本身。

Answer 2

让我们更深入地了解正在发生的事情以及原因。

当我们打电话时

A mock = Mockito.spy(obj);

mockito 创建一个包装器对象，我们可以用它来监视对象。我们使用这个间谍来模拟我们想要模拟的调用：

Mockito.doReturn(2).when(mock).get_a();

请注意，原来的 obj 保持不变。特别是，它的行为保持不变。如果我们使用 obj，它的行为就像我们从未创建过间谍一样。

因此，如果我们调用

obj.is_a_even()

我们的模拟将不会被使用。为了获得所需的行为，我们需要调用

mock.is_a_even()

然而，正确的解决方案是使 class 可测试，例如通过提供允许设置 a 值的构造函数，例如：

public class A {
    private final int a;

    public A(int a) {
        this.a = a;
    }

    public A() {
        this(67);
    }

    ...
}

有了这个设置，我们可以编写相同的测试而不需要任何模拟。

三个备注：

我们应该尊重封装，即设置属性 private 并使它们只能通过访问器方法访问。
我们应该赞成
```
Mockito.when(mock.get_a()).thenReturn(2);
```
超过
```
Mockto.doReturn(2).when(mock).get_a();
```
因为前者在编译时保证类型安全，而后者则不然。
在Java中，方法名应该写成lowerCamelCase而不是snake_case（get_a() -> getA()，is_a_even() -> isAEven())。我还建议为字段 a 以及两种方法找到更好的名称。

当使用 Mockito.spy() 模拟被另一个方法调用的方法时，为什么会出现 UnnecessaryStubbingException？

When using Mockito.spy() to mock a method being called by another method, why do I get a UnnecessaryStubbingException?

java

unit-testing

mockito