鄭 閩睿 (zhengmr@cn.ibm.com), 軟件工程師, IBM CSDL
黃 湘平 (xphuang@cn.ibm.com), 高級(jí)軟件工程師，IBM CSDL

2007 年 10 月 25 日

EasyMock 是一套通過簡單的方法對于指定的接口或類生成 Mock 對象的類庫，它能利用對接口或類的模擬來輔助單元測試。本文將對 EasyMock 的功能和原理進(jìn)行介紹，并通過示例來說明如何使用 EasyMock 進(jìn)行單元測試。

Mock 方法是單元測試中常見的一種技術(shù)，它的主要作用是模擬一些在應(yīng)用中不容易構(gòu)造或者比較復(fù)雜的對象，從而把測試與測試邊界以外的對象隔離開。

編 寫自定義的 Mock 對象需要額外的編碼工作，同時(shí)也可能引入錯(cuò)誤。EasyMock 提供了根據(jù)指定接口動(dòng)態(tài)構(gòu)建 Mock 對象的方法，避免了手工編寫 Mock 對象。本文將向您展示如何使用 EasyMock 進(jìn)行單元測試，并對 EasyMock 的原理進(jìn)行分析。

1．Mock 對象與 EasyMock 簡介

單元測試與 Mock 方法

單 元測試是對應(yīng)用中的某一個(gè)模塊的功能進(jìn)行驗(yàn)證。在單元測試中，我們常遇到的問題是應(yīng)用中其它的協(xié)同模塊尚未開發(fā)完成，或者被測試模塊需要和一些不容易構(gòu) 造、比較復(fù)雜的對象進(jìn)行交互。另外，由于不能肯定其它模塊的正確性，我們也無法確定測試中發(fā)現(xiàn)的問題是由哪個(gè)模塊引起的。

Mock 對象能夠模擬其它協(xié)同模塊的行為，被測試模塊通過與 Mock 對象協(xié)作，可以獲得一個(gè)孤立的測試環(huán)境。此外，使用 Mock 對象還可以模擬在應(yīng)用中不容易構(gòu)造（如 HttpServletRequest 必須在 Servlet 容器中才能構(gòu)造出來）和比較復(fù)雜的對象（如 JDBC 中的 ResultSet 對象），從而使測試順利進(jìn)行。

EasyMock 簡介

手 動(dòng)的構(gòu)造 Mock 對象會(huì)給開發(fā)人員帶來額外的編碼量，而且這些為創(chuàng)建 Mock 對象而編寫的代碼很有可能引入錯(cuò)誤。目前，有許多開源項(xiàng)目對動(dòng)態(tài)構(gòu)建 Mock 對象提供了支持，這些項(xiàng)目能夠根據(jù)現(xiàn)有的接口或類動(dòng)態(tài)生成，這樣不僅能避免額外的編碼工作，同時(shí)也降低了引入錯(cuò)誤的可能。

EasyMock 是一套用于通過簡單的方法對于給定的接口生成 Mock 對象的類庫。它提供對接口的模擬，能夠通過錄制、回放、檢查三步來完成大體的測試過程，可以驗(yàn)證方法的調(diào)用種類、次數(shù)、順序，可以令 Mock 對象返回指定的值或拋出指定異常。通過 EasyMock，我們可以方便的構(gòu)造 Mock 對象從而使單元測試順利進(jìn)行。

安裝 EasyMock

EasyMock 是采用 MIT license 的一個(gè)開源項(xiàng)目，您可以在 Sourceforge 上下載到相關(guān)的 zip 文件。目前您可以下載的 EasyMock 最新版本是2.3，它需要運(yùn)行在 Java 5.0 平臺(tái)上。如果您的應(yīng)用運(yùn)行在 Java 1.3 或 1.4 平臺(tái)上，您可以選擇 EasyMock1.2。在解壓縮 zip 包后，您可以找到 easymock.jar 這個(gè)文件。如果您使用 Eclipse 作為 IDE，把 easymock.jar 添加到項(xiàng)目的 Libraries 里就可以使用了（如下圖所示）。此外，由于我們的測試用例運(yùn)行在 JUnit 環(huán)境中，因此您還需要 JUnit.jar（版本3.8.1以上）。

回頁首

2．使用 EasyMock 進(jìn)行單元測試

通過 EasyMock，我們可以為指定的接口動(dòng)態(tài)的創(chuàng)建 Mock 對象，并利用 Mock 對象來模擬協(xié)同模塊或是領(lǐng)域?qū)ο螅瑥亩箚卧獪y試順利進(jìn)行。這個(gè)過程大致可以劃分為以下幾個(gè)步驟：

• 使用 EasyMock 生成 Mock 對象；
• 設(shè)定 Mock 對象的預(yù)期行為和輸出；
• 將 Mock 對象切換到 Replay 狀態(tài)；
• 調(diào)用 Mock 對象方法進(jìn)行單元測試；
• 對 Mock 對象的行為進(jìn)行驗(yàn)證。

接下來，我們將對以上的幾個(gè)步驟逐一進(jìn)行說明。除了以上的基本步驟外，EasyMock 還對特殊的 Mock 對象類型、特定的參數(shù)匹配方式等功能提供了支持，我們將在之后的章節(jié)中進(jìn)行說明。

