單元測試系列：Mock工具之Mockito實戰

本文轉載自查看原文 2018-12-03 15:13 679 單元測試

原文鏈接：http://www.cnblogs.com/zishi/p/6780719.html

在實際項目中寫單元測試的過程中我們會發現需要測試的類有很多依賴，這些依賴項又會有依賴，導致在單元測試代碼里幾乎無法完成構建，尤其是當依賴項尚未構建完成時會導致單元測試無法進行。為了解決這類問題我們引入了Mock的概念，簡單的說就是模擬這些需要構建的類或者資源，提供給需要測試的對象使用。業內的Mock工具有很多，也已經很成熟了，這里我們將直接使用最流行的Mockito進行實戰演練，完成mockito教程。

Mock工具概述

1.1 Mockito簡介

EasyMock 以及 Mockito 都因為可以極大地簡化單元測試的書寫過程而被許多人應用在自己的工作中，但是這兩種 Mock 工具都不可以實現對靜態函數、構造函數、私有函數、Final 函數以及系統函數的模擬，但是這些方法往往是我們在大型系統中需要的功能。

另外，關於更多Mockito2.0新特性，參考官方介紹文檔，里邊有關於為什么不mock private的原因，挺有意思的：

https://github.com/mockito/mockito/wiki/What%27s-new-in-Mockito-2

1.2 Mockito准備工作

###Maven###

通過Maven管理的，需要在項目的Pom.xml中增加如下的依賴：

 <dependencies>

<dependency>

<groupId>org.mockito</groupId>

<artifactId>mockito-core</artifactId>

<version>2.7.19</version>

<scope>test</scope>

</dependency>

</dependencies>

在程序中可以import org.mockito.Mockito，然后調用它的static方法。

Maven用戶可以聲明對mockito-core的依賴。 Mockito自動發布到Bintray的中心，並同步到Maven Central Repository。

特別提醒：使用手工依賴關系管理的Legacy構建可以使用1. *“mockito-all”分發。它可以從Mockito的Bintray存儲庫或Bintray的中心下載。在但是Mockito 2. * “mockito-all”發行已經停止，Mockito 2以上版本使用“mockito-core”。

官網下載中心：

http://search.maven.org/#search|gav|1|g%3A%22org.mockito%22%20AND%20a%3A%22mockito-core%22

目前最新版本為2.7.19，由於公司網絡網關問題，最好是去官網手工下載。

另外Mockito需要Junit配合使用，在Pom文件中同樣引入：

<dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.12</version>
        <scope>test</scope>
      </dependency>

然后為了使代碼更簡潔，最好在測試類中導入靜態資源，還有為了使用常用的junit關鍵字，也要引入junit的兩個類Before和Test：

import static org.mockito.Mockito.*;
import static org.junit.Assert.*;
import org.junit.Before;
import org.junit.Test;

1.3 模擬對象

創建 Mock 對象的語法為 mock(class or interface)。

Mock 對象的創建

mock(Class classToMock);
 mock(Class classToMock, String name)
 mock(Class classToMock, Answer defaultAnswer)
 mock(Class classToMock, MockSettings mockSettings)
 mock(Class classToMock, ReturnValues returnValues)

可以對類和接口進行mock對象的創建，創建時可以為mock對象命名。對mock對象命名的好處是調試的時候容易辨認mock對象。

Mock對象的期望行為和返回值設定

假設我們創建了LinkedList類的mock對象：

LinkedList mockedList = mock(LinkedList.class);

1.4 設置對象調用的預期返回值

通過 when(mock.someMethod()).thenReturn(value) 來設定 Mock 對象某個方法調用時的返回值。我們可以看看源碼中關於thenReturn方法的注釋：

使用when(mock.someMethod()).thenThrow(new RuntimeException) 的方式來設定當調用某個方法時拋出的異常。

以及Answer：

Answer 是個泛型接口。到調用發生時將執行這個回調，通過 Object[] args = invocation.getArguments();可以拿到調用時傳入的參數，通過 Object mock = invocation.getMock();可以拿到mock對象。

有些方法可能接口的參數為一個Listener參數，如果我們使用Answer打樁，我們就可以獲取這個Listener,並且在Answer函數中執行對應的回調函數，這對我們了解函數的內部執行過成有很大的幫助。

使用doThrow(new RuntimeException(“clear exception”)).when(mockedList).clear();mockedList.clear();的方式Mock沒有返回值類型的函數：

doThrow(new RuntimeException()).when(mockedList).clear();

//將會拋出 RuntimeException:

mockedList.clear();

