Android單元測(cè)試之Mockito

背景

在寫單元測(cè)試的過程中雕憔，一個(gè)很普遍的問題是，要測(cè)試的目標(biāo)類會(huì)有很多依賴，這些依賴的類/對(duì)象/資源又會(huì)有別的依賴结借，從而形成一個(gè)大的依賴樹，要在單元測(cè)試的環(huán)境中完整地構(gòu)建這樣的依賴卒茬，是一件很困難的事情船老。

Mock就是解決的方案咖熟。簡(jiǎn)單地說就是對(duì)測(cè)試的類所依賴的其他類和對(duì)象，進(jìn)行mock －構(gòu)建它們的一個(gè)假的對(duì)象柳畔，定義這些假對(duì)象上的行為馍管，然后提供給被測(cè)試對(duì)象使用。被測(cè)試對(duì)象像使用真的對(duì)象一樣使用它們薪韩。用這種方式确沸，我們可以把測(cè)試的目標(biāo)限定于被測(cè)試對(duì)象本身，就如同在被測(cè)試對(duì)象周圍做了一個(gè)劃斷俘陷，形成了一個(gè)盡量小的被測(cè)試目標(biāo)罗捎。

Mockito是什么

Mockito是一套非常強(qiáng)大的測(cè)試框架，被廣泛的應(yīng)用于Java程序的unit test中拉盾。相比于EasyMock框架桨菜，Mockito使用起來簡(jiǎn)單，學(xué)習(xí)成本很低捉偏，而且具有非常簡(jiǎn)潔的API倒得，測(cè)試代碼的可讀性很高。

Mockito使用

配置依賴：

testCompile "org.mockito:mockito-core:1.10.19"

先來看看Mockito的基礎(chǔ)使用告私。比如我們有以下幾個(gè)類：

public class Person {
    private int id;
    private String name;

    public Person(int id,String name){
        this.id = id;
        this.name = name;
    }

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

public interface PersonDAO {
    Person getPerson(int id);

    boolean update(Person person);
}

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);
    }
}

說明：以上是開發(fā)中基礎(chǔ)的mvc分層結(jié)構(gòu)屎暇，比如在開發(fā)中，PersonDAO的具體實(shí)現(xiàn)還未完成驻粟，這時(shí)候就可以通過mock來mock一個(gè)實(shí)例來做測(cè)試根悼。

來看一下測(cè)試時(shí)怎么寫的，這里我們主要對(duì)PersonService 中的update方法寫測(cè)試用例蜀撑。

public class PersonServiceTest {

    private PersonDAO mockDao;
    private PersonService personService;

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

        personService = new PersonService(mockDao);

    }

    @Test
    public void testUpdate() throws Exception {

        boolean result = personService.update(1,"Tom");
        assertTrue("is true",result);
        //驗(yàn)證是否執(zhí)行過一次getPerson(1)
        Mockito.verify(mockDao,Mockito.times(1)).getPerson(Mockito.eq(1));
        //驗(yàn)證是否執(zhí)行過一次update
        Mockito.verify(mockDao,Mockito.times(1)).update(Mockito.isA(Person.class));
    }

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

簡(jiǎn)單說明一下：

首先在setUp中挤巡，我們先模擬一個(gè)對(duì)象出來，主要通過Mockito.mock(PersonDAO.class);來mock的酷麦。
然后添加Stubbind條件矿卑，Mockito.when(mockDao.getPerson(1)).thenReturn(new Person(1,"Jim")); 意思是當(dāng)調(diào)用mockDao.getPerson(1)時(shí)返回一個(gè)id為1，name為"Jim"的Person對(duì)象沃饶。
在testUpdate()方法中 Mockito.verify(mockDao,Mockito.times(1)).getPerson(Mockito.eq(1));驗(yàn)證是否執(zhí)行過一次getPerson(1)母廷。只要有執(zhí)行過Mockito都會(huì)記錄下拉，所以這句是對(duì)的糊肤。

