Mock以及Mockito的使用
mockito
http://www.vogella.com/tutorials/Mockito/article.html
原文地址:
http://www.open-open.com/lib/view/open1462177583813.html
在第一篇文章里面 我们提到,返回类型为void方法的单元测试方式,往往是验证里面的某个对象的某个方法是否得到了调用。在那篇文章里面,我举的例子是activity里面的一个login方法:
1 public void login() { 2 String username = ...//get username from username EditText 3 String password = ...//get password from password EditText 4 //do other operation like validation, etc 5 ... 6 7 mUserManager.performLogin(username, password); 8 }
对于这个login方法的单元测试,应该是调用Activity里面的这个login方法,然后验证 mUserManager 的 performLogin 方法得到了验证。但是如果使用Activity,我们就需要用到 Robolectric 框架,然而我们到目前为止还没有讲到Robolectric的使用。所以在这篇文章中,我们假设这段代码是放在一个Presenter(LoginPresenter)里面的,这个是 MVP模式 里面的概念,这个 LoginPresenter 是一个纯java类,而用户名和密码是外面传进来的:
1 public class LoginPresenter { 2 private UserManager mUserManager = new UserManager(); 3 4 public void login(String username, String password) { 5 if (username == null || username.length() == 0) return; 6 if (password == null || password.length() < 6) return; 7 8 mUserManager.performLogin(username, password); 9 } 10 11 }
根据 前面一篇关于JUnit的文章 的讲解,我们很容易的写出针对 login() 方法的单元测试:
1 public class LoginPresenterTest { 2 3 @Test 4 public void testLogin() throws Exception { 5 LoginPresenter loginPresenter = new LoginPresenter(); 6 loginPresenter.login("xiaochuang", "xiaochuang password"); 7 8 //验证LoginPresenter里面的mUserManager的performLogin()方法得到了调用,同时参数分别是“xiaochuang”、“xiaochuang‘s password” 9 ... 10 } 11 }
现在,关键的问题来了,怎么验证 LoginPresenter 里面的 mUserManager 的 performLogin() 方法得到了调用,以及它的参数是正确性呢?如果大家看了 该系列的第一篇文章 就知道,这里需要用到 mock ,那么接下来,我们就介绍mock这个东西。
Mock的概念:两种误解
Mock的概念,其实很简单,我们前面也介绍过:所谓的mock就是创建一个类的虚假的对象,在测试环境中,用来替换掉真实的对象,以达到两大目的:
验证这个对象的某些方法的调用情况,调用了多少次,参数是什么等等
指定这个对象的某些方法的行为,返回特定的值,或者是执行特定的动作
要使用Mock,一般需要用到mock框架,这篇文章我们使用 Mockito 这个框架,这个是Java界使用最广泛的一个mock框架。
对于上面的例子,我们要验证 mUserManager 的一些行为,首先要mock UserManager这个类,mock这个类的方式是:
Mockito.mock(UserManager.class); mock了 UserManager 类之后,我们就可以开始测试了:
1 public class LoginPresenterTest { 2 3 @Test 4 public void testLogin() { 5 Mockito.mock(UserManager.class); //<== 6 LoginPresenter loginPresenter = new LoginPresenter(); 7 loginPresenter.login("xiaochuang", "xiaochuang password"); 8 9 //验证LoginPresenter里面的mUserManager的performLogin()方法得到了调用,参数分别是“xiaochuang”、“xiaochuang‘s password” 10 ... 11 } 12 }
然而我们要验证的是 LoginPresenter 里面的 mUserManager 这个对象,但是现在我们没有办法获得这个对象,因为 mUserManager 是private的,怎么办?先不想太多,我们简单除暴点,给 LoginPresenter 加一个getter,稍后你会明白我现在为什么做这样的决定。
1 public class LoginPresenter { 2 private UserManager mUserManager = new UserManager(); 3 4 public void login(String username, String password) { 5 if (username == null || username.length() == 0) return; 6 if (password == null || password.length() < 6) return; 7 8 mUserManager.performLogin(username, password); 9 } 10 11 public UserManager getUserManager() { //<== 12 return mUserManager; 13 } 14 }
好了,现在我们可以验证 mUserManager 被调用的情况了:
1 public class LoginPresenterTest { 2 3 @Test 4 public void testLogin() throws Exception { 5 Mockito.mock(UserManager.class); 6 LoginPresenter loginPresenter = new LoginPresenter(); 7 loginPresenter.login("xiaochuang", "xiaochuang password"); 8 9 UserManager userManager = loginPresenter.getUserManager(); //<== 10 //验证userManager的performLogin()方法得到了调用,参数分别是“xiaochuang”、“xiaochuang password” 11 ... 12 } 13 }
终于到了解释如何验证一个对象的某个方法的调用情况了。使用Mockito,验证一个对象的方法调用情况的姿势是:
Mockito.verify(objectToVerify).methodToVerify(arguments);
其中, objectToVerify 和 methodToVerify 分别是你想要验证的对象和方法。对应上面的例子,那就是:
Mockito.verify(userManager).performLogin("xiaochuang", "xiaochuang password"); 好,现在我们把这行代码放到测试里面:
1 public class LoginPresenterTest { 2 3 @Test 4 public void testLogin() throws Exception { 5 Mockito.mock(UserManager.class); 6 LoginPresenter loginPresenter = new LoginPresenter(); 7 loginPresenter.login("xiaochuang", "xiaochuang password"); 8 9 UserManager userManager = loginPresenter.getUserManager(); 10 Mockito.verify(userManager).performLogin("xiaochuang", "xiaochuang password"); //<== 11 } 12 }
接着我们跑一下这个测试方法,结果发现,额。。。出错了:
具体出错的是最后这一行代码: Mockito.verify(userManager).performLogin("xiaochuang", "xiaochuang password"); 。这个错误的大概意思是,传给 Mockito.verify() 的参数必须是一个mock对象,而我们传进去的不是一个mock对象,所以出错了。
这就是我想解释的,关于mock的第一个误解: Mockito.mock() 并不是mock一整个类,而是根据传进去的一个类,mock出属于这个类的一个对象,并且返回这个mock对象;而传进去的这个类本身并没有改变,用这个类new出来的对象也没有受到任何改变!
结合上面的例子, Mockito.mock(UserManager.class); 只是返回了一个属于 UserManager 这个类的一个mock对象。 UserManager 这个类本身没有受到任何影响,而 LoginPresenter 里面直接 new UserManager() 得到的 mUserManager 也是正常的一个对象,不是一个mock对象。 Mockito.verify() 的参数必须是mock对象,也就是说,Mockito只能验证mock对象的方法调用情况。因此,上面那种写法就出错了。
好的,知道了,既然这样,看来我们需要使用 Mockito.mock(UserManager.class); 返回的对象来验证,代码如下:
1 public class LoginPresenterTest { 2 3 @Test 4 public void testLogin() throws Exception { 5 UserManager mockUserManager = Mockito.mock(UserManager.class); //<== 6 LoginPresenter loginPresenter = new LoginPresenter(); 7 8 loginPresenter.login("xiaochuang", "xiaochuang password"); 9 10 Mockito.verify(mockUserManager).performLogin("xiaochuang", "xiaochuang password"); //<== 11 } 12 }
在运行一下,发现,额。。。又出错了:
错误信息的大意是,我们想验证 mockUserManager 的 performLogin() 方法得到了调用,然而其实并没有。
这就是我想解释的,关于mock的第二个误解: mock出来的对象并不会自动替换掉正式代码里面的对象,你必须要有某种方式把mock对象应用到正式代码里面
结合上面的例子, UserManager mockUserManager = Mockito.mock(UserManager.class); 的确给我们创建了一个mock对象,保存在 mockUserManager 里面。然而,当我们调用 loginPresenter.login("xiaochuang", "xiaochuang password"); 的时候,用到的mUserManager依然是使用 new UserManager() 创建的正常的对象。而 mockUserManager 并没有得到任何的调用,因此,当我们验证它的 performLogin() 方法得到了调用时,就失败了。
对于这个问题,很明显,我们必须在调用 loginPresenter.login() 之前,把 mUserManager 引用换成 mockUserManager 所引用的mock对象。最简单的办法,就是加一个setter:
1 public class LoginPresenter { 2 3 private UserManager mUserManager = new UserManager(); 4 5 public void login(String username, String password) { 6 if (username == null || username.length() == 0) return; 7 if (password == null || password.length() < 6) return; 8 9 mUserManager.performLogin(username, password); 10 } 11 12 public void setUserManager(UserManager userManager) { //<== 13 this.mUserManager = userManager; 14 } 15 16 }
同时,getter我们用不到了,于是这里就直接删了。那么按照上面的思路,写出来的测试代码如下:
1 @Test 2 public void testLogin() throws Exception { 3 UserManager mockUserManager = Mockito.mock(UserManager.class); 4 LoginPresenter loginPresenter = new LoginPresenter(); 5 loginPresenter.setUserManager(mockUserManager); //<== 6 7 loginPresenter.login("xiaochuang", "xiaochuang password"); 8 9 Mockito.verify(mockUserManager).performLogin("xiaochuang", "xiaochuang password"); 10 }
最后运行一次,hu。。。终于通过了!
当然,如果你的正式代码里面没有任何地方用到了那个setter的话,那么专门为了测试而增加了一个方法,毕竟不是很优雅的解决办法,更好的解决办法是使用依赖注入,简单解释就是把 UserManager 作为 LoginPresenter 的构造函数的参数,传进去。具体操作请期待下一篇文章^_^,这里我们专门讲mock的概念和Mockito的使用。
然而还是忍不住想多嘴一句:优雅归优雅,有么有必要,值不值得,却又是另外一回事。总体来说,我认为是值得的,因为这可以让这个类变得可测,也就意味着我们可以验证这个类的正确性,更给以后重构这个类有了保障,防止误改错这个类等等。因此,很多时候,如果你为了做单元测试,不得已要给一些类加一些额外的代码。那就加吧!毕竟优雅不能当饭吃,而解决问题、修复bug可以,做出优秀的、少有bug的产品更可以,所以,Just Do It!
好了,现在我想大家对mock的概念应该有了正确的认识,对怎么样使用mock也有了认识,接下来我们就可以全心全意介绍Mockito的功能和使用了。
Mockito的使用
1. 验证方法调用
前面我们讲了验证一个对象的某个method得到调用的方法:
Mockito.verify(mockUserManager).performLogin("xiaochuang", "xiaochuang password");
这句话的作用是,验证 mockUserManager 的 performLogin() 得到了调用,同时参数是“xiaochuang”和"xiaochuang password"。其实更准确的说法是,这行代码验证的是, mockUserManager 的 performLogin() 方法得到了 一次 调用。因为这行代码其实是:
Mockito.verify(mockUserManager, Mockito.times(1)).performLogin("xiaochuang", "xiaochuang password");
的简写,或者说重载方法,注意其中的 Mockito.times(1) 。
因此,如果你想验证一个对象的某个方法得到了多次调用,只需要将次数传给 Mockito.times() 就好了。
Mockito.verify(mockUserManager, Mockito.times(3)).performLogin(...); //验证mockUserManager的performLogin得到了三次调用。
对于调用次数的验证,除了可以验证固定的多少次,还可以验证最多,最少从来没有等等,方法分别是: atMost(count), atLeast(count), never() 等等,都是Mockito的静态方法,其实大部分时候我们会static import Mockito这个类的所有静态方法,这样就不用每次加上 Mockito. 前缀了。本文下面我也按照这个规则。(其实我早就想说这句话啦,只是一直没找到好的时机[喜极而泣])
很多时候你并不关心被调用方法的参数具体是什么,或者是你也不知道,你只关心这个方法得到调用了就行。这种情况下,Mockito提供了一系列的 any 方法,来表示任何的参数都行:
Mockito.verify(mockUserManager).performLogin(Mockito.anyString(), Mockito.anyString());
anyString() 表示任何一个字符串都可以。null?也可以的!
类似 anyString ,还有 anyInt, anyLong, anyDouble 等等。 anyObject 表示任何对象, any(clazz) 表示任何属于clazz的对象。在写这篇文章的时候,我刚刚发现,还有非常有意思也非常人性化的 anyCollection,anyCollectionOf(clazz), anyList(Map, set), anyListOf(clazz) 等等。看来我之前写了不少冤枉代码啊T_T。。。
2. 指定mock对象的某些方法的行为
到目前为止,我们介绍了mock的一大作用:验证方法调用。我们说mock主要有两大作用,第二个大作用是:指定某个方法的返回值,或者是执行特定的动作。
那么接下来,我们就来介绍mock的第二大作用,先介绍其中的第一点:指定mock对象的某个方法返回特定的值。
现在假设我们上面的 LoginPresenter 的 login 方法是如下实现的:
1 public void login(String username, String password) { 2 if (username == null || username.length() == 0) return; 3 //假设我们对密码强度有一定要求,使用一个专门的validator来验证密码的有效性 4 if (mPasswordValidator.verifyPassword(password)) return; //<== 5 6 mUserManager.performLogin(null, password); 7 }
这里,我们有个 PasswordValidator 来验证密码的有效性,但是这个类的 verifyPassword() 方法运行需要很久,比如说需要联网。这个时候在测试的环境下我们想简单处理,指定让它直接返回true或false。你可能会想,这样做可以吗?真的好吗?回答是肯定的,因为这里我们要测的是 login() 这个方法,这其实跟 PasswordValidator 内部的逻辑没有太大关系,这才是单元测试真正该有的粒度。
话说回来,这种指定mock对象的某个方法,让它返回特定值的写法如下:
Mockito.when(mockObject.targetMethod(args)).thenReturn(desiredReturnValue); 应该很好理解,结合上面PasswordValidator的例子:
1 //先创建一个mock对象 2 PasswordValidator mockValidator = Mockito.mock(PasswordValidator.class); 3 4 //当调用mockValidator的verifyPassword方法,同时传入"xiaochuang_is_handsome"时,返回true 5 Mockito.when(mockValidator.verifyPassword("xiaochuang_is_handsome")).thenReturn(true); 6 7 //当调用mockValidator的verifyPassword方法,同时传入"xiaochuang_is_not_handsome"时,返回false 8 Mockito.when(validator.verifyPassword("xiaochuang_is_not_handsome")).thenReturn(false); 9 同样的,你可以用 any 系列方法来指定"无论传入任何参数值,都返回xxx": 10 11 //当调用mockValidator的verifyPassword方法时,返回true,无论参数是什么 12 Mockito.when(validator.verifyPassword(anyString())).thenReturn(true);
指定方法返回特定值就介绍到这,更详细更高级的用法大家可以自己google。接下来介绍,怎么样指定一个方法执行特定的动作,这个功能一般是用在目标的方法是void类型的时候。
现在假设我们的 LoginPresenter 的 login() 方法是这样的:
1 public void loginCallbackVersion(String username, String password) { 2 if (username == null || username.length() == 0) return; 3 //假设我们对密码强度有一定要求,使用一个专门的validator来验证密码的有效性 4 if (mPasswordValidator.verifyPassword(password)) return; 5 6 //login的结果将通过callback传递回来。 7 mUserManager.performLogin(username, password, new NetworkCallback() { //<== 8 @Override 9 public void onSuccess(Object data) { 10 //update view with data 11 } 12 13 @Override 14 public void onFailure(int code, String msg) { 15 //show error msg 16 } 17 }); 18 }
在这里,我们想进一步测试传给 mUserManager.performLogin 的 NetworkCallback 里面的代码,验证view得到了更新等等。在测试环境下,我们并不想依赖 mUserManager.performLogin 的真实逻辑,而是让 mUserManager 直接调用传入的 NetworkCallback 的 onSuccess 或 onFailure 方法。这种指定mock对象执行特定的动作的写法如下:
Mockito.doAnswer(desiredAnswer).when(mockObject).targetMethod(args); 传给 doAnswer() 的是一个 Answer 对象,我们想要执行什么样的动作,就在这里面实现。结合上面的例子解释:
1 Mockito.doAnswer(new Answer() { 2 @Override 3 public Object answer(InvocationOnMock invocation) throws Throwable { 4 //这里可以获得传给performLogin的参数 5 Object[] arguments = invocation.getArguments(); 6 7 //callback是第三个参数 8 NetworkCallback callback = (NetworkCallback) arguments[2]; 9 10 callback.onFailure(500, "Server error"); 11 return 500; 12 } 13 }).when(mockUserManager).performLogin(anyString(), anyString(), any(NetworkCallback.class));
这里,当调用 mockUserManager 的 performLogin 方法时,会执行answer里面的代码,我们上面的例子是直接调用传入的 callback 的 onFailure 方法,同时传给 onFailure 方法500和"Server error"。
当然,使用 Mockito.doAnswer() 需要创建一个Answer对象,这有点麻烦,代码看起来也繁琐,如果想简单的指定目标方法“什么都不做”,那么可以使用 Mockito.doNothing() 。如果想指定目标方法“抛出一个异常”,那么可以使用 Mockito.doThrow(desiredException) 。如果你想让目标方法调用真实的逻辑,可以使用 Mockito.doCallRealMethod() 。(什么??? 默认不是会这样吗??? No! )
Spy
最后介绍一个Spy的东西。前面我们讲了mock对象的两大功能,对于第二大功能: 指定方法的特定行为,不知道你会不会好奇,如果我不指定的话,它会怎么样呢?那么现在补充一下,如果不指定的话,一个mock对象的所有非void方法都将返回默认值:int、long类型方法将返回0,boolean方法将返回false,对象方法将返回null等等;而void方法将什么都不做。然而很多时候,你希望达到这样的效果:除非指定,否者调用这个对象的默认实现,同时又能拥有验证方法调用的功能。这正好是spy对象所能实现的效果。创建一个spy对象,以及spy对象的用法介绍如下:
1 //假设目标类的实现是这样的 2 public class PasswordValidator { 3 public boolean verifyPassword(String password) { 4 return "xiaochuang_is_handsome".equals(password); 5 } 6 } 7 8 @Test 9 public void testSpy() { 10 //跟创建mock类似,只不过调用的是spy方法,而不是mock方法。spy的用法 11 PasswordValidator spyValidator = Mockito.spy(PasswordValidator.class); 12 13 //在默认情况下,spy对象会调用这个类的真实逻辑,并返回相应的返回值,这可以对照上面的真实逻辑 14 spyValidator.verifyPassword("xiaochuang_is_handsome"); //true 15 spyValidator.verifyPassword("xiaochuang_is_not_handsome"); //false 16 17 //spy对象的方法也可以指定特定的行为 18 Mockito.when(spyValidator.verifyPassword(anyString())).thenReturn(true); 19 20 //同样的,可以验证spy对象的方法调用情况 21 spyValidator.verifyPassword("xiaochuang_is_handsome"); 22 Mockito.verify(spyValidator).verifyPassword("xiaochuang_is_handsome"); //pass 23 }
总之,spy与mock的唯一区别就是默认行为不一样:spy对象的方法默认调用真实的逻辑,mock对象的方法默认什么都不做,或直接返回默认值。
小结
这篇文章介绍了mock的概念以及Mockito的使用,可能Mockito的很多的一些其他方法没有介绍,但这只是阅读文档的问题而已,更重要的是理解mock的概念。
如果你想了解Mockito更详细的用法可以参考 这篇文章 ,写的是相当的好。
下一篇文章我们将介绍依赖注入的概念,以及(或许)使用dagger2来更方便的做依赖注入,以及在单元测试里面的应用,这里依然后很多的误区,需要大家注意的,想知道具体是什么吗?那就Stay tuned!
转载于:https://www.cnblogs.com/wangtj-19/p/5822369.html
Mock以及Mockito的使用相关推荐
- 单元测试Mock框架--Mockito
文章目录 目前开发中,单元测试遇到的问题 解决方案--Mock Junit4 + Mockito: Mockito常用注解: Mockito常用方法: Tips: 总结 目前开发中,单元测试遇到的问题 ...
- Mock和Mockito简介
本篇对Mock和Mockito做了简单的介绍,并列出了简单的示例. 使用Mockito需要基于JUnit,所以不了解JUnit的同学请先参考一下之前JUnit的文章. 什么是Mock? 在面向对象程序 ...
- Mock 及 Mockito 教程
Mockito 教程 Mockito框架官方地址mockito,文档地址,中文版文档. Mockito库能够Mock对象.验证结果以及打桩(stubbing). 1. Mock和Mockito的关系 ...
- Android单元测试系列(3)-Mock之Mockito
目录 一.官网 二.Demo示例 1. 目录结构 2. 被测试的类 3. 测试类 三.Mockito方法说明 1. mock对象创建 2. Mockito框架中的常见方法说明 2.1 常见的打桩方法 ...
- 单元测试mock之mockito使用
先来一个简单的例子来感受一下 外部接口类:TestService.java 1 package com.yzl.mock; 2 3 /** 4 * 测试用服务 5 * 6 * @author yang ...
- Mock和Java单元测试中的Mock框架Mockito介绍
什么是Mock? 在面向对象程序设计中,模拟对象(英语:mock object,也译作模仿对象)是以可控的方式模拟真实对象行为的假的对象.程序员通常创造模拟对象(mock object)来测试其他对象 ...
- android mock测试资源,Android 单元测试 --Mock 及 Mockito
以前我在 Mock 概念 所谓的 Mock 就是创建一个类的虚假的对象,在测试环境中,用来替换掉真实的对象,主要提供两大功能: 验证这个对象的某些方法的调用情况,调用了多少次,参数是什么等等 指定这个 ...
- mock java_JAVA的mock工具mockito简介
在测试过程中,难免会碰到交互的外围系统不给力的情况,这时候mock就派上用场了,前段时间跟同学聊到这块的时候,他向我推荐mockito这个mock工具,试用了一下,确实很好用,这里给大家介绍下这款工具 ...
- junit5 mock静态方法 Mockito.mockStatic()
junit5 mock静态方法 环境 jdk11 , junit5 ,springboot pom <dependency><groupId>org.springframewo ...
最新文章
- Hibernate之检索方式
- 在Tomcat上挂载预下载文件的方法
- oculus rift 开发入门
- TinyMCE的使用
- linux汇编和x86汇编,linux平台学x86汇编(四):从“hello world!”开始
- 湘苗培优|值不值?效果告诉你
- linux图形界面 革命,Windows 95带来的革命
- java web删除文件_Web开发为了java端程序能删除文件的解决办法
- C# 根据年月日计算星期几
- HTML,CSS基础十大重点问题
- 基于RTP/RTCP流媒体服务器技术研究
- Linux中的ls命令详细使用
- Editormd的使用——在线编辑和查看文章
- MacOS工程替换MainMenu.xib
- 大数据发展趋势十个大方向
- MSSQL2019+Linux7, The SQLServerAgent is not currently running, so it cannot be notified of this
- php 获取header头信息并显示网址,php 获取远程网址header头信息的方法
- 台式计算机中经常使用的硬盘多是多少英寸,笔记本硬盘和台式机硬盘有什么不同...
- 微信小程序人脸核身---快速入门到实战(附开发工具类,复制即用)
- unity 2019 点击脚本启动不了VS_蚂蚁森林能量脚本,无需ROOT+支持模拟器
热门文章
- erp核心目的及erp特点
- 安装GIT(基于Ubuntu Desktop 12.04 LTS)
- 使用IDEA编写一个springMVC架构的HelloWorld
- POJ-1328(Greedy,Vector,Sort,Iterator)
- Leetcode刷题指南和top100题目
- Linux系统下文件与目录操作
- Java——IO基础
- layer——极简的jquery弹出层插件
- 高级着色语言HLSL入门(5)
- 安装不成功_win10+cuda10.1+cudnn+tensorflow1.15.0安装