這個實例表示當執行到mockedList.clear()時，將會拋出RuntimeException。其他的doXXX執行與它類似。

例如： doReturn()|doThrow()| doAnswer()|doNothing()|doCallRealMethod() 系列方法。

Spy函數：

你可以為真實對象創建一個監控（spy）對象，當你使用這個spy對象時，真實的對象也會被調用，除非它的函數被打樁。你應該盡量少的使用spy對象，使用時也需要小心，例如spy對象可以用來處理遺留代碼，Spy示例如下：

List list = new LinkedList();

//監控一個真實對象

List spy = spy(list);

//你可以為某些函數打樁

when(spy.size()).thenReturn(100);

//使用這個將調用真實對象的函數

spy.add("one");

spy.add("two");

//打印"one"

System.out.println(spy.get(0));

//size() 將打印100

System.out.println(spy.size());

//交互驗證

verify(spy).add("one"); 
verify(spy).add("two");

理解監控真實對象非常重要，有時，在監控對象上使用when(Object)來進行打樁是不可能或者不切實際的。因為，當使用監控對象時，請考慮用doReturn、Answer、Throw()函數組來進行打樁，例如：

List list = new LinkedList();

List spy = spy(list);

//這是不可能的：因為調用spy.get(0)時會調用真實對象的get(0)函數，此時會發生

//IndexOutOfBoundsException異常，因為真實對象是空的 when(spy.get(0)).thenReturn("foo");

//你需要使用 doReturn() 來打樁

doReturn("foo").when(spy).get(0);

Mockito並不會為真實的對象代理函數調用，實際上它會復制真實對象，因此，如果你保留了真實對象並且與之交互，不要期望監控對象得到正確的結果。當你在監控對象上調用一個沒有stub函數時，並不會調用真實對象的對應函數，你不會在真實對象上看到任何效果。

1.5 驗證被測試類方法

Mock 對象一旦建立便會自動記錄自己的交互行為，所以我們可以有選擇的對它的交互行為進行驗證。在 Mockito 中驗證 Mock 對象交互行為的方法是 verify(mock).someMethod(…)。最后 Assert() 驗證返回值是否和預期一樣。

1.6 Demo

從網上找來一個最簡單的代碼實例，下面以具體代碼演示如何使用Mockito，代碼有三個類，分別如下：

Person類：

public class Person {
    private final int id; 
    private final String name; 
    public Person(int id, String name) { 
        this.id = id; 
        this.name = name; 
        } 
    public int getId() { 
        return id; 
        } 
    public String getName() { 
        return name; 
        }
}

PersonDao類：

public interface PersonDao {
    Person getPerson(int id); 
    boolean update(Person person); 
    }

PersonService類：

public class PersonService {
    private final PersonDao personDao; 
    public PersonService(PersonDao personDao) { 
        this.personDao = personDao; 
        } 
    public boolean update(int id, String name) { 
        Person person = personDao.getPerson(id); 
        if (person == null) 
        { return false; } 
        Person personUpdate = new Person(person.getId(), name); 
        return personDao.update(personUpdate); 
        }
}

仍然使用Junit自動生成測試類或者手工新建測試類：

測試代碼生成后，將默認assertfail的刪掉，輸入以下兩個測試方法：

import org.junit.Before;
import org.junit.Test;
import static org.junit.Assert.*;
import static org.mockito.Mockito.*;


public class PersonServiceTest {

    private PersonDao     mockDao;
    private PersonService personService;

    @Before
    public void setUp() throws Exception {
        //模擬PersonDao對象
        mockDao = mock(PersonDao.class);
        when(mockDao.getPerson(1)).thenReturn(new Person(1, "Person1"));
        when(mockDao.update(isA(Person.class))).thenReturn(true);

        personService = new PersonService(mockDao);
    }

    @Test
    public void testUpdate() throws Exception {
        boolean result = personService.update(1, "new name");
        assertTrue("must true", result);
        //驗證是否執行過一次getPerson(1)
        verify(mockDao, times(1)).getPerson(eq(1));
        //驗證是否執行過一次update
        verify(mockDao, times(1)).update(isA(Person.class));
    }

    @Test
    public void testUpdateNotFind() throws Exception {
        boolean result = personService.update(2, "new name");
        assertFalse("must true", result);
        //驗證是否執行過一次getPerson(1)
        verify(mockDao, times(1)).getPerson(eq(1));
        //驗證是否執行過一次update
        verify(mockDao, never()).update(isA(Person.class));
    }
}

注意：我們對PersonDAO進行mock，並且設置stubbing，stubbing設置如下：