EasyMock 使用方法與原理剖析_EasyMock

Mock 方法是單元測試中常見的一種技術，它的主要作用是類比一些在應用中不容易構造或者比較複雜的對象，從而把測試與測試邊界以外的對象隔離開。

編寫自訂的 Mock 對象需要額外的編碼工作，同時也可能引入錯誤。EasyMock 提供了根據指定介面動態構建 Mock 對象的方法，避免了手工編寫 Mock 對象。本文將向您展示如何使用 EasyMock 進行單元測試，並對 EasyMock 的原理進行分析。 1．Mock 對象與 EasyMock 簡介 單元測試與 Mock 方法

單元測試是對應用中的某一個模組的功能進行驗證。在單元測試中，我們常遇到的問題是應用中其它的協同模組尚未開發完成，或者被測試模組需要和一些不容易構造、比較複雜的對象進行互動。另外，由於不能肯定其它模組的正確性，我們也無法確定測試中發現的問題是由哪個模組引起的。

Mock 對象能夠類比其它協同模組的行為，被測試模組通過與 Mock 對象協作，可以獲得一個孤立的測試環境。此外，使用 Mock 對象還可以類比在應用中不容易構造（如 HttpServletRequest 必須在 Servlet 容器中才能構造出來）和比較複雜的對象（如 JDBC 中的 ResultSet 對象），從而使測試順利進行。 EasyMock 簡介

手動的構造 Mock 對象會給開發人員帶來額外的編碼量，而且這些為建立 Mock 對象而編寫的代碼很有可能引入錯誤。目前，有許多開源項目對動態構建 Mock 對象提供了支援，這些項目能夠根據現有的介面或類動態產生，這樣不僅能避免額外的編碼工作，同時也降低了引入錯誤的可能。

EasyMock 是一套用於通過簡單的方法對於給定的介面產生 Mock 對象的類庫。它提供對介面的類比，能夠通過錄製、回放、檢查三步來完成大體的測試過程，可以驗證方法的調用種類、次數、順序，可以令 Mock 對象返回指定的值或拋出指定異常。通過 EasyMock，我們可以方便的構造 Mock 對象從而使單元測試順利進行。 安裝 EasyMock

EasyMock 是採用 MIT license 的一個開源項目，您可以在 Sourceforge 上下載到相關的 zip 檔案。目前您可以下載的 EasyMock 最新版本是2.3，它需要運行在 Java 5.0 平台上。如果您的應用運行在 Java 1.3 或 1.4 平台上，您可以選擇 EasyMock1.2。在解壓縮 zip 包後，您可以找到 easymock.jar 這個檔案。如果您使用 Eclipse 作為 IDE，把 easymock.jar 添加到項目的 Libraries 裡就可以使用了（如下圖所示）。此外，由於我們的測試案例運行在 JUnit 環境中，因此您還需要 JUnit.jar（版本3.8.1以上）。 圖1：Eclipse 項目中的 Libraries

回頁首 2．使用 EasyMock 進行單元測試

通過 EasyMock，我們可以為指定的介面動態建立 Mock 對象，並利用 Mock 對象來類比協同模組或是領域對象，從而使單元測試順利進行。這個過程大致可以劃分為以下幾個步驟： 使用 EasyMock 產生 Mock 對象； 設定 Mock 對象的預期行為和輸出； 將 Mock 對象切換到 Replay 狀態； 調用 Mock 對象方法進行單元測試； 對 Mock 對象的行為進行驗證。

接下來，我們將對以上的幾個步驟逐一進行說明。除了以上的基本步驟外，EasyMock 還對特殊的 Mock 物件類型、特定的參數匹配方式等功能提供了支援，我們將在之後的章節中進行說明。 使用 EasyMock 產生 Mock 對象

根據指定的介面或類，EasyMock 能夠動態建立 Mock 對象（EasyMock 預設只支援為介面產生 Mock 對象，如果需要為類產生 Mock 對象，在 EasyMock 的首頁上有擴充包可以實現此功能），我們以 ResultSet 介面為例說明EasyMock的功能。java.sql.ResultSet 是每一個 Java 開發人員都非常熟悉的介面： 清單1：ResultSet 介面

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

通常，構建一個真實的 RecordSet 對象需要經過一個複雜的過程：在開發過程中，開發人員通常會編寫一個 DBUtility 類來擷取資料庫連接 Connection，並利用 Connection 建立一個 Statement。執行一個 Statement 可以擷取到一個或多個 ResultSet 對象。這樣的構造過程複雜並且依賴於資料庫的正確運行。資料庫或是資料庫互動模組出現問題，都會影響單元測試的結果。

我們可以使用 EasyMock 動態構建 ResultSet 介面的 Mock 對象來解決這個問題。一些簡單的測試案例只需要一個 Mock 對象，這時，我們可以用以下的方法來建立 Mock 對象：

