Java Mockito匹配器如何工作？

Question

争论的Mockito匹配器（如any，argThat，eq，same，和ArgumentCaptor.capture()）从Hamcrest匹配器表现非常不同。

• Mockito匹配器经常导致InvalidUseOfMatchersException，即使在使用任何匹配器很长时间后执行的代码中也是如此。

• Mockito匹配器遵循怪异的规则，例如，如果给定方法中的一个参数使用匹配器，则仅要求对所有参数使用Mockito匹配器。

• 当覆盖Answers或使用(Integer) any()etc时，Mockito匹配器可能导致NullPointerException 。

• 使用Mockito匹配器以某些方式重构代码会产生异常和意外行为，并且可能会完全失败。

为什么Mockito匹配器是这样设计的，如何实现？

Answer 1

匹配器的Mockito是静态的方法和这些方法，要求站在了争论在通话过程when和verify。

Hamcrest匹配器（存档版本）（或Hamcrest样式的匹配器）是无状态的通用对象实例，该实例实现Matcher<T>并公开一个方法matches(T)，如果对象符合Matcher的条件，则该方法返回true。它们无副作用，通常用于断言之类的声明中。

/* Mockito */  verify(foo).setPowerLevel(gt(9000));
/* Hamcrest */ assertThat(foo.getPowerLevel(), is(greaterThan(9000)));

存在Mockito匹配器，与Hamcrest风格的匹配器分开，以便匹配表达式的描述直接适合方法调用：Mockito匹配器返回THamcrest匹配器方法返回Matcher对象（类型Matcher<T>）的地方。

匹配器的Mockito通过静态方法，如调用eq，any，gt，和startsWith上org.mockito.Matchers和org.mockito.AdditionalMatchers。还有一些适配器，它们在Mockito版本之间进行了更改：

• 对于Mockito 1.x，Matchers某些调用（例如intThat或argThat）是Mockito匹配器，它们直接接受Hamcrest匹配器作为参数。ArgumentMatcher<T>extended org.hamcrest.Matcher<T>，用于内部Hamcrest表示形式，并且是Hamcrest匹配器的基类，而不是任何Mockito匹配器。
• 对于Mockito 2.0 +，Mockito不再直接依赖Hamcrest。Matchers调用短语为intThat或argThat包装ArgumentMatcher<T>不再实现org.hamcrest.Matcher<T>但以相似方式使用的对象。Hamcrest适配器（例如argThat和）intThat仍然可用，但已MockitoHamcrest改为使用。
  无论匹配器是Hamcrest还是简单的Hamcrest风格，都可以像这样进行修改：
  

/* Mockito matcher intThat adapting Hamcrest-style matcher is(greaterThan(...)) */
verify(foo).setPowerLevel(intThat(is(greaterThan(9000))));

在上面的语句中：foo.setPowerLevel是一个接受的方法int。is(greaterThan(9000))返回一个Matcher<Integer>，它不能作为setPowerLevel参数。Mockito匹配器intThat包装了Hamcrest风格的Matcher并返回一个，int因此它可以作为参数出现；像gt(9000)示例代码的第一行一样，类似Mockito的匹配器会将整个表达式包装到一个调用中。

匹配者做什么/返回

when(foo.quux(3, 5)).thenReturn(true);

当不使用参数匹配器时，Mockito会记录你的参数值，并将其与equals方法进行比较。

when(foo.quux(eq(3), eq(5))).thenReturn(true);    // same as above
when(foo.quux(anyInt(), gt(5))).thenReturn(true); // this one's different

当你将匹配器称为any或gt（大于）时，Mockito将存储一个匹配器对象，该对象使Mockito跳过该相等性检查并应用你选择的匹配项。在这种情况下，argumentCaptor.capture()将存储一个匹配器，该匹配器将保存其参数，以供以后检查。

匹配器返回虚拟值，例如零，空集合或null。尝试的Mockito返回一个安全，适当的虚值，如0 anyInt()或any(Integer.class)或空List<String>的anyListOf(String.class)。但是，由于类型擦除，Mockito缺少用于返回任何值的类型信息，但是nullfor any()或argThat(...)，如果尝试“自动拆箱” null原始值，则可能导致NullPointerException 。

匹配器喜欢eq并gt获取参数值；理想情况下，应在存根/验证开始之前计算这些值。在模拟另一个呼叫的中间调用模拟可能会干扰存根。

匹配器方法不能用作返回值；例如，无法使用短语thenReturn(anyInt())或thenReturn(any(Foo.class))Mockito。Mockito需要确切地知道在存根调用中返回哪个实例，并且不会为你选择任意返回值。

实施细节

匹配器（作为Hamcrest样式的对象匹配器）存储在包含在名为ArgumentMatcherStorage的类中的堆栈中。MockitoCore和Matchers各自拥有一个ThreadSafeMockingProgress实例，该实例静态包含一个包含MockingProgress实例的ThreadLocal。正是这个MockingProgressImpl持有一个具体的ArgumentMatcherStorageImpl。因此，模拟和匹配器状态是静态的，但是Mockito和Matchers类之间的线程作用域一致。

