• 使用mockito模拟静态方法

    一、为什么要使用Mock工具

          在做单元测试的时候，我们会发现我们要测试的方法会引用很多外部依赖的对象，比如：（发送邮件，网络通讯，远程服务, 文件系统等等）。 而我们没法控制这些外部依赖的对象，为了解决这个问题，我们就需要用到Mock工具来模拟这些外部依赖的对象，来完成单元测试。

          二、为什么要使用PowerMock

          现如今比较流行的Mock工具如EasyMock 、Mockito等都有一个共同的缺点：不能mock静态、final、私有方法等。而PowerMock能够完美的弥补以上三个Mock工具的不足。

          三、PowerMock简介

          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 public boolean callArgumentInstance(File file) {
    2  
    3      return file.exists();
    4  
    5 }

         测试用例代码： 

    01 @Test 
    02 public void testCallArgumentInstance() {
    03   
    04     File file = PowerMockito.mock(File.class); 
    05  
    06     ClassUnderTest underTest = new ClassUnderTest();
    07    
    08     PowerMockito.when(file.exists()).thenReturn(true);
    09   
    10     Assert.assertTrue(underTest.callArgumentInstance(file)); 
    11 }

          说明：普通Mock不需要加@RunWith和@PrepareForTest注解。

           (2)  Mock方法内部new出来的对象

           测试目标代码：

    01 public class ClassUnderTest {
    02  
    03     public boolean callInternalInstance(String path) { 
    04  
    05         File file = new File(path); 
    06  
    07         return file.exists(); 
    08  
    09     } 
    10 }

           测试用例代码：    

    01 @RunWith(PowerMockRunner.class) 
    02 public class TestClassUnderTest {
    03  
    04     @Test 
    05     @PrepareForTest(ClassUnderTest.class) 
    06     public void testCallInternalInstance() throws Exception { 
    07  
    08         File file = PowerMockito.mock(File.class); 
    09  
    10         ClassUnderTest underTest = new ClassUnderTest(); 
    11  
    12         PowerMockito.whenNew(File.class).withArguments("bbb").thenReturn(file); 
    13          
    14         PowerMockito.when(file.exists()).thenReturn(true); 
    15  
    16         Assert.assertTrue(underTest.callInternalInstance("bbb")); 
    17     } 
    18 }

          说明：当使用PowerMockito.whenNew方法时，必须加注解@PrepareForTest和@RunWith。注解@PrepareForTest里写的类是需要mock的new对象代码所在的类。

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

         测试目标代码：

    1 public class ClassUnderTest {
    2  
    3     public boolean callFinalMethod(ClassDependency refer) { 
    4  
    5         return refer.isAlive(); 
    6  
    7     } 
    8 }
    01 public class ClassDependency {
    02      
    03     public final boolean isAlive() {
    04  
    05         // do something 
    06  
    07         return false; 
    08  
    09     } 
    10 }

           测试用例代码：

    01 @RunWith(PowerMockRunner.class) 
    02 public class TestClassUnderTest {
    03  
    04     @Test 
    05     @PrepareForTest(ClassDependency.class) 
    06     public void testCallFinalMethod() {
    07  
    08         ClassDependency depencency =  PowerMockito.mock(ClassDependency.class);
    09   
    10         ClassUnderTest underTest = new ClassUnderTest();
    11   
    12         PowerMockito.when(depencency.isAlive()).thenReturn(true);
    13   
    14         Assert.assertTrue(underTest.callFinalMethod(depencency));
    15   
    16     }
    17 }

          说明： 当需要mock final方法的时候，必须加注解@PrepareForTest和@RunWith。注解@PrepareForTest里写的类是final方法所在的类。 

          (4) Mock普通类的静态方法

          测试目标代码：

    1 public class ClassUnderTest {
    2  
    3     public boolean callStaticMethod() {
    4   
    5         return ClassDependency.isExist(); 
    6  
    7     }  
    8 }
    01 public class ClassDependency {
    02     
    03     public static boolean isExist() {
    04  
    05         // do something 
    06  
    07         return false; 
    08  
    09     } 
    10 }

          测试用例代码：

    01 @RunWith(PowerMockRunner.class) 
    02 public class TestClassUnderTest {
    03  
    04     @Test 
    05     @PrepareForTest(ClassDependency.class) 
    06     public void testCallStaticMethod() {
    07   
    08         ClassUnderTest underTest = new ClassUnderTest();
    09   
    10         PowerMockito.mockStatic(ClassDependency.class); 
    11  
    12         PowerMockito.when(ClassDependency.isExist()).thenReturn(true);
    13   
    14         Assert.assertTrue(underTest.callStaticMethod());
    15   
    16     }
    17 }

          说明：当需要mock静态方法的时候，必须加注解@PrepareForTest和@RunWith。注解@PrepareForTest里写的类是静态方法所在的类。

          (5) Mock 私有方法

          测试目标代码： 

    01 public class ClassUnderTest {
    02  
    03     public boolean callPrivateMethod() { 
    04  
    05         return isExist(); 
    06  
    07     }       
    08  
    09     private boolean isExist() {
    10    
    11         return false; 
    12  
    13     }
    14 }

         测试用例代码：  

    01 @RunWith(PowerMockRunner.class) 
    02 public class TestClassUnderTest {
    03  
    04     @Test 
    05     @PrepareForTest(ClassUnderTest.class) 
    06     public void testCallPrivateMethod() throws Exception { 
    07  
    08        ClassUnderTest underTest = PowerMockito.mock(ClassUnderTest.class); 
    09  
    10        PowerMockito.when(underTest.callPrivateMethod()).thenCallRealMethod(); 
    11  
    12        PowerMockito.when(underTest, "isExist").thenReturn(true);
    13    
    14        Assert.assertTrue(underTest.callPrivateMethod());
    15   
    16     }
    17 }

           说明：和Mock普通方法一样，只是需要加注解@PrepareForTest(ClassUnderTest.class)，注解里写的类是私有方法所在的类。 

           (6) Mock系统类的静态和final方法 

            测试目标代码：   

    01 public class ClassUnderTest {
    02  
    03     public boolean callSystemFinalMethod(String str) {
    04  
    05         return str.isEmpty(); 
    06  
    07     } 
    08  
    09     public String callSystemStaticMethod(String str) {
    10   
    11         return System.getProperty(str); 
    12  
    13     }
    14 }

          测试用例代码：

    01 @RunWith(PowerMockRunner.class) 
    02 public class TestClassUnderTest {
    03  
    04   @Test 
    05   @PrepareForTest(ClassUnderTest.class) 
    06   public void testCallSystemStaticMethod() { 
    07  
    08       ClassUnderTest underTest = new ClassUnderTest(); 
    09  
    10       PowerMockito.mockStatic(System.class); 
    11  
    12       PowerMockito.when(System.getProperty("aaa")).thenReturn("bbb");
    13    
    14       Assert.assertEquals("bbb", underTest.callJDKStaticMethod("aaa")); 
    15  
    16   } 
    17 }

          说明：和Mock普通对象的静态方法、final方法一样，只不过注解@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需求。


    powmock的maven依赖：

    <dependency>
    <groupId>org.powermock</groupId>
    <artifactId>powermock-api-mockito</artifactId>
    <version>1.6.1</version>
    <scope>test</scope>
    </dependency>

    <dependency>
    <groupId>org.powermock</groupId>
    <artifactId>powermock-module-junit4</artifactId>
    <version>1.6.1</version>
    <scope>test</scope>
    </dependency> 

    1 public boolean callArgumentInstance(File file) {
    2  
    3      return file.exists();
    4  
    5 }

         测试用例代码： 

    01 @Test 
    02 public void testCallArgumentInstance() {
    03   
    04     File file = PowerMockito.mock(File.class); 
    05  
    06     ClassUnderTest underTest = new ClassUnderTest();
    07    
    08     PowerMockito.when(file.exists()).thenReturn(true);
    09   
    10     Assert.assertTrue(underTest.callArgumentInstance(file)); 
    11 }

          说明：普通Mock不需要加@RunWith和@PrepareForTest注解。

           (2)  Mock方法内部new出来的对象

           测试目标代码：

    01 public class ClassUnderTest {
    02  
    03     public boolean callInternalInstance(String path) { 
    04  
    05         File file = new File(path); 
    06  
    07         return file.exists(); 
    08  
    09     } 
    10 }

           测试用例代码：    

    01 @RunWith(PowerMockRunner.class) 
    02 public class TestClassUnderTest {
    03  
    04     @Test 
    05     @PrepareForTest(ClassUnderTest.class) 
    06     public void testCallInternalInstance() throws Exception { 
    07  
    08         File file = PowerMockito.mock(File.class); 
    09  
    10         ClassUnderTest underTest = new ClassUnderTest(); 
    11  
    12         PowerMockito.whenNew(File.class).withArguments("bbb").thenReturn(file); 
    13          
    14         PowerMockito.when(file.exists()).thenReturn(true); 
    15  
    16         Assert.assertTrue(underTest.callInternalInstance("bbb")); 
    17     } 
    18 }

          说明：当使用PowerMockito.whenNew方法时，必须加注解@PrepareForTest和@RunWith。注解@PrepareForTest里写的类是需要mock的new对象代码所在的类。

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

         测试目标代码：

    1 public class ClassUnderTest {
    2  
    3     public boolean callFinalMethod(ClassDependency refer) { 
    4  
    5         return refer.isAlive(); 
    6  
    7     } 
    8 }
    01 public class ClassDependency {
    02      
    03     public final boolean isAlive() {
    04  
    05         // do something 
    06  
    07         return false; 
    08  
    09     } 
    10 }

           测试用例代码：

    01 @RunWith(PowerMockRunner.class) 
    02 public class TestClassUnderTest {
    03  
    04     @Test 
    05     @PrepareForTest(ClassDependency.class) 
    06     public void testCallFinalMethod() {
    07  
    08         ClassDependency depencency =  PowerMockito.mock(ClassDependency.class);
    09   
    10         ClassUnderTest underTest = new ClassUnderTest();
    11   
    12         PowerMockito.when(depencency.isAlive()).thenReturn(true);
    13   
    14         Assert.assertTrue(underTest.callFinalMethod(depencency));
    15   
    16     }
    17 }

          说明： 当需要mock final方法的时候，必须加注解@PrepareForTest和@RunWith。注解@PrepareForTest里写的类是final方法所在的类。 

          (4) Mock普通类的静态方法

          测试目标代码：

    1 public class ClassUnderTest {
    2  
    3     public boolean callStaticMethod() {
    4   
    5         return ClassDependency.isExist(); 
    6  
    7     }  
    8 }
    01 public class ClassDependency {
    02     
    03     public static boolean isExist() {
    04  
    05         // do something 
    06  
    07         return false; 
    08  
    09     } 
    10 }

          测试用例代码：

    01 @RunWith(PowerMockRunner.class) 
    02 public class TestClassUnderTest {
    03  
    04     @Test 
    05     @PrepareForTest(ClassDependency.class) 
    06     public void testCallStaticMethod() {
    07   
    08         ClassUnderTest underTest = new ClassUnderTest();
    09   
    10         PowerMockito.mockStatic(ClassDependency.class); 
    11  
    12         PowerMockito.when(ClassDependency.isExist()).thenReturn(true);
    13   
    14         Assert.assertTrue(underTest.callStaticMethod());
    15   
    16     }
    17 }

          说明：当需要mock静态方法的时候，必须加注解@PrepareForTest和@RunWith。注解@PrepareForTest里写的类是静态方法所在的类。

          (5) Mock 私有方法

          测试目标代码： 

    01 public class ClassUnderTest {
    02  
    03     public boolean callPrivateMethod() { 
    04  
    05         return isExist(); 
    06  
    07     }       
    08  
    09     private boolean isExist() {
    10    
    11         return false; 
    12  
    13     }
    14 }

         测试用例代码：  

    01 @RunWith(PowerMockRunner.class) 
    02 public class TestClassUnderTest {
    03  
    04     @Test 
    05     @PrepareForTest(ClassUnderTest.class) 
    06     public void testCallPrivateMethod() throws Exception { 
    07  
    08        ClassUnderTest underTest = PowerMockito.mock(ClassUnderTest.class); 
    09  
    10        PowerMockito.when(underTest.callPrivateMethod()).thenCallRealMethod(); 
    11  
    12        PowerMockito.when(underTest, "isExist").thenReturn(true);
    13    
    14        Assert.assertTrue(underTest.callPrivateMethod());
    15   
    16     }
    17 }

           说明：和Mock普通方法一样，只是需要加注解@PrepareForTest(ClassUnderTest.class)，注解里写的类是私有方法所在的类。 

           (6) Mock系统类的静态和final方法 

            测试目标代码：   

    01 public class ClassUnderTest {
    02  
    03     public boolean callSystemFinalMethod(String str) {
    04  
    05         return str.isEmpty(); 
    06  
    07     } 
    08  
    09     public String callSystemStaticMethod(String str) {
    10   
    11         return System.getProperty(str); 
    12  
    13     }
    14 }

          测试用例代码：

    01 @RunWith(PowerMockRunner.class) 
    02 public class TestClassUnderTest {
    03  
    04   @Test 
    05   @PrepareForTest(ClassUnderTest.class) 
    06   public void testCallSystemStaticMethod() { 
    07  
    08       ClassUnderTest underTest = new ClassUnderTest(); 
    09  
    10       PowerMockito.mockStatic(System.class); 
    11  
    12       PowerMockito.when(System.getProperty("aaa")).thenReturn("bbb");
    13    
    14       Assert.assertEquals("bbb", underTest.callJDKStaticMethod("aaa")); 
    15  
    16   } 
    17 }

          说明：和Mock普通对象的静态方法、final方法一样，只不过注解@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需求。
  • 相关阅读:
    Android环境说明 与 屏幕尺寸问题
    关于修改Visual Studio 2010 Ultimate RC的密钥
    安装Office 2010是出现windows installer服务不能更新一个或多个受保护的windows文件 错误
    Sharepoint 2010和阿里通进行集成完成短信通知功能
    用visual studio 2010 打开winform程序 时 无法运行 的解决方案
    一次尴尬的招聘经历
    TFS里的MSB3021错误
    程序员是强者
    修改密码导致应用程序池无法启动
    远离客户开发陷阱（转）
  • 原文地址：https://www.cnblogs.com/dengshihuang/p/7903642.html
Copyright © 2020-2023  润新知