Mockito基礎(chǔ)使用

Mockito的使用琴昆，有詳細(xì)的api文檔，具體可以查看：http://site.mockito.org/mockito/docs/current/org/mockito/Mockito.html馆揉，下面是整理的一些常用的使用方式业舍。

verify 驗(yàn)證

一旦創(chuàng)建，mock會(huì)記錄所有交互，你可以驗(yàn)證所有你想要驗(yàn)證的東西,即使刪掉也會(huì)有操作記錄在舷暮。

@Test
public void testVerify() throws Exception {
    //mock creation
    List mockList = Mockito.mock(List.class);

    mockList.add("one");
    mockList.add("two");
    mockList.add("two");
    mockList.clear();

    //驗(yàn)證是否調(diào)用過一次 mockedList.add("one")方法态罪，若不是（0次或者大于一次），測(cè)試將不通過,默認(rèn)是一次
    Mockito.verify(mockList).add("one");
    //驗(yàn)證調(diào)用過2次 mockedList.add("two")方法下面，若不是复颈，測(cè)試將不通過
    Mockito.verify(mockList,Mockito.times(2)).add("two");
    //驗(yàn)證是否調(diào)用過一次 mockedList.clear()方法，若沒有（0次或者大于一次）诸狭，測(cè)試將不通過
    Mockito.verify(mockList).clear();
}

這里主要注意券膀。mock會(huì)記錄你所有的操作的君纫，即使刪除也會(huì)記錄下來驯遇。比如mockList中添加完，然后clear掉蓄髓，Mockito.verify(mockList).add("one");這個(gè)的驗(yàn)證也是會(huì)通過的叉庐，驗(yàn)證的關(guān)鍵方法是verify， verify有兩個(gè)重載方法：

verify(T mock)：默認(rèn)是驗(yàn)證調(diào)用一次会喝，里面默認(rèn)調(diào)用times(1)陡叠。
verify(T mock, VerificationMode mode)：mode，調(diào)用次數(shù).

Stubbing 條件

@Test
public void testStubbing() throws Exception{
    //你可以mock具體的類肢执，而不僅僅是接口
    LinkedList mockedList = Mockito.mock(LinkedList.class);

    //設(shè)置值
    Mockito.when(mockedList.get(0)).thenReturn("one");
    Mockito.when(mockedList.get(1)).thenReturn("two");
    Mockito.when(mockedList.get(2)).thenReturn(new RuntimeException());

    //print 輸出"one"
    System.out.println(mockedList.get(0));
    //輸出 "java.lang.RuntimeException"
    System.out.println(mockedList.get(2));
    //這里會(huì)打印 "null" 因?yàn)?get(999) 沒有設(shè)置
    System.out.println(mockedList.get(999));

    Mockito.verify(mockedList).get(0);
}

對(duì)于有返回值的方法枉阵，mock會(huì)默認(rèn)返回null、空集合预茄、默認(rèn)值兴溜。比如，為int/Integer返回0耻陕，為boolean/Boolean返回false
stubbing可以被覆蓋拙徽，但是請(qǐng)注意覆蓋已有的stubbing有可能不是很好
一旦stubbing，不管調(diào)用多少次诗宣，方法都會(huì)永遠(yuǎn)返回stubbing的值
當(dāng)你對(duì)同一個(gè)方法進(jìn)行多次stubbing膘怕，最后一次stubbing是最重要的

ArgumentMatcher參數(shù)匹配

@Test
public void testArgumentMatcher() throws Exception {
    LinkedList mockedList = Mockito.mock(LinkedList.class);
    //用內(nèi)置的參數(shù)匹配器來stub
    Mockito.when(mockedList.get(Mockito.anyInt())).thenReturn("element");

    //打印 "element"
    System.out.println(mockedList.get(999));

    //你也可以用參數(shù)匹配器來驗(yàn)證，此處測(cè)試通過
    Mockito.verify(mockedList).get(Mockito.anyInt());

    //此處測(cè)試將不通過召庞，因?yàn)闆]調(diào)用get(33)
    Mockito.verify(mockedList).get(Mockito.eq(33));
}

