Mock 测试技术

news2024/12/26 23:25:08

一、Mock 类框架的使用场景

在实际软件开发中,要进行测试的方法存在外部依赖(如 db,redis,第三方接口调用等),这些外部依赖可能存在各种问题,例如不稳定、缺乏数据、难以模拟等等,所以为了能够专注于对该方法(单元)的 逻辑 进行测试,就希望能虚拟出外部依赖,避免外部依赖成为测试的阻塞项,一般都是测试 service 层即可。

使用 Mock 就可以解决这些问题,Mock 框架他本是是不依赖于其他任何外部依赖的,使用 Mock 对象可以模拟外部依赖的行为和状态,所以相当于将测试方法和外部依赖隔离,能够更好的对单元方法的逻辑测试。

二、Mockito

1、Mockito 简介

Java 中主流的 Mock 框架

Mockito 支持情况:
限制: 老版本对于 final class、final method、staticmethod、private method 均不能被 mockitomock,目前已支持 final class、final method、staticmethod 的 mock
官网文档: https://javadoc.io/doc/org.mockito/mockito-core/latest/org/mockito/Mockito.html


spring-boot-starter-test 已经集成了mockito,所以 SpringBoot 项目无需另外引入依赖。

mock 对象与 spy 对象

Mock 对象是一个完全模拟的对象,用于单元测试中替代真实对象。它允许开发者定义方法的预期行为,而不执行任何实际的业务逻辑。这种对象常用于隔离被测类的依赖,以确保测试的独立性和纯粹性。Mock 对象在方法调用时会返回预设的结果,帮助测试者验证方法调用的正确性和交互行为。

Spy 对象是一个部分模拟的对象,用于单元测试中模拟部分行为,同时保留对象的其他真实行为。Spy 对象在未定义行为的方法调用时,会执行真实对象的方法。它允许开发者在某些方法上插桩,而在其他方法上执行真实逻辑。

作用对象方法插桩方法不插桩备注
mock 对象执行插桩逻辑返回 mock 对象的默认值接口或实现类,用于创建完全虚拟的 mock 对象,无需实际实现
spy 对象执行插桩逻辑调用真实方法类,用于创建部分 mock、部分真实的 spy 对象,需要实际实例

插桩: 指定调用某个方法时的行为,一般是指调用某个方法时的返回值。

不插桩: 使用模拟对象的方法默认行为(mock 对象返回默认值,spy 对象调用真实方法)

2、初始化 mock 和 spy 对象的三种方式

  • junit4:@RunWith(MockitoJUnitRunner.class)+@Mock 等注解
  • junit5:@Extendwith(MockitoExtension.class)+@Mock 等注解
@ExtendWith(MockitoExtension.class)
public class InitMockito {
    @Mock
    private IUserService mockUserService;
    @Spy
    private IUserService spyUserService;

    @Test
    public void testMock1() {
        // 判断某对象是不是 mock 对象 -- true
        Assertions.assertTrue(Mockito.mockingDetails(mockUserService).isMock());
        // 判断某对象是不是 spy 对象 -- false
        Assertions.assertFalse(Mockito.mockingDetails(mockUserService).isSpy());
        // 判断某对象是不是 mock 对象 -- true -- spy 对象是另一种不同类型的 mock 对象
        Assertions.assertTrue(Mockito.mockingDetails(spyUserService).isMock());
        // 判断某对象是不是 spy 对象 -- true
        Assertions.assertTrue(Mockito.mockingDetails(spyUserService).isSpy());
    }
}
  • Mockito.mock(X.class) 等静态方法
public class InitMockito2 {
    private IUserService mockUserService;

    private IUserService spyUserService;

    @BeforeEach
    public void init() {
        mockUserService = Mockito.mock(IUserService.class);
        spyUserService = Mockito.spy(IUserService.class);
    }