ResultSet mockResultSet = createMock(ResultSet.class);

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

如果需要在相對複雜的測試案例中使用多個 Mock 對象，EasyMock 提供了另外一種產生和管理 Mock 對象的機制：

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 方法能建立一個介面 IMocksControl 的對象，該對象能建立並管理多個 Mock 對象。如果需要在測試中使用多個 Mock 對象，我們推薦您使用這一機制，因為它在多個 Mock 對象的管理上提供了相對便捷的方法。

如果您要類比的是一個具體類而非介面，那麼您需要下載擴充包 EasyMock Class Extension 2.2.2。在對具體類進行類比時，您只要用 org.easymock.classextension.EasyMock 類中的靜態方法代替 org.easymock.EasyMock 類中的靜態方法即可。 設定 Mock 對象的預期行為和輸出

在一個完整的測試過程中，一個 Mock 對象將會經曆兩個狀態：Record 狀態和 Replay 狀態。Mock 對象一經建立，它的狀態就被置為 Record。在 Record 狀態，使用者可以設定 Mock 對象的預期行為和輸出，這些對象行為被錄製下來，儲存在 Mock 對象中。

添加 Mock 對象行為的過程通常可以分為以下3步： 對 Mock 對象的特定方法作出調用； 通過 org.easymock.EasyMock 提供的靜態方法 expectLastCall 擷取上一次方法調用所對應的 IExpectationSetters 執行個體； 通過 IExpectationSetters 執行個體設定 Mock 對象的預期輸出。

設定預期傳回值

Mock 對象的行為可以簡單的理解為 Mock 對象方法的調用和方法調用所產生的輸出。在 EasyMock 2.3 中，對 Mock 對象行為的添加和設定是通過介面 IExpectationSetters 來實現的。Mock 對象方法的調用可能產生兩種類型的輸出：（1）產生傳回值；（2）拋出異常。介面 IExpectationSetters 提供了多種設定預期輸出的方法，其中和設定傳回值相對應的是 andReturn 方法：

IExpectationSetters<T> andReturn(T value);

我們仍然用 ResultSet 介面的 Mock 對象為例，如果希望方法 mockResult.getString(1) 的傳回值為 "My return value"，那麼你可以使用以下的語句：

mockResultSet.getString(1);expectLastCall().andReturn("My return value");

以上的語句表示 mockResultSet 的 getString 方法被調用一次，這次調用的傳回值是 "My return value"。有時，我們希望某個方法的調用總是返回一個相同的值，為了避免每次調用都為 Mock 對象的行為進行一次設定，我們可以用設定預設傳回值的方法：

void andStubReturn(Object value);

假設我們建立了 Statement 和 ResultSet 介面的 Mock 對象 mockStatement 和 mockResultSet，在測試過程中，我們希望 mockStatement 對象的 executeQuery 方法總是返回 mockResultSet，我們可以使用如下的語句

mockStatement.executeQuery("SELECT * FROM sales_order_table");expectLastCall().andStubReturn(mockResultSet);

EasyMock 在對參數值進行匹配時，預設採用 Object.equals() 方法。因此，如果我們以 "select * from sales_order_table" 作為參數，預期方法將不會被調用。如果您希望上例中的 SQL 陳述式能不區分大小寫，可以用特殊的參數匹配器來解決這個問題，我們將在 "在 EasyMock 中使用參數匹配器" 一章對此進行說明。

設定預期異常拋出

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

IExpectationSetters<T> andThrow(Throwable throwable);

和設定預設傳回值類似，IExpectationSetters 介面也提供了設定拋出預設異常的函數：

void andStubThrow(Throwable throwable);

設定預期方法調用次數

通過以上的函數，您可以對 Mock 對象特定行為的預期輸出進行設定。除了對預期輸出進行設定，IExpectationSetters 介面還允許使用者對方法的調用次數作出限制。在 IExpectationSetters 所提供的這一類方法中，常用的一種是 times 方法：

IExpectationSetters<T>times(int count);

該方法可以 Mock 對象方法的調用次數進行確切的設定。假設我們希望 mockResultSet 的 getString 方法在測試過程中被調用3次，期間的傳回值都是 "My return value"，我們可以用如下語句：

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

注意到 andReturn 和 andThrow 方法的傳回值依然是一個 IExpectationSetters 執行個體，因此我們可以在此基礎上繼續調用 times 方法。

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

某些方法的傳回值類型是 void，對於這一類方法，我們無需設定傳回值，只要設定調用次數就可以了。以 ResultSet 介面的 close 方法為例，假設在測試過程中，該方法被調用3至5次：

mockResultSet.close();expectLastCall().times(3, 5);

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

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

