【Java 单元测试进阶--无返回值的void方法如何进行单元测试】

Mockito when(…).thenReturn(…)和doReturn(…).when(…)和doAnswer()…when()的区别

• when(…) thenReturn(…)会调用真实的方法，如果你不想调用真实的方法而是想要mock的话，就不要使用这个方法。
• doReturn(…) when(…) 不会调用真实方法。
• doAnswer…when：当模拟对象调用它的方法，需要执行一些操作(其实就是需要执行一个代码块)才能得到返回值时，则需要使用doAnswer来构造产生这个模拟的返回值。例如：当模拟对象调用某个方法的**返回值是个复合值(bean)**时，就需要用doAnswer来构造该返回值。

被测试类：

public class Myclass {
    public String methodToBeTested(){
        return function();
    }

    public String function(){
        throw  new NullPointerException();
    }
}

单元测试：

@RunWith(MockitoJUnitRunner.class)
public class MyclassTest {
    @Spy
    private Myclass myclass;

    @Test
    public void test(){
       // when(myclass.methodToBeTested()).thenReturn("when(...)thenReturn(...)");
        doReturn("doReturn(...)when(...)").when(myclass).methodToBeTested();

        String str = myclass.methodToBeTested();
        System.out.println(str);
    }
}

测试结果：

1. 使用when(…).thenReturn(…),抛出了异常。
2. doReturn(…).when(…)，测试通过

doAnswer示例：

@Mock
private StockDao stockDao;
...

@Before
public void init() {
	doAnswer(new Answer<StockModel>) {
	    @Override
	    public StockModel answer(InvocationOnMock invocation) throws Throwable {
	        StockModel  stock = new StockModel ();
	        stock.setFundFamilyName("fundFamily01");
	        return stock;
	    }
	}).when(stockDao).lookup("testStock");
}

测试结果：

代码为stockDao这个模拟对象指定当它调用lookup()这个方法(参数为 “testStock” )时, 将得到一个fundFamilyName为指定值的StockModel对象作为返回值。

文章引用：

1. https://cloud.tencent.com/developer/article/1650835
2. https://www.cnblogs.com/lanqi/p/7865163.html

校验方法是否调用 verify()

验证是校验待验证的对象是否发生过某些行为，Mockito 中验证的方法是：verify。

verify(mock).someMethod("some arg");
verify(mock, times(1)).someMethod("some arg");

verify 配合 time() 方法，可以校验某些操作发生的次数。

@Test
void check() {
    Random random = Mockito.mock(Random.class, "test");
    System.out.println(random.nextInt());
    Mockito.verify(random,Mockito.times(2)).nextInt();
}

verify 配合 never() 方法，可以校验某些操作没有发生。
示例：验证getPerson从未被调用，而实际上执行update时调用了一次，则会报错。

@Test
    public void update() throws Exception {
        boolean result = personService.update(1, "new name");
        //验证mockDao的getPeron从未被调用
        verify(mockDao,never()).getPerson(1);
}
//测试不通过

Mockito 如何 mock 返回值为 void 的方法

最初接触 Mockito 还思考并尝试过如何用它来 mock 返回值为 void 的方法，然而 Google 查找到的一般都会说用 doThrow() 的办法

doThrow(new RuntimeException()).when(mockObject).methodWithVoidReturn();

因为无法使用常规的 when(mockObject.foo()).thenReturn(…) 的方法。

当时我就纳闷，为何我想 mock 一个返回值为 void 的方法，却是在模拟抛出一个异常，现在想来如果一个返回值为 void 的方法，为何要去 mock 这个方法呢？

回想一个我们要 mock 一个方法的意图是什么：

• 在特定输入参数的情况下期待需要的输出结果(返回值)
• 在方法抛出某种类型异常调用者作出的反应

对于 void 返回值的方法，如果要验证有没有被调用过几次可以在事后用 verify() 方法去断言。所以基本上对于 void 返回值的方法一般可不用去 mock 它，只需用 verify() 去验证，或者就是像前面一样模拟出现异常时的情况。

所以本文并不像是去直接回答标题所示的问题: Mockito 如何 mock 返回值为 void 的方法，而是如何应对 mock 对象的 void 方法

1. 不用对 void 方法打桩, 事后 verify
2. 模拟 void 方法抛出异常时调用者的响应
3. 部分 mock 时 void 方法可 doNothing

部分 mock 时 void 方法可 doNothing