    @Test
    public void testMock1() {
        // 判断某对象是不是 mock 对象 -- true
        Assertions.assertTrue(Mockito.mockingDetails(mockUserService).isMock());
        // 判断某对象是不是 spy 对象 -- false
        Assertions.assertFalse(Mockito.mockingDetails(mockUserService).isSpy());
        // 判断某对象是不是 mock 对象 -- true -- spy 对象是另一种不同类型的 mock 对象
        Assertions.assertTrue(Mockito.mockingDetails(spyUserService).isMock());
        // 判断某对象是不是 spy 对象 -- true
        Assertions.assertTrue(Mockito.mockingDetails(spyUserService).isSpy());
    }
}
  • MockitoAnnotations.openMocks(this)+@Mock 等注解
public class InitMockito3 {
    @Mock
    private IUserService mockUserService;
    @Spy
    private IUserService spyUserService;

    @BeforeEach
    public void init() {
        MockitoAnnotations.openMocks(this);
    }

    @Test
    public void testMock1() {
        // 判断某对象是不是 mock 对象 -- true
        Assertions.assertTrue(Mockito.mockingDetails(mockUserService).isMock());
        // 判断某对象是不是 spy 对象 -- false
        Assertions.assertFalse(Mockito.mockingDetails(mockUserService).isSpy());
        // 判断某对象是不是 mock 对象 -- true -- spy 对象是另一种不同类型的 mock 对象
        Assertions.assertTrue(Mockito.mockingDetails(spyUserService).isMock());
        // 判断某对象是不是 spy 对象 -- true
        Assertions.assertTrue(Mockito.mockingDetails(spyUserService).isSpy());
    }
}

3、参数匹配

在 Mockito 中,参数匹配器(ArgumentMatchers)用于指定在模拟对象的方法被调用时匹配某些参数的规则。这样可以灵活地定义方法行为,而不必精确匹配所有参数。Mockito 提供了多种参数匹配器,可以匹配各种类型和条件的参数。

测试参数匹配

@ExtendWith(MockitoExtension.class)
public class MockitoMatchParamsTest {
    @Mock
    private IUserService mockUserService;
    @Test
    public void test1() {
        // 方法插桩
        Mockito.when(mockUserService.login("lee","123")).thenReturn(new User());
        Mockito.doReturn(new User()).when(mockUserService).login("boy","456");
        // 调用方法
        mockUserService.login("lee","123");
        mockUserService.login("boy","456");
        // 验证 mock 方法是否按预期被调用次数
        Mockito.verify(mockUserService,Mockito.times(1)).login(ArgumentMatchers.eq("lee"),ArgumentMatchers.anyString());
        Mockito.verify(mockUserService,Mockito.times(1)).login(ArgumentMatchers.anyString(),ArgumentMatchers.eq("456"));
        Mockito.verify(mockUserService,Mockito.times(2)).login(ArgumentMatchers.anyString(),ArgumentMatchers.anyString());
    }
}

注意: Mockito 的参数匹配器需要与非匹配器参数分开使用,不能混合。

// 错误:混合使用匹配器和非匹配器参数         
when(myService.performAction(anyString(), "fixed value")).thenReturn("Mocked Result");

正确写法:

// 正确:所有参数都使用匹配器         
when(myService.performAction(anyString(), eq("fixed value"))).thenReturn("Mocked Result");
 // 正确:所有参数都不使用匹配器         
 when(myService.performAction("specific input", "fixed value")).thenReturn("Mocked Result");

4、方法插桩

插桩: 指定调用某个方法时的行为,一般是指调用某个方法时的返回值。

不插桩: 使用模拟对象的方法默认行为(mock 对象返回默认值,spy 对象调用真实方法)。
在 Mockito 中,mock 和 spy 对象在不进行方法插桩的情况下有不同的默认行为。下面是对它们默认值行为的详细说明。

下表,展示了在不插桩的情况下,mock 和 spy 对象的默认值情况:

对象类型Mock 对象默认值Spy 对象默认值
对象类型null调用真实对象的方法返回值
booleanfalse调用真实对象的方法返回值
int0调用真实对象的方法返回值
short0调用真实对象的方法返回值
byte0调用真实对象的方法返回值
long0L调用真实对象的方法返回值
float0.0f调用真实对象的方法返回值
double0.0d调用真实对象的方法返回值
集合类型空集合或数组调用真实对象的方法返回值
void 方法什么都不做调用真实对象的方法(有副作用)

