PowerMockito學習筆記--protected方法如何mock

PowerMockito使用詳解

　　一、PowerMock概述

      現如今比較流行的Mock工具如jMock,EasyMock,Mockito等都有一個共同的缺點：不能mock靜態、final、私有方法等。而PowerMock能夠完美的彌補以上三個Mock工具的不足。

      PowerMock是一個擴展了其它如EasyMock等mock框架的、功能更加強大的框架。PowerMock使用一個自定義類加載器和字節碼操作來模擬靜態方法，構造函數，final類和方法，私有方法，去除靜態初始化器等等。通過使用自定義的類加載器，簡化採用的IDE或持續集成服務器不需要做任何改變。熟悉PowerMock支持的mock框架的開發人員會發現PowerMock很容易使用，因爲對於靜態方法和構造器來說，整個的期望API是一樣的。PowerMock旨在用少量的方法和註解擴展現有的API來實現額外的功能。目前PowerMock支持EasyMock和Mockito。

      二、PowerMock入門    

      PowerMock有兩個重要的註解：

      –@RunWith(PowerMockRunner.class)

      –@PrepareForTest( { YourClassWithEgStaticMethod.class })

      如果你的測試用例裏沒有使用註解@PrepareForTest，那麼可以不用加註解@RunWith(PowerMockRunner.class)，反之亦然。當你需要使用PowerMock強大功能（Mock靜態、final、私有方法等）的時候，就需要加註解@PrepareForTest。

      三、PowerMock基本用法

　　 (1) 普通Mock：Mock參數傳遞的對象

1 2 3 4 5 6 7 8 9 10 11 12 13

//測試目標代碼： public boolean callArgumentInstance(File file) {     return file.exists(); }   //測試用例代碼： @Test public void testCallArgumentInstance() {     File file = PowerMockito.mock(File.class);     Source underTest = new Source();     PowerMockito.when(file.exists()).thenReturn(true);     Assert.assertTrue(underTest.callArgumentInstance(file)); }

 說明：普通Mock不需要加@RunWith和@PrepareForTest註解。

　　 (2)  Mock方法內部new出來的對象

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

//測試目標代碼： public boolean callInternalInstance(String path) {     File file = new File(path);     return file.exists(); }    //測試用例代碼：    @Test @PrepareForTest(Source.class) public void testCallInternalInstance() throws Exception {     File file = PowerMockito.mock(File.class);     Source underTest = new Source();     PowerMockito.whenNew(File.class).withArguments("bbb").thenReturn(file);     PowerMockito.when(file.exists()).thenReturn(true);     Assert.assertTrue(underTest.callInternalInstance("bbb")); }

說明：當使用PowerMockito.whenNew方法時，必須加註解@PrepareForTest和@RunWith。註解@PrepareForTest裏寫的類是需要mock的new對象代碼所在的類。

　　 (3) Mock普通對象的final方法

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22

//測試目標代碼： public class Source {     public boolean callFinalMethod(SourceDepend refer) {         return refer.isAlive();     } } public class SourceDepend {     public final boolean isAlive() {         return false;     } }    //測試用例代碼： @Test @PrepareForTest(SourceDepend.class) public void testCallFinalMethod() {     SourceDepend depencency = PowerMockito.mock(SourceDepend.class);     Source underTest = new Source();     PowerMockito.when(depencency.isAlive()).thenReturn(true);     Assert.assertTrue(underTest.callFinalMethod(depencency)); }

說明： 當需要mock final方法的時候，必須加註解@PrepareForTest和@RunWith。註解@PrepareForTest裏寫的類是final方法所在的類。 

 　　(4) Mock普通類的靜態方法

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

//測試目標代碼： public boolean callStaticMethod() {       return SourceDepend.isExist(); } public static boolean isExist() {     return false; }   //測試用例代碼： @Test @PrepareForTest(SourceDepend.class) public void testCallStaticMethod() {     Source underTest = new Source();     PowerMockito.mockStatic(SourceDepend.class);     PowerMockito.when(SourceDepend.isExist()).thenReturn(true);     Assert.assertTrue(underTest.callStaticMethod()); }

說明：當需要mock靜態方法的時候，必須加註解@PrepareForTest和@RunWith。註解@PrepareForTest裏寫的類是靜態方法所在的類。

　　(5) Mock私有方法

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

//測試目標代碼： public boolean callPrivateMethod() {     return isExist(); }   private boolean isExist() {     return false; }    //測試用例代碼：  @Test @PrepareForTest(Source.class) public void testCallPrivateMethod() throws Exception {     Source underTest = PowerMockito.mock(Source.class);     PowerMockito.when(underTest.callPrivateMethod()).thenCallRealMethod();     PowerMockito.when(underTest, "isExist").thenReturn(true);     Assert.assertTrue(underTest.callPrivateMethod()); }

說明：和Mock普通方法一樣，只是需要加註解@PrepareForTest(ClassUnderTest.class)，註解裏寫的類是私有方法所在的類。 

 　　(6) Mock系統類的靜態和final方法 

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21

//測試目標代碼：   public boolean callSystemFinalMethod(String str) {     return str.isEmpty(); }   public String callSystemStaticMethod(String str) {     return System.getProperty(str); }    //測試用例代碼： @Test @PrepareForTest(Source.class) public void testCallSystemStaticMethod() {     Source underTest = new Source();     PowerMockito.mockStatic(System.class);     PowerMockito.when(System.getProperty("aaa")).thenReturn("bbb");     Assert.assertEquals("bbb", underTest.callSystemStaticMethod("aaa")); }

說明：和Mock普通對象的靜態方法、final方法一樣，只不過註解@PrepareForTest裏寫的類不一樣 ，註解裏寫的類是需要調用系統方法所在的類。

        (7) Mock protected方法 

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21

//測試目標代碼： public class Source extends SourceDepend {     public boolean callFinalMethod() {         return isAlive("test");     } } public class SourceDepend {     protected boolean isAlive(String param) {         return false;     } }    //測試用例代碼： @Test @PrepareForTest(Source.class) public void testCallFinalMethod() {     Source source= PowerMockito.spy(new Source());     PowerMockito.doReturn(true).when(source, "isAlive", "test");     Assert.assertTrue(source.callFinalMethod()); }

說明：Mock受保護(protected)的方法時，註解@PrepareForTest裏寫的類是該方法所在的類，如果存在子類繼承父類的該方法時，則@PrepareForTest裏寫的是子類信息。

      四、無所不能的PowerMock

       (1) 驗證靜態方法：

       PowerMockito.verifyStatic();
       Static.firstStaticMethod(param);

       (2) 擴展驗證:

       PowerMockito.verifyStatic(Mockito.times(2)); // 被調用2次

     Static.thirdStaticMethod(Mockito.anyInt()); // 以任何整數值被調用

       (3) 更多的Mock方法

       http://code.google.com/p/powermock/wiki/MockitoUsage13

      五、PowerMock簡單實現原理

       當某個測試方法被註解@PrepareForTest標註以後，在運行測試用例時，會創建一個新的org.powermock.core.classloader.MockClassLoader實例，然後加載該測試用例使用到的類（系統類除外）。

      PowerMock會根據你的mock要求，去修改寫在註解@PrepareForTest裏的class文件（當前測試類會自動加入註解中），以滿足特殊的mock需求。例如：去除final方法的final標識，在靜態方法的最前面加入自己的虛擬實現等。

       如果需要mock的是系統類的final方法和靜態方法，PowerMock不會直接修改系統類的class文件，而是修改調用系統類的class文件，以滿足mock需求。