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 物件重新初始化。

相關推薦