阿里妹导读
好的单元测试不仅可以验证代码结构设计的是否合理,而且可以提前发现代码中的漏洞,将线上风险扼杀在摇篮中。本文从常用的单元测试框架出发,对Mockito框架深入浅出的讲解,希望能帮到每一位同学。
随着我们各种“code大赛”的不断推进,大家对于单元测试也越发重视。好的单元测试不仅可以验证代码结构设计得是否合理,而且可以提前发现代码中的漏洞,将线上风险扼杀在摇篮中。写好单元测试是每一位程序员的基本功,但是有不少同学对于单元测试有些知其然但不知其所以然,对于单元测试的底层逻辑并未深入研究过,只停留在使用的层面。本文从常用的单元测试框架出发,对Mockito框架深入浅出的讲解,希望能帮到每一位同学。
Java中存在很多单元测试框架,每种框架有着自己独特的特点,根据不同的需求和团队要求,每位同学所使用的框架不尽相同,目前主流的测试框架有且不仅有以下几种:
JUnit是Java中最常用的单元测试框架。该框架提供了丰富的测试与断言方法,例如:assertNull、assertTrue、assertEquals等,使用方法比较简单。JUnit目前已经更新到JUnit5版本,该版本提供了更多的新特性,例如:动态测试,依赖注入等,使得该框架更为健壮。
官网介绍:https://junit.org/junit5/
TestNG是Java中的另一种测试框架,集团内使用的较为小众。该框架的设计是受了JUnit的启发,初衷是为了更好地支持从单元测试到集成测试的各个方面,用来完成一些JUnit所不能完成的测试任务。该框架较JUnit相比,功能更加强大,提供了更多的高级特性,例如:测试套件、数据驱动测试、依赖测试、并行测试等。在更复杂的测试场景(如参数化测试、依赖测试等)中,TestNG的表现更加优异。
官网介绍:https://testng.org/
Spock是基于Groovy语言编写的测试框架,该框架可以用来测试Java和Groovy的代码程序。Spock用来写测试代码的语言十分优美、表达力强,这一优点大大提高了测试代码的可读性和可维护性。Spock框架融合了JUnit、jMock、RSpec、Groovy、Scala和Vulcans等多种框架和语言的优点,旨在提供一套强大的测试平台。官网介绍:https://spockframework.org/Mockito
Mockito不是一个完整的单元测试框架,而是专注于mock对象的创建、验证。它通常与JUnit或TestNG结合使用来简化对复杂依赖的测试。是目前集团内最主流的测试框架,下文中将对该框架进行详细阐述。
官网介绍:http://site.mockito.org/
EasyMock是一套通过简单方法对于给定的接口生成mock对象的类库,通过使用Java代理机制动态生成模拟对象。该框架提供对接口的模拟,能够通过录制、回放、检查三步来完成大体的测试过程,可以验证方法的调用种类、次数、顺序等,还可以令mock对象返回指定的值或抛出指定异常。开发者通过EasyMock可以方便的构造mock对象而忽略对象背后真正的业务逻辑。一般情况下,EasyMock与JUnit或TestNG配合使用。官网介绍:https://easymock.org/
PowerMock是一种用于Java单元测试的框架,它扩展了其他mocking框架的能力,比如EasyMock和Mockito。PowerMock的主要特点是它可以mock静态方法、私有方法、final方法、构造函数,甚至系统类(如System、String等),这些通常是传统mocking框架所做不到的。
有了这些功能,PowerMock在一些复杂场景下进行单元测试更加方便。虽然PowerMock提供了强大的功能,但由于它修改了类加载器和字节码操作,可能会导致一些测试方法与JVM或第三方库之间的兼容性问题。所以,在使用PowerMock时需要权衡其提供的功能和可能带来的复杂性。
ps:由于PowerMock的执行速度问题(每个测试类都需要重启spring的TestContext),我们团队内部不建议使用该框架。
官网介绍:https://github.com/powermock/powermock
JMock是一种用于Java单元测试的框架,属于一种轻量级框架,该框架采用了行为驱动开发(BDD)的测试风格。用来在单元测试中mock接口或类的依赖项,对代码进行隔离测试,而无需关心整个系统的其他部分。JMock支持通过声明式的方式来指定对象间的交互行为。
官网介绍:http://jmock.org/
大部分开发者在使用这些测试框架时,不会独立使用其中一种,而是会结合使用,例如,可以在JUnit或TestNG的基础上使用Mockito来创建和使用mock对象,来完成比较复杂的测试任务。每个框架都有其独特的优点与缺点,选择哪个框架通常取决于个人偏好、项目需求以及现有代码库的兼容性。当然,实际开发中的单元测试框架远不止以上所提到的这些,还有一些同样优秀的框架在本文中没有介绍,例如:Selenium、Cucumber、Appium等,感兴趣的读者可以自行学习。
目前集团内主流的单元测试框架用的是Mockito框架,该框架的单元测试流程为:
以下面的代码为例,展示一下单元测试的常用写法:
@Autowired
private BenefitRecordQueryServiceI benefitRecordQueryServiceI;
@Override
public List<BenefitRecordExtendVO> queryBenefitRecordList(Long companyId, String scene) {
Validate.notNull(companyId, "companyId cannot be null");
Validate.notBlank(scene, "scene cannot be null");
BenefitRecordQueryParam param = new BenefitRecordQueryParam();
param.setCompanyId(companyId);
param.setScene(scene);
MultiResponse<BenefitRecordExtendDTO> res = benefitRecordQueryServiceI
.pageQueryBenefitRecordWithExtendAttrs(param);
if (res == null || !res.isSuccess()) {
log.error("pageQueryBenefitRecordWithExtendAttrs error, companyId:{}, scene:{}, res:{}",companyId, scene, JSON.toJSONString(res));
throw new SupplierFosterException("pageQueryBenefitRecordWithExtendAttrs error");
}
return DataObjectUtils.transferDeep(res.getData(), BenefitRecordExtendVO.class);
}
对以上代码写一段合格的单元测试是每一位程序员的基本功,无非就是@InjectMocks、@Mock、Mockito.when()、Mockito.verify()等一系列操作。当然,我们也是这样做的:
@InjectMocks
private BenefitAdaptorImpl benefitAdaptor;
@Mock
private BenefitRecordQueryServiceI benefitRecordQueryServiceI;
@Test
public void testQueryBenefitRecordListWhenSuccess() {
Long companyId = 123L;
String scene = "cnfm";
MultiResponse<BenefitRecordExtendDTO> res = new MultiResponse<>();
List<BenefitRecordExtendDTO> resList = new ArrayList<>();
BenefitRecordExtendDTO benefitRecordExtendDTO = new BenefitRecordExtendDTO();
benefitRecordExtendDTO.setBenefitCode("rfq");
resList.add(benefitRecordExtendDTO);
res.setSuccess(true);
res.setData(resList);
Mockito.when(benefitRecordQueryServiceI.pageQueryBenefitRecordWithExtendAttrs(
Mockito.any())).thenReturn(res);
List<BenefitRecordExtendVO> result = benefitAdaptor.queryBenefitRecordList(companyId, scene);
Assert.assertEquals(1, result.size());
BenefitRecordExtendVO benefitRecordRes = result.get(0);
Assert.assertNotNull(benefitRecordRes);
Assert.assertEquals("rfq", benefitRecordRes.getBenefitCode());
Mockito.verify(benefitRecordQueryServiceI).pageQueryBenefitRecordWithExtendAttrs(
Mockito.any());
}
点击,运行,没问题!ok,继续写下一段,等等~真的没问题了吗?那请尝试回答一下下面的几个问题:
如果你能清晰的回答以上4个问题,那么这篇文章对于你来说是一个温故的作用;如果回答不上来,那么阅读这篇文章来知新吧!
@RunWith(MockitoJUnitRunner.class)是Junit中的一个注解,用来指定测试运行环境(MockitoJUnitRunner)。该注解的主要作用就是自动初始化mock对象。
在Mockito 1.9.5之前,初始化mock对象需要通过手动的显示调用:
@Before
public void initMocks() {
MockitoAnnotations.initMocks(this);
}
Mockito 1.9.5之后,将该初始化过程集成到MockitoJUnitRunner中,仅需要一个注解,就可以完成mock对象的注入,让我们一起看一下MockitoJUnitRunner到底是怎么执行的,以Mockito 2.23.0版本为例:
看起来MockitoAnnotations.initMocks(this)可能不是在MockitoJUnitRunner的构造函数中直接调用的。相反,MockitoJUnitRunner可能在另外一个封装层(如StrictRunner或RunnerFactory中创建的某个Runner)中处理初始化mock的逻辑:
可以看出,InternalRunner接口的实现类DefaultInternalRunner的构造函数中调用了MockitoAnnotations.initMocks(this)来初始化mock对象。这样做的好处主要有两点:1)代码更加简洁;2)在运行测试用例之前保证对象都已经mock完成。至于MockitoAnnotations.initMocks(this)是怎么mock对象的,请继续往下看。
@InjectMocks是Mockito测试框架提供的一个注解,会自动将mock对象注入到被测试类的实例中,来创建和初始化那些需要被注入的mock对象,被测试对象通常是要被进行单元测试的类。@InjectMocks注解如下:
根据官网对@InjectMocks的介绍,注入mock对象的方式有3种:
仅仅知道这3种注入方式,并不能帮我们深入理解Mockito到底是怎么运行的,那么该注解的执行是怎么样的呢?
前文提到,Mockito在处理注解时,主要是通过MockitoAnnotations.initMocks(this)方法进入。首先,这个方法会创建一个注解引擎-AnnotationEngine:
这个引擎会对测试类进行扫描,寻找所有Mockito注解字段(包括@Mock,@Spy,@Captor和@InjectMocks),每一种注解有着相对应的处理器进行相应的处理,以InjectingAnnotationEngine为例:
通过injectMocks和injectMocksOnFields方法可以看出,Mockito是会尝试在被测试类中找到一个构造器,该构造器的参数与现有的mock对象是相匹配的,并使用这些mock对象实例化@InjectMocks注解的字段。如果没有找到相匹配的构造器,Mockito将使用属性注入的方式直接设置字段的值,或者通过setter方法进行注入。@InjectMocks注解的功能是由Mockito内部的几个类协同工作实现的,逻辑处理十分复杂,涉及到许多边界情况的处理和错误管理,例如,需要处理多个构造器、避免循环依赖、选择最佳的注入策略等。
下面通过一段伪代码对上述的流程进行逻辑概括:
public class MockitoAnnotations {
public static void initMocks(Object test) {
AnnotationEngine annotationEngine = ...;
annotationEngine.process(test.getClass(), test);
}
}
public class InjectMocksAnnotationEngine implements AnnotationEngine {
public void process(Class<?> clazz, Object testInstance) {
// 获取所有 @Mock 标注的字段
Set<Field> mockFields = ...;
// 获取所有 @InjectMocks 标注的字段
Set<Field> injectMocksFields = ...;
for (Field injectMocksField : injectMocksFields) {
// 创建 @InjectMocks 标注字段的实例
Object fieldInstance = createInstance(injectMocksField.getType());
injectMocksField.setAccessible(true);
// 将实例设置到测试类的字段中
injectMocksField.set(testInstance, fieldInstance);
PropertySetterInjector propertySetterInjector = new PropertySetterInjector(mockFields);
ConstructorInjector constructorInjector = new ConstructorInjector(mockFields);
if (!constructorInjector.tryConstructorInjection(fieldInstance, injectMocksField)) {
propertySetterInjector.tryPropertyOrSetterInjection(fieldInstance, injectMocksField);
}
}
}
}
public class ConstructorInjector {
public boolean tryConstructorInjection(Object fieldInstance, Field injectMocksField) {
// 使用反射尝试通过构造器注入 mock 对象
}
}
public class PropertySetterInjector {
public void tryPropertyOrSetterInjection(Object fieldInstance, Field injectMocksField) {
// 使用反射尝试通过属性或setter方法注入 mock 对象
}
}
对于该注解的执行逻辑,可以总结为以下4步:
对于属性或setter方法,它会直接注入mock对象。通过以上的步骤注入的mock对象,和Spring加载的对象有着明显的区别:
@Mock注解用于注入测试对象,该测试对象通常是被测试对象的依赖或者外部组件,主要用来标记需要模拟的类或者接口。
注入之后,可以在测试中模拟该对象的行为和返回值,而忽略该对象中的依赖和外部组件的行为。
@Mock注解如下:
@Mock注解的逻辑入口和@InjectMocks一致,都是从MockitoAnnotations.initMocks(this)开始执行,同样创建一个AnnotationEngine引擎:
根据该引擎的执行可以看出,首先通过反射获取测试类中所有字段,检查带有@Mock注解的字段,并为这些字段创建mock对象并设置到相应的字段上:
会根据不同的注解找到不同的处理器进行mock对象的处理:
读取注解的中配置的属性并将其转换为Mockito的MockSettings对象,调用Mockito.mock()方法并传入字段的类型和设置,以便创建具有所需特性的mock对象:
真正创建mock对象的代码如下:
分析上面的代码,发现一共做了以下几件事:
可以看出,逻辑还是非常复杂的。下面通过一段伪代码对上述的流程进行逻辑概括:
// MockitoAnnotations.initMocks方法的简化伪代码
public static void initMocks(Object testClassInstance) {
Class<?> testClass = testClassInstance.getClass();
Field[] fields = testClass.getDeclaredFields();
for (Field field : fields) {
if (field.isAnnotationPresent(Mock.class)) {
Mock mock = field.getAnnotation(Mock.class);
Object mockObject = createMockObject(field.getType(), mock);
field.setAccessible(true);
field.set(testClassInstance, mockObject);
}
}
}
private static Object createMockObject(Class<?> fieldType, Mock mockAnnotation) {
// 创建mock配置
MockSettings mockSettings = configureMockSettings(mockAnnotation);
// 使用Mockito API创建mock对象
return Mockito.mock(fieldType, mockSettings);
}
private static MockSettings configureMockSettings(Mock mockAnnotation) {
// 根据@Mock注解的属性配置MockSettings
MockSettings mockSettings = Mockito.withSettings();
if (!"".equals(mockAnnotation.name())) {
mockSettings.name(mockAnnotation.name());
}
if (mockAnnotation.stubOnly()) {
mockSettings.stubOnly();
}
// 其他配置参数
mockSettings.defaultAnswer(mockAnnotation.answer());
return mockSettings;
}
// Mockito.mock方法的简化伪代码
public static <T> T mock(Class<T> classToMock, MockSettings mockSettings) {
// 检查是否可以被mock
if (isNotMockable(classToMock)) {
throw new MockitoException("Cannot mock/spy class: " + classToMock.getName());
}
// 创建mock设置,如果未提供则使用默认设置
if (mockSettings == null) {
mockSettings = withSettings();
// 创建mock对象
T mockInstance = createMockInstance(classToMock, mockSetting
// 返回mock对象
return mockInstance;
}
private static <T> T createMockInstance(Class<T> classToMock, MockSettings mockSettings) {
// 根据mock设置创建一个MockCreationSettings对象
MockCreationSettings<T> settings = new MockCreationSettings<>(classToMock, mockSetting
// 获取MockMaker插件,它负责创建mock实例
MockMaker mockMaker = Plugins.getMockMaker
// 使用MockMaker创建mock实例
T mock = mockMaker.createMock(settings, new MockHandlerImpl<T>(settings
// 返回创建的mock实例
return mock;
}
对于该注解的执行原理,可以总结为以下4步:
Mockito.when()是Mockito框架中的一个核心功能,该功能用于为mock对象的方法调用指定一个预期的行为。
例如:返回一个特定的值、抛出一个异常或者执行一个特定的动作。然而,Mockito.when()只用来设置打桩状态,而不会定义预期的返回值,一般结合doReturn()、doThrow()、 doAnswer()、doNothing()、doCallRealMethod()等方法一起使用来指定函数调用的预期行为。
当Mockito.when()被调用时,会获取一个线程安全的MockingProgress实例来设置mock对象的打桩状态。该过程会涉及到线程局部变量的操作,以确保验证状态不会与其他线程的操作冲突。
通过pullOngoingStubbing()方法提取当前正在进行的打桩对象:
首先会获取当前的OngoingStubbing,该字段存储着当前线程的正在进行的打桩对象,然后清除该对象,防止未来的打桩操作错误地使用旧的打桩对象,最后返回该对象。
OngoingStubbing对象并无法分析开发者设置预期行为,需要链式调用thenReturn()、thenThrow() 等方法。例如:Mockito.when().thenReturn()。
下面以thenReturn()为例分析:
当OngoingStubbing对象链式调用thenReturn()之后,首先会通过new Returns(value)实例化一个返回指定值的对象并调用thenAnswer()方法:
从上面代码看,主要是将设置的预期行为添加到Mockito.when()生成的OngoingStubbing对象中,可以分为以下流程:
Mockito.verify()方法是Mockito框架中的一个核心功能,该功能用于验证一个mock对象的某个方法是否被调用,以及调用的次数和参数是否一致。
当Mockito.verify()被调用时,大致的运行流程如下:
verify()方法会创建一个新的VerificationMode实例,通常是调用1次的验证模式。所以,当验证函数只调用1次的情况下在verify函数中可以省略times的参数。
分析上面的代码,发现一共做了以下几件事:
在verify()的实际调用中,还包含了对InOrder验证、验证超时等高级特性的支持,以及对异常处理和各种边界情况的处理,本文仅提供了一个验证流程上的分析。
下面通过一段伪代码对上述的流程进行逻辑概括:
public class Mockito {
public static <T> T verify(T mock) {
return verify(mock, times(1));
}
public static <T> T verify(T mock, VerificationMode mode) {
MockingProgress progress = MockingProgressImpl.threadSafeMockingProgress();
progress.verificationStarted(mode);
return mock;
}
}
public class MockHandlerImpl<T> implements MockHandler<T> {
public Object handle(Invocation invocation) throws Throwable {
MockingProgress progress = MockingProgressImpl.threadSafeMockingProgress();
VerificationMode verificationMode = progress.pullVerificationMode();
if (verificationMode != null) {
// 验证调用
verificationMode.verify(invocation);
return null;
} else {
// 执行实际的mock行为
return invocation.callRealMethod();
}
}
}
本文讲述了Mockito框架运行单元测试的常用底层逻辑,对其中的一些高级特性并未深入探讨,感兴趣的小伙伴可以自行研究。单元测试是开发中一个庞大的分支,并非一篇文章能论述得清楚。当然,如果此文能引起你对单元测试底层逻辑的兴趣,那便是本文最大的价值了。
本文由微信公众号阿里云开发者原创,哈喽比特收录。
文章来源:https://mp.weixin.qq.com/s/9_TQbVSl1CQLQzuUrsrHLQ
京东创始人刘强东和其妻子章泽天最近成为了互联网舆论关注的焦点。有关他们“移民美国”和在美国购买豪宅的传言在互联网上广泛传播。然而,京东官方通过微博发言人发布的消息澄清了这些传言,称这些言论纯属虚假信息和蓄意捏造。
日前,据博主“@超能数码君老周”爆料,国内三大运营商中国移动、中国电信和中国联通预计将集体采购百万台规模的华为Mate60系列手机。
据报道,荷兰半导体设备公司ASML正看到美国对华遏制政策的负面影响。阿斯麦(ASML)CEO彼得·温宁克在一档电视节目中分享了他对中国大陆问题以及该公司面临的出口管制和保护主义的看法。彼得曾在多个场合表达了他对出口管制以及中荷经济关系的担忧。
今年早些时候,抖音悄然上线了一款名为“青桃”的 App,Slogan 为“看见你的热爱”,根据应用介绍可知,“青桃”是一个属于年轻人的兴趣知识视频平台,由抖音官方出品的中长视频关联版本,整体风格有些类似B站。
日前,威马汽车首席数据官梅松林转发了一份“世界各国地区拥车率排行榜”,同时,他发文表示:中国汽车普及率低于非洲国家尼日利亚,每百户家庭仅17户有车。意大利世界排名第一,每十户中九户有车。
近日,一项新的研究发现,维生素 C 和 E 等抗氧化剂会激活一种机制,刺激癌症肿瘤中新血管的生长,帮助它们生长和扩散。
据媒体援引消息人士报道,苹果公司正在测试使用3D打印技术来生产其智能手表的钢质底盘。消息传出后,3D系统一度大涨超10%,不过截至周三收盘,该股涨幅回落至2%以内。
9月2日,坐拥千万粉丝的网红主播“秀才”账号被封禁,在社交媒体平台上引发热议。平台相关负责人表示,“秀才”账号违反平台相关规定,已封禁。据知情人士透露,秀才近期被举报存在违法行为,这可能是他被封禁的部分原因。据悉,“秀才”年龄39岁,是安徽省亳州市蒙城县人,抖音网红,粉丝数量超1200万。他曾被称为“中老年...
9月3日消息,亚马逊的一些股东,包括持有该公司股票的一家养老基金,日前对亚马逊、其创始人贝索斯和其董事会提起诉讼,指控他们在为 Project Kuiper 卫星星座项目购买发射服务时“违反了信义义务”。
据消息,为推广自家应用,苹果现推出了一个名为“Apps by Apple”的网站,展示了苹果为旗下产品(如 iPhone、iPad、Apple Watch、Mac 和 Apple TV)开发的各种应用程序。
特斯拉本周在美国大幅下调Model S和X售价,引发了该公司一些最坚定支持者的不满。知名特斯拉多头、未来基金(Future Fund)管理合伙人加里·布莱克发帖称,降价是一种“短期麻醉剂”,会让潜在客户等待进一步降价。
据外媒9月2日报道,荷兰半导体设备制造商阿斯麦称,尽管荷兰政府颁布的半导体设备出口管制新规9月正式生效,但该公司已获得在2023年底以前向中国运送受限制芯片制造机器的许可。
近日,根据美国证券交易委员会的文件显示,苹果卫星服务提供商 Globalstar 近期向马斯克旗下的 SpaceX 支付 6400 万美元(约 4.65 亿元人民币)。用于在 2023-2025 年期间,发射卫星,进一步扩展苹果 iPhone 系列的 SOS 卫星服务。
据报道,马斯克旗下社交平台𝕏(推特)日前调整了隐私政策,允许 𝕏 使用用户发布的信息来训练其人工智能(AI)模型。新的隐私政策将于 9 月 29 日生效。新政策规定,𝕏可能会使用所收集到的平台信息和公开可用的信息,来帮助训练 𝕏 的机器学习或人工智能模型。
9月2日,荣耀CEO赵明在采访中谈及华为手机回归时表示,替老同事们高兴,觉得手机行业,由于华为的回归,让竞争充满了更多的可能性和更多的魅力,对行业来说也是件好事。
《自然》30日发表的一篇论文报道了一个名为Swift的人工智能(AI)系统,该系统驾驶无人机的能力可在真实世界中一对一冠军赛里战胜人类对手。
近日,非营利组织纽约真菌学会(NYMS)发出警告,表示亚马逊为代表的电商平台上,充斥着各种AI生成的蘑菇觅食科普书籍,其中存在诸多错误。
社交媒体平台𝕏(原推特)新隐私政策提到:“在您同意的情况下,我们可能出于安全、安保和身份识别目的收集和使用您的生物识别信息。”
2023年德国柏林消费电子展上,各大企业都带来了最新的理念和产品,而高端化、本土化的中国产品正在不断吸引欧洲等国际市场的目光。
罗永浩日前在直播中吐槽苹果即将推出的 iPhone 新品,具体内容为:“以我对我‘子公司’的了解,我认为 iPhone 15 跟 iPhone 14 不会有什么区别的,除了序(列)号变了,这个‘不要脸’的东西,这个‘臭厨子’。