原文同步至 http://waylau.com/mockito-quick-start/

Mock 測(cè)試是單元測(cè)試的重要方法之一。本文介紹了基于 Java 語(yǔ)言的 Mock 測(cè)試框架 -- Mockito 的使用。

什么是 Mock 測(cè)試

Mock 測(cè)試就是在測(cè)試過(guò)程中，對(duì)于某些不容易構(gòu)造（如 HttpServletRequest 必須在Servlet 容器中才能構(gòu)造出來(lái)）或者不容易獲取比較復(fù)雜的對(duì)象（如 JDBC 中的ResultSet 對(duì)象），用一個(gè)虛擬的對(duì)象（Mock 對(duì)象）來(lái)創(chuàng)建以便測(cè)試的測(cè)試方法。

Mock 最大的功能是幫你把單元測(cè)試的耦合分解開(kāi)，如果你的代碼對(duì)另一個(gè)類或者接口有依賴，它能夠幫你模擬這些依賴，并幫你驗(yàn)證所調(diào)用的依賴的行為。

比如一段代碼有這樣的依賴：

當(dāng)我們需要測(cè)試A類的時(shí)候，如果沒(méi)有 Mock，則我們需要把整個(gè)依賴樹(shù)都構(gòu)建出來(lái)，而使用 Mock 的話就可以將結(jié)構(gòu)分解開(kāi)，像下面這樣：

Mock 對(duì)象使用范疇

真實(shí)對(duì)象具有不可確定的行為，產(chǎn)生不可預(yù)測(cè)的效果，（如：股票行情，天氣預(yù)報(bào)） 真實(shí)對(duì)象很難被創(chuàng)建的 真實(shí)對(duì)象的某些行為很難被觸發(fā) 真實(shí)對(duì)象實(shí)際上還不存在的（和其他開(kāi)發(fā)小組或者和新的硬件打交道）等等

使用 Mock 對(duì)象測(cè)試的關(guān)鍵步驟

使用一個(gè)接口來(lái)描述這個(gè)對(duì)象 在產(chǎn)品代碼中實(shí)現(xiàn)這個(gè)接口 在測(cè)試代碼中實(shí)現(xiàn)這個(gè)接口 在被測(cè)試代碼中只是通過(guò)接口來(lái)引用對(duì)象，所以它不知道這個(gè)引用的對(duì)象是真實(shí)對(duì)象,還是 Mock 對(duì)象。

Java Mock 測(cè)試

目前，在 Java 陣營(yíng)中主要的 Mock 測(cè)試工具有 Mockito，JMock，EasyMock 等。

關(guān)于這些框架的比較，不是本文的重點(diǎn)。本文著重介紹 Mockito 的使用。

Mockito 的特性

Mockito 是美味的 Java 單元測(cè)試 Mock 框架，開(kāi)源。

大多 Java Mock 庫(kù)如 EasyMock 或 JMock 都是 expect-run-verify （期望-運(yùn)行-驗(yàn)證）方式，而 Mockito 則使用更簡(jiǎn)單，更直觀的方法：在執(zhí)行后的互動(dòng)中提問(wèn)。使用 Mockito，你可以驗(yàn)證任何你想要的。而那些使用 expect-run-verify 方式的庫(kù)，你常常被迫查看無(wú)關(guān)的交互。

非 expect-run-verify 方式 也意味著，Mockito 無(wú)需準(zhǔn)備昂貴的前期啟動(dòng)。他們的目標(biāo)是透明的，讓開(kāi)發(fā)人員專注于測(cè)試選定的行為。

Mockito 擁有的非常少的 API，所有開(kāi)始使用 Mockito，幾乎沒(méi)有時(shí)間成本。因?yàn)橹挥幸环N創(chuàng)造 mock 的方式。只要記住，在執(zhí)行前 stub，而后在交互中驗(yàn)證。你很快就會(huì)發(fā)現(xiàn)這樣 TDD java 代碼是多么自然。