最匹配的呼叫只会增加这个堆栈，与喜欢的匹配例外and，or和not。这完全对应于（并依赖于）Java的评估顺序，该顺序在调用方法之前从左到右评估参数：

when(foo.quux(anyInt(), and(gt(10), lt(20)))).thenReturn(true);
[6]      [5]  [1]       [4] [2]     [3]

这将：

1. 添加anyInt()到堆栈。
2. 添加gt(10)到堆栈。
3. 添加lt(20)到堆栈。
4. 删除gt(10)和lt(20)添加and(gt(10), lt(20))。
5. 呼叫foo.quux(0, 0)（除非另有说明），它将返回默认值false。内部Mockito标记quux(int, int)为最近通话。
6. Call when(false)，它放弃其参数并准备对quux(int, int)5中标识的方法进行存根。只有两个有效状态是堆栈长度为0（等于）或2（匹配器），并且堆栈上有两个匹配器（步骤1和4），因此Mockito将方法的any()第一个参数和and(gt(10), lt(20))第二个参数与匹配器进行存根，并清除堆栈。

这演示了一些规则：

• 可以的Mockito不能告诉之间的区别quux(anyInt(), 0)和quux(0, anyInt())。它们看起来都像是quux(0, 0)在堆栈上调用一个int匹配器。因此，如果使用一个匹配器，则必须匹配所有参数。

• 呼叫顺序不仅很重要，而且还可以使所有工作正常进行。将匹配器提取到变量通常不起作用，因为它通常会更改调用顺序。但是，将匹配器提取为方法非常有用。

int between10And20 = and(gt(10), lt(20));
/* BAD */ when(foo.quux(anyInt(), between10And20)).thenReturn(true);
// Mockito sees the stack as the opposite: and(gt(10), lt(20)), anyInt().

public static int anyIntBetween10And20() { return and(gt(10), lt(20)); }
/* OK */  when(foo.quux(anyInt(), anyIntBetween10And20())).thenReturn(true);
// The helper method calls the matcher methods in the right order.

• 堆栈经常变化，以至于Mockito不能非常谨慎地管理它。当你与Mockito或模拟游戏进行交互时，它只能检查堆栈，并且必须接受匹配器而不知道它们是立即使用还是被意外丢弃。从理论上讲，在调用when或之外，堆栈应始终为空verify，但Mockito不能自动检查。你可以使用手动检查Mockito.validateMockitoUsage()。

• 在对的调用中when，Mockito实际上会调用有问题的方法，如果你对方法进行了更改以引发异常（或要求非零或非空值），则该方法将引发异常。 doReturn和doAnswer（etc）不会调用实际方法，通常是一个有用的选择。

• 如果你在存根过程中调用了模拟方法（例如，为eq匹配器计算答案），则Mockito会根据该调用检查堆栈长度，并且可能会失败。

• 如果你尝试做一些不好的事情，例如对最终方法进行存根/验证，则Mockito将调用real方法，并在堆栈上保留额外的匹配器。该final方法调用可能不会抛出异常，但你可能会得到一个InvalidUseOfMatchersException从流浪的匹配，当你下一次交互使用模拟。

常见问题

InvalidUseOfMatchersException：

• 如果你完全使用匹配器，并且没有在whenor verify调用之外使用匹配器，请检查每个参数是否恰好有一个匹配器调用。绝不能将匹配器用作存根返回值或字段/变量。

• 检查是否没有在提供匹配器参数的过程中调用模拟程序。

• 检查你是否没有尝试使用匹配器对最终方法进行存根/验证。这是将匹配器保留在堆栈中的一种好方法，除非你的final方法抛出异常，否则这可能是你唯一一次意识到所模拟的方法是final方法。

• 具有原始参数的NullPointerException： (Integer) any()在any(Integer.class)返回0时返回null ；在返回0时返回null 。NullPointerException如果你期望int使用Integer而不是Integer，则会导致此错误。在任何情况下，preferred anyInt()都将返回零，并跳过自动装箱步骤。

• NullPointerException或其他异常：对的调用when(foo.bar(any())).thenReturn(baz)实际上会调用 foo.bar(null)，你可能已经被桩打败，以在收到null参数时引发异常。切换为doReturn(baz).when(foo).bar(any())跳过存根行为。

常规故障排除

• 使用MockitoJUnitRunner，或显式调用validateMockitoUsage你的tearDown或@After方法（运行程序将自动为你执行此操作）。这将有助于确定你是否滥用了匹配器。

• 为了进行调试，validateMockitoUsage请直接在代码中添加对的调用。如果堆栈中有任何东西，则会抛出该错误，这是对不良症状的一个很好的警告。