掌握 PowerMockito 靜態方法

一、為什麼需要 PowerMockito

在傳統的單元測試中，我們使用的是 Junit 等測試框架來完成測試。這些框架往往只能測試到被測類中普通的方法，但很多時候，我們需要測試一些涉及到靜態方法、私有方法、構造方法、final 類、enum 等特殊情況的方法。這個時候，傳統的單元測試框架就顯得力不從心了。

此時，我們就需要藉助 PowerMockito，它可以幫助我們繞過一些限制，完成更加全面的測試工作。

二、使用 PowerMockito 繞過靜態方法的限制

下面我們以一個具體的案例來介紹 PowerMockito 如何解決無法測試靜態方法的問題。

1) 案例描述

現在我們要測試的類是一個日誌記錄器 Logger，其中有一個靜態方法 write，可以將日誌信息寫入到文件中。

public class Logger {
    public static void write(String message) {
        // 將日誌信息寫入到文件中
    }
}

假設我們需要測試如下的 Printer 類：

public class Printer {
    public void print(String message) {
        Logger.write(message);
        // 還有其他代碼
    }
}

在傳統的單元測試框架中，我們無法測試 print 方法中調用的 Logger.write 方法，因為 Logger.write 是一個靜態方法。此時，我們需要使用 PowerMockito 來解決這個問題。

2) 解決方法

首先，我們需要在測試類中使用 PowerMockito.mockStatic 方法創建一個被測類中靜態方法的 Mock 對象：

@RunWith(PowerMockRunner.class)
@PrepareForTest({Logger.class})
public class PrinterTest {

    @Test
    public void printTest() {
        PowerMockito.mockStatic(Logger.class);
        // 此處省略其他測試代碼
    }
}

mockStatic 方法中傳入的參數就是我們需要測試的類中的靜態方法所在的類名。在本例中，需要測試的類是 Printer，其調用了 Logger.write 靜態方法，因此我們傳入的參數是 Logger.class。

接下來，我們可以使用 PowerMockito.when(xxx) 和 PowerMockito.verify(xxx) 方法來模擬和驗證被測方法中的靜態方法的行為：

@RunWith(PowerMockRunner.class)
@PrepareForTest({Logger.class})
public class PrinterTest {

    @Test
    public void printTest() {
        PowerMockito.mockStatic(Logger.class);

        Printer printer = new Printer();
        String message = "hello world";
        printer.print(message);

        PowerMockito.verifyStatic(Logger.class);
        Logger.write(message);
    }
}

在上面的代碼中，我們使用 PowerMockito.verifyStatic 方法來驗證 Logger.write 方法是否被正確地執行。同時，我們在執行被測方法前，需要先創建一個 Printer 對象，並傳入需要列印的信息 message。

三、使用 PowerMockito 繞過私有方法的限制

在進行單元測試時，有時候我們需要測試這個類中的某一個私有方法，但是傳統的單元測試框架並不支持測試私有方法。這個時候，我們需要使用 PowerMockito 來解決這個問題。

1) 解決方法

首先，我們需要在測試類中使用 PowerMockito.spy 方法來創建一個被測類的 Spy 對象。Spy 對象是可以調用被測類中的私有方法的。

@RunWith(PowerMockRunner.class)
public class CalculatorTest {

    @Test
    public void testAdd() throws Exception {
        Calculator calculator = new Calculator();
        Calculator calculatorSpy = PowerMockito.spy(calculator);

        // 這裡調用 calculatorSpy 中的私有方法
        int result = (int) PowerMockito.invokeMethod(calculatorSpy, "addHelper", 1, 2);

        assertEquals(3, result);
    }
}

在上面的代碼中，我們先創建一個 Calculator 對象，然後使用 PowerMockito.spy 方法來創建一個 Calculator 的 Spy 對象 calculatorSpy。接著，我們使用 PowerMockito.invokeMethod 方法來調用 calculatorSpy 中的私有方法 addHelper，並將 1 和 2 作為參數傳入。

四、使用 PowerMockito 繞過構造方法的限制

在進行單元測試時，有時候我們需要測試一些沒有無參構造函數的類，但是傳統的單元測試框架並不支持測試這樣的類。這個時候，我們需要使用 PowerMockito 來解決這個問題。

1) 案例描述

現在我們要測試的是一個沒有無參構造函數的類 AndroidDevice，它具有一個有參構造函數，接受一個設備名稱作為參數：

public class AndroidDevice {
    private String deviceName;

    public AndroidDevice(String deviceName) {
        this.deviceName = deviceName;
    }

    public String getDeviceName() {
        return deviceName;
    }
}

我們在測試中需要創建一個 AndroidDevice 對象，並調用 getDeviceName 方法來驗證其正確性。

2) 解決方法

我們可以使用 PowerMockito.whenNew(xxx.class).withArguments(xxx).thenReturn(xxx) 方法來創建一個沒有無參構造函數的類的 Mock 對象，並為其設置返回值：

@RunWith(PowerMockRunner.class)
@PrepareForTest({AndroidDevice.class})
public class DeviceManagerTest {

    @Test
    public void testGetDeviceName() throws Exception {
        AndroidDevice androidDeviceMock = PowerMockito.mock(AndroidDevice.class);
        whenNew(AndroidDevice.class).withArguments("設備1").thenReturn(androidDeviceMock);

        DeviceManager deviceManager = new DeviceManager();
        String deviceName = deviceManager.getDeviceName("設備1");

        assertEquals("設備1", deviceName);
    }
}

在上面的代碼中，我們首先使用 PowerMockito.mock 方法創建一個 AndroidDevice 的 Mock 對象 androidDeviceMock。然後，我們使用 PowerMockito.whenNew 方法，來模擬 AndroidDevice 類的有參構造方法，並將 “設備1” 作為參數傳入，並將 androidDeviceMock 設置為其返回值。

五、使用 PowerMockito 繞過 final 類和 enum 的限制

在進行單元測試時，有時候我們需要測試一些 final 類和 enum，但是傳統的單元測試框架並不支持測試這樣的類。這個時候，我們需要使用 PowerMockito 來解決這個問題。

1) 解決方法

我們可以使用 PowerMockito.mock 方法來創建 final 類和 enum 的 Mock 對象：

@RunWith(PowerMockRunner.class)
@PrepareForTest({FinalClass.class, EnumClass.class})
public class ClassTest {

    @Test
    public void testFinalClass() {
        FinalClass finalClassMock = PowerMockito.mock(FinalClass.class);
        PowerMockito.when(finalClassMock.finalMethod()).thenReturn("mock");
        String result = finalClassMock.finalMethod();
        assertEquals("mock", result);
    }

    @Test
    public void testEnumClass() {
        EnumClass enumClassMock = PowerMockito.mock(EnumClass.class);
        PowerMockito.when(enumClassMock.getName()).thenReturn("mock");
        String result = enumClassMock.getName();
        assertEquals("mock", result);
    }
}

在上面的代碼中，我們分別使用 PowerMockito.mock 方法創建 FinalClass 類和 EnumClass 類的 Mock 對象 finalClassMock 和 enumClassMock。然後，我們使用 PowerMockito.when 方法，來預設 Mock 對象的行為。在測試 FinalClass 類時，我們需要調用 final 方法 finalMethod，因此我們在設置行為時需要使用 finalClassMock.finalMethod()。而在測試 EnumClass 類時，我們需要調用枚舉類中的 getName 方法，因此我們在設置行為時需要使用 enumClassMock.getName()。