類似 EasyMock 的語(yǔ)法來(lái)的，所以你可以放心地重構(gòu)。Mockito 并不需要“expectation（期望）”的概念。只有 stub 和驗(yàn)證。

Mockito 實(shí)現(xiàn)了 Gerard Meszaros 所謂的 Test Spy.

其他的一些特點(diǎn)：

• 可以 mock 具體類而不單止是接口
• 一點(diǎn)注解語(yǔ)法糖 - @Mock
• 干凈的驗(yàn)證錯(cuò)誤是 - 點(diǎn)擊堆棧跟蹤，看看在測(cè)試中的失敗驗(yàn)證;點(diǎn)擊異常的原因來(lái)導(dǎo)航到代碼中的實(shí)際互動(dòng)。堆棧跟蹤總是干干凈凈。
• 允許靈活有序的驗(yàn)證（例如：你任意有序 verify，而不是每一個(gè)單獨(dú)的交互）
• 支持“詳細(xì)的用戶號(hào)碼的時(shí)間”以及“至少一??次”驗(yàn)證
• 靈活的驗(yàn)證或使用參數(shù)匹配器的 stub （anyObject()，anyString() 或 refEq() 用于基于反射的相等匹配）
• 允許創(chuàng)建自定義的參數(shù)匹配器或者使用現(xiàn)有的 hamcrest 匹配器

Mockito 入門(mén)

聲明 mockito 依賴

Gradle 用戶可以使用：

repositories { jcenter() } dependencies { testCompile "org.mockito:mockito-core:1.+" }

Maven 用戶可以使用：http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.mockito%22%2C%20a%3A%22mockito-core%22

Mockito 自動(dòng)發(fā)布到 http://jcenter.bintray.com/org/mockito/mockito-core/ 并同步到 Maven Central Repository

示例

1.驗(yàn)證行為

//Let's import Mockito statically so that the code looks clearerimport static org.mockito.Mockito.*;//mock creationList mockedList = mock(List.class);//using mock objectmockedList.add("one");mockedList.clear();//verificationverify(mockedList).add("one");verify(mockedList).clear();

一旦創(chuàng)建 mock 將會(huì)記得所有的交互。你可以選擇驗(yàn)證你感興趣的任何交互

2.stubbing

//You can mock concrete classes, not just interfacesLinkedList mockedList = mock(LinkedList.class);//stubbingwhen(mockedList.get(0)).thenReturn("first");when(mockedList.get(1)).thenThrow(new RuntimeException());//following prints "first"System.out.println(mockedList.get(0));//following throws runtime exceptionSystem.out.println(mockedList.get(1));//following prints "null" because get(999) was not stubbedSystem.out.println(mockedList.get(999));//Although it is possible to verify a stubbed invocation, usually it's just redundant//If your code cares what get(0) returns, then something else breaks (often even before verify() gets executed).//If your code doesn't care what get(0) returns, then it should not be stubbed. Not convinced? See here.verify(mockedList).get(0);

• 默認(rèn)情況下，所有方法都會(huì)返回值，一個(gè) mock 將返回要么 null，一個(gè)原始/基本類型的包裝值或適當(dāng)?shù)目占＠?#xff0c;對(duì)于一個(gè) int/Integer 就是 0，而對(duì)于 boolean/Boolean 就是 false。
• Stubbing 可以被覆蓋。
• 一旦 stub，該方法將始終返回一個(gè) stub 的值，無(wú)論它有多少次被調(diào)用。
• 最后的 stubbing 是很重要的 - 當(dāng)你使用相同的參數(shù) stub 多次同樣的方法。換句話說(shuō)：stubbing 的順序是重要的，但它唯一有意義的卻很少，例如當(dāng) stubbing 完全相同的方法調(diào)用，或者有時(shí)當(dāng)參數(shù)匹配器的使用，等等。

3.參數(shù)匹配器

Mockito 驗(yàn)證參數(shù)值使用 Java 方式：通過(guò)使用 equals() 方法。有時(shí)，當(dāng)需要額外的靈活性，可以使用參數(shù)匹配器：