InvocationTimes驗(yàn)證準(zhǔn)確的調(diào)用次數(shù)

驗(yàn)證準(zhǔn)確的調(diào)用次數(shù)包括最多岛心、最少、從未等篮灼，times(),never(),atLeast(),atMost().

/**
 * 驗(yàn)證準(zhǔn)確的調(diào)用次數(shù)忘古，最多、最少穿稳、從未等
 * @throws Exception
 */
@Test
public void testInvocationTimes() throws Exception {
    LinkedList mockedList = Mockito.mock(LinkedList.class);
    //using mock
    mockedList.add("once");

    mockedList.add("twice");
    mockedList.add("twice");

    mockedList.add("three times");
    mockedList.add("three times");
    mockedList.add("three times");

    //下面兩個(gè)是等價(jià)的存皂， 默認(rèn)使用times(1)
    Mockito.verify(mockedList).add("once");
    Mockito.verify(mockedList, Mockito.times(1)).add("once");

    //驗(yàn)證準(zhǔn)確的調(diào)用次數(shù)
    Mockito.verify(mockedList, Mockito.times(2)).add("twice");
    Mockito.verify(mockedList, Mockito.times(3)).add("three times");

    //從未調(diào)用過. never()是times(0)的別名
    Mockito.verify(mockedList, Mockito.never()).add("never happened");

    //用atLeast()/atMost()驗(yàn)證
    Mockito.verify(mockedList, Mockito.atLeastOnce()).add("three times");
    Mockito.verify(mockedList, Mockito.atLeast(2)).add("three times");

    //最多
    Mockito.verify(mockedList, Mockito.atMost(3)).add("three times");
}

為void方法拋異常

@Test
public void testVoidMethodsWithExceptions() throws Exception {
    LinkedList mockedList = Mockito.mock(LinkedList.class);
    Mockito.doThrow(new RuntimeException()).when(mockedList).clear();
    //這邊會(huì)拋出異常
    mockedList.clear();
}

InOrder驗(yàn)證調(diào)用順序

@Test
public void testVerificationInOrder() throws Exception {
    List singleMock = Mockito.mock(List.class);
    //使用單個(gè)mock對(duì)象
    singleMock.add("was added first");
    singleMock.add("was added second");

    //創(chuàng)建inOrder
    InOrder inOrder = Mockito.inOrder(singleMock);

    //驗(yàn)證調(diào)用次數(shù)，若是調(diào)換兩句，將會(huì)出錯(cuò)旦袋，因?yàn)閟ingleMock.add("was added first")是先調(diào)用的
    inOrder.verify(singleMock).add("was added first");
    inOrder.verify(singleMock).add("was added second");


    // 多個(gè)mock對(duì)象
    List firstMock = Mockito.mock(List.class);
    List secondMock = Mockito.mock(List.class);

    //using mocks
    firstMock.add("was called first");
    secondMock.add("was called second");

    //創(chuàng)建多個(gè)mock對(duì)象的inOrder
    inOrder = Mockito.inOrder(firstMock, secondMock);

    //驗(yàn)證firstMock先于secondMock調(diào)用
    inOrder.verify(firstMock).add("was called first");
    inOrder.verify(secondMock).add("was called second");
}

spy

spy是創(chuàng)建一個(gè)拷貝骤菠，如果你保留原始的list，并用它來進(jìn)行操作疤孕，那么spy并不能檢測(cè)到其交互