(1)Mockito 提供了两种插桩方式

  1. when(obj.someMethod().thenXxx()–其中 obj 可以是 mock 对象,不适用无返回值的方法
  2. doXxx().when(obj).someMethod()–其中 obj 可以是 mock/spy 对象,也适用于没有返回值的方法 注意:spy 对象写在 when 中会先执行一次原方法,即使插桩也起不到 mock 的目的
@ExtendWith(MockitoExtension.class)
public class MockitoStubbingTest {
    @Mock
    private IUserService mockUserService;
    @Spy
    private UserServiceImpl spyUserService; // spy 作用于实现类

    @Test
    public void testStubbing() {
        // 1. mock 和 spy 对象都使用 when-then 进行插桩
        when(mockUserService.realMethod()).thenReturn("test-mockMethod!");
        when(spyUserService.realMethod()).thenReturn("test-spyMethod!");
        // 结果:spy 对象写在 when 中会先执行一次原方法,即使插桩也起不到 mock 的目的
        System.out.println(mockUserService.realMethod());
        System.out.println(spyUserService.realMethod());
    }
}

正确写法:

@Test
public  void testStubbing2() {
    // 1. mock 和 spy 对象都使用 when-then 进行插桩
    when(mockUserService.realMethod()).thenReturn("test-mockMethod!");
    doReturn("test-spyMethod!").when(spyUserService).realMethod();
    // 结果:spy 对象写在 when 中会先执行一次原方法,及时插桩也起不到 mock 的目的
    System.out.println(mockUserService.realMethod());
    System.out.println(spyUserService.realMethod());
}


(2)void 返回值方法插桩

使用 doNothing().when().yourMethod():

@Test
public void testStubbing3() {
    doNothing().when(mockUserService).modefyPwd(anyString(),anyString(),any(User.class));
    mockUserService.modefyPwd("123","456",new User());
}

(3)抛异常

两种方式:

  1. doThrow - when
  2. when - thenThrow
@Test
public void testThrowException() {
    // 方法一:使用 doThrow-when
    doThrow(RuntimeException.class).when(mockUserService).realMethod();
    try {
        mockUserService.realMethod();
        // 如果未抛出异常,这 mock 失败
        Assertions.fail();
    } catch (Exception e) {
        // 断言异常类型
        Assertions.assertTrue(e instanceof RuntimeException);
    }

    // 方法二:使用 when-throw
    when(mockUserService.login("boy","123")).thenThrow(RuntimeException.class);
    try {
        mockUserService.login("boy","123");
        // 如果未抛出异常,这 mock 失败
        Assertions.fail();
    } catch (Exception e) {
        // 断言异常类型
        Assertions.assertTrue(e instanceof RuntimeException);
    }
}

(4)多次插桩

    @Test
    public void multiStubbing() {
        // 第一次调用返回 1,第二次调用返回 2,第三次调用返回 3,第四次调用返回 3 ...
//        doReturn(1l).doReturn(2l).doReturn(3l).when(mockUserService).count();
//        doReturn(1l,2l,3l).when(mockUserService).count();
        
//        when(mockUserService.count()).thenReturn(1l).thenReturn(2l).thenReturn(3l);
        when(mockUserService.count()).thenReturn(1l,2l,3l);
        Assertions.assertEquals(1,mockUserService.count());
        Assertions.assertEquals(2,mockUserService.count());
        Assertions.assertEquals(3,mockUserService.count());
        Assertions.assertEquals(3,mockUserService.count());
    }

(5)thenAnswer 指定插桩逻辑

  1. 调用 thenAnswer 方法,重写 Answer
  2. 调用 doAnswer 方法,重写 Answer 使用 thenAnswer 时

注意: 泛型表示[插桩方法的返回值]

@Test
public void thenAnswerStubbing() {
    when(mockUserService.login(anyString(),anyString())).thenAnswer(new Answer<User>() {
        /**
         * 泛型表示[插桩方法的返回值]
         */
        @Override
        public User answer(InvocationOnMock invocationOnMock) throws Throwable {
            // getArgument 表示获取插桩方法的第几个参数值
            String name = invocationOnMock.getArgument(0, String.class);
            String pasw = invocationOnMock.getArgument(1, String.class);
            // 重组数据
            User user = new User();
            user.setUsername("用户名:"+name);
            user.setPassword("密码:"+pasw);
            return user;
        }
    });
    // 或者使用 doAnswer()
    
    // 调用方法
    User user = mockUserService.login("lee", "123");
    // 断言
    Assertions.assertEquals("用户名:lee",user.getUsername());
    Assertions.assertEquals("密码:123",user.getPassword());
}

(6)执行真正的原始方法

  1. 调用 thenCallRealMethod 方法
  2. 调用 doCallRealMethod 方法

注意: 要求此时 @Mock 注解标记的是 实现类。

    @Test
    public void testMockRealMethod() {
        when(mockUserService.realMethod()).thenCallRealMethod();
//        doCallRealMethod().when(mockUserService).realMethod();
        // 调用
        String res = mockUserService.realMethod();
        // 断言
        Assertions.assertEquals("service-realMethod!",res);
    }

(7)verify 的使用

verify 方法主要用于验证 mock 对象的方法是否按预期被调用。也可以验证方法的调用次数、顺序和参数。

@Test
public void testMockVerify() {
    // 默认返回 null (没有插桩)
    User user = mockUserService.login("lee", "123");
    Assertions.assertNull(user);

    // 验证调用过 1 次 login 方法,且参数是 "lee","123"
    verify(mockUserService).login("lee","123");
    // 等价于上面 vetify
    verify(mockUserService,times(1)).login("lee","123");

    // 校验没有调用的两种方式
    verify(mockUserService,times(0)).count();
    verify(mockUserService,never()).count();

    // 校验最少或最多调用了多少次
    verify(mockUserService,atLeast(1)).login("lee","123");
    verify(mockUserService,atMost(1)).login("lee","123");
}

5、@InjectMocks 注解使用

@InjectMocks 注解的主要作用是将使用 @Mock 或 @Spy 注解创建的 mock 对象或 spy 对象注入到被测试对象中,以便在测试中使用这些对象。它可以自动识别和匹配需要注入的字段,无论是通过构造函数、字段注入还是方法注入。

注意: 被 @InjectMocks 标注的属性必须是实现类,因为 mockito 会创建对应的实例对象,默认创建的对象就是未经过 mockito 处理的普通对象,因此常配合 @Spy 注解使其变为默认调用真实方法的 mock 对象。一般被测试的类,都需要标注这两个注解。

// 被测试的服务类
class MyService {
    private final MyDependency myDependency;

    // 构造函数注入依赖
    public MyService(MyDependency myDependency) {
        this.myDependency = myDependency;
    }

    public String performAction() {
        return myDependency.someMethod();
    }
}

// 依赖类
class MyDependency {
    public String someMethod() {
        return "Real Response";
    }
}

public class MyServiceTest {

    @Mock
    private MyDependency myDependency; // 创建 mock 对象

    @InjectMocks
    @Spy
    private MyService myService; // 自动注入 mock 对象

    @Before
    public void setUp() {
        // 初始化注解标注的对象
        MockitoAnnotations.openMocks(this);
    }

    @Test
    public void testPerformAction() {
        // 设置 mock 对象的行为
        when(myDependency.someMethod()).thenReturn("Mocked Response");

        // 调用被测试对象的方法
        String result = myService.performAction();

        // 验证结果
        assertEquals("Mocked Response", result);
    }
}

三、实际编写单元测试注意事项

  1. 在实际测试中,mock 不全,可能会出现空指针情况,这个时候不要慌,先看报错,再根据报错将为空的对象 mock 到测试类中。
  2. 实际代码中,每个 service 接口方法都可能有多个 return,此时要想保证代码覆盖率,就需要为每个方法构造合适插桩,多写几个 Test 测试,确保覆盖到每个 return。

四、Mockito 在 SpringBoot 环境使用(不推荐,慢)

  1. @MockBean:类似 @Mock 用于通过类型或名字替换 spring 容器中已经存在的 bean, 从而达到对这些 bean 进行 mock 的目的。
  2. @SpyBean:作用类似 @Spy 用于通过类型或名字包装 spring 容器中已经存在的 bean,当需要 mock 被测试类的某些方法时可以使用。
  3. Spring 中生成的对象受 spring 管理,上述 Bean 被 mock 或 spy 后,依然受 Spring 容器管理。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/1912814.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

Python29 Tensorflow的基本知识和使用

1. TensorFlow TensorFlow 是一个开源的机器学习框架&#xff0c;由 Google Brain 团队开发。它用于数据流图的计算&#xff0c;尤其擅长深度学习任务。在 TensorFlow 中&#xff0c;数据流图&#xff08;Data Flow Graph&#xff09;是其核心概念之一&#xff0c;它定义了计算…

(图文详解)小程序AppID申请以及在Hbuilderx中运行

今天小编给大家带来了如何去申请APPID&#xff0c;如果你是小程序的开发者&#xff0c;就必须要这个id。 申请步骤 到小程序注册页面&#xff0c;注册一个小程序账号 微信公众平台 填完信息后提交注册 会在邮箱收到 链接激活账号 确认。邮箱打开链接后&#xff0c;会输入实…

宜春旅游集散中心展厅OLED透明屏方案设计

一、项目概述 为提升宜春旅游集散中心展厅的现代化展示水平&#xff0c;增强游客的参观体验&#xff0c;我们计划在展厅的核心区域引入OLED透明屏技术。该方案旨在通过高科技的视觉呈现方式&#xff0c;将展品信息以虚拟与现实相结合的方式展现&#xff0c;打造出一个既具科技感…

Junior.Crypt.2024 CTF Web方向 题解WirteUp 全

Buy a cat 题目描述&#xff1a;Buy a cat 开题 第一思路是抓包改包 Very Secure App 题目描述&#xff1a;All secrets become clear 开题 乱输一个密码就登陆成功了&#xff08;不是弱口令&#xff09; 但是回显Your role is: user 但是有jwt&#xff01;&#xff01;&a…

【ROS2】中级-编写动作服务器和客户端(C++)

目标&#xff1a;用 C实现一个动作服务器和客户端。 教程级别&#xff1a;中级 时间&#xff1a;15 分钟 目录 背景 先决条件 任务 1. 创建 custom_action_cpp 包2. 编写动作服务器3. 编写动作客户端 摘要 相关内容 背景 动作是 ROS 中异步通信的一种形式。动作客户端向动作服务…

每日Attention学习9——Efficient Channel Attention

模块出处 [CVPR 20] [link] [code] ECA-Net: Efficient Channel Attention for Deep Convolutional Neural Networks 模块名称 Efficient Channel Attention (ECA) 模块作用 通道注意力 模块结构 模块代码 import torch import torch.nn as nn import torch.nn.functional …

LeetCode之无重复字符的最长子串

1.题目链接 3. 无重复字符的最长子串 - 力扣&#xff08;LeetCode&#xff09;https://leetcode.cn/problems/longest-substring-without-repeating-characters/description/ 2.题目解析 题目主要思路其实是滑动窗口&#xff0c;使用两个指针维护一个动态区间&#xff0c;使…

uniapp使用高德地图(公众号+h5)

选择微信小程序的话后果就是你的地图出不来&#xff0c;出来了就报key异常 下面直接放配置和代码&#xff1a; 打包后的高德uni-app,uniCloud,serverless,高德地图,申请高德地图Key,配置使用高德地图,参数说明,高德开放平台用户名,百度地图,申请百度地图Key,配置使用百度地图,…

【深度学习基础】环境搭建 linux系统下安装pytorch

目录 一、anaconda 安装二、创建pytorch1. 创建pytorch环境&#xff1a;2. 激活环境3. 下载安装pytorch包4. 检查是否安装成功 一、anaconda 安装 具体的安装说明可以参考我的另外一篇文章【环境搭建】Linux报错bash: conda: command not found… 二、创建pytorch 1. 创建py…

计算给定数字的阶乘

1 问题 计算给定数字的阶乘. 2 方法 使用while循环。使用for循环。使用函数。 通过实验、实践等证明提出的方法是有效的&#xff0c;是能够解决开头提出的问题。 代码清单 1 使用while循环numberint(input(请输入一个数字:))factorial1i1while i<number: factorialfactor…

Python面试宝典第8题:二叉树遍历

题目 给定一棵二叉树的根节点 root &#xff0c;返回它节点值的前序遍历。 示例 1&#xff1a; 输入&#xff1a;root [1,null,2,3] 输出&#xff1a;[1,2,3] 示例 2&#xff1a; 输入&#xff1a;root [] 输出&#xff1a;[] 示例 3&#xff1a; 输入&#xff1a;root […

python学习-容器类型

列表 列表&#xff08;list&#xff09;是一种有序容器&#xff0c;可以向其中添加或删除任意元素. 列表数据类型是一种容器类型&#xff0c;列表中可以存放不同数据类型的值,代码示例如下&#xff1a; 列表中可以实现元素的增、删、改、查。 示例代码如下&#xff1a; 增 …

xcode项目添加README.md文件并进行编辑

想要给xcode项目添加README.md文件其实还是比较简单的&#xff0c;但是对于不熟悉xcode这个工具的人来讲&#xff0c;还是有些陌生&#xff0c;下面简单给大家讲一下流程。 选择“文件”>“新建”>“文件”&#xff0c;在其他&#xff08;滚动到工作表底部&#xff09;下…

Linux 一键部署Mysql 8.4.1 LTS

mysql 前言 MySQL 是一个基于 SQL(Structured Query Language)的数据库系统,SQL 是一种用于访问和管理数据库的标准语言。MySQL 以其高性能、稳定性和易用性而闻名,它被广泛应用于各种场景,包括: Web 应用程序:许多动态网站和内容管理系统(如 WordPress)使用 MySQL 存…

HTTPS 发送请求出现TLS握手失败2

之前写过一篇《HTTPS 发送请求出现TLS握手失败》&#xff0c;后续来了&#xff1b; 之前发现https进行握手缺少椭圆曲线&#xff0c;是因为手动删除provider导致的&#xff1a; static {Security.removeProvider("SunEC");} 深入分析之后发现&#xff0c;虽然这里把…

工控巨头360亿疯狂收购全球子业务,真的成为巨无霸了!

导语 大家好&#xff0c;我是社长&#xff0c;老K。专注分享智能制造和智能仓储物流等内容。 新书《智能物流系统构成与技术实践》 工业自动化领域的领航者霍尼韦尔&#xff0c;近期宣布了一项震撼业界的交易——成功完成对开利公司全球安防业务的收购&#xff0c;交易额高达49…

使用ResizeObserver观察DOM元素的尺寸变化

文章目录 关于ResizeObserver示例代码示例代码结果如下所示echarts自适应容器div大小示例代码结果如下所示echarts自适应容器大小的方式二 关于ResizeObserver 关于这个Web API&#xff0c;可以看mdn的官网&#xff0c;ResizeObserver - Web API | MDN (mozilla.org)&#xff…

图论---匈牙利算法求二分图最大匹配的实现

开始编程前分析设计思路和程序的整体的框架&#xff0c;以及作为数学问题的性质&#xff1a; 程序流程图&#xff1a; 数学原理&#xff1a; 求解二分图最大匹配问题的算法&#xff0c;寻找一个边的子集&#xff0c;使得每个左部点都与右部点相连&#xff0c;并且没有两条边共享…

AI提示词:打造爆款标题生成器

打开GPT输入以下内容&#xff1a; # Role 爆款标题生成器## Profile - author: 姜小尘 - version: 02 - LLM: Kimi - language: 中文 - description: 利用心理学和市场趋势&#xff0c;生成吸引眼球的自媒体文章标题。## Background 一个吸引人的标题是提升文章点击率和传播力…

(四)前端javascript中的数据结构之归并排序

归并排序是一种分治算法&#xff0c; 其思想是&#xff1a; 将原始数组切分成较小的数组&#xff0c;直到每个小数组只有一 个位置&#xff0c;接着将小数组归并成较大的数组&#xff0c;直到最后只有一个排序完毕的大数组 归并排序是第一个可以被实际使用的排序算法。它比前面…