使用 EasyMock 生成 Mock 對象

根據(jù)指定的接口或類，EasyMock 能夠動(dòng)態(tài)的創(chuàng)建 Mock 對象（EasyMock 默認(rèn)只支持為接口生成 Mock 對象，如果需要為類生成 Mock 對象，在 EasyMock 的主頁上有擴(kuò)展包可以實(shí)現(xiàn)此功能），我們以 ResultSet 接口為例說明EasyMock的功能。java.sql.ResultSet 是每一個(gè) Java 開發(fā)人員都非常熟悉的接口：

                

            public interface java.sql.ResultSet {

            ......

            public abstract java.lang.String getString(int arg0) throws java.sql.SQLException;

            public abstract double getDouble(int arg0) throws java.sql.SQLException;

            ......

            }

            

通常，構(gòu)建一個(gè)真實(shí)的 RecordSet 對象需要經(jīng)過一個(gè)復(fù)雜的過程：在開發(fā)過程中，開發(fā)人員通常會(huì)編寫一個(gè) DBUtility 類來獲取數(shù)據(jù)庫連接 Connection，并利用 Connection 創(chuàng)建一個(gè) Statement。執(zhí)行一個(gè) Statement 可以獲取到一個(gè)或多個(gè) ResultSet 對象。這樣的構(gòu)造過程復(fù)雜并且依賴于數(shù)據(jù)庫的正確運(yùn)行。數(shù)據(jù)庫或是數(shù)據(jù)庫交互模塊出現(xiàn)問題，都會(huì)影響單元測試的結(jié)果。

我們可以使用 EasyMock 動(dòng)態(tài)構(gòu)建 ResultSet 接口的 Mock 對象來解決這個(gè)問題。一些簡單的測試用例只需要一個(gè) Mock 對象，這時(shí)，我們可以用以下的方法來創(chuàng)建 Mock 對象：

ResultSet mockResultSet = createMock(ResultSet.class);

            

其中 createMock 是 org.easymock.EasyMock 類所提供的靜態(tài)方法，你可以通過 static import 將其引入（注：static import 是 java 5.0 所提供的新特性）。

如果需要在相對復(fù)雜的測試用例中使用多個(gè) Mock 對象，EasyMock 提供了另外一種生成和管理 Mock 對象的機(jī)制：

IMocksControl control = EasyMock.createControl();

            java.sql.Connection mockConnection = control.createMock(Connection.class);

            java.sql.Statement mockStatement = control.createMock(Statement.class);

            java.sql.ResultSet mockResultSet = control.createMock(ResultSet.class);

            

EasyMock 類的 createControl 方法能創(chuàng)建一個(gè)接口 IMocksControl 的對象，該對象能創(chuàng)建并管理多個(gè) Mock 對象。如果需要在測試中使用多個(gè) Mock 對象，我們推薦您使用這一機(jī)制，因?yàn)樗诙鄠€(gè) Mock 對象的管理上提供了相對便捷的方法。

如果您要模擬的是一個(gè)具體類而非接口，那么您需要下載擴(kuò)展包 EasyMock Class Extension 2.2.2。在對具體類進(jìn)行模擬時(shí)，您只要用 org.easymock.classextension.EasyMock 類中的靜態(tài)方法代替 org.easymock.EasyMock 類中的靜態(tài)方法即可。

設(shè)定 Mock 對象的預(yù)期行為和輸出

在 一個(gè)完整的測試過程中，一個(gè) Mock 對象將會(huì)經(jīng)歷兩個(gè)狀態(tài)：Record 狀態(tài)和 Replay 狀態(tài)。Mock 對象一經(jīng)創(chuàng)建，它的狀態(tài)就被置為 Record。在 Record 狀態(tài)，用戶可以設(shè)定 Mock 對象的預(yù)期行為和輸出，這些對象行為被錄制下來，保存在 Mock 對象中。

添加 Mock 對象行為的過程通常可以分為以下3步：

• 對 Mock 對象的特定方法作出調(diào)用；
• 通過 org.easymock.EasyMock 提供的靜態(tài)方法 expectLastCall 獲取上一次方法調(diào)用所對應(yīng)的 IExpectationSetters 實(shí)例；
• 通過 IExpectationSetters 實(shí)例設(shè)定 Mock 對象的預(yù)期輸出。

設(shè)定預(yù)期返回值

Mock 對象的行為可以簡單的理解為 Mock 對象方法的調(diào)用和方法調(diào)用所產(chǎn)生的輸出。在 EasyMock 2.3 中，對 Mock 對象行為的添加和設(shè)置是通過接口 IExpectationSetters 來實(shí)現(xiàn)的。Mock 對象方法的調(diào)用可能產(chǎn)生兩種類型的輸出：（1）產(chǎn)生返回值；（2）拋出異常。接口 IExpectationSetters 提供了多種設(shè)定預(yù)期輸出的方法，其中和設(shè)定返回值相對應(yīng)的是 andReturn 方法：

IExpectationSetters<T> andReturn(T value);

            