這個語句和上例中的語句功能是完全相同的。 將 Mock 對象切換到 Replay 狀態

在產生 Mock 對象和設定 Mock 對象行為兩個階段，Mock 對象的狀態都是 Record 。在這個階段，Mock 對象會記錄使用者對預期行為和輸出的設定。

在使用 Mock 對象進行實際的測試前，我們需要將 Mock 對象的狀態切換為 Replay。在 Replay 狀態，Mock 對象能夠根據設定對特定的方法調用作出預期的響應。將 Mock 對象切換成 Replay 狀態有兩種方式，您需要根據 Mock 對象的產生方式進行選擇。如果 Mock 對象是通過 org.easymock.EasyMock 類提供的靜態方法 createMock 產生的（第1節中介紹的第一種 Mock 對象產生方法），那麼 EasyMock 類提供了相應的 replay 方法用於將 Mock 對象切換為 Replay 狀態：

replay(mockResultSet);

如果 Mock 對象是通過 IMocksControl 介面提供的 createMock 方法產生的（第1節中介紹的第二種Mock對象產生方法），那麼您依舊可以通過 IMocksControl 介面對它所建立的所有 Mock 對象進行切換：

control.replay();

以上的語句能將在第1節中產生的 mockConnection、mockStatement 和 mockResultSet 等3個 Mock 對象都切換成 Replay 狀態。 調用 Mock 對象方法進行單元測試

為了更好的說明 EasyMock 的功能，我們引入 src.zip 中的樣本來解釋 Mock 對象在實際測試階段的作用。其中所有的範例程式碼都可以在 src.zip 中找到。如果您使用的 IDE 是 Eclipse，在匯入 src.zip 之後您可以看到 Workspace 中增加的 project（如下圖所示）。 圖2：匯入 src.zip 後的 Workspace

下面是範例程式碼中的一個介面 SalesOrder，它的實作類別 SalesOrderImpl 的主要功能是從資料庫中讀取一個 Sales Order 的 Region 和 Total Price，並根據讀取的資料計算該 Sales Order 的 Price Level（完整的實現代碼都可以在 src.zip 中找到）： 清單2：SalesOrder 介面

public interface SalesOrder{  ……  public void loadDataFromDB(ResultSet resultSet) throws SQLException;  public String getPriceLevel();}

其實作類別 SalesOrderImpl 中對 loadDataFromDB 的實現如下： 清單3：SalesOrderImpl 實現

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 對象包含的資料。當我們將之前定義的 Mock 對象調整為 Replay 狀態，並將該對象作為參數傳入，那麼 Mock 對象的方法將會返回預先定義的預期傳回值。完整的 TestCase 如下： 清單4：完整的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();    }  }}

在這個樣本中，我們首先建立了 ResultSet 的 Mock 對象 moResultSet，並記錄該 Mock 對象的預期行為。之後我們調用了 control.replay()，將 Mock 對象的狀態置為 Replay 狀態。 在實際的測試階段，Sales Order 對象的 loadDataFromDB 方法調用了 mockResultSet 對象的 getString 和 getDouble 方法讀取 mockResultSet 中的資料。Sales Order 對象根據讀取的資料計算出 Price Level，並和預期輸出進行比較。 對 Mock 對象的行為進行驗證

在利用 Mock 對象進行實際的測試過程之後，我們還有一件事情沒有做：對 Mock 對象的方法調用的次數進行驗證。

為了驗證指定的方法調用真的完成了，我們需要調用 verify 方法進行驗證。和 replay 方法類似，您需要根據 Mock 對象的產生方式來選用不同的驗證方式。如果 Mock 對象是由 org.easymock.EasyMock 類提供的 createMock 靜態方法產生的，那麼我們同樣採用 EasyMock 類的靜態方法 verify 進行驗證：

verify(mockResultSet);

如果Mock對象是有 IMocksControl 介面所提供的 createMock 方法產生的，那麼採用該介面提供的 verify 方法，例如第1節中的 IMocksControl 執行個體 control：

control.verify();

將對 control 執行個體所產生的 Mock 對象 mockConnection、mockStatement 和 mockResultSet 等進行驗證。如果將上例中 expectLastCall().andReturn(false).times(1) 的預期次數修改為2，在 Eclipse 中將可以看到： 圖3：Mock對象驗證失敗 Mock 對象的重用

為了避免產生過多的 Mock 對象，EasyMock 允許對原有 Mock 對象進行重用。要對 Mock 對象重新初始化，我們可以採用 reset 方法。和 replay 和 verify 方法類似，EasyMock 提供了兩種 reset 方式：（1）如果 Mock 對象是由 org.easymock.EasyMock 類中的靜態方法 createMock產生的，那麼該 Mock 對象的可以用 EasyMock 類的靜態方法 reset 重新初始化；（2）如果 Mock 方法是由 IMocksControl 執行個體的 createMock 方法產生的，那麼該 IMocksControl 執行個體方法 reset 的調用將會把所有該執行個體建立的 Mock 對象重新初始化。