//stubbing using built-in anyInt() argument matcherwhen(mockedList.get(anyInt())).thenReturn("element");//stubbing using custom matcher (let's say isValid() returns your own matcher implementation):when(mockedList.contains(argThat(isValid()))).thenReturn("element");//following prints "element"System.out.println(mockedList.get(999));//you can also verify using an argument matcherverify(mockedList).get(anyInt());

參數(shù)匹配器允許靈活的驗(yàn)證或 stubbing。點(diǎn)擊這里查看更多內(nèi)置的匹配器和自定義的參數(shù)匹配器/ hamcrest匹配器的例子。

自定義參數(shù)的匹配信息，請(qǐng)查看 Javadoc 中 ArgumentMatcher 類。

如果你正在使用參數(shù)的匹配，所有的參數(shù)都由匹配器來(lái)提供。

下面的示例演示驗(yàn)證，但同樣適用于 stubbing：

verify(mock).someMethod(anyInt(), anyString(), eq("third argument")); //above is correct - eq() is also an argument matcherverify(mock).someMethod(anyInt(), anyString(), "third argument"); //above is incorrect - exception will be thrown because third argument is given without an argument matcher.

4.調(diào)用額外的調(diào)用數(shù)字/at least x / never

//using mock mockedList.add("once");mockedList.add("twice"); mockedList.add("twice");mockedList.add("three times"); mockedList.add("three times"); mockedList.add("three times");//following two verifications work exactly the same - times(1) is used by default verify(mockedList).add("once"); verify(mockedList, times(1)).add("once");//exact number of invocations verification verify(mockedList, times(2)).add("twice"); verify(mockedList, times(3)).add("three times");//verification using never(). never() is an alias to times(0) verify(mockedList, never()).add("never happened");//verification using atLeast()/atMost() verify(mockedList, atLeastOnce()).add("three times"); verify(mockedList, atLeast(2)).add("five times"); verify(mockedList, atMost(5)).add("three times");

times(1) 是默認(rèn)的，因此，使用的 times(1) 可以顯示的省略。

5.Stubbing void 方法處理異常

doThrow(new RuntimeException()).when(mockedList).clear();//following throws RuntimeException: mockedList.clear();

6.有序的驗(yàn)證

// A. Single mock whose methods must be invoked in a particular order List singleMock = mock(List.class);//using a single mock singleMock.add("was added first"); singleMock.add("was added second");//create an inOrder verifier for a single mock InOrder inOrder = inOrder(singleMock);//following will make sure that add is first called with "was added first, then with "was added second" inOrder.verify(singleMock).add("was added first"); inOrder.verify(singleMock).add("was added second");// B. Multiple mocks that must be used in a particular order List firstMock = mock(List.class); List secondMock = mock(List.class);//using mocks firstMock.add("was called first"); secondMock.add("was called second");//create inOrder object passing any mocks that need to be verified in order InOrder inOrder = inOrder(firstMock, secondMock);//following will make sure that firstMock was called before secondMock inOrder.verify(firstMock).add("was called first"); inOrder.verify(secondMock).add("was called second");// Oh, and A + B can be mixed together at will

有序驗(yàn)證是為了靈活 - 你不必一個(gè)接一個(gè)驗(yàn)證所有的交互。

此外，您還可以通過(guò)創(chuàng)建 InOrder 對(duì)象傳遞只與有序驗(yàn)證相關(guān)的 mock 。

7. 確保 mock 上不會(huì)發(fā)生交互

//using mocks - only mockOne is interacted mockOne.add("one");//ordinary verification verify(mockOne).add("one");//verify that method was never called on a mock verify(mockOne, never()).add("two");//verify that other mocks were not interacted verifyZeroInteractions(mockTwo, mockThree);

8.尋找多余的調(diào)用

//using mocks mockedList.add("one"); mockedList.add("two");verify(mockedList).add("one");//following verification will fail verifyNoMoreInteractions(mockedList);