我們?nèi)匀挥?ResultSet 接口的 Mock 對象為例，如果希望方法 mockResult.getString(1) 的返回值為 "My return value"，那么你可以使用以下的語句：

mockResultSet.getString(1);

            expectLastCall().andReturn("My return value");

            

以上的語句表示 mockResultSet 的 getString 方法被調(diào)用一次，這次調(diào)用的返回值是 "My return value"。有時(shí)，我們希望某個(gè)方法的調(diào)用總是返回一個(gè)相同的值，為了避免每次調(diào)用都為 Mock 對象的行為進(jìn)行一次設(shè)定，我們可以用設(shè)置默認(rèn)返回值的方法：

void andStubReturn(Object value);

            

假設(shè)我們創(chuàng)建了 Statement 和 ResultSet 接口的 Mock 對象 mockStatement 和 mockResultSet，在測試過程中，我們希望 mockStatement 對象的 executeQuery 方法總是返回 mockResultSet，我們可以使用如下的語句

mockStatement.executeQuery("SELECT * FROM sales_order_table");

            expectLastCall().andStubReturn(mockResultSet);

            

EasyMock 在對參數(shù)值進(jìn)行匹配時(shí)，默認(rèn)采用 Object.equals() 方法。因此，如果我們以 "select * from sales_order_table" 作為參數(shù)，預(yù)期方法將不會(huì)被調(diào)用。如果您希望上例中的 SQL 語句能不區(qū)分大小寫，可以用特殊的參數(shù)匹配器來解決這個(gè)問題，我們將在 "在 EasyMock 中使用參數(shù)匹配器" 一章對此進(jìn)行說明。

設(shè)定預(yù)期異常拋出

對象行為的預(yù)期輸出除了可能是返回值外，還有可能是拋出異常。IExpectationSetters 提供了設(shè)定預(yù)期拋出異常的方法：

IExpectationSetters<T> andThrow(Throwable throwable);

            

和設(shè)定默認(rèn)返回值類似，IExpectationSetters 接口也提供了設(shè)定拋出默認(rèn)異常的函數(shù)：

void andStubThrow(Throwable throwable);

            

設(shè)定預(yù)期方法調(diào)用次數(shù)

通過以上的函數(shù)，您可以對 Mock 對象特定行為的預(yù)期輸出進(jìn)行設(shè)定。除了對預(yù)期輸出進(jìn)行設(shè)定，IExpectationSetters 接口還允許用戶對方法的調(diào)用次數(shù)作出限制。在 IExpectationSetters 所提供的這一類方法中，常用的一種是 times 方法：

IExpectationSetters<T>times(int count);

            

該方法可以 Mock 對象方法的調(diào)用次數(shù)進(jìn)行確切的設(shè)定。假設(shè)我們希望 mockResultSet 的 getString 方法在測試過程中被調(diào)用3次，期間的返回值都是 "My return value"，我們可以用如下語句：

mockResultSet.getString(1);

            expectLastCall().andReturn("My return value").times(3);

            

除了設(shè)定確定的調(diào)用次數(shù)，IExpectationSetters 還提供了另外幾種設(shè)定非準(zhǔn)確調(diào)用次數(shù)的方法：
times(int minTimes, int maxTimes)：該方法最少被調(diào)用 minTimes 次，最多被調(diào)用 maxTimes 次。
atLeastOnce()：該方法至少被調(diào)用一次。
anyTimes()：該方法可以被調(diào)用任意次。

某些方法的返回值類型是 void，對于這一類方法，我們無需設(shè)定返回值，只要設(shè)置調(diào)用次數(shù)就可以了。以 ResultSet 接口的 close 方法為例，假設(shè)在測試過程中，該方法被調(diào)用3至5次：

mockResultSet.close();

            expectLastCall().times(3, 5);

            

為了簡化書寫，EasyMock 還提供了另一種設(shè)定 Mock 對象行為的語句模式。對于上例，您還可以將它寫成：

expect(mockResult.close()).times(3, 5);

            

將 Mock 對象切換到 Replay 狀態(tài)

在生成 Mock 對象和設(shè)定 Mock 對象行為兩個(gè)階段，Mock 對象的狀態(tài)都是 Record 。在這個(gè)階段，Mock 對象會(huì)記錄用戶對預(yù)期行為和輸出的設(shè)定。

在 使用 Mock 對象進(jìn)行實(shí)際的測試前，我們需要將 Mock 對象的狀態(tài)切換為 Replay。在 Replay 狀態(tài)，Mock 對象能夠根據(jù)設(shè)定對特定的方法調(diào)用作出預(yù)期的響應(yīng)。將 Mock 對象切換成 Replay 狀態(tài)有兩種方式，您需要根據(jù) Mock 對象的生成方式進(jìn)行選擇。如果 Mock 對象是通過 org.easymock.EasyMock 類提供的靜態(tài)方法 createMock 生成的（第1節(jié)中介紹的第一種 Mock 對象生成方法），那么 EasyMock 類提供了相應(yīng)的 replay 方法用于將 Mock 對象切換為 Replay 狀態(tài)：

replay(mockResultSet);

            