@Test
public void testSpy() throws Exception {
    List list = new LinkedList();
    List spy = Mockito.spy(list);

    //可選的商乎，你可以stub某些方法
    Mockito.when(spy.size()).thenReturn(100);

    //如果操作原始list，那么spy是不會(huì)檢測(cè)到的祭阀。
    list.add("first");

    //調(diào)用"真正"的方法
    spy.add("one");
    spy.add("two");

    //打印one
    System.out.println(spy.get(0));

    //size()方法被stub了鹉戚，打印100
    System.out.println(spy.size());

    //可選，驗(yàn)證spy對(duì)象的行為
    Mockito.verify(spy).add("one");
    Mockito.verify(spy).add("two");

    //下面寫法有問題专控，spy.get(10)會(huì)拋IndexOutOfBoundsException異常
    Mockito.when(spy.get(10)).thenReturn("foo");
    //可用以下方式
    Mockito.doReturn("foo").when(spy).get(10);
}

Captur 參數(shù)捕捉

@Test
public void testCapturingArguments() throws Exception {
    List mockedList = Mockito.mock(List.class);
    ArgumentCaptor<String> argument = ArgumentCaptor.forClass(String.class);
    mockedList.add("John");

    //進(jìn)行參數(shù)捕捉抹凳，這里參數(shù)應(yīng)該是"John"
    Mockito.verify(mockedList).add(argument.capture());

    assertEquals("John",argument.getValue());
}

Mock 的 Annotation，

Mockito跟junit4一樣也支持Annotation伦腐，Mockito支持的注解有：@Mock赢底，@Spy（監(jiān)視真實(shí)的對(duì)象），@Captor（參數(shù)捕獲器）柏蘑，@InjectMocks（mock對(duì)象自動(dòng)注入）幸冻。

Annotation的初始化

在使用Annotation注解之前，必須先初始化咳焚，一般初始化在Junit4的@Before里面洽损，初始化的方法為：MockitoAnnotations.initMocks(testClass)參數(shù)testClass是你所寫的測(cè)試類。

@Before
public void setUp() throws Exception {
    /**
     * 要想讓Annotation起作用革半，就必須初始化.一般初始化都在@Before里面
     */
    MockitoAnnotations.initMocks(this);

}

@Mock注解

使用@Mock注解來定義mock對(duì)象有如下的優(yōu)點(diǎn)：

方便mock對(duì)象的創(chuàng)建
減少mock對(duì)象創(chuàng)建的重復(fù)代碼
提高測(cè)試代碼可讀性
變量名字作為mock對(duì)象的標(biāo)示碑定，所以易于排錯(cuò)

我們還是通過第一個(gè)例子來修改：

public class MockTest {
    @Mock
    private PersonDAO mockDao;
    private PersonService personService;
    
    @Before
    public void setUp() throws Exception {
        /**
         * 要想讓Annotation起作用，就必須初始化.一般初始化都在@Before里面
         */
        MockitoAnnotations.initMocks(this);

        Mockito.when(mockDao.getPerson(1)).thenReturn(new Person(1,"Jim"));
        Mockito.when(mockDao.update(Mockito.isA(Person.class))).thenReturn(true);
        personService = new PersonService(mockDao);

    }

    @Test
    public void testUpdate() throws Exception {

        boolean result = personService.update(1,"Tom");
        assertTrue("is true",result);
        //驗(yàn)證是否執(zhí)行過一次getPerson(1)
        Mockito.verify(mockDao,Mockito.times(1)).getPerson(Mockito.eq(1));
        //驗(yàn)證是否執(zhí)行過一次update
        Mockito.verify(mockDao,Mockito.times(1)).update(Mockito.isA(Person.class));
    }
}

結(jié)果和前面沒用注解的一樣督惰。

@Spy注解

使用@Spy生成的類不傅，所有方法都是真實(shí)方法，返回值和真實(shí)方法一樣的赏胚，是使用Mockito.spy()的快捷方式.

public class MockTest {

    @Spy
    private List list = new LinkedList();
    
