description函数

public static VerificationMod description(String description)

添加验证失败时要输出的文字内容

  2. verify(mock, description("This will print on failure")).someMethod("some arg");

Parameters:

输出的文字内容

Returns:

验证模式

Since:

  • 2.0.0

doAnswer函数

public static Stubber doAnswer(Answer answer)

当你想要测试一个无返回值的函数时，可以使用一个含有泛型类Answer参数的doAnswer()函数。为无返回值的函数做测试桩与when(Objecy)方法不同，因为编译器不喜欢在大括号内使用void函数。

  2. doAnswer(new Answer() {
  3.       public Object answer(InvocationOnMock invocation) {
  4.           Object[] args = invocation.getArguments();
  5.           Mock mock = invocation.getMock();
  6.           return null;
  7.       }})
  8.   .when(mock).someMethod();

参照Mockito类的javadoc帮助文档中的例子

Parameters:

测试函数的应答内容

Returns:

测试方法的测试桩

doCallRealMethod函数

public static Stubber doCallRealMethod()

如果你想调用某一个方法的真实实现请使用doCallRealMethod()。

像往常一样你需要阅读局部的mock对象警告:面向对象编程通过将复杂的事物分解成单独的、具体的、SRPY对象来减少对复杂事件的处理。 局部模拟是如何符合这种范式的呢。？局部模拟通常情况下是指在对象相同的情况下那些复杂的事物被移动另一个不同的方法中。在大多数情况下，并没有按照你所希望的方式来设计你的应用。

然而，使用局部mock对象也会有个别情况:有些代码你并不能非常容易的改变(3rd接口,临时遗留代码的重构等)，但是我对于新的、测试驱动及良好设计的代码不会使用局部mock对象。

同样在javadoc中spy(Object)阅读更多关于partial mocks的说明.推荐使用Mockito.spy()来创建局部mock对象原因是由于你负责构建对象并传值到spy()中，它只管保证被调用。

  2. Foo mock = mock(Foo.class);
  3.    doCallRealMethod().when(mock).someVoidMethod();
  5.    // this will call the real implementation of Foo.someVoidMethod()
  6.    // 调用Foo.someVoidMethod()的真实现
  7.    mock.someVoidMethod();

参照Mockito类的javadoc帮助文档中的例子

Returns:

测试方法的测试桩

Since:

  • 1.9.5

doNothing函数

public static Stubber doNothing()

使用doNothing()函数是为了设置void函数什么也不做。需要注意的是默认情况下返回值为void的函数在mocks中是什么也不做的但是，也会有一些特殊情况。

1.测试桩连续调用一个void函数

  2. doNothing().
  3.    doThrow(new RuntimeException())
  4.    .when(mock).someVoidMethod();
  6.    //does nothing the first time:
  7.    //第一次才能都没做
  8.    mock.someVoidMethod();
  10.    //throws RuntimeException the next time:
  11.    //一下次抛出RuntimeException
  12.    mock.someVoidMethod();

2.当你监控真实的对象并且你想让void函数什么也不做：

  2. List list = new LinkedList();
  3.    List spy = spy(list);
  5.    //let's make clear() do nothing
  6.    doNothing().when(spy).clear();
  8.    spy.add("one");
  10.    //clear() does nothing, so the list still contains "one"
  11.    spy.clear();

参照Mockito类的javadoc帮助文档中的例子

Returns:

stubber - 测试方法的测试桩

doReturn函数

public static Stubber doReturn(Object toBeReturned)

在某些特殊情况下如果你无法使用when(Object)可以使用doReturn()函数

注意：对于测试桩推荐使用when(Object)函数，因为它是类型安全的并且可读性更强(特别是在测试桩连续调用的情况下)

都有哪些特殊情况下需要使用doReturn()

1.当监控真实的对象并且调用真实的函数带来的影响时：

  1. List list = new LinkedList();
  2.    List spy = spy(list);
  4.    //Impossible: real method is called so spy.get(0) throws IndexOutOfBoundsException (the list is yet empty)
  6.    // 不能完成的：真实方法被调用所以spy.get(0)抛出IndexOutOfBoundsException(list仍是空的)
  7.    when(spy.get(0)).thenReturn("foo");
  9.    //You have to use doReturn() for stubbing:
  10.    //你应用使用doReturn()函数
  11.    doReturn("foo").when(spy).get(0);
  1. 重写一个前exception-stubbing：
  2. when(mock.foo()).thenThrow(new RuntimeException());
  4.    //Impossible: the exception-stubbed foo() method is called so RuntimeException is thrown.
  5.     // 不能完成的：exception-stubbed foo()被调用抛出RuntimeException异常
  6.    when(mock.foo()).thenReturn("bar");
  8.    //You have to use doReturn() for stubbing:
  9.    //你应用使用doReturn()函数
  10.    doReturn("bar").when(mock).foo();