如果 Mock 對象是通過 IMocksControl 接口提供的 createMock 方法生成的（第1節(jié)中介紹的第二種Mock對象生成方法），那么您依舊可以通過 IMocksControl 接口對它所創(chuàng)建的所有 Mock 對象進(jìn)行切換：

control.replay();

            

以上的語句能將在第1節(jié)中生成的 mockConnection、mockStatement 和 mockResultSet 等3個(gè) Mock 對象都切換成 Replay 狀態(tài)。

調(diào)用 Mock 對象方法進(jìn)行單元測試

為 了更好的說明 EasyMock 的功能，我們引入 src.zip 中的示例來解釋 Mock 對象在實(shí)際測試階段的作用。其中所有的示例代碼都可以在 src.zip 中找到。如果您使用的 IDE 是 Eclipse，在導(dǎo)入 src.zip 之后您可以看到 Workspace 中增加的 project（如下圖所示）。

下面是示例代碼中的一個(gè)接口 SalesOrder，它的實(shí)現(xiàn)類 SalesOrderImpl 的主要功能是從數(shù)據(jù)庫中讀取一個(gè) Sales Order 的 Region 和 Total Price，并根據(jù)讀取的數(shù)據(jù)計(jì)算該 Sales Order 的 Price Level（完整的實(shí)現(xiàn)代碼都可以在 src.zip 中找到）：

                

            public interface SalesOrder

            {

            ……

            public void loadDataFromDB(ResultSet resultSet) throws SQLException;	

            public String getPriceLevel();

            }

            

其實(shí)現(xiàn)類 SalesOrderImpl 中對 loadDataFromDB 的實(shí)現(xiàn)如下：

                

            public class SalesOrderImpl implements SalesOrder

            {

            ......

            public void loadDataFromDB(ResultSet resultSet) throws SQLException

            {

            orderNumber = resultSet.getString(1);

            region = resultSet.getString(2);

            totalPrice = resultSet.getDouble(3);

            }

            ......

            }

            

方法 loadDataFromDB 讀取了 ResultSet 對象包含的數(shù)據(jù)。當(dāng)我們將之前定義的 Mock 對象調(diào)整為 Replay 狀態(tài)，并將該對象作為參數(shù)傳入，那么 Mock 對象的方法將會(huì)返回預(yù)先定義的預(yù)期返回值。完整的 TestCase 如下：

                

            public class SalesOrderTestCase extends TestCase {

            public void testSalesOrder() {

            IMocksControl control = EasyMock.createControl();

            ......

            ResultSet mockResultSet = control.createMock(ResultSet.class);

            try {

            ......

            mockResultSet.next();

            expectLastCall().andReturn(true).times(3);

            expectLastCall().andReturn(false).times(1);

            mockResultSet.getString(1);

            expectLastCall().andReturn("DEMO_ORDER_001").times(1);

            expectLastCall().andReturn("DEMO_ORDER_002").times(1);

            expectLastCall().andReturn("DEMO_ORDER_003").times(1);

            mockResultSet.getString(2);

            expectLastCall().andReturn("Asia Pacific").times(1);

            expectLastCall().andReturn("Europe").times(1);

            expectLastCall().andReturn("America").times(1);

            mockResultSet.getDouble(3);

            expectLastCall().andReturn(350.0).times(1);

            expectLastCall().andReturn(1350.0).times(1);

            expectLastCall().andReturn(5350.0).times(1);

            control.replay();

            ......

            int i = 0;

            String[] priceLevels = { "Level_A", "Level_C", "Level_E" };

            while (mockResultSet.next()) {

            SalesOrder order = new SalesOrderImpl();

            order.loadDataFromDB(mockResultSet);

            assertEquals(order.getPriceLevel(), priceLevels[i]);

            i++;

            }

            control.verify();

            } catch (Exception e) {

            e.printStackTrace();

            }

            }

            }

            

在這個(gè)示例中，我們首先創(chuàng)建了 ResultSet 的 Mock 對象 moResultSet，并記錄該 Mock 對象的預(yù)期行為。之后我們調(diào)用了 control.replay()，將 Mock 對象的狀態(tài)置為 Replay 狀態(tài)。 在實(shí)際的測試階段，Sales Order 對象的 loadDataFromDB 方法調(diào)用了 mockResultSet 對象的 getString 和 getDouble 方法讀取 mockResultSet 中的數(shù)據(jù)。Sales Order 對象根據(jù)讀取的數(shù)據(jù)計(jì)算出 Price Level，并和預(yù)期輸出進(jìn)行比較。

對 Mock 對象的行為進(jìn)行驗(yàn)證

在利用 Mock 對象進(jìn)行實(shí)際的測試過程之后，我們還有一件事情沒有做：對 Mock 對象的方法調(diào)用的次數(shù)進(jìn)行驗(yàn)證。

為了驗(yàn)證指定的方法調(diào)用真的完成了，我們需要調(diào)用 verify 方法進(jìn)行驗(yàn)證。和 replay 方法類似，您需要根據(jù) Mock 對象的生成方式來選用不同的驗(yàn)證方式。如果 Mock 對象是由 org.easymock.EasyMock 類提供的 createMock 靜態(tài)方法生成的，那么我們同樣采用 EasyMock 類的靜態(tài)方法 verify 進(jìn)行驗(yàn)證：

