Mockito 1-9节
内容翻译自 Mockito Javadoc首页 的1-9节。
1. 让我们验证某些行为
//静态导入mockito，这样代码看上去干净一些
import static org.mockito.Mockito.*;
//创建mock
List mockedList = mock(List.class);
//使用 mock 对象
mockedList.add("one");
mockedList.clear();
//验证
verify(mockedList).add("one");
verify(mockedList).clear();
Once created, a mock will remember all interactions. Then you can selectively verify whatever interactions you are interested in.
一旦创建，mock对象会记住所有的交互。然后你可以有选择性的验证你感兴趣的任何交互。
注：这里和easymock的默认行为(strick mock)不同
2. 再来一点stubbing?
//可以mock具体的类，而不仅仅是接口
LinkedList mockedList = mock(LinkedList.class);
//存根(stubbing)
when(mockedList.get(0)).thenReturn("first");
when(mockedList.get(1)).thenThrow(new RuntimeException());
//下面会打印 "first"
System.out.println(mockedList.get(0));
//下面会抛出运行时异常
System.out.println(mockedList.get(1));
//下面会打印"null" 因为get(999)没有存根(stub)
System.out.println(mockedList.get(999));
// 虽然可以验证一个存根的调用，但通常这是多余的
// 如果你的代码关心get(0)返回什么，那么有某些东西会出问题(通常在verify()被调用之前)
// 如果你的代码不关系get(0)返回什么，那么它不需要存根。如果不确信，那么还是验证吧
verify(mockedList).get(0);
- 默认情况， 对于返回一个值的所有方法， mock对象在适当的时候要不返回null，基本类型/基本类型包装类，或者一个空集合。比如int/Integer返回0, boolean/Boolean返回false。
- 存根(stub)可以覆盖： 例如通用存根可以固定搭建但是测试方法可以覆盖它。请注意覆盖存根是潜在的代码异味(code smell)，说明存根太多了
- 一旦做了存根，方法将总是返回存根的值，无论这个方法被调用多少次
- 最后一个存根总是更重要 - 当你用同样的参数对同一个方法做了多次存根时。换句话说：存根顺序相关，但是它只在极少情况下有意义。例如，当需要存根精确的方法调用次数，或者使用参数匹配器等。
3. 参数匹配器
mockito使用java原生风格来验证参数的值： 使用equals()方法。有些时候，如果需要额外的灵活性，应该使用参数匹配器：
//使用内建anyInt()参数匹配器
when(mockedList.get(anyInt())).thenReturn("element");
//使用自定义匹配器(这里的isValid()返回自己的匹配器实现)
when(mockedList.contains(argThat(isValid()))).thenReturn("element");
//下面会打印 "element"
System.out.println(mockedList.get(999));
//同样可以用参数匹配器做验证
verify(mockedList).get(anyInt());
参数匹配器容许灵活验证或存根。点击 这里 查看更多内建的pipil和自定义参数匹配器/hamcrest 匹配器的例子。
更多的关于自定义参数匹配器的单独的信息，请见类 ArgumentMatcher 的javadoc。
请合理使用复杂的按数匹配器。使用带有少量anyX()的equals()的原生匹配风格易于提供整洁而简单的测试。有时更应该重构代码以便容许equals()匹配，甚至实现equals()方法来帮助测试。
另外，请阅读 第15章 或者 类ArgumentCaptor的javadoc。ArgumentCaptor 是一个特殊的参数匹配器实现，为后面的断言捕获参数的值。
参数匹配警告：
如果使用参数匹配器，所有的参数都不得不通过匹配器提供。
下面的例子：
verify(mock).someMethod(anyInt(), anyString(), eq("third argument"));
//上面是正确的 - eq(0也是参数匹配器)
verify(mock).someMethod(anyInt(), anyString(), "third argument");
//上面不正确 - 会抛出异常因为第三个参数不是参数匹配器提供的
类似anyObject(), eq() 的匹配器方法 不 返回匹配器。实际上，他们在栈上记录一个匹配器并返回一个虚假值(dummy，通常是null)。这个实现为了java编译器的静态类型安全。推论是不能在verified/stubbed 方法外使用anyObject(), eq()方法。
4. 验证精确调用次数/至少X次/从不
//使用mock
mockedList.add("once");
mockedList.add("twice");
mockedList.add("twice");
mockedList.add("three times");
mockedList.add("three times");
mockedList.add("three times");
//下面两个验证是等同的 - 默认使用times(1)
verify(mockedList).add("once");
verify(mockedList, times(1)).add("once");
//验证精确调用次数
verify(mockedList, times(2)).add("twice");
verify(mockedList, times(3)).add("three times");
//使用using never()来验证. never()相当于 times(0)
verify(mockedList, never()).add("never happened");
//使用 atLeast()/atMost()来验证
verify(mockedList, atLeastOnce()).add("three times");
verify(mockedList, atLeast(2)).add("five times");
verify(mockedList, atMost(5)).add("three times");
默认times(1)。因此可以不用写times(1)。
5. 使用exception做void方法的存根
doThrow(new RuntimeException()).when(mockedList).clear();
//下面会抛出 RuntimeException:
mockedList.clear();
在段落12 中查看更多关于 doThrow|doAnswer 方法家族的信息。
最初， stubVoid(Object) 方法被用于存根void方法。目前stubVoid(Object)被废弃，被doThrow(Throwable...)取代。这是为了提高doAnswer(Answer) 方法家族的可读性和一致性。
6. 验证顺序
// A. 单个Mock，方法必须以特定顺序调用
List singleMock = mock(List.class);
//使用单个Mock
singleMock.add("was added first");
singleMock.add("was added second");
//为singleMock创建 inOrder 检验器
InOrder inOrder = inOrder(singleMock);
//下面将确保add方法第一次调用是用"was added first",然后是用"was added second"
inOrder.verify(singleMock).add("was added first");
inOrder.verify(singleMock).add("was added second");
// B. 多个Mock必须以特定顺序调用
List firstMock = mock(List.class);
List secondMock = mock(List.class);
//使用mock
firstMock.add("was called first");
secondMock.add("was called second");
//创建 inOrder 对象，传递任意多个需要验证顺序的mock
InOrder inOrder = inOrder(firstMock, secondMock);
//下面将确保firstMock在secondMock之前调用
inOrder.verify(firstMock).add("was called first");
inOrder.verify(secondMock).add("was called second");
// Oh, 另外 A + B 可以任意混合
顺序验证是灵活的 - 不需要逐个验证所有交互 ，只需要验证那些你感兴趣的需要在测试中保持顺序的交互。
7. 确保交互从未在mock对象上发生
//使用mock - 仅有mockOne有交互
mockOne.add("one");
//普通验证
verify(mockOne).add("one");
//验证方法从未在mock对象上调用
verify(mockOne, never()).add("two");
//验证其他mock没有交互
verifyZeroInteractions(mockTwo, mockThree);
8. 发现冗余调用
//使用mock
mockedList.add("one");
mockedList.add("two");
verify(mockedList).add("one");
//下面的验证将会失败
verifyNoMoreInteractions(mockedList);
警告：默写做过很多经典的 expect-run-verify mock的用户倾向于非常频繁的使用verifyNoMoreInteractions()，甚至在每个测试方法中。不推荐在每个测试中都使用verifyNoMoreInteractions()。verifyNoMoreInteractions()是交互测试工具集中的便利断言。仅仅在真的有必要时使用。滥用它会导致定义过度缺乏可维护性的测试。可以在这里找到更多阅读内容。
可以看 never() - 这个更直白并且将意图交代的更好。
9. 创建mock的捷径 - @mock注解
- 最大限度的减少罗嗦的创建mock对象的代码
- 让测试类更加可读
- 让验证错误更加可读因为 field name 被用于标志mock对象
public class ArticleManagerTest {
@Mock private ArticleCalculator calculator;
@Mock private ArticleDatabase database;
@Mock private UserProvider userProvider;
private ArticleManager manager;
重要的是： 需要在基类或者test runner中的加入：
MockitoAnnotations.initMocks(testClass);
可以使用内建的runner: MockitoJUnitRunner 或者 rule: MockitoRule.
更多内容请看这里: MockitoAnnotations