Mockito初探——快速入门

Mockito是基于CGLIB代理，实现打桩。它通过拦截对象的所有操作方法，对于满足打桩条件的调用，返回预设的返回值。

主要注解

@InjectMocks

用于标记对象属性允许用mock或spy注入。尝试通过按「先构造函数注入再setter注入最后属性（字段）注入」的顺序注入依赖。

• 构造函数注入：选取最大的构造函数，用已声明的mock作为参数注入；注：如果已经通过构造注入，将不再尝试其他策略注入（即不会再有如下两种的注入）；

• setter注入：先通过类型匹配，如果匹配的类型有多个mock实例，再通过名字匹配；

• 字段注入：同setter注入（不同的是字段可以不提供setter方法），先类型再名字；

@Mock

用于标记一个Mock字段，被标记的对象将被创建为mock对象（对于没有打桩的方法，返回值为默认值0或null或false）；

• 允许多次代理mock对象的同一个方法，但具体的行为取决于该方法最近的一次代理行为
• mock对象的代理方法，允许多次调用，只要不覆盖它的代理行为，那么每次调用的执行相同的行为或者返回相同的值
• 相同的方法和参数唯一确认一个代理。比如你可以分别代理get(int)方法在参数分别为0和1时的不同行为

@MockBean

可以在Spring ApplicationContext容器内Mock Bean。做了@MockBean标注的Mock对象会通过类型或名字（若注解中指定名字）注入到Spring容器中。容器中定义的任何类型的单例的bean将会被mock替代（若容器中不存在，则会新建）。

@Spy

与@Mock不同的是，@Spy标注的mock对象是基于真实的实例创建，对mock对象的方法调用同时也会调用真实对象的方法；

@Test
public void whenSpyingOnList_thenCorrect() {
    List list = new ArrayList();
    List spyList = Mockito.spy(list);
 
    spyList.add("one");
    spyList.add("two");
 
    Mockito.verify(spyList).add("one");
    Mockito.verify(spyList).add("two");
 
    assertEquals(2, spyList.size());
}

可以像使用mock对象时的语法一样，配置或者说重新改写spy对象的方法，下面的例子使用了doReturn()来重写了size()方法：

@Test
public void whenStubASpy_thenStubbed() {
    List list = new ArrayList();
    List spyList = Mockito.spy(list);
 
    assertEquals(0, spyList.size());
 
    Mockito.doReturn(100).when(spyList).size();
    assertEquals(100, spyList.size());
}

注：

• 在监控对象上使用when(Object)来进行打桩有时候是不可能或者不切实际的。

  在使用spy的时候，推荐用 doReturn|Answer|Throw() 等一系列的方法来打桩。

  List list = new LinkedList();
  List spy = spy(list);
  
  // 不可能：
  // 因为当调用spy.get(0)时会调用真实对象的get(0)函数，
  // 此时会发生IndexOutOfBoundsException，因为真实list对象是空的。
  when(spy.get(0)).thenReturn("foo");
  
  // 你需要使用 doReturn来进行打桩。
  doReturn("foo").when(spy).get(0);
  

• 另外注意, Mockito并不会为真实对象代理函数调用，实际上它会复制真实对象。

  所以，如果你保留了真实对象并与其交互，不要期望从监控对象得到正确的结果。
  当你在监控对象上调用一个没有被打桩的函数时，并不会调用真实对象的对应函数，因此你不会在真实对象上看到任何结果。

• Mock vs. Spy

  当Mockito创造一个mock对象时，它是从类的类型中创建，而不是从类的实例中创建。也就是说mock对象是一个简单的只带有骨架的空壳的对象实例，同时我们可以跟踪它的所有交互方法。不同的是，spy对象是对一个对象实例进行的封装，它仍然能够像正常对象实例一样有这正常的行为，唯一不同的是这些行为交互是可以跟踪和配置的。

  @Test
  public void whenCreateMock_thenCreated() {
      List mockedList = Mockito.mock(ArrayList.class);
   
      mockedList.add("one");
      Mockito.verify(mockedList).add("one");
   
      assertEquals(0, mockedList.size());
  }
  
  @Test
  public void whenCreateSpy_thenCreate() {
      List spyList = Mockito.spy(new ArrayList());
   
      spyList.add("one");
      Mockito.verify(spyList).add("one");
   
      assertEquals(1, spyList.size());
  }
  

用法指南

• 基本用法

  Mockito.when(list.size()).thenReturn(1);
  

  上述代码表示，当对list对象调用size()方法时，会返回1.这样我们就可以自定义mock对象的行为了。

• 迭代风格的返回值设定

  // 第一种方式 
  when(i.next()).thenReturn("Hello").thenReturn("World");
  
  // 第二种方式
  when(i.next()).thenReturn("Hello", "World");
  
  // 第三种方式 
  when(i.next()).thenReturn("Hello");
  when(i.next()).thenReturn("World");
  

• 没有返回值的打桩

  Mockito.doNothing().when(obj).notify();
  // 或直接
  when(obj).notify();
  

• 对被测试的方法强行抛出异常

  when(i.next()).thenThrow(new RuntimeException());
  
  // void 方法的
  doThrow(new RuntimeException()).when(i).remove(); 
  

• 模拟传入的参数 (Mockito.anyInt())

  when(mockedList.get(anyInt())).thenReturn("element");   
  System.out.println(mockedList.get(999));
  // 此时打印是 element   
  

  anyString() 匹配任何 String 参数，
  anyInt() 匹配任何 int 参数，
  anySet() 匹配任何 Set，
  any() 则意味着参数为任意值
  再进一步，自定义类型也可以，如 any(User.class)
  自定义参数匹配器 可以实现 ArgumentMatcher 接口,
  然后 when(mock.addAll(argThat(new YourImplClass()))).thenReturn(true)

• 获取返回的结果: 实现 Answer接口

  final Map hash = new HashMap();
  Answer answer = new Answer() {  
     public String answer(InvocationOnMock invocation) {  
         Object[] args = invocation.getArguments();  
         return hash.get(args[0].toString()).toString();  
     } 
  };
  when(request.getAttribute("errMsg")).thenAnswer(answer); 
  

  利用 InvocationOnMock 提供的方法可以获取 mock 方法的调用信息。下面是它提供的方法：

• getArguments() 调用后会以 Object 数组的方式返回 mock 方法调用的参数。

• getMethod() 返回 java.lang.reflect.Method 对象

• getMock() 返回 mock 对象

• callRealMethod() 真实方法调用，如果 mock 的是接口它将会抛出异常

  void 方法可以获取参数，只是写法上有区别，

  Answer answer = new Answer