丰富的线上&线下活动,深入探索云世界
做任务,得社区积分和周边
最真实的开发者用云体验
让每位学生受益于普惠算力
让创作激发创新
资深技术专家手把手带教
遇见技术追梦人
技术交流,直击现场
海量开发者使用工具、手册,免费下载
极速、全面、稳定、安全的开源镜像
开发手册、白皮书、案例集等实战精华
为开发者定制的Chrome浏览器插件
清代杰出思想家章学诚有一句名言:“学必求其心得,业必贵其专精。”
意思是:学习上一定要追求心得体会,事业上一定要贵以专注精深。做技术就是这样,一件事如果做到了极致,就必然会有所心得体会。作者最近在一个项目上,追求单元测试覆盖率到极致(行覆盖率96.11%,分支覆盖率93.35%),所以才有了这篇心得体会。
Mockito是一个单元测试模拟框架,可以让你写出优雅、简洁的单元测试代码。Mockito采用了模拟技术,模拟了一些在应用中依赖的复杂对象,从而把测试对象和依赖对象隔离开来。
PowerMock是一个单元测试模拟框架,是在其它单元测试模拟框架的基础上做出扩展。通过提供定制的类加载器以及一些字节码篡改技术的应用,PowerMock实现了对静态方法、构造方法、私有方法以及final方法的模拟支持等强大的功能。但是,正因为PowerMock进行了字节码篡改,导致部分单元测试用例并不被JaCoco统计覆盖率。
通过作者多年单元测试的编写经验,优先推荐使用Mockito提供的功能;只有在Mockito提供的功能不能满足需求时,才会采用PowerMock提供的功能;但是,不推荐使用影响JaCoco统计覆盖率的PowerMock功能。在本文中,我们也不会对影响JaCoco统计覆盖率的PowerMock功能进行介绍。
下面,将以Mockito为主、以PowerMock为辅,介绍一下如何编写单元测试用例。
为了引入Mockito和PowerMock包,需要在maven项目的pom.xml文件中加入以下包依赖:
一个典型的服务代码案例如下:
UserServiceTest.java:
{"name":"test"}userCreateDO.json:
{"id":1,"name":"test"}userModifyDO.json:
{"id":1,"name":"test"}通过执行以上测试用例,可以看到对源代码进行了100%的行覆盖。
通过上一章编写Java类单元测试用例的实践,可以总结出以下Java类单元测试用例的编写流程:
上面一共有3个测试用例,这里只以测试用例testCreateUserWithNew(创建用户-新)为例说明。
第1步是定义对象阶段,主要包括定义被测对象、模拟依赖对象(类成员)、注入依赖对象(类成员)3大部分。
在编写单元测试时,首先需要定义被测对象,或直接初始化、或通过Spy包装……其实,就是把被测试服务类进行实例化。
/**定义被测对象*//**用户服务*/@InjectMocksprivateUserServiceuserService;2.1.2.模拟依赖对象(类成员)在一个服务类中,我们定义了一些类成员对象——服务(Service)、数据访问对象(DAO)、参数(Value)等。在Spring框架中,这些类成员对象通过@Autowired、@Value等方式注入,它们可能涉及复杂的环境配置、依赖第三方接口服务……但是,在单元测试中,为了解除对这些类成员对象的依赖,我们需要对这些类成员对象进行模拟。
/**模拟依赖对象*//**用户DAO*/@MockprivateUserDAOuserDAO;/**标识生成器*/@MockprivateIdGeneratoridGenerator;2.1.3.注入依赖对象(类成员)当模拟完这些类成员对象后,我们需要把这些类成员对象注入到被测试类的实例中。以便在调用被测试方法时,可能使用这些类成员对象,而不至于抛出空指针异常。
/**定义被测对象*//**用户服务*/@InjectMocksprivateUserServiceuserService;/***在测试之前*/@BeforepublicvoidbeforeTest(){//注入依赖对象Whitebox.setInternalState(userService,"canModify",Boolean.TRUE);}2.2.模拟方法阶段第2步是模拟方法阶段,主要包括模拟依赖对象(参数或返回值)、模拟依赖方法2大部分。
通常,在调用一个方法时,需要先指定方法的参数,然后获取到方法的返回值。所以,在模拟方法之前,需要先模拟该方法的参数和返回值。
LonguserId=1L;2.2.2.模拟依赖方法在模拟完依赖的参数和返回值后,就可以利用Mockito和PowerMock的功能,进行依赖方法的模拟。如果依赖对象还有方法调用,还需要模拟这些依赖对象的方法。
//模拟依赖方法//模拟依赖方法:userDAO.getByNameMockito.doReturn(null).when(userDAO).getIdByName(Mockito.anyString());//模拟依赖方法:idGenerator.nextMockito.doReturn(userId).when(idGenerator).next();2.3.调用方法阶段第3步是调用方法阶段,主要包括模拟依赖对象(参数)、调用被测方法、验证参数对象(返回值)3步。
在调用被测方法之前,需要模拟被测方法的参数。如果这些参数还有方法调用,还需要模拟这些参数的方法。
Stringtext=ResourceHelper.getResourceAsString(getClass(),"userCreateVO.json");UserVOuserCreate=JSON.parseObject(text,UserVO.class);2.3.2.调用被测方法在准备好参数对象后,就可以调用被测试方法了。如果被测试方法有返回值,需要定义变量接收返回值;如果被测试方法要抛出异常,需要指定期望的异常。
userService.createUser(userCreate)2.3.3.验证数据对象(返回值)在调用被测试方法后,如果被测试方法有返回值,需要验证这个返回值是否符合预期;如果被测试方法要抛出异常,需要验证这个异常是否满足要求。
Assert.assertEquals("用户标识不一致",userId,userService.createUser(userCreate));2.4.验证方法阶段第4步是验证方法阶段,主要包括验证依赖方法、验证数据对象(参数)、验证依赖对象3步。
作为一个完整的测试用例,需要对每一个模拟的依赖方法调用进行验证。
//验证依赖方法//验证依赖方法:userDAO.getByNameMockito.verify(userDAO).getIdByName(userCreate.getName());//验证依赖方法:idGenerator.nextMockito.verify(idGenerator).next();//验证依赖方法:userDAO.createArgumentCaptor
text=ResourceHelper.getResourceAsString(getClass(),"userCreateDO.json");Assert.assertEquals("用户创建不一致",text,JSON.toJSONString(userCreateCaptor.getValue()));2.4.3.验证依赖对象作为一个完整的测试用例,应该保证每一个模拟的依赖方法调用都进行了验证。正好,Mockito提供了一套方法,用于验证模拟对象所有方法调用都得到了验证。
//验证依赖对象Mockito.verifyNoMoreInteractions(idGenerator,userDAO);
直接构建一个对象,总是简单又直接。
UserServiceuserService=newUserService();3.2.利用Mockito.spy方法Mockito提供一个spy功能,用于拦截那些尚未实现或不期望被真实调用的方法,默认所有方法都是真实方法,除非主动去模拟对应方法。所以,利用spy功能来定义被测对象,适合于需要模拟被测类自身方法的情况,适用于普通类、接口和虚基类。
UserServiceuserService=Mockito.spy(newUserService());UserServiceuserService=Mockito.spy(UserService.class);AbstractOssServiceossService=Mockito.spy(AbstractOssService.class);3.3.利用@Spy注解@Spy注解跟Mockito.spy方法一样,可以用来定义被测对象,适合于需要模拟被测类自身方法的情况,适用于普通类、接口和虚基类。@Spy注解需要配合@RunWith注解使用。
@RunWith(PowerMockRunner.class)publicclassCompanyServiceTest{@SpyprivateUserServiceuserService=newUserService();...}注意:@Spy注解对象需要初始化。如果是虚基类或接口,可以用Mockito.mock方法实例化。
@InjectMocks注解用来创建一个实例,并将其它对象(@Mock、@Spy或直接定义的对象)注入到该实例中。所以,@InjectMocks注解本身就可以用来定义被测对象。@InjectMocks注解需要配合@RunWith注解使用。
@RunWith(PowerMockRunner.class)publicclassUserServiceTest{@InjectMocksprivateUserServiceuserService;...}
在编写单元测试用例时,需要模拟各种依赖对象——类成员、方法参数和方法返回值。
如果需要构建一个对象,最简单直接的方法就是——定义对象并赋值。
LonguserId=1L;StringuserName="admin";UserDOuser=newUser();user.setId(userId);user.setName(userName);List
反序列化模型对象:
Stringtext=ResourceHelper.getResourceAsString(getClass(),"user.json");UserDOuser=JSON.parseObject(text,UserDO.class);反序列化集合对象:
Stringtext=ResourceHelper.getResourceAsString(getClass(),"userList.json");List
Stringtext=ResourceHelper.getResourceAsString(getClass(),"userMap.json");Map
利用Mockito.mock方法模拟依赖对象,主要用于以下几种情形:
MockClassmockClass=Mockito.mock(MockClass.class);List
@RunWith(PowerMockRunner.class)publicclassUserServiceTest{@MockprivateUserDAOuserDAO;...}4.5.利用Mockito.spy方法Mockito.spy方法跟Mockito.mock方法功能相似,只是Mockito.spy方法默认所有方法都是真实方法,除非主动去模拟对应方法。
UserServiceuserService=Mockito.spy(newUserService());UserServiceuserService=Mockito.spy(UserService.class);AbstractOssServiceossService=Mockito.spy(AbstractOssService.class);4.6.利用@Spy注解@Spy注解跟Mockito.spy方法一样,可以用来模拟依赖对象,适用于普通类、接口和虚基类。@Spy注解需要配合@RunWith注解使用。
当模拟完这些类成员对象后,我们需要把这些类成员对象注入到被测试类的实例中。以便在调用被测试方法时,可能使用这些类成员对象,而不至于抛出空指针异常。
如果类定义了Setter方法,可以直接调用方法设置字段值。
userService.setMaxCount(100);userService.setUserDAO(userDAO);5.2.利用ReflectionTestUtils.setField方法注入JUnit提供ReflectionTestUtils.setField方法设置属性字段值。
ReflectionTestUtils.setField(userService,"maxCount",100);ReflectionTestUtils.setField(userService,"userDAO",userDAO);5.3.利用Whitebox.setInternalState方法注入PowerMock提供Whitebox.setInternalState方法设置属性字段值。
Whitebox.setInternalState(userService,"maxCount",100);Whitebox.setInternalState(userService,"userDAO",userDAO);5.4.利用@InjectMocks注解注入@InjectMocks注解用来创建一个实例,并将其它对象(@Mock、@Spy或直接定义的对象)注入到该实例中。@InjectMocks注解需要配合@RunWith注解使用。
@RunWith(PowerMockRunner.class)publicclassUserServiceTest{@MockprivateUserDAOuserDAO;privateBooleancanModify;@InjectMocksprivateUserServiceuserService;...}5.5.设置静态常量字段值有时候,我们需要对静态常量对象进行模拟,然后去验证是否执行了对应分支下的方法。比如:需要模拟Lombok的@Slf4j生成的log静态常量。但是,Whitebox.setInternalState方法和@InjectMocks注解并不支持设置静态常量,需要自己实现一个设置静态常量的方法:
publicfinalclassFieldHelper{publicstaticvoidsetStaticFinalField(Class<>clazz,StringfieldName,ObjectfieldValue)throwsNoSuchFieldException,IllegalAccessException{Fieldfield=clazz.getDeclaredField(fieldName);FieldUtils.removeFinalModifier(field);FieldUtils.writeStaticField(field,fieldValue,true);}}具体使用方法如下:
FieldHelper.setStaticFinalField(UserService.class,"log",log);注意:经过测试,该方法对于int、Integer等基础类型并不生效,应该是编译器常量优化导致。
在模拟完依赖的参数和返回值后,就可以利用Mockito和PowerMock的功能,进行依赖方法的模拟。如果依赖对象还有方法调用,还需要模拟这些依赖对象的方法。
Mockito.doNothing().when(userDAO).delete(userId);6.1.2.模拟方法单个返回值Mockito.doReturn(user).when(userDAO).get(userId);Mockito.when(userDAO.get(userId)).thenReturn(user);6.1.3.模拟方法多个返回值直接列举出多个返回值:
Mockito.doReturn(record0,record1,record2,null).when(recordReader).read();Mockito.when(recordReader.read()).thenReturn(record0,record1,record2,null);转化列表为多个返回值:
List
Mockito.doThrow(PersistenceException.class).when(userDAO).get(Mockito.anyLong());Mockito.when(userDAO.get(Mockito.anyLong())).thenThrow(PersistenceException.class);指定单个异常对象:
Mockito.doThrow(exception).when(userDAO).get(Mockito.anyLong());Mockito.when(userDAO.get(Mockito.anyLong())).thenThrow(exception);6.1.6.模拟方法抛出多个异常指定多个异常类型:
Mockito.doThrow(PersistenceException.class,RuntimeException.class).when(userDAO).get(Mockito.anyLong());Mockito.when(userDAO.get(Mockito.anyLong())).thenThrow(PersistenceException.class,RuntimeException.class);指定多个异常对象:
Mockito.doThrow(exception1,exception2).when(userDAO).get(Mockito.anyLong());Mockito.when(userDAO.get(Mockito.anyLong())).thenThrow(exception1,exception2);6.1.7.直接调用真实方法Mockito.doCallRealMethod().when(userService).getUser(userId);Mockito.when(userService.getUser(userId)).thenCallRealMethod();6.2.根据参数模拟方法Mockito提供do-when语句和when-then语句模拟方法。
对于无参数的方法模拟:
Mockito.doReturn(deleteCount).when(userDAO).deleteAll();Mockito.when(userDAO.deleteAll()).thenReturn(deleteCount);6.2.2.模拟指定参数方法对于指定参数的方法模拟:
Mockito.doReturn(user).when(userDAO).get(userId);Mockito.when(userDAO.get(userId)).thenReturn(user);6.2.3.模拟任意参数方法在编写单元测试用例时,有时候并不关心传入参数的具体值,可以使用Mockito参数匹配器的any方法。Mockito提供了anyInt、anyLong、anyString、anyList、anySet、anyMap、any(Class
Mockito.doReturn(user).when(userDAO).get(Mockito.anyLong());Mockito.when(userDAO.get(Mockito.anyLong())).thenReturn(user);6.2.4.模拟可空参数方法Mockito参数匹配器的any具体方法,并不能够匹配null对象。而Mockito提供一个nullable方法,可以匹配包含null对象的任意对象。此外,Mockito.any()方法也可以用来匹配可空参数。
Mockito.doReturn(user).when(userDAO).queryCompany(Mockito.anyLong(),Mockito.nullable(Long.class));Mockito.when(userDAO.queryCompany(Mockito.anyLong(),Mockito.
Mockito.doReturn(user).when(userDAO).queryCompany(Mockito.anyLong(),Mockito.isNull());Mockito.when(userDAO.queryCompany(Mockito.anyLong(),Mockito.eq(null))).thenReturn(user);6.2.6.模拟不同参数方法Mockito支持按不同的参数分别模拟同一方法。
Mockito.doReturn(user1).when(userDAO).get(1L);Mockito.doReturn(user2).when(userDAO).get(2L);...注意:如果一个参数满足多个模拟方法条件,会以最后一个模拟方法为准。
对于一些变长度参数方法,可以按实际参数个数进行模拟:
Mockito.when(userService.delete(Mockito.anyLong()).thenReturn(true);Mockito.when(userService.delete(1L,2L,3L).thenReturn(true);也可以用Mockito.any()模拟一个通用匹配方法:
Mockito.when(userService.delete(Mockito.
PowerMock提供对final方法的模拟,方法跟模拟普通方法一样。但是,需要把对应的模拟类添加到@PrepareForTest注解中。
//添加@PrepareForTest注解@PrepareForTest({UserService.class})//跟模拟普通方法完全一致Mockito.doReturn(userId).when(idGenerator).next();Mockito.when(idGenerator.next()).thenReturn(userId);6.3.2.模拟私有方法PowerMock提供提对私有方法的模拟,但是需要把私有方法所在的类放在@PrepareForTest注解中。
PowerMockito.doReturn(true).when(UserService.class,"isSuper",userId);PowerMockito.when(UserService.class,"isSuper",userId).thenReturn(true);6.3.3.模拟构造方法PowerMock提供PowerMockito.whenNew方法来模拟构造方法,但是需要把使用构造方法的类放在@PrepareForTest注解中。
PowerMockito.whenNew(UserDO.class).withNoArguments().thenReturn(userDO);PowerMockito.whenNew(UserDO.class).withArguments(userId,userName).thenReturn(userDO);6.3.4.模拟静态方法PowerMock提供PowerMockito.mockStatic和PowerMockito.spy来模拟静态方法类,然后就可以模拟静态方法了。同样,需要把对应的模拟类添加到@PrepareForTest注解中。
在准备好参数对象后,就可以调用被测试方法了。
如果把方法按访问权限分类,可以简单地分为有访问权限和无访问权限两种。但实际上,Java语言中提供了public、protected、private和缺失共4种权限修饰符,在不同的环境下又对应不同的访问权限。具体映射关系如下:
修饰符
本类
本包
子类
其它
public
有
protected
无
缺省
private
下面,将根据有访问权限和无访问权限两种情况,来介绍如何调用被测方法。
可以直接调用有访问权限的构造方法。
UserDOuser=newUser();UserDOuser=newUser(1L,"admin");7.1.2.调用无访问权限的构造方法调用无访问权限的构造方法,可以使用PowerMock提供的Whitebox.invokeConstructor方法。
Whitebox.invokeConstructor(NumberHelper.class);Whitebox.invokeConstructor(User.class,1L,"admin");备注:该方法也可以调用有访问权限的构造方法,但是不建议使用。
可以直接调用有访问权限的普通方法。
userService.deleteUser(userId);Useruser=userService.getUser(userId);7.2.2.调用无权限访问的普通方法调用无访问权限的普通方法,可以使用PowerMock提供的Whitebox.invokeMethod方法。
Useruser=(User)Whitebox.invokeMethod(userService,"isSuper",userId);也可以使用PowerMock提供Whitebox.getMethod方法和PowerMockito.method方法,可以直接获取对应类方法对象。然后,通过Method的invoke方法,可以调用没有访问权限的方法。
Methodmethod=Whitebox.getMethod(UserService.class,"isSuper",Long.class);Methodmethod=PowerMockito.method(UserService.class,"isSuper",Long.class);Useruser=(User)method.invoke(userService,userId);备注:该方法也可以调用有访问权限的普通方法,但是不建议使用。
可以直接调用有访问权限的静态方法。
booleanisPositive=NumberHelper.isPositive(-1);7.3.2.调用无权限访问的静态方法调用无权限访问的静态方法,可以使用PowerMock提供的Whitebox.invokeMethod方法。
Stringvalue=(String)Whitebox.invokeMethod(JSON.class,"toJSONString",object);备注:该方法也可以调用有访问权限的静态方法,但是不建议使用。
在单元测试中,验证是确认模拟的依赖方法是否按照预期被调用或未调用的过程。Mockito提供了许多方法来验证依赖方法调用,给我们编写单元测试用例带来了很大的帮助。
Mockito.verify(userDAO).deleteAll();8.1.2.验证指定参数方法调用Mockito.verify(userDAO).delete(userId);Mockito.verify(userDAO).delete(Mockito.eq(userId));8.1.3.验证任意参数方法调用Mockito.verify(userDAO).delete(Mockito.anyLong());8.1.4.验证可空参数方法调用Mockito.verify(userDAO).queryCompany(Mockito.anyLong(),Mockito.nullable(Long.class));8.1.5.验证必空参数方法调用Mockito.verify(userDAO).queryCompany(Mockito.anyLong(),Mockito.isNull());8.1.6.验证可变参数方法调用对于一些变长度参数方法,可以按实际参数个数进行验证:
Mockito.verify(userService).delete(Mockito.any(Long.class));Mockito.verify(userService).delete(1L,2L,3L);也可以用Mockito.any()进行通用验证:
Mockito.verify(userService).delete(Mockito.
Mockito.verify(userDAO,Mockito.call(n)).delete(userId);8.2.8.验证对象及其方法调用1次用于验证对象及其方法调用1次,如果该对象还有别的方法被调用或者该方法调用了多次,都将导致验证方法调用失败。
Mockito.verify(userDAO,Mockito.only()).delete(userId);相当于:
Mockito.verify(userDAO).delete(userId);Mockito.verifyNoMoreInteractions(userDAO);8.3.验证方法调用并捕获参数值Mockito提供ArgumentCaptor类来捕获参数值,通过调用forClass(Class
ArgumentCaptor的主要接口方法:
在测试用例方法中,直接使用ArgumentCaptor.forClass方法定义参数捕获器。
ArgumentCaptor
也可以用Mockito提供的@Captor注解,在测试用例类中定义参数捕获器。
@RunWith(PowerMockRunner.class)publicclassUserServiceTest{@CaptorprivateArgumentCaptor
ArgumentCaptor
PowerMockito提供verifyPrivate方法验证私有方法调用。
PowerMockito.verifyPrivate(myClass,times(1)).invoke("unload",any(List.class));8.4.3.验证构造方法调用PowerMockito提供verifyNew方法验证构造方法调用。
PowerMockito.verifyNew(MockClass.class).withNoArguments();PowerMockito.verifyNew(MockClass.class).withArguments(someArgs);8.4.4.验证静态方法调用PowerMockito提供verifyStatic方法验证静态方法调用。
PowerMockito.verifyStatic(StringUtils.class);StringUtils.isEmpty(string);
JUnit测试框架中Assert类就是断言工具类,主要验证单元测试中实际数据对象与期望数据对象一致。在调用被测方法时,需要对返回值和异常进行验证;在验证方法调用时,也需要对捕获的参数值进行验证。
通过JUnit提供的Assert.assertNull方法验证数据对象为空。
Assert.assertNull("用户标识必须为空",userId);9.1.2.验证数据对象非空通过JUnit提供的Assert.assertNotNull方法验证数据对象非空。
Assert.assertNotNull("用户标识不能为空",userId);9.2.验证数据对象布尔值9.2.1.验证数据对象为真通过JUnit提供的Assert.assertTrue方法验证数据对象为真。
Assert.assertTrue("返回值必须为真",NumberHelper.isPositive(1));9.2.2.验证数据对象为假通过JUnit提供的Assert.assertFalse方法验证数据对象为假。
Assert.assertFalse("返回值必须为假",NumberHelper.isPositive(-1));9.3.验证数据对象引用在单元测试用例中,对于一些参数或返回值对象,不需要验证对象具体取值,只需要验证对象引用是否一致。
JUnit提供的Assert.assertSame方法验证数据对象一致。
UserDOexpectedUser=...;Mockito.doReturn(expectedUser).when(userDAO).get(userId);UserDOactualUser=userService.getUser(userId);Assert.assertSame("用户必须一致",expectedUser,actualUser);9.3.1.验证数据对象不一致JUnit提供的Assert.assertNotSame方法验证数据对象一致。
UserDOexpectedUser=...;Mockito.doReturn(expectedUser).when(userDAO).get(userId);UserDOactualUser=userService.getUser(otherUserId);Assert.assertNotSame("用户不能一致",expectedUser,actualUser);9.4.验证数据对象值JUnit提供Assert.assertEquals、Assert.assertNotEquals、Assert.assertArrayEquals方法组,可以用来验证数据对象值是否相等。
对于简单数据对象(比如:基础类型、包装类型、实现了equals的数据类型……),可以直接通过JUnit的Assert.assertEquals和Assert.assertNotEquals方法组进行验证。
Assert.assertNotEquals("用户名称不一致","admin",userName);Assert.assertEquals("账户金额不一致",10000.0D,accountAmount,1E-6D);9.4.2.验证简单数组或集合对象对于简单数组对象(比如:基础类型、包装类型、实现了equals的数据类型……),可以直接通过JUnit的Assert.assertArrayEquals方法组进行验证。对于简单集合对象,也可以通过Assert.assertEquals方法验证。
Long[]userIds=...;Assert.assertArrayEquals("用户标识列表不一致",newLong[]{1L,2L,3L},userIds);List
UserDOuser=...;Assert.assertEquals("用户标识不一致",Long.valueOf(1L),user.getId());Assert.assertEquals("用户名称不一致","admin",user.getName());Assert.assertEquals("用户公司标识不一致",Long.valueOf(1L),user.getCompany().getId());...9.4.4.验证复杂数组或集合对象对于复杂的JavaBean数组和集合对象,需要先展开数组和集合对象中每一个JavaBean数据对象,然后验证JavaBean数据对象的每一个属性字段。
List
Map
MapperScannerConfigurerconfigurer=myBatisConfiguration.buildMapperScannerConfigurer();Assert.assertEquals("基础包不一致","com.alibaba.example",Whitebox.getInternalState(configurer,"basePackage"));9.5.验证异常对象内容异常作为Java语言的重要特性,是Java语言健壮性的重要体现。捕获并验证异常数据内容,也是测试用例的一种。
JUnit的注解@Test提供了一个expected属性,可以指定一个期望的异常类型,用来捕获并验证异常。但是,这种方式只能验证异常类型,并不能验证异常原因和消息。
@RuleprivateExpectedExceptionexception=ExpectedException.none();@TestpublicvoidtestGetUser(){//模拟依赖方法LonguserId=123L;Mockito.doReturn(null).when(userDAO).get(userId);//调用被测方法exception.expect(ExampleException.class);exception.expectMessage(String.format("用户(%s)不存在",userId));userService.getUser(userId);}9.5.3.通过Assert.assertThrows验证异常对象在最新版的JUnit中,提供了一个更为简洁的异常验证方式——Assert.assertThrows方法。
@TestpublicvoidtestGetUser(){//模拟依赖方法LonguserId=123L;Mockito.doReturn(null).when(userDAO).get(userId);//调用被测方法ExampleExceptionexception=Assert.assertThrows("异常类型不一致",ExampleException.class,()->userService.getUser(userId));Assert.assertEquals("异常消息不一致","处理异常",exception.getMessage());}
Mockito提供了verifyNoInteractions方法,可以验证模拟对象在被测试方法中没有任何调用。
Mockito.verifyNoInteractions(idGenerator,userDAO);10.2.验证模拟对象没有更多方法调用Mockito提供了verifyNoMoreInteractions方法,在验证模拟对象所有方法调用后使用,可以验证模拟对象所有方法调用是否都得到验证。如果模拟对象存在任何未验证的方法调用,就会抛出NoInteractionsWanted异常。
Mockito.verifyNoMoreInteractions(idGenerator,userDAO);备注:Mockito的verifyZeroInteractions方法与verifyNoMoreInteractions方法功能相同,但是目前前者已经被废弃。
在编写单元测试用例时,为了减少单元测试用例数和代码量,可以把多组参数定义在同一个单元测试用例中,然后用for循环依次执行每一组参数的被测方法调用。为了避免上一次测试的方法调用影响下一次测试的方法调用验证,最好使用Mockito提供clearInvocations方法清除上一次的方法调用。
//清除所有对象调用Mockito.clearInvocations();//清除指定对象调用Mockito.clearInvocations(idGenerator,userDAO);
这里,只收集了几个经典案例,解决了特定环境下的特定问题。
在编写单元测试用例时,或多或少会遇到一些问题,大多数是由于对测试框架特性不熟悉导致,比如:
……
在编写单元测试用例时,通常采用ArgumentCaptor进行参数捕获,然后对参数对象值进行验证。如果参数对象值没有变更,这个步骤就没有任何问题。但是,如果参数对象值在后续流程中发生变更,就会导致验证参数值失败。
原始代码:
public>dataStorage){try{//依次读取数据Recordrecord;booleanisContinue=true;List
执行单元测试用例失败,抛出以下异常信息:
java.lang.AssertionError:数据列表不一致expected:<[[java.lang.Object@1e3469df,java.lang.Object@79499fa],[java.lang.Object@48531d5]]>butwas:<[[],[]]>问题原因:
由于参数dataList在调用dataStorage.test方法后,都被主动调用dataList.clear方法进行清空。由于ArgumentCaptor捕获的是对象引用,所以最后捕获到了同一个空列表。
解决方案:
可以在模拟依赖方法dataStorage.test时,保存传入参数的当前值进行验证。代码如下:
@TestpublicvoidtestReadData()throwsException{//模拟依赖方法...//模拟依赖方法:dataStorage.testList
Lombok的@Slf4j注解,广泛地应用于Java项目中。在某些代码分支里,可能只有log记录日志的操作,为了验证这个分支逻辑被正确执行,需要在单元测试用例中对log记录日志的操作进行验证。
原始方法:
@Slf4j@ServicepublicclassExampleService{publicvoidrecordLog(intcode){if(code==1){log.info("执行分支1");return;}if(code==2){log.info("执行分支2");return;}log.info("执行默认分支");}...}测试用例:
@RunWith(PowerMockRunner.class)publicclassExampleServiceTest{@MockprivateLoggerlog;@InjectMocksprivateExampleServiceexampleService;@TestpublicvoidtestRecordLog1(){exampleService.recordLog(1);Mockito.verify(log).info("执行分支1");}}问题现象:
Wantedbutnotinvoked:logger.info("执行分支1");原因分析:
经过调式跟踪,发现ExampleService中的log对象并没有被注入。通过编译发现,Lombok的@Slf4j注解在ExampleService类中生成了一个静态常量log,而@InjectMocks注解并不支持静态常量的注入。
采用作者实现的FieldHelper.setStaticFinalField方法,可以实现对静态常量的注入模拟对象。
@RunWith(PowerMockRunner.class)publicclassExampleServiceTest{@MockprivateLoggerlog;@InjectMocksprivateExampleServiceexampleService;@BeforepublicvoidbeforeTest()throwsException{FieldHelper.setStaticFinalField(ExampleService.class,"log",log);}@TestpublicvoidtestRecordLog1(){exampleService.recordLog(1);Mockito.verify(log).info("执行分支1");}}11.4.兼容Pandora等容器问题阿里巴巴的很多中间件,都是基于Pandora容器的,在编写单元测试用例时,可能会遇到一些坑。
java.lang.RuntimeException:com.alibaba.rocketmq.client.producer.SendResultwasloadedbyorg.powermock.core.classloader.javassist.JavassistMockClassLoader@5d43661b,itshouldbeloadedbyPandoraContainer.Cannotloadthisfakesdkclass.原因分析:
基于Pandora容器的中间件,需要使用Pandora容器加载。在上面测试用例中,使用了PowerMock容器加载,从而导致抛出类加载异常。
首先,把PowerMockRunner替换为PandoraBootRunner。其次,为了使@Mock、@InjectMocks等Mockito注解生效,需要调用MockitoAnnotations.initMocks(this)方法进行初始化。
@RunWith(PandoraBootRunner.class)publicclassMetaqMessageSenderTest{...@BeforepublicvoidbeforeTest(){MockitoAnnotations.initMocks(this);}...}
在编写测试用例时,特别是泛型类型转换时,很容易产生类型转换警告。常见类型转换警告如下:
Typesafety:UncheckedcastfromObjecttoList
Mockito提供@Mock注解来模拟类实例,提供@Captor注解来初始化参数捕获器。由于这些注解实例是通过测试框架进行初始化的,所以不会产生类型转换警告。
问题代码:
Map
@MockprivateMap
Function
/**定义临时类或接口*/privateinterfaceDataParserextendsFunction
Function
Function
注意:CastUtils.cast方法本质是——先转换为Object类型,再强制转换对应类型,本身不会对类型进行校验。所以,CastUtils.cast方法好用,但是不要乱用,否则就是大坑(只有执行时才能发现问题)。
在Mockito中,提供形式如下的方法——泛型类型只跟返回值有关,而跟输入参数无关。这样的方法,可以根据调用方法的参数类型自动转换,而无需手动强制类型转换。如果手动强制类型转换,反而会产生类型转换警告。
Mockito.doAnswer(invocation->dataList.addAll((List
Mockito.doAnswer(invocation->dataList.addAll(invocation.getArgument(0))).when(dataStorage).test(Mockito.anyList());Mockito.doThrow(e).when(workflow).beginToPrepare(Mockito.any());Map
Mockito的when-thenReturn语句需要对返回类型强制校验,而doReturn-when语句不会对返回类型强制校验。利用这个特性,可以利用doReturn-when语句代替when-thenReturn语句解决类型转换警告。
List
List<>valueList=Mockito.mock(List.class);Mockito.doReturn(valueList).when(listOperations).range(KEY,start,end);12.6.利用Whitebox.invokeMethod方法代替Method.invoke方法JDK提供的Method.invoke方法返回的是Object类型,转化为具体类型时需要强制转换,会产生类型转换警告。而PowerMock提供的Whitebox.invokeMethod方法返回类型可以自动转化,不会产生类型转换警告
Methodmethod=PowerMockito.method(UserService.class,"getScoreMap");Map
Map
JSONArrayjsonArray=(JSONArray)object;...建议代码:
if(objectinstanceofJSONArray){JSONArrayjsonArray=(JSONArray)object;...}12.8.利用Class.cast方法在泛型类型强制转换时,会产生类型转换警告。可以采用泛型类的cast方法转换,从而避免产生类型转换警告。
publicstatic
publicstatic
BooleanisSupper=(Boolean)method.invokeMethod(userService,userId);Assert.assertEquals("期望值不为真",Boolean.TRUE,isSupper);List
Assert.assertEquals("期望值不为真",Boolean.TRUE,method.invokeMethod(userService,userId));ObjectuserList=method.invokeMethod(userService,companyId);Assert.assertEquals("期望值不一致",expectedJson,JSON.toJSONString(userList));
登妙峰山记
山高路远车难骑,
精疲力尽人易弃。
多少妙峰登顶者,
又练心境又练力!
骑行的人,一定要沉得住气、要吃得了苦、要耐得住寂寞、要意志坚定不移、要体力够猛够持久……恰好,这也正是技术人所要具备的精神。只要技术人做到了这些,练就了好的“心境”和“体力”,才有可能登上技术的“妙峰山”。