除了 @Mock 或 Mockito.mock(Class) 来创建 mock 对象，还可以使用 spy(realObject) 或 spy(Class) 来获得 mock 对象，这两种方式得到的 mock 对象是不同的。前者所有的方法都被 mock, 后者(spy) 未打桩的方法会调用被 spy 对象的实际实现。

@Test
public void partialMockSpiedObject() {
  List<String> names = new ArrayList<>();
  List<String> spy = spy(names);
 
  doNothing().when(spy).add(anyInt(), anyString());
 
  spy.add("Yanbin");
  spy.add(0, "Unmi");
 
  assertEquals(1, spy.size());
  assertEquals("Yanbin", spy.get(0));
  assertEquals(0, names.size());
}

上面的测试可成功通过，我们用 doNothing().when(spy).add(anyInt(), anyString()) 让带下标的方式添加元素什么也不做，而未被打桩的方法会调用 names 的实际实现。因此我们可以看到上面的断言结果。

doNothing() 还真不是 doNothing(), 在搭配 spy 作部分 mock 时还是很有用的，如下面的测试：

public class Handler {
    private UserDao userDao;
    
    void initialize() {
        userDao = new UserDao();
    }
  
    public void handle(Event event) {
        if(event != null) {
           initialize();
        }
        ......
    }
}
 
//test code
@Test
public void testHandleEvent() {
    Handler handler = spy(new Handler()); //spy 会是部分 mock, 只有 stub 了方法才会被 mock, 其余调用实际方法
    
    //放心的用反射去修改 userDao 的值，因为不会被 initialize() 方法覆盖
    UserDao mockedUserDao = Mockito.mock(UserDao);
    setFieldValueOfUserDaoInReflection(handler, mockedUserDao);
 
    doNothing().when(handler).initialize(); //因为它 doNothing, 保证了 handler 仍然持有 mockedUserDao
 
    when(mockedUserDao.findUsers()).thenReturn(users);
  
    ......
}

另外如果还有其他情况可考虑 doCallRealMethod() 或 doAnser()

doCallRealMethod().when(mockObject).voidMethod();
doAnswer(answer).when(mockObject).voidMethod();

一般不用对 void 方法打桩, 事后 verify 就行

测试代码针对 mock 对象的 void 方法调用本来就没有什么效果，所以一般也无须用 doNothing(), 况且 void 提供不了返回值作进一步 mock，只需要在事后用 verify() 进行验证一下。

例如有下面的代码

类 UserDao：

public interface UserDao {
  void save(User user);
}

类 UserService：

public class UserService {
  private UserDao userDao;
 
  public UserService(UserDao userDao) {
    this.userDao = userDao;
  }
 
  public void saveUser(User user) {
    userDao.save(user);
  }
}

要写一个针对 UserService.saveUser(User user) 的测试方法：

@Test
public void shouldCallUserDaoSaveMethod() {
  UserDao userDao = Mockito.mock(UserDao.class);
  UserService userService = new UserService(userDao);
  
  User user = new User(1, "Yanbin");
  userService.saveUser(user);
 
  verify(userDao, times(1)).save(user);
}

模拟 void 方法抛出异常时调用者的响应 doThrow()

这就是为什么 Google 上那么多答案告诉我们要用到 doThrow() 的原因，假如我们的 UserService.saveUser(User user) 方法在userDao报出 DataAccessException 时转换为 ApplicationException 异常, 它的代码实现如下：

//UserService 的 saveUser(User user) 方法修改如下
 
public void saveUser(User user) {
  try (
    userDao.save(user);
  catch(DataAccessException dae) {
    throw new ApplicationException(dae, "can't save user due to issue reported from database");
  }
}

要测试上面那个异常处理过程，我们可以写下面的测试：

@Test(expected = ApplicationException.class)
public void raiseApplicationExceptionIfDataAccessExceptionOccursFromUserDao() {
  UserDao userDao = Mockito.mock(UserDao.class);
  UserService userService = new UserService(userDao);
  User user = new User(1, "Yanbin");
 
  doThrow(new DataAccessException()).when(userDao).save(user);
 
  userService.saveUser(user);
}

上面的 doThrow() 行写成下面的方式也是一样的,Mockito 在调用 mock 对象的 void 方法时本来默认就是 doNothing。
doNothing().doThrow(new DataAccessException()).when(userDao).save(user);

文章引用：https://www.cnblogs.com/ceshi2016/p/7880739.html