verify(mockResultSet);

            

如果Mock對象是有 IMocksControl 接口所提供的 createMock 方法生成的，那么采用該接口提供的 verify 方法，例如第1節(jié)中的 IMocksControl 實(shí)例 control：

control.verify();

            

將對 control 實(shí)例所生成的 Mock 對象 mockConnection、mockStatement 和 mockResultSet 等進(jìn)行驗(yàn)證。如果將上例中 expectLastCall().andReturn(false).times(1) 的預(yù)期次數(shù)修改為2，在 Eclipse 中將可以看到：

Mock 對象的重用

為 了避免生成過多的 Mock 對象，EasyMock 允許對原有 Mock 對象進(jìn)行重用。要對 Mock 對象重新初始化，我們可以采用 reset 方法。和 replay 和 verify 方法類似，EasyMock 提供了兩種 reset 方式：（1）如果 Mock 對象是由 org.easymock.EasyMock 類中的靜態(tài)方法 createMock 生成的，那么該 Mock 對象的可以用 EasyMock 類的靜態(tài)方法 reset 重新初始化；（2）如果 Mock 方法是由 IMocksControl 實(shí)例的 createMock 方法生成的，那么該 IMocksControl 實(shí)例方法 reset 的調(diào)用將會(huì)把所有該實(shí)例創(chuàng)建的 Mock 對象重新初始化。

在重新初始化之后，Mock 對象的狀態(tài)將被置為 Record 狀態(tài)。

回頁首

3．在 EasyMock 中使用參數(shù)匹配器

EasyMock 預(yù)定義的參數(shù)匹配器

在使用 Mock 對象進(jìn)行實(shí)際的測試過程中，EasyMock 會(huì)根據(jù)方法名和參數(shù)來匹配一個(gè)預(yù)期方法的調(diào)用。EasyMock 對參數(shù)的匹配默認(rèn)使用 equals() 方法進(jìn)行比較。這可能會(huì)引起一些問題。例如在上一章節(jié)中創(chuàng)建的mockStatement對象：

mockStatement.executeQuery("SELECT * FROM sales_order_table");

            expectLastCall().andStubReturn(mockResultSet);

            

在實(shí)際 的調(diào)用中，我們可能會(huì)遇到 SQL 語句中某些關(guān)鍵字大小寫的問題，例如將 SELECT 寫成 Select，這時(shí)在實(shí)際的測試中，EasyMock 所采用的默認(rèn)匹配器將認(rèn)為這兩個(gè)參數(shù)不匹配，從而造成 Mock 對象的預(yù)期方法不被調(diào)用。EasyMock 提供了靈活的參數(shù)匹配方式來解決這個(gè)問題。如果您對 mockStatement 具體執(zhí)行的語句并不關(guān)注，并希望所有輸入的字符串都能匹配這一方法調(diào)用，您可以用 org.easymock.EasyMock 類所提供的 anyObject 方法來代替參數(shù)中的 SQL 語句：

mockStatement.executeQuery( anyObject() );

            expectLastCall().andStubReturn(mockResultSet);

            

anyObject 方法表示任意輸入值都與預(yù)期值相匹配。除了 anyObject 以外，EasyMock還提供了多個(gè)預(yù)先定義的參數(shù)匹配器，其中比較常用的一些有：

• aryEq(X value)：通過Arrays.equals()進(jìn)行匹配，適用于數(shù)組對象；
• isNull()：當(dāng)輸入值為Null時(shí)匹配；
• notNull()：當(dāng)輸入值不為Null時(shí)匹配；
• same(X value)：當(dāng)輸入值和預(yù)期值是同一個(gè)對象時(shí)匹配；
• lt(X value), leq(X value), geq(X value), gt(X value)：當(dāng)輸入值小于、小等于、大等于、大于預(yù)期值時(shí)匹配，適用于數(shù)值類型；
• startsWith(String prefix), contains(String substring), endsWith(String suffix)：當(dāng)輸入值以預(yù)期值開頭、包含預(yù)期值、以預(yù)期值結(jié)尾時(shí)匹配，適用于String類型；
• matches(String regex)：當(dāng)輸入值與正則表達(dá)式匹配時(shí)匹配，適用于String類型。

自定義參數(shù)匹配器

預(yù)定義的參數(shù)匹配器可能無法滿足一些復(fù)雜的情況，這時(shí)你需要定義自己的參數(shù)匹配器。在上一節(jié)中，我們希望能有一個(gè)匹配器對 SQL 中關(guān)鍵字的大小寫不敏感，使用 anyObject 其實(shí)并不是一個(gè)好的選擇。對此，我們可以定義自己的參數(shù)匹配器 SQLEquals。