上面的情况展示了Mockito’s的优雅语法。注意这些情况并不常见。监控应该是分散的并且重写exception-stubbing也不常见。更何况对于指出测试桩并复写测试桩是一种潜在的代码嗅觉

参照Mockito类的javadoc帮助文档中的例子

Parameters:

toBeReturned - 当测试桩函数被调用时要被返回的对象

Returns:

stubber - 测试方法的测试桩

doThrow函数

public static Stubber doThrow(Class<? extends Throwable> toBeThrown)

当你想测试void函数中指定类的抛出异常时使用doThrow()

当每一个函数被调用时一个新的异常实例将会被创建

为无返回值的函数做测试桩与when(Objecy)方法不同，因为编译器不喜欢在大括号内使用void函数。

  1. doThrow(RuntimeException.class).when(mock).someVoidMethod();

Parameters:

测试方法被调用时返回的对象

Returns:

测试方法的测试桩

Since:

  • 1.9.0

doThrow函数

public static Stubber doThrow(Throwable toBeThrown)

当测试一个void函数的异常时使用doThrow()

测试void函数需要与使用when(Object)不同的方式，因为编译器不喜欢大括号内有void函数

Example:

  1. doThrow(RuntimeException.class).when(mock).someVoidMethod();

Parameters:

测试方法被调用时返回的对象

Returns:

测试方法的测试桩

Since:

  • 1.9.0

ignoreStubs函数

public static Object[] ignoreStubs(Object... mocks)

忽略对验证函数的测试，当与verifyNoMoreInteractions()成对出现或是验证inOrder()时是很有用的。避免了在测试时的多余验证，实际上我们对验证测试一点也不感兴趣。

警告,ignoreStubs()可能会导致verifyNoMoreInteractions(ignoreStubs(...))的过度使用。考虑到Mockito并不推荐使用verifyNoMoreInteractions()函数轰炸每一个测试，这其中的原由在文档verifyNoMoreInteractions(Object…)部分已经说明：换句话说在mocks中所有 stubbed 的函数都被标记为 verified 所以不需要使用这种方式。

该方法改变了input mocks！该方法只是为了方便返回 imput mocks 。

忽略测试也会被忽略掉验证inOrder,包括InOrder.verifyNoMoreInteractions()，看下面第二个示例：

Example:

  1. //mocking lists for the sake of the example (if you mock List in real you will burn in hell)
  2.   List mock1 = mock(List.class), mock2 = mock(List.class);
  4.   //stubbing mocks:
  5.   when(mock1.get(0)).thenReturn(10);
  6.   when(mock2.get(0)).thenReturn(20);
  8.   //using mocks by calling stubbed get(0) methods:
  10.   // 调用stubbed get(0)使用mocks
  11.   System.out.println(mock1.get(0)); //prints 10
  12.   System.out.println(mock2.get(0)); //prints 20
  14.   //using mocks by calling clear() methods:
  15.   // 调用clear()使用mocks
  16.   mock1.clear();
  17.   mock2.clear();
  19.   //verification:
  21.   // 验证
  22.   verify(mock1).clear();
  23.   verify(mock2).clear();
  25.   //verifyNoMoreInteractions() fails because get() methods were not accounted for.
  27.   // verifyNoMoreInteractions()会失败，因为get()未关联账号
  29.   try { verifyNoMoreInteractions(mock1, mock2); } catch (NoInteractionsWanted e);
  31.   //However, if we ignore stubbed methods then we can verifyNoMoreInteractions()
  32.   //如要我们忽略测试函数我可以这样verifyNoMoreInteractions()
  34.   verifyNoMoreInteractions(ignoreStubs(mock1, mock2));
  36.   //Remember that ignoreStubs() *changes* the input mocks and returns them for convenience.

忽略测试可以用于verification in order:

  1. List list = mock(List.class);
  2.   when(mock.get(0)).thenReturn("foo");
  4.   list.add(0);
  5.   System.out.println(list.get(0)); //we don't want to verify this
  6.   list.clear();
  8.   InOrder inOrder = inOrder(ignoreStubs(list));
  9.   inOrder.verify(list).add(0);
  10.   inOrder.verify(list).clear();
  11.   inOrder.verifyNoMoreInteractions();

Parameters:

将被改变的input mocks

Returns:

和传入参数一样的mocks

Since:

1.9.0

inOrder函数

public static InOrder inOrder(Object... mocks)

