最近工作中由于要写单元测试,接触到了Mockito这门对于笔者来说完全陌生的技术,在学习和使用中也遇到了不少坑,在这里做一下总结和梳理。
Mockito是做什么用的?
与其说Mockito是做什么用的,不如说说单元测试是做什么用的,相信大多数人和笔者一样,习惯用PostMan来测试接口的连通性,我们都知道其实PostMan这种自测的方式是完全可以的,但是为什么还会出现单元测试这个东西呢?网上大家的分享其实很多了,但是笔者认为最重要的就是一点:单元测试是写在当下,但是为的是服务于未来的。假如未来我们的代码修改了,比如逻辑的一些修改,那么我们的单元测试从原则上说是不用修改的,因为我们需求的结果不变或者变动较少。而且单元测试保留了我们代码稳固的验证记录。而Mockito的假如,则让单元测试又多了一层意义,那就是在我们可以对代码进行提前的校验。比如说我们的A类要依赖B接口中的方法,但是B接口还未开发完毕,但是我们已经通过提前沟通知道了B接口要返回的内容,此时便可以用Mockito去模拟B接口的调用过程。比如我们的项目要连接某个数据库,但是目前数据库的网络还没调通,硬件那边正在交涉,我们便可以通过使用Mockito来模拟这个数据库的返回结果,从而进行单元测试。
在上段文字中出现了多次的“模拟”二字。是的,Mockito最大的作用就是模拟。从而达到我们在单元测试中想写什么写什么,缺什么就用Mockito来模拟就好了!
Mockito怎么用?
1.TestA mockA = Mockito.mock(TestA.class);
这便是Mockito最简单的使用方法,我们的TestA就是我们想要模拟的一个类。而mockA便是一个我们模拟出来的一个TestA类型的对象。
这个模拟类有什么特点呢?首先,无法set任何值,也就是说即使你这个类是有一个setId的方法的,但是你在调用了mockA.setId(10);的情况下,当我们的单元测试执行到真实的业务代码中,是不生效的。
2.不生效?那模拟它有什么用?用处来了。模拟对象的意义在于,可以使用一个叫“打桩”的操作,stub,其实它也有存根的意思,但是我看到其他帖子称之为打桩的场景最多,所以我们这里就称这个行为是打桩好了。打桩怎么用:Mockito.when(mock.getId()).thenReturn(10);这段代码的含义是当我们的mock对象执行到了getId这个方法的时候,就返回“10”这个值。这个when(XXX).thenReturn(XXX)的写法,就叫做“打桩”,也是Mockito的一个核心用法。
打桩好在哪?比如你需要连数据库,需要通过某个查询语句去数据库查询你的数据,然后再返回一个值,但是现在连接不到数据库,或者说连数据库你需要去公司连内网才可以,你本地又懒得建一个类似的表了,那么你就可以通过使用打桩操作,来返回一个你需要的值。
打桩需要注意的点:
1.when里面的对象,一定要是Mockito类型的虚拟对象,你放一个真实对象进去,会报类型错误。
2.我进行了打桩操作,但是实际业务代码中没有执行我的打桩操作,没有返回我的预期结果怎么办?这种情况一般是出现在你的打桩的when里面的条件和实际的业务代码匹配不上才会发生。这里传授几个小技巧,比如说方法的参数是一个String类型的对象,那么在when中,就使用Mockito.anyString()来代替。如果实际业务代码中就是一个String.class,那么在when方法中就使用Mockito.eq(String.class)即可。有时候我们使用Mockito.when(mock(Mockito.any()))都无法匹配上,也是这个原因。Moktio还给我们提供了一个方法,来检验我们的打桩操作是否被执行了,具体使用如下:
// 创建一个 mock 对象
List<String> mockedList = mock(List.class);
// 打桩 mockedList.size() 方法返回 100
when(mockedList.size()).thenReturn(100);
// 调用 mock 对象
int size = mockedList.size();
// 验证 mockedList.size() 方法是否被调用
verify(mockedList).size();
在我的业务代码中,有些地方我想用真实数据,有些地方想用模拟数据,怎么办?
比如说我的代码要检验一个文件,从文件里拿出来一些需要的内容,然后再去数据库查询对应的数据,接下来再做一些别的处理。我现在就想测测这个我检验文件的格式的代码是否正确,其他的部分,比如说数据库查询这种我想用模拟数据来解决。也就是说检验文件格式的这部分的代码是不能被模拟的,而且我本地确实也准备了一个真实的文件。这种情况下就得提到Mockito的另一个API了,它叫spy。
比如Person person = new Person(); person.setName("张三"); Person spyPerson=Mockito.spy(person);上面这几句代码是什么意思呢,首先我们新建了一个真实的person类,然后给这个类设置了一个名字,然后又在这个类的基础上创建了spy类,也就是Mockito的模拟类。这么做有什么用呢,首先是在之后的测试中,我们的业务代码碰到了需要去getName的时候,返回的会是我们提前在测试代码中设置的这个张三。如果是碰到了getAge()的话,我们又可以通过使用Mocktio.when(spyPerson.getAge()).thenReturn(18);来返回18这个值了。
也就是说,通过spy新产生的对象,既具有之前的真实类的属性,也可以执行我们新加的打桩操作。但是有一点,就是我们传入Person类的时候,传入的需要时spyPerson这个类。
Mockito的静态方法的使用
在上面的内容,不管是普通的Mockito的类也好,还是通过spy模拟产生的类也罢,都是需要通过将Mockito对象作为入参传入实际的业务代码中去执行的方法。但是我们也有一些类,是不通过入参传入的。比如我们的业务代码中直接通过调用其他类的静态方法,这种无法通过入参传入,怎么去模拟呢?答案就是使用Mocktio.mockStatic()这个API。
具体使用方法try(MockedStatic<MyClassWithStaticMethods> mockedStatic = mockStatic(MyClassWithStaticMethods.class);)
{
mockedStatic.when(MyClassWithStaticMethods.getXXX()).then(XXX);
};
可以发现,是加了一个try的语句块在上面。把涉及这个模拟的静态类要去执行的方法写在大括号里,这么做有一个好处,就是执行完了大括号里的内容后,这个静态方法会自动关闭,不影响这个被我们模拟的类的静态方法在别的地方调用,就是说在别的地方如果再调这个类的静态方法,就会回归它本身的真实方法了。还有一种方法,就是通过调用mockedStatic.close()来关闭对于这个对象的调用。如果以上两种方法都没有使用,当我们进行项目打包的时候,就会报错,比如A和B两个测试类中都有使用Mockito.mockStatic的话,就会提示说MockitoStatic已经在存在了。
通过一些链式调用解决业务的场景
比如现在有一个学校类,学校类里有学生类,学生自己又有姓名和年龄这两个属性。我们现在Mockito产生的是学校类,我们一开始传入实际业务代码中的入参也是学校类,但是实际需要的却是学生类的姓名,该如何去做?
在测试类中,1.首先模拟一个学校对象:School school = Mockito.mock(School.class);2.再模拟一个学生类:Student student = Mockito.mock(Student.class);3.打桩一个操作,当学校类获取学生类的时候,就返回我们模拟的这个学生类:Mockito.when(school.getStudent()).thenReturn(student);4.打桩一个操作,当学生类进行获取姓名的时候,就返回我们的设置值:Mockito.when(student.getName()).thenReturn("张三");
我们进行了上述操作后,再看看我们实际业务代码中的操作: String name = school.getStudent().getName();结合两段操作下来,这里的name的值就是张三了。我们通过链式调用的办法,将通过学校获取学生并且通过学生获取姓名的方法进行了模拟的拆解。
好了,以上就是我的一些分享,都是一些Mockito的基础的使用,希望大家可以喜欢。
网友评论