如何使用 Mockito 模拟 void 方法

IT小君 2021-09-11T23:46:36

如何使用 void 返回类型模拟方法？

我实现了一个观察者模式，但我不能用 Mockito 模拟它，因为我不知道如何。

我试图在互联网上找到一个例子但没有成功。

我的课是这样的：

public class World {

    List<Listener> listeners;

    void addListener(Listener item) {
        listeners.add(item);
    }

    void doAction(Action goal,Object obj) {
        setState("i received");
        goal.doAction(obj);
        setState("i finished");
    }

    private string state;
    //setter getter state
} 

public class WorldTest implements Listener {

    @Test public void word{
    World  w= mock(World.class);
    w.addListener(this);
    ...
    ...

    }
}

interface Listener {
    void doAction();
}

系统不是用模拟触发的。

我想显示上述系统状态。并根据它们做出断言。

IT小君

查看 Mockito API 文档。正如链接文档中提到的（第 12 点），您可以使用Mockito 框架中的任何doThrow(), doAnswer(), doNothing(),doReturn()系列方法来模拟 void 方法。

例如，

Mockito.doThrow(new Exception()).when(instance).methodName();

或者如果你想把它与后续行为结合起来，

Mockito.doThrow(new Exception()).doNothing().when(instance).methodName();

假设您正在查看setState(String s)下面类 World 中的 setter是代码使用doAnswer方法来模拟setState.

World mockWorld = mock(World.class); 
doAnswer(new Answer<Void>() {
    public Void answer(InvocationOnMock invocation) {
      Object[] args = invocation.getArguments();
      System.out.println("called with arguments: " + Arrays.toString(args));
      return null;
    }
}).when(mockWorld).setState(anyString());

2021-09-11T23:46:37 回复

IT小君

我想我已经找到了一个更简单的答案，只为一个方法调用真正的方法（即使它有一个 void 返回），你可以这样做：

Mockito.doCallRealMethod().when(<objectInstance>).<method>();
<objectInstance>.<method>();

或者，您可以为该类的所有方法调用真正的方法，这样做：

<Object> <objectInstance> = mock(<Object>.class, Mockito.CALLS_REAL_METHODS);

2021-09-11T23:46:38 回复

IT小君

添加@sateesh 所说的，当您只想模拟 void 方法以防止测试调用它时，您可以使用Spy这种方式：

World world = new World();
World spy = Mockito.spy(world);
Mockito.doNothing().when(spy).methodToMock();

当您要运行测试时，请确保在spy对象上而不是在world对象上调用 test 中的方法。例如：

assertEquals(0, spy.methodToTestThatShouldReturnZero());

2021-09-11T23:46:38 回复

IT小君

所谓问题的解决方案是使用spy Mockito.spy(...)而不是mock Mockito.mock(..)。

Spy 使我们能够进行部分模拟。Mockito 擅长这件事。因为您的课程不完整，因此您可以通过这种方式模拟该课程中的某些必需位置。

2021-09-11T23:46:38 回复

IT小君

首先：您应该始终导入 mockito static，这样代码将更具可读性（和直观）：

import static org.mockito.Mockito.*;

对于部分模拟并仍然保留其余部分的原始功能，mockito 提供“间谍”。

您可以按如下方式使用它：

private World world = spy(new World());

要消除执行的方法，您可以使用以下内容：

doNothing().when(someObject).someMethod(anyObject());

为方法使用“when”和“thenReturn”提供一些自定义行为：

doReturn("something").when(this.world).someMethod(anyObject());

有关更多示例，请在文档中找到优秀的 mockito 示例。

2021-09-11T23:46:38 回复

IT小君

如何使用 mockito 模拟 void 方法 - 有两种选择：

doAnswer - 如果我们想让我们的模拟 void 方法做一些事情（尽管是无效的，但还是模拟了行为）。
doThrow- 然后，Mockito.doThrow()如果您想从模拟的 void 方法中抛出异常。

以下是如何使用它的示例（不是理想的用例，只是想说明基本用法）。

@Test
public void testUpdate() {

    doAnswer(new Answer<Void>() {

        @Override
        public Void answer(InvocationOnMock invocation) throws Throwable {
            Object[] arguments = invocation.getArguments();
            if (arguments != null && arguments.length > 1 && arguments[0] != null && arguments[1] != null) {

                Customer customer = (Customer) arguments[0];
                String email = (String) arguments[1];
                customer.setEmail(email);

            }
            return null;
        }
    }).when(daoMock).updateEmail(any(Customer.class), any(String.class));

    // calling the method under test
    Customer customer = service.changeEmail("[email protected]", "[email protected]");

    //some asserts
    assertThat(customer, is(notNullValue()));
    assertThat(customer.getEmail(), is(equalTo("[email protected]")));

}

@Test(expected = RuntimeException.class)
public void testUpdate_throwsException() {

    doThrow(RuntimeException.class).when(daoMock).updateEmail(any(Customer.class), any(String.class));

    // calling the method under test
    Customer customer = service.changeEmail("[email protected]", "[email protected]");

}
}

您可以在我的文章How to mock with Mockito（带示例的综合指南）中找到有关如何使用 Mockito模拟和测试 void方法的更多详细信息

2021-09-11T23:46:39 回复

IT小君

在 Java 8 中，这可以更简洁一些，假设您有一个静态导入org.mockito.Mockito.doAnswer：

doAnswer(i -> {
  // Do stuff with i.getArguments() here
  return null;
}).when(*mock*).*method*(*methodArguments*);

该return null;是很重要的，没有它编译将一些比较隐蔽的错误失败，因为它无法找到一个合适的替代doAnswer。

例如ExecutorService，可以使用以下方法实现立即执行Runnable传递给的任何内容execute()：

doAnswer(i -> {
  ((Runnable) i.getArguments()[0]).run();
  return null;
}).when(executor).execute(any());

2021-09-11T23:46:40 回复

IT小君

添加另一个答案到一堆（没有双关语意）...

如果您不能\不想使用间谍，则确实需要调用 doAnswer 方法。但是，您不一定需要推出自己的Answer。有几个默认实现。值得注意的是，CallsRealMethods。

在实践中，它看起来像这样：

doAnswer(new CallsRealMethods()).when(mock)
        .voidMethod(any(SomeParamClass.class));

或者：

doAnswer(Answers.CALLS_REAL_METHODS.get()).when(mock)
        .voidMethod(any(SomeParamClass.class));

2021-09-11T23:46:40 回复

IT小君

我认为您的问题是由于您的测试结构造成的。我发现很难将模拟与在测试类中实现接口的传统方法混合使用（正如您在此处所做的那样）。

如果将侦听器实现为 Mock，则可以验证交互。

Listener listener = mock(Listener.class);
w.addListener(listener);
world.doAction(..);
verify(listener).doAction();

这应该让您满意，“世界”正在做正确的事情。

2021-09-11T23:46:40 回复

IT小君

在您的示例中，您应该模拟 Listener 项目并使用 Mockito.verify 检查与它的交互

2021-09-11T23:46:41 回复