创建InOrder对象验证 mocks in order

  1. InOrder inOrder = inOrder(firstMock, secondMock);
  3. inOrder.verify(firstMock).add("was called first");
  4. inOrder.verify(secondMock).add("was called second");

验证in order是很灵活的。你可以只验证你感兴趣的，并不需要一个一个验证所有的交互。同样你也可以创建InOrder对象只在相关in-order的验证中进行传值。

InOrder 验证是’greedy’.你很难每一个都注意到。你可以在Mockito wiki pages页搜索’greedy’获取更多信息。

Mockito 1.8.4版本你能以order-sensitive方式调用verifyNoMoreInvocations()，阅读更多InOrder.verifyNoMoreInteractions())

参照Mockito类的javadoc帮助文档中的例子

Parameters:

in order中被修改的mocks

Returns:

in order中被用于验证的InOrder对象

mock函数

public static <T> T mock(Class <T> classToMock)

对给定的类或接口创建mock对象

Parameters:

需要mock的类或接口

Returns:

mock对象

mock函数

public static <T> T mock(Class <T> classToMock, Answer defaultAnswer)

根据它对交互的回应指明策略创建mock对象。这个是比较高级特性并且你不需要它写多少测试代码。但是对于legacy系统这是非常有用的。

这个是默认answer，所以当你不想测试函数时你可以使用它。

  2. Foo mock = mock(Foo.class, RETURNS_SMART_NULLS);
  3. Foo mockTwo = mock(Foo.class, new YourOwnAnswer());

参照Mockito类的javadoc帮助文档中的例子

Parameters:

  • 需要mock的类或接口

  • 未测试函数的默认answer

Returns:

mock对象

mock函数

public static <T> T mock(Class <T> classToMock, MockSettings mockSettings)

没有标准的设置来创建mock对象

配置点的数目对mock的扩大有影响，所以我们在没有越来越多重载Mockito.mock()的情况下需要一种更流利的方式来介绍一种新的配置方式。即MockSettings.

  2. Listener mock = mock(Listener.class, withSettings()
  3.      .name("firstListner").defaultBehavior(RETURNS_SMART_NULLS));
  4.    );

使用它时需要小心一些并且不要常用。在什么情况下你的测试会不需要标准配置的mocks?在测试代码下太复杂以至于不需要标准配置的mocks?你有没有重构测试代码来让它更加容易测试？

也可以参考withSettings())

参照Mockito类的javadoc帮助文档中的例子

Parameters:

  • 需要mock的类或接口
  • mock配置

Returns:

  • mock对象

mock

@Deprecated

@已过期

public static <T> T mock(Class <T> classToMock, ReturnValues returnValues)

已过期，请使用mock(Foo.class, defaultAnswer);

已过期，请使用mock(Foo.class, defaultAnswer);

见mock(Class, Answer))

为什么会过期？为了框架更好的一致性与交互性用Answer替换了ReturnValues。Answer接口很早就存在框架中了并且它有和ReturnValues一样的责任。没有必要维护两个一样的接口。

针对它的返回值需要指明策略来创建mock对象。这个是比较高级特性并且你不需要它写多少测试代码。但是对于legacy系统这是非常有用的。

明显地，当你不需要测试方法时可以使用这个返回值。

  1. Foo mock = mock(Foo.class, Mockito.RETURNS_SMART_NULLS);
  2. Foo mockTwo = mock(Foo.class, new YourOwnReturnValues());

参照Mockito类的javadoc帮助文档中的例子

Parameters:

  • 需要mock的类或接口
  • 未测试方法默认返回值

Returns:

  • mock对象

mock

public static <T> T mock(Class <T> classToMock, String name)

指明mock的名字。命名mock在debug的时候非常有用。名字会在所有验证错误中使用。需要注意的是对于使用太多mock或者collaborators的复杂代码命名mock并不能解决问题。如果你使用了太多的mock，为了更加容易测试/调试 你需要对其进行重构而不是对mock命名。

如果你使用了@Mock注解，意味着你的mock已经有名字了！

@Mock使用字段名称作为mock名字Read more

参照Mockito类的javadoc帮助文档中的例子

Parameters:

  • 需要mock的类或接口
  • mock的名字

Returns:

  • mock对象

mockingDetails函数

public static MockingDetails mockingDetails(Object toInspect)

对于Mockito的关联信息返回MockingDetails实例可以用于检查某一特定的对象，无论给定的对象是mock还是监视的都可以被找出来。

在Mockito以后的版本中MockingDetails可能会扩大并且提供其它有用的有关mock的信息。e.g. invocations, stubbing info, etc.

Parameters:

  • 要检查的对象。允许为空

Returns:

MockingDetails实例

Since:

  • 1.9.5