Mock 测试就是在测试过程中,对于某些不容易构造(如 HttpServletRequest 必须在Servlet 容器中才能构造出来)或者不容易获取比较复杂的对象(如 JDBC 中的ResultSet 对象),用一个虚拟的对象(Mock 对象)来创建以便测试的测试方法。
Mock 最大的功能是帮你把单元测试的耦合分解开,如果你的代码对另一个类或者接口有依赖,它能够帮你模拟这些依赖,并帮你验证所调用的依赖的行为。
mock中的必知概念:
桩函数(stub):桩函数实际上是白盒测试中的概念,意思是使用一些自己定义的测试函数来替换当前需要测试的函数。被替换的函数可能是目前还没写完的,这样能够加速开发,或更好的找错误源。
打桩(存根):模拟要调用的函数(打桩对象),给它提供桩函数,给桩函数返回一个值。简单的说自定义输入输出,不打桩默认返回null。
mock和stub:
相同点:Stub和Mock对象都是用来模拟外部依赖,使我们能控制。
不同点:而stub完全是模拟一个外部依赖,用来提供测试时所需要的测试数据。而mock对象用来判断测试是否能通过,也就是用来验证测试中依赖对象间的交互能否达到预期。在mocking框架中mock对象可以同时作为stub和mock对象使用,两者并没有严格区别。
如果不了解Junit,也可以参考我个人总结:Junit单元测试学习以及使用
本文用maven作例子,导入jar包
<dependencies> <!-- junit --> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.8.2</version> </dependency> <!-- https://mvnrepository.com/artifact/org.mockito/mockito-core --> <dependency> <groupId>org.mockito</groupId> <artifactId>mockito-core</artifactId> <version>2.23.4</version> <scope>test</scope> </dependency> </dependencies>
1、声明mockito对象
有两种方式,但首先都得导入import static org.mockito.Mockito.*; 最好用静态导入,可以直接调用方法
通过@Mock注解声明mock对象。MockitoJUnitRunner(或者Mockito.initMocks(this))为@mock,@spy等注解提供了初始化作用,所以用到注解时,一般都要使用它。
@Mock: 创建一个Mock.
@InjectMocks: 创建一个实例,简单的说是这个Mock可以调用真实代码的方法,其余用@Mock(或@Spy)注解创建的mock将被注入到用该实例中。可以调用类中的真实方法。
//让注解生效的第一种方法 @RunWith(MockitoJUnitRunner.class) public class TestMocks { //@Mock注解会自动mock一个list对象 @Mock List mock; //让注解生效的第二种方法,二选一即可 @Before public void setup() { MockitoAnnotations.initMocks(this); } @Test public void testMethod(){ mock.add("firstTime"); mock.add("secondTime"); } }
直接声明mock对象
public class TestMock { //声明一个List的mock对象 List mock=mock(List.class); @Test public void testMethod(){ mock.add("firstTime"); mock.add("secondTime"); } }
2、mock对象的when存根方法
就是前面提到的打桩,一般用于给mock对象的函数指定自己需要的输入输出值,示例:
List mock=mock(List.class); @Test public void testMethod(){ mock.add("firstTime"); mock.add("secondTime"); //打桩 when(mock.get(0)).thenReturn(1); //如果是没有返回值的void方法,直接 when(method).notify(); }
表示mock.get(0)返回值为1,这个地方的0也可以替换成anyInt()函数,代表获取任意数字返回都为0,不打桩默认返回为null。
注意:对于 static 和 final 方法, Mockito 无法对其 when(…).thenReturn(…) 操作。
3、mock的doNothing方法
不做任何返回
List mock=mock(List.class); @Test public void testMethod(){ //打桩,返回值为1 doNothing().when(mock.get(1)); }
4、mock的verify方法
一般用于检查是否调用了某些指定的方法。简单来说, 它可以验证一次测试中发生的某些行为。在测试代??码的底部使用它来确保调用定义的方法。同时也可以测试方法的调用次数,当不使用times函数试,默认为检查一次,times(num),num为调用检查的次数。
List mock=mock(List.class); @Test public void testMethod(){ //打桩,返回值为1 when(mock.get(0)).thenReturn(1); //此处调用了mock.get(0)方法一次 assertEquals("测试一下",mock.get(0),1); //验证是否调用一次 verify(mock).get(0); //加上times(num)函数,检查是否调用num次 verify(mock,times(2)).get(0); }
mock除了times(num)方法以外,还提供了几种更加方便的方法:
never() 没有被调用,相当于 times(0)
atLeast(N) 至少被调用 N 次
atLeastOnce() 相当于 atLeast(1)
atMost(N) 最多被调用 N 次
随后我们可以使用verifyNoMoreInteractions方法来验证是否该mock对象所有的交互都得到验证
verifyNoMoreInteractions(mock);
如果有哪一次的调用没有验证,会报错提示
5、mock的thenThrow方法
用于存根void方法以引发异常时使用。它为每个方法调用创建一个新的异常实例。
List mock=mock(List.class); @Test public void testMethod(){ //打桩,返回值为1 when(mock.get(0)).thenReturn(1); //调用get(0)时自定义异常 doThrow(new Exception("出错啦")).when(mock).get(0); }
注意: thenThrow和doThrow作用都是抛出异常,用 doThrow 可以让返回void的函数抛出异常,而thenThrow不可以,因为when的参数是非void,doThrow语法:
doThrow(new RuntimeException("异常")).when(mock).hello();
6、mock的spy函数
spy 的意思是你可以修改某个真实对象的某些方法的行为特征。
List list = new LinkedList(); List spy = spy(list); //optionally, you can stub out some methods: when(spy.size()).thenReturn(100); //using the spy calls <b>real</b> methods spy.add("one"); spy.add("two"); //prints "one" - the first element of a list System.out.println(spy.get(0)); //size() method was stubbed - 100 is printed System.out.println(spy.size()); //optionally, you can verify verify(spy).add("one"); verify(spy).add("two");
这里改掉了list的size方法,如果我们再声明对象spy后添加when(spy.get(0)).thenReturn(“foo”); 就会抛出空指针异常,因为用spy之后,在我们的原始对象中,list.get(0)是没有值的,不能直接存根,所以使用spy的时候打桩我们尽量使用doReturn方法,如果用mock的话,都是虚假函数,不会执行真正的函数部分。
7、mock的thenAnswer函数
虽然doReturn函数可以帮助我们返回想要的值,但是有时候根据业务逻辑,我们需要对参数进行判断,返回不同的值,怎么办呢。这时候就可以用thenAnswer函数。此接口允许通过InvocationOnMock参数与参数进行交互.此外,answer方法的返回值将是模拟方法的返回值。
List mock=mock(List.class); @Test public void testMethod(){ when(mock.get(anyInt())).thenAnswer(new Answer<Object>() { public Object answer(InvocationOnMock invocationOnMock) throws Throwable { //获取参数值 Object[] args = invocationOnMock.getArguments(); Integer a= (Integer) args[0]; //根据参数值返回不同的数值 if(a == 1){ return 99; }else { return 10; } } });
注意: thenAnswer和doAnswer作用是一样的,只是使用方法(语法)不同,doAnswer语法:
doAnswer(new Answer.....//方法和上面一样).when(mock).method();
8、mock的doCallRealMethod方法
thenCallRealMethod 可以用来重置 spy 对象的特定方法特定参数调用。例如我们声明了一个spy对象,但是spy对象调用的是函数的真实的方法,如果我们给spy对象赋了新的值,但是我们又想要原来对象真实的值,这时候用doCallRealMethod方法重置spy对象,恢复真实值。示例:
调用类:
public class TestClass { public int add(int a,int b){ return a+b; } }
测试方法:
@Spy TestClass test; @Before public void setup() { //让注解生效 MockitoAnnotations.initMocks(this); } @Test public void testMethods(){ assertEquals(3,test.add(1,2)); //给1+2赋值为100 when(test.add(1,2)).thenReturn(100); System.out.println(test.add(1,2)); //调用真实值 doCallRealMethod().when(test).add(1,2); System.out.println(test.add(1,2)); }
输出结果:
注意::和thenCallMethod用法一样,只不过语法有不同:
when(mock.method).thenCallMethod();
9、mock的reset方法
使用 reset 方法,可以重置之前自定义的返回值和异常。
用法:reset(对象)
例子:
@Test public void test() { List list= mock(List.class); // mock 对象方法的默认返回值是返回类型的默认值,默认值为null assertEquals(null, list.get(0)); when(list.get(0)).thenReturn(100); // 设置让 list.get(0)返回 100 // 重置 mock 对象,list.get(0)返回 null reset(list); assertEquals(null, list.get(0)); }
这里注意,如果reset(spy对象)的话,其实和doCallRealMethod方法有异曲同工之妙,最后都会调用真实的方法,即重置spy对象。
通过以上使用,我们大致可以了解到mock对我们测试的具体帮助是什么,还有它的基本使用,当然它还有其它方法,只了解了一些最常用的测试方法,需要更深入了解还需要我们在写代码的过程中去探索,mock大大简化了我们写单元测试的复杂度,一些难引用的对象都可以通过mock来模拟。
小结:mock中doMethod和thenMethod区别,例如doThrow和thenThrow(当然这两个不止语法有区别,用法也有点区别,详情看上面的doThrow,其它方法基本就是语法上的差异比如doReturn和thenReturn等):
语法:
List list=mock(List.class); when(list.get(0)).thenThrow(new Exception()); //等同于(这两个稍有区别) doThrow(new Exception()).when(list).get(0);
作者:CX330 star
原文链接:https://blog.csdn.net/weixin_43909848/article/details/109304994