    @Before
    public void setUp() throws Exception {
        /**
         * 要想讓Annotation起作用访娶，就必須初始化.一般初始化都在@Before里面
         */
        MockitoAnnotations.initMocks(this);
    }
    
    @Test
    public void testSpy() throws Exception {
        //可選的，你可以stub某些方法
        Mockito.when(list.size()).thenReturn(100);


        //調(diào)用"真正"的方法
        list.add("one");
        list.add("two");

        //打印one
        System.out.println(list.get(0));

        //size()方法被stub了觉阅，打印100
        System.out.println(list.size());
    }

}

@Captor注解

@Captor是參數(shù)捕獲器的注解崖疤，通過注解的方式可以更便捷的對(duì)ArgumentCaptor進(jìn)行定義。還可以通過ArgumentCaptor對(duì)象的forClass(Class<T> clazz)方法來構(gòu)建ArgumentCaptor對(duì)象典勇，然后便可在驗(yàn)證時(shí)對(duì)方法的參數(shù)進(jìn)行捕獲劫哼，最后驗(yàn)證捕獲的參數(shù)值。如果方法有多個(gè)參數(shù)都要捕獲驗(yàn)證割笙，那就需要?jiǎng)?chuàng)建多個(gè)ArgumentCaptor對(duì)象處理权烧。

public class MockTest {

    @Captor
    private ArgumentCaptor<String>  captor;
    
    @Before
    public void setUp() throws Exception {
        /**
         * 要想讓Annotation起作用眯亦，就必須初始化.一般初始化都在@Before里面
         */
        MockitoAnnotations.initMocks(this);
    }
    
    @Test
    public void testCaptor() throws Exception {
        /**
         * ArgumentCaptor的Api
         argument.capture() 捕獲方法參數(shù)；
         argument.getValue() 獲取方法參數(shù)值般码，如果方法進(jìn)行了多次調(diào)用妻率，它將返回最后一個(gè)參數(shù)值；
         argument.getAllValues() 方法進(jìn)行多次調(diào)用后板祝，返回多個(gè)參數(shù)值宫静；

         */

        list.add("John");
        //進(jìn)行參數(shù)捕捉，這里參數(shù)應(yīng)該是"John"
        Mockito.verify(list).add(captor.capture());

        assertEquals("John",captor.getValue());

    }

}

最后編輯于：2017.12.10 05:24:59

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者