要定義新的參數(shù)匹配器，需要實(shí)現(xiàn) org.easymock.IArgumentMatcher 接口。其中，matches(Object actual) 方法應(yīng)當(dāng)實(shí)現(xiàn)輸入值和預(yù)期值的匹配邏輯，而在 appendTo(StringBuffer buffer) 方法中，你可以添加當(dāng)匹配失敗時(shí)需要顯示的信息。以下是 SQLEquals 實(shí)現(xiàn)的部分代碼（完整的代碼可以在 src.zip 中找到）：

                

            public class SQLEquals implements IArgumentMatcher {

            private String expectedSQL = null;

            public SQLEquals(String expectedSQL) {

            this.expectedSQL = expectedSQL;

            }

            ......

            public boolean matches(Object actualSQL) {

            if (actualSQL == null && expectedSQL == null)

            return true;

            else if (actualSQL instanceof String)

            return expectedSQL.equalsIgnoreCase((String) actualSQL);

            else

            return false;

            }

            }

            

在實(shí)現(xiàn)了 IArgumentMatcher 接口之后，我們需要寫一個(gè)靜態(tài)方法將它包裝一下。這個(gè)靜態(tài)方法的實(shí)現(xiàn)需要將 SQLEquals 的一個(gè)對象通過 reportMatcher 方法報(bào)告給EasyMock：

                

            public static String sqlEquals(String in) {

            reportMatcher(new SQLEquals(in));

            return in;

            }

            

這樣，我們自定義的 sqlEquals 匹配器就可以使用了。我們可以將上例中的 executeQuery 方法設(shè)定修改如下：

mockStatement.executeQuery(sqlEquals("SELECT * FROM sales_order_table"));

            expectLastCall().andStubReturn(mockResultSet);

            

4．特殊的 Mock 對象類型

到 目前為止，我們所創(chuàng)建的 Mock 對象都屬于 EasyMock 默認(rèn)的 Mock 對象類型，它對預(yù)期方法的調(diào)用次序不敏感，對非預(yù)期的方法調(diào)用拋出 AssertionError。除了這種默認(rèn)的 Mock 類型以外，EasyMock 還提供了一些特殊的 Mock 類型用于支持不同的需求。

Strick Mock 對象

如果 Mock 對象是通過 EasyMock.createMock() 或是 IMocksControl.createMock() 所創(chuàng)建的，那么在進(jìn)行 verify 驗(yàn)證時(shí)，方法的調(diào)用順序是不進(jìn)行檢查的。如果要?jiǎng)?chuàng)建方法調(diào)用的先后次序敏感的 Mock 對象（Strick Mock），應(yīng)該使用 EasyMock.createStrickMock() 來創(chuàng)建，例如：

ResultSet strickMockResultSet = createStrickMock(ResultSet.class);

            

類似于 createMock，我們同樣可以用 IMocksControl 實(shí)例來創(chuàng)建一個(gè) Strick Mock 對象：

IMocksControl control = EasyMock.createStrictControl();

            ResultSet strickMockResultSet = control.createMock(ResultSet.class);

            

Nice Mock 對象

使用 createMock() 創(chuàng)建的 Mock 對象對非預(yù)期的方法調(diào)用默認(rèn)的行為是拋出 AssertionError，如果需要一個(gè)默認(rèn)返回0，null 或 false 等"無效值"的 "Nice Mock" 對象，可以通過 EasyMock 類提供的 createNiceMock() 方法創(chuàng)建。類似的，你也可以用 IMocksControl 實(shí)例來創(chuàng)建一個(gè) Nice Mock 對象。

回頁首

5．EasyMock 的工作原理

EasyMock 是如何為一個(gè)特定的接口動(dòng)態(tài)創(chuàng)建 Mock 對象，并記錄 Mock 對象預(yù)期行為的呢？其實(shí)，EasyMock 后臺(tái)處理的主要原理是利用 java.lang.reflect.Proxy 為指定的接口創(chuàng)建一個(gè)動(dòng)態(tài)代理，這個(gè)動(dòng)態(tài)代理，就是我們在編碼中用到的 Mock 對象。EasyMock 還為這個(gè)動(dòng)態(tài)代理提供了一個(gè) InvocationHandler 接口的實(shí)現(xiàn)，這個(gè)實(shí)現(xiàn)類的主要功能就是將動(dòng)態(tài)代理的預(yù)期行為記錄在某個(gè)映射表中和在實(shí)際調(diào)用時(shí)從這個(gè)映射表中取出預(yù)期輸出。下圖是 EasyMock 中主要的功能類：

和開發(fā)人員聯(lián)系最緊密的是 EasyMock 類，這個(gè)類提供了 createMock、replay、verify 等方法以及所有預(yù)定義的參數(shù)匹配器。

我們知道 Mock 對象有兩種創(chuàng)建方式：一種是通過 EasyMock 類提供的 createMock 方法創(chuàng)建，另一種是通過 EasyMock 類的 createControl 方法得到一個(gè) IMocksControl 實(shí)例，再由這個(gè) IMocksControl 實(shí)例創(chuàng)建 Mock 對象。其實(shí)，無論通過哪種方法獲得 Mock 對象，EasyMock 都會(huì)生成一個(gè) IMocksControl 的實(shí)例，只不過第一種方式中的 IMocksControl 的實(shí)例對開發(fā)人員不可見而已。這個(gè) IMocksControl 的實(shí)例，其實(shí)就是 MocksControl 類的一個(gè)對象。MocksControl 類提供了 andReturn、andThrow、times、createMock 等方法。