注意：不建議 verifyNoMoreInteractions() 在每個(gè)測(cè)試方法中使用。 verifyNoMoreInteractions() 是從交互測(cè)試工具包一個(gè)方便的斷言。只有與它的相關(guān)時(shí)才使用它。濫用它導(dǎo)致難以維護(hù)。

9. 標(biāo)準(zhǔn)創(chuàng)建 mock 方式 - 使用 @Mock 注解

• 最小化可重用 mock 創(chuàng)建代碼

• 使測(cè)試類更加可讀性

• 使驗(yàn)證錯(cuò)誤更加易讀，因?yàn)樽侄蚊Q用于唯一識(shí)別 mock

  public class ArticleManagerTest {

  @Mock private ArticleCalculator calculator;@Mock private ArticleDatabase database;@Mock private UserProvider userProvider;private ArticleManager manager;

在基礎(chǔ)類或者測(cè)試 runner 里面，使用如下：

MockitoAnnotations.initMocks(testClass);

可以使用內(nèi)建 runner: MockitoJUnitRunner 或者 rule: MockitoRule

更多詳見(jiàn) MockitoAnnotations

10. Stubbing 連續(xù)調(diào)用（迭代器式的 stubbing）

when(mock.someMethod("some arg")).thenThrow(new RuntimeException()).thenReturn("foo");//First call: throws runtime exception: mock.someMethod("some arg");//Second call: prints "foo" System.out.println(mock.someMethod("some arg"));//Any consecutive call: prints "foo" as well (last stubbing wins). System.out.println(mock.someMethod("some arg"));

下面是一個(gè)精簡(jiǎn)版本：

when(mock.someMethod("some arg")).thenReturn("one", "two", "three");

11. 回調(diào) Stubbing

允許使用泛型 Answer 接口。

然而，這是不包括在最初的 Mockito 另一個(gè)有爭(zhēng)議的功能。我們建議您只需用thenReturn() 或 thenThrow() 來(lái) stubbing ，這在測(cè)試/測(cè)試驅(qū)動(dòng)中應(yīng)用簡(jiǎn)潔與簡(jiǎn)單的代碼足夠了。但是，如果你有一個(gè)需要 stub 到泛型 Answer 接口，這里是一個(gè)例子：

when(mock.someMethod(anyString())).thenAnswer(new Answer() {Object answer(InvocationOnMock invocation) {Object[] args = invocation.getArguments();Object mock = invocation.getMock();return "called with arguments: " + args;} });//the following prints "called with arguments: foo" System.out.println(mock.someMethod("foo"));

12. doReturn()|doThrow()| doAnswer()|doNothing()|doCallRealMethod() 家族方法

Stubbing void 方法，需要不同的 when(Object) ，因?yàn)榫幾g器不喜歡括號(hào)內(nèi)無(wú)效的方法...

在 用于 Stubbing void 方法中，doThrow(Throwable...) 取代 stubVoid(Object)。主要原因是提高可讀性和與 doAnswer() 保持一致性。

當(dāng)你想用 stub void 方法 使用 doThrow（）：

doThrow(new RuntimeException()).when(mockedList).clear();//following throws RuntimeException: mockedList.clear();

在調(diào)用 when() 的相應(yīng)地方可以使用 oThrow(), doAnswer(), doNothing(), doReturn() 和 doCallRealMethod()，當(dāng)：

• stub void 方法
• stub 方法在 spy 對(duì)象(見(jiàn)下面)
• 可以不止一次的 stub 相同的方法，在測(cè)試的中期來(lái)改變 mock 的行為

但你更加傾向于使用這些方法來(lái)代替 when()，在所有的 stubbing 調(diào)用。可以關(guān)于這些方法的描述：

doReturn(Object)

doThrow(Throwable...)

doThrow(Class)

doAnswer(Answer)

doNothing()

doCallRealMethod()

參考

• http://martinfowler.com/articles/mocksArentStubs.html
• http://mockito.org/

轉(zhuǎn)載于:https://my.oschina.net/waylau/blog/617403

總結(jié)

以上是生活随笔為你收集整理的Mockito 简明教程的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。