人面猴
序言：七十年代末券时，一起剝皮案震驚了整個(gè)濱河市孤里，隨后出現(xiàn)的幾起案子，更是在濱河造成了極大的恐慌橘洞，老刑警劉巖捌袜，帶你破解...
沈念sama閱讀 221,198評(píng)論 6贊 514
死咒
序言：濱河連續(xù)發(fā)生了三起死亡事件，死亡現(xiàn)場(chǎng)離奇詭異震檩，居然都是意外死亡琢蛤，警方通過查閱死者的電腦和手機(jī)，發(fā)現(xiàn)死者居然都...
沈念sama閱讀 94,334評(píng)論 3贊 398
救了他兩次的神仙讓他今天三更去死
文/潘曉璐我一進(jìn)店門抛虏，熙熙樓的掌柜王于貴愁眉苦臉地迎上來，“玉大人套才，你說我怎么就攤上這事迂猴。” “怎么了背伴？”我有些...
開封第一講書人閱讀 167,643評(píng)論 0贊 360
道士緝兇錄：失蹤的賣姜人
文/不壞的土叔我叫張陵沸毁，是天一觀的道長。經(jīng)常有香客問我傻寂，道長息尺，這世上最難降的妖魔是什么？我笑而不...
開封第一講書人閱讀 59,495評(píng)論 1贊 296
?港島之戀（遺憾婚禮）
正文為了忘掉前任疾掰，我火速辦了婚禮搂誉，結(jié)果婚禮上，老公的妹妹穿的比我還像新娘静檬。我一直安慰自己炭懊，他們只是感情好，可當(dāng)我...
茶點(diǎn)故事閱讀 68,502評(píng)論 6贊 397
惡毒庶女頂嫁案：這布局不是一般人想出來的
文/花漫我一把揭開白布拂檩。她就那樣靜靜地躺著侮腹，像睡著了一般。火紅的嫁衣襯著肌膚如雪稻励。梳的紋絲不亂的頭發(fā)上父阻，一...
開封第一講書人閱讀 52,156評(píng)論 1贊 308
城市分裂傳說
那天，我揣著相機(jī)與錄音，去河邊找鬼加矛。笑死钠署，一個(gè)胖子當(dāng)著我的面吹牛，可吹牛的內(nèi)容都是我干的荒椭。我是一名探鬼主播谐鼎，決...
沈念sama閱讀 40,743評(píng)論 3贊 421
雙鴛鴦連環(huán)套：你想象不到人心有多黑
文/蒼蘭香墨我猛地睜開眼，長吁一口氣：“原來是場(chǎng)噩夢(mèng)啊……” “哼趣惠！你這毒婦竟也來了狸棍？” 一聲冷哼從身側(cè)響起，我...
開封第一講書人閱讀 39,659評(píng)論 0贊 276
萬榮殺人案實(shí)錄
序言：老撾萬榮一對(duì)情侶失蹤味悄，失蹤者是張志新（化名）和其女友劉穎草戈，沒想到半個(gè)月后，有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體侍瑟，經(jīng)...
沈念sama閱讀 46,200評(píng)論 1贊 319
?護(hù)林員之死
正文獨(dú)居荒郊野嶺守林人離奇死亡唐片，尸身上長有42處帶血的膿包…… 初始之章·張勛以下內(nèi)容為張勛視角年9月15日...
茶點(diǎn)故事閱讀 38,282評(píng)論 3贊 340
?白月光啟示錄
正文我和宋清朗相戀三年，在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了涨颜。大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片费韭。...
茶點(diǎn)故事閱讀 40,424評(píng)論 1贊 352
活死人
序言：一個(gè)原本活蹦亂跳的男人離奇死亡，死狀恐怖庭瑰，靈堂內(nèi)的尸體忽然破棺而出星持，到底是詐尸還是另有隱情，我是刑警寧澤弹灭，帶...
沈念sama閱讀 36,107評(píng)論 5贊 349
?日本核電站爆炸內(nèi)幕
正文年R本政府宣布督暂，位于F島的核電站，受9級(jí)特大地震影響穷吮，放射性物質(zhì)發(fā)生泄漏逻翁。R本人自食惡果不足惜，卻給世界環(huán)境...
茶點(diǎn)故事閱讀 41,789評(píng)論 3贊 333
男人毒藥：我在死后第九天來索命
文/蒙蒙一捡鱼、第九天我趴在偏房一處隱蔽的房頂上張望八回。院中可真熱鬧，春花似錦堰汉、人聲如沸辽社。這莊子的主人今日做“春日...
開封第一講書人閱讀 32,264評(píng)論 0贊 23
一樁弒父案翘鸭，背后竟有這般陰謀
文/蒼蘭香墨我抬頭看了看天上的太陽滴铅。三九已至，卻和暖如春就乓，著一層夾襖步出監(jiān)牢的瞬間汉匙，已是汗流浹背拱烁。一陣腳步聲響...
開封第一講書人閱讀 33,390評(píng)論 1贊 271
情欲美人皮
我被黑心中介騙來泰國打工，沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留噩翠，地道東北人戏自。一個(gè)月前我還...
沈念sama閱讀 48,798評(píng)論 3贊 376
代替公主和親
正文我出身青樓，卻偏偏與公主長得像伤锚，于是被迫代替她去往敵國和親擅笔。傳聞我的和親對(duì)象是個(gè)殘疾皇子，可洞房花燭夜當(dāng)晚...
茶點(diǎn)故事閱讀 45,435評(píng)論 2贊 359