MocksControl 類中包含了兩個(gè)重要的成員變量，分別是接口 IMocksBehavior 和 IMocksControlState 的實(shí)例。其中，IMocksBehavior 的實(shí)現(xiàn)類 MocksBehavior 是 EasyMock 的核心類，它保存著一個(gè) ExpectedInvocationAndResult 對象的一個(gè)列表，而 ExpectedInvocationAndResult 對象中包含著 Mock 對象方法調(diào)用和預(yù)期結(jié)果的映射。MocksBehavior 類提供了 addExpected 和 addActual 方法用于添加預(yù)期行為和實(shí)際調(diào)用。

MocksControl 類中包含的另一個(gè)成員變量是 IMocksControlState 實(shí)例。IMocksControlState 擁有兩個(gè)不同的實(shí)現(xiàn)類：RecordState 和 ReplayState。顧名思義，RecordState 是 Mock 對象在 Record 狀態(tài)時(shí)的支持類，它提供了 invoke 方法在 Record 狀態(tài)下的實(shí)現(xiàn)。此外，它還提供了 andReturn、andThrow、times 等方法的實(shí)現(xiàn)。ReplayState 是 Mock 對象在 Replay 狀態(tài)下的支持類，它提供了 invoke 方法在 Replay 狀態(tài)下的實(shí)現(xiàn)。在 ReplayState 中，andReturn、andThrow、times 等方法的實(shí)現(xiàn)都是拋出IllegalStateException，因?yàn)樵?Replay 階段，開發(fā)人員不應(yīng)該再調(diào)用這些方法。

當(dāng)我們調(diào)用 MocksControl 的 createMock 方法時(shí)，該方法首先會(huì)生成一個(gè) JavaProxyFactory 類的對象。JavaProxyFactory 是接口 IProxyFactory 的實(shí)現(xiàn)類，它的主要功能就是通過 java.lang.reflect.Proxy 對指定的接口創(chuàng)建動(dòng)態(tài)代理實(shí)例，也就是開發(fā)人員在外部看到的 Mock 對象。

在創(chuàng)建動(dòng)態(tài)代理的同時(shí)，應(yīng)當(dāng)提供 InvocationHandler 的實(shí)現(xiàn)類。MockInvocationHandler 實(shí)現(xiàn)了這個(gè)接口，它的 invoke 方法主要的功能是根據(jù) Mock 對象狀態(tài)的不同而分別調(diào)用 RecordState 的 invoke 實(shí)現(xiàn)或是 ReplayState 的 invoke 實(shí)現(xiàn)。

創(chuàng)建 Mock 對象

下圖是創(chuàng)建 Mock 對象的時(shí)序圖：

當(dāng) EasyMock 類的 createMock 方法被調(diào)用時(shí)，它首先創(chuàng)建一個(gè) MocksControl 對象，并調(diào)用該對象的 createMock 方法創(chuàng)建一個(gè) JavaProxyFactory 對象和一個(gè) MockInvocationHandler 對象。JavaProxyFactory 對象將 MockInvocationHandler 對象作為參數(shù)，通過 java.lang.reflect.Proxy 類的 newProxyInstance 靜態(tài)方法創(chuàng)建一個(gè)動(dòng)態(tài)代理。

記錄 Mock 對象預(yù)期行為