在重新初始化之後，Mock 對象的狀態將被置為 Record 狀態。

回頁首 3．在 EasyMock 中使用參數匹配器 EasyMock 預定義的參數匹配器

在使用 Mock 對象進行實際的測試過程中，EasyMock 會根據方法名和參數來匹配一個預期方法的調用。EasyMock 對參數的匹配預設使用 equals() 方法進行比較。這可能會引起一些問題。例如在上一章節中建立的mockStatement對象：

mockStatement.executeQuery("SELECT * FROM sales_order_table");expectLastCall().andStubReturn(mockResultSet);

在實際的調用中，我們可能會遇到 SQL 陳述式中某些關鍵字大小寫問題，例如將 SELECT 寫成 Select，這時在實際的測試中，EasyMock 所採用的預設匹配器將認為這兩個參數不匹配，從而造成 Mock 對象的預期方法不被調用。EasyMock 提供了靈活的參數匹配方式來解決這個問題。如果您對 mockStatement 具體執行的語句並不關注，並希望所有輸入的字串都能匹配這一方法調用，您可以用 org.easymock.EasyMock類所提供的 anyObject 方法來代替參數中的 SQL 陳述式：

mockStatement.executeQuery( anyObject() );expectLastCall().andStubReturn(mockResultSet);

anyObject 方法表示任意輸入值都與預期值相匹配。除了 anyObject 以外，EasyMock還提供了多個預先定義的參數匹配器，其中比較常用的一些有： aryEq(X value)：通過Arrays.equals()進行匹配，適用於數組對象； isNull()：當輸入值為Null時匹配； notNull()：當輸入值不為Null時匹配； same(X value)：當輸入值和預期值是同一個對象時匹配； lt(X value), leq(X value), geq(X value), gt(X value)：當輸入值小於、小等於、大等於、大於預期值時匹配，適用於數實值型別； startsWith(String prefix), contains(String substring), endsWith(String suffix)：當輸入值以預期值開頭、包含預期值、以預期值結尾時匹配，適用於String類型； matches(String regex)：當輸入值與Regex匹配時匹配，適用於String類型。 自訂參數匹配器

預定義的參數匹配器可能無法滿足一些複雜的情況，這時你需要定義自己的參數匹配器。在上一節中，我們希望能有一個匹配器對 SQL 中關鍵字的大小寫不敏感，使用 anyObject 其實並不是一個好的選擇。對此，我們可以定義自己的參數匹配器 SQLEquals。

要定義新的參數匹配器，需要實現 org.easymock.IArgumentMatcher 介面。其中，matches(Object actual) 方法應當實現輸入值和預期值的匹配邏輯，而在 appendTo(StringBuffer buffer) 方法中，你可以添加當匹配失敗時需要顯示的資訊。以下是 SQLEquals 實現的部分代碼（完整的代碼可以在 src.zip 中找到）： 清單5：自訂參數匹配器SQLEquals

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

在實現了 IArgumentMatcher 介面之後，我們需要寫一個靜態方法將它封裝一下。這個靜態方法的實現需要將 SQLEquals 的一個對象通過 reportMatcher 方法報告給EasyMock： 清單6：自訂參數匹配器 SQLEquals 靜態方法

public static String sqlEquals(String in) {  reportMatcher(new SQLEquals(in));  return in;}

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

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

在使用 executeQuery("select * from sales_order_table") 進行方法調用時，該預期行為將被匹配。

回頁首 4．特殊的 Mock 物件類型

到目前為止，我們所建立的 Mock 對象都屬於 EasyMock 預設的 Mock 物件類型，它對預期方法的調用次序不敏感，對非預期的方法調用拋出 AssertionError。除了這種預設的 Mock 類型以外，EasyMock 還提供了一些特殊的 Mock 類型用於支援不同的需求。 Strick Mock 對象

如果 Mock 對象是通過 EasyMock.createMock() 或是 IMocksControl.createMock() 所建立的，那麼在進行 verify 驗證時，方法的調用順序是不進行檢查的。如果要建立方法調用的先後次序敏感的 Mock 對象（Strick Mock），應該使用 EasyMock.createStrickMock() 來建立，例如：

ResultSet strickMockResultSet = createStrickMock(ResultSet.class);

類似於 createMock，我們同樣可以用 IMocksControl 執行個體來建立一個 Strick Mock 對象：

IMocksControl control = EasyMock.createStrictControl();ResultSet strickMockResultSet = control.createMock(ResultSet.class);

Nice Mock 對象