單元測試之Mockito與PowerMock

什麼是Mock？

在單元測試中，我們往往想去獨立地去測一個類中的某個方法，但是這個類可不是獨立的，它會去調用一些其它類的方法和service，這也就導緻了以下兩個問題：

• 外部服務可能無法在單元測試的環境中正常工作，因為它們可能需要通路資料庫或者使用一些其它的外部系統。
• 我們的測試關注點在于這個類的實作上，外部類的一些行為可能會影響到我們對本類的測試，那也就失去了我們進行單測的意義。

為了解決這種問題，Mockito和PowerMock誕生了。這兩種工具都可以用一個虛拟的對象來替換那些外部的、不容易構造的對象，便于我們進行單元測試。兩者的不同點在于Mockito對于大多數的标準單測case都很适用，而PowerMock可以去解決一些更難的問題（比如靜态方法、私有方法等）。

Mockito

話不多說，就上幹貨。在下面這個例子中，我們要測試的class是

DummyService

，

DummyRepository

用來從資料庫中擷取資料。

getDummyNameUpperCase()

方法會根據id擷取資料，且該方法有一些資料處理的邏輯，如果我們隻想測試這個邏輯：

public class DummyServiceTest {
 
    @Mock
    private DummyRepository dummyRepository;
 
    @InjectMocks
    private DummyService dummyService;
 
    @Before
    public void setUp() throws Exception {
        MockitoAnnotations.initMocks(this);
    }
 
    @Test
    public void getDummyNameUpperCase() {
 
        Dummy mockedDummy = new Dummy("dm1", "Dummy 1", "This is dummy 1", , true);
        when(dummyRepository.findById("dm1")).thenReturn(mockedDummy);
 
        String result = dummyService.getDummyNameUpperCase("dm1");

        verify(dummyRepository, times()).findById("dm1");
        assertThat(result, is("DUMMY 1"));
    }
}
                

根據經驗，在大多數項目中，都會使用一些依賴注入架構（PicoContainer、Avalon、Excalibur等），是以這裡的例子是基于Spring且我們使用了對應的Mockito注釋

@Mock

來建立虛拟對象。對于被測class，使用

@injectMocks

進行注釋即可。

實際上，mock的發生時機是當程式執行至”when-method-call-then-return”之類的語句時，上例中，也就是執行到

when(dummyRepository.findById("dm1")).thenReturn(mockedDummy)

時，mock就已經發生了；當程式運作至

verify(dummyRepository, times(1)).findById("dm1")

類的語句時，我們可以确認的是方法已經被調用了，這在測試一個類的邏輯流程時格外地有效。

上例展示了Mockito的基本用法，然後實際測試可能不會這麼簡單。比如我們需要将對象傳遞給mock的對象作為參數時，需要使用

doAnswer

：

@Test
public void testAddressCombination() {
 

    Customer customer = new Customer("100089", "Zhang San", "1 Zhongguancun East Rd");
 
    doAnswer(new Answer<Customer>() {
        @Override
        public Customer answer(InvocationOnMock invocation) throws Throwable {
            Object originalArgument = (invocation.getArguments())[];
            Customer param = (Customer) originalArgument;
            param.setHost("TestHost");
            return null;
        }
    }).when(hostService).expand(any(Customer.class));
 
    when(addressService.getPLZForCustomer(customer)).thenReturn();
    doNothing().when(addressService).updateExternalSystems(customer);
 

    String address = customerService.getAddressCombination(customer, true);
 

    Mockito.verify(addressService, times()).updateExternalSystems(any(Customer.class));
    assertThat(address, is("47891_1 Zhongguancun East Rd_TestHost"));
}
                

以上的兩個例子足以延伸并cover掉大部分普通的單測case，但是如果方法是靜态的該怎麼辦呢？那就是——PowerMock。

PowerMock

PowerMock基本上cover了所有Mockito不能支援的case（大多數情況也就是靜态方法，但其實也可以支援私有方法和構造函數的調用）。PowerMock使用了位元組碼操作，是以它是自帶Junit runner的。在使用PowerMock時，必須使用

@PrepareForTest

注釋被測類，mock才會被執行：

@RunWith(PowerMockRunner.class)
@PrepareForTest({StaticService.class})
public class DummyServiceTest {
 
    @Mock
    private DummyRepository dummyRepository;
 
    @InjectMocks
    private DummyService dummyService;
 
    @Before
    public void setUp() throws Exception {
        MockitoAnnotations.initMocks(this);
    }
 
    @Test
    public void readDummyDescriptionWithoutIOException() throws IOException {
 
        String fileName = "DummyName";
 
        mockStatic(StaticService.class);
        when(StaticService.readFile(fileName)).thenReturn("Dummy");
 
        String value = dummyService.readDummyDescription(fileName);
 
        verifyStatic(times());
        StaticService.readFile(fileName);
        assertThat(value, equalTo("Dummy"));
    }
}
                

從上例可以看出，PowerMock的寫法與Mockito基本相同，主要原因是PowerMock其實是從Mockito的一個特殊的API衍化而來，我們從Maven的摘錄中可以看到，我們不僅導入了PowerMock Junit-module，還導入了Mockito-API：

<dependency>
    <groupId>org.powermock</groupId>
    <artifactId>powermock-module-junit4</artifactId>
    <version>1.6.4</version>
    <scope>test</scope>
</dependency>
 
<dependency>
    <groupId>org.powermock</groupId>
    <artifactId>powermock-api-mockito</artifactId>
    <version>1.6.4</version>
    <scope>test</scope>
    </dependency>
           

注意，被測類如果包含了靜态方法，必須使用

mockStatic()

方法；與Mockito相似，當程式執行至when-then-mocking類語句時，我們可以認為方法被成功調用了。

PowerMock另外一個很好用的特性是當使用

@PowerMockRunnerDelegate

作為代理。比如在Spring中一般使用的是SpringJUnit4ClassRunner，但是這樣

@PrepairForTest

就不能用了，是以：

@RunWith(PowerMockRunner.class)
@PowerMockRunnerDelegate(Parameterized.class)
@PrepareForTest({StaticService.class})
public class DummyServiceTest {
...
}
                

總結

Mockito提供了可讀性較強、易于使用的mocking測試方法，而PowerMock提供了Mockito-like API是它使用方法基本與Mockito有很大類似，且它能解決靜态方法、私有方法等“問題方法”