記錄 Mock 的預(yù)期行為可以分為兩個(gè)階段：預(yù)期方法的調(diào)用和預(yù)期輸出的設(shè)定。在外部程序中獲得的 Mock 對象，其實(shí)就是由 JavaProxyFactory 創(chuàng)建的指定接口的動(dòng)態(tài)代理，所有外部程序?qū)涌诜椒ǖ恼{(diào)用，都會(huì)指向 InvocationHandler 實(shí)現(xiàn)類的 invoke 方法。在 EasyMock 中，這個(gè)實(shí)現(xiàn)類是 MockInvocationHandler。下圖是調(diào)用預(yù)期方法的時(shí)序圖：

當(dāng) MockInvocationHandler 的 invoke 方法被調(diào)用時(shí)，它首先通過 reportLastControl 靜態(tài)方法將 Mock 對象對應(yīng)的 MocksControl 對象報(bào)告給 LastControl 類，LastControl 類將該對象保存在一個(gè) ThreadLocal 變量中。接著，MockInvocationHandler 將創(chuàng)建一個(gè) Invocation 對象，這個(gè)對象將保存預(yù)期調(diào)用的 Mock 對象、方法和預(yù)期參數(shù)。

在記錄 Mock 對象預(yù)期行為時(shí)，Mock 對象的狀態(tài)是 Record 狀態(tài)，因此 RecordState 對象的 invoke 方法將被調(diào)用。這個(gè)方法首先調(diào)用 LastControl 的 pullMatchers 方法獲取參數(shù)匹配器。如果您還記得自定義參數(shù)匹配器的過程，應(yīng)該能想起參數(shù)匹配器被調(diào)用時(shí)會(huì)將實(shí)現(xiàn)類的實(shí)例報(bào)告給 EasyMock，而這個(gè)實(shí)例最終保存在 LastControl 中。如果沒有指定參數(shù)匹配器，默認(rèn)的匹配器將會(huì)返回給 RecordState。

根據(jù) Invocation 對象和參數(shù)匹配器，RecordState 將創(chuàng)建一個(gè) ExpectedInvocation 對象并保存下來。

在對預(yù)期方法進(jìn)行調(diào)用之后，我們可以對該方法的預(yù)期輸出進(jìn)行設(shè)定。我們以

expectLastCall().andReturn(X value).times(int times)

            

在預(yù)期方法被調(diào)用時(shí)，Mock 對象對應(yīng)的 MocksControl 對象引用已經(jīng)記錄在 LastControl 中，expectLastCall 方法通過調(diào)用 LastControl 的 lastControl 方法可以獲得這個(gè)引用。MocksControl 對象的 andReturn 方法在 Mock 對象 Record 狀態(tài)下會(huì)調(diào)用 RecordState 的 andReturn 方法，將設(shè)定的預(yù)期輸出以 Result 對象的形式記錄下來，保存在 RecordState 的 lastResult 變量中。

當(dāng) MocksControl 的 times 方法被調(diào)用時(shí)，它會(huì)檢查 RecordState 的 lastResult 變量是否為空。如果不為空，則將 lastResult 和預(yù)期方法被調(diào)用時(shí)創(chuàng)建的 ExpectedInvocation 對象一起，作為參數(shù)傳遞給 MocksBehavior 的 addExpected 方法。MocksBehavior 的 addExpected 方法將這些信息保存在數(shù)據(jù)列表中。

在 Replay 狀態(tài)下調(diào)用 Mock 對象方法

EasyMock 類的 replay 方法可以將 Mock 對象切換到 Replay 狀態(tài)。在 Replay 狀態(tài)下，Mock 對象將根據(jù)之前的設(shè)定返回預(yù)期輸出。下圖是 Replay 狀態(tài)下 Mock 對象方法調(diào)用的時(shí)序圖：

在 Replay 狀態(tài)下，MockInvocationHandler 會(huì)調(diào)用 ReplayState 的 invoke 方法。該方法會(huì)把 Mock 對象通過 MocksBehavior 的 addActual 方法添加到實(shí)際調(diào)用列表中，該列表在 verify 方法被調(diào)用時(shí)將被用到。同時(shí)，addActual 方法會(huì)根據(jù)實(shí)際方法調(diào)用與預(yù)期方法調(diào)用進(jìn)行匹配，返回對應(yīng)的 Result 對象。調(diào)用 Result 對象的 answer 方法就可以獲取該方法調(diào)用的輸出。

回頁首

6．使用 EasyMock 進(jìn)行單元測試小結(jié)

如 果您需要在單元測試中構(gòu)建 Mock 對象來模擬協(xié)同模塊或一些復(fù)雜對象，EasyMock 是一個(gè)可以選用的優(yōu)秀框架。EasyMock 提供了簡便的方法創(chuàng)建 Mock 對象：通過定義 Mock 對象的預(yù)期行為和輸出，你可以設(shè)定該 Mock 對象在實(shí)際測試中被調(diào)用方法的返回值、異常拋出和被調(diào)用次數(shù)。通過創(chuàng)建一個(gè)可以替代現(xiàn)有對象的 Mock 對象，EasyMock 使得開發(fā)人員在測試時(shí)無需編寫自定義的 Mock 對象，從而避免了額外的編碼工作和因此引入錯(cuò)誤的機(jī)會(huì)。

回頁首

下載

	關(guān)于下載方法的信息

參考資料

• 如果您想要獲得 EasyMock 完整的文檔和 API，您可以訪問 EasyMock 的主頁：http://www.easymock.org/。
  
  
• 您可以在 JUnit 的主頁上找到完整的文檔和相關(guān)下載：http://www.junit.org/index.htm。
  
  
• 通過 Developer Works 上的文章，您可以和其它的框架做比較：利用 Eclipse 進(jìn)行單元測試。
  
  

• 在Source Forge上，你可以下載到最新的 EasyMock 相關(guān)代碼：http://sourceforge.net/project/showfiles.php?group_id=82958。
  
  
• Eclipse 的相關(guān)下載可以在 http://www.eclipse.org/ 上找到。

作者簡介

		鄭閩睿是一名 IBM CSDL 的軟件工程師，具有豐富的 Java 開發(fā)經(jīng)驗(yàn)。現(xiàn)在正從事于 IBM 網(wǎng)上電子商務(wù)平臺(tái)項(xiàng)目的開發(fā)和支持工作。

		黃湘平是一名工作在IBM CSDL的高級(jí)軟件工程師，從1997年開始從事網(wǎng)絡(luò)開發(fā)設(shè)計(jì)工作。他對Java的網(wǎng)絡(luò)和Web開發(fā)有豐富的經(jīng)驗(yàn)，對底層協(xié)議也有一定的了解。現(xiàn)在正從事于頁面在線翻譯項(xiàng)目的開發(fā)和支持。你可以通過jobike@sina.com與黃湘平聯(lián)系。