技术

并发的成本 基础设施优化 hashicorp raft源码学习 docker 架构 mosn细节 与微服务框架整合 Java动态代理 编程范式 并发通信模型 《网络是怎样连接的》笔记 go细节 codereview mat使用 jvm 线程实现 go打包机制 go interface及反射 如何学习Kubernetes 《编译原理之美》笔记——后端部分 《编译原理之美》笔记——前端部分 Pilot MCP协议分析 go gc 内存管理玩法汇总 软件机制 istio流量管理 Pilot源码分析 golang io 学习Spring mosn源码浅析 MOSN简介 《datacenter as a computer》笔记 学习JVM Tomcat源码分析 Linux可观测性 MVCC 学习存储 学计算 Gotty源码分析 kubernetes operator kaggle泰坦尼克问题实践 kubernetes自动扩容缩容 神经网络模型优化 直觉上理解机器学习 knative入门 如何学习机器学习 神经网络系列笔记 TIDB源码分析 《阿里巴巴云原生实践15讲》笔记 Alibaba Java诊断工具Arthas TIDB存储——TIKV 《Apache Kafka源码分析》——简介 netty中的线程池 guava cache 源码分析 Springboot 启动过程分析 Spring 创建Bean的年代变迁 Linux内存管理 自定义CNI IPAM 扩展Kubernetes 副本一致性 spring redis 源码分析 kafka实践 spring kafka 源码分析 Linux进程调度 让kafka支持优先级队列 Codis源码分析 Redis源码分析 C语言学习 《趣谈Linux操作系统》笔记 docker和k8s安全机制 jvm crash分析 Prometheus 学习 Kubernetes监控 Kubernetes 控制器模型 容器日志采集 容器狂占cpu怎么办? 容器狂打日志怎么办? Kubernetes资源调度——scheduler 时序性数据库介绍及对比 influxdb入门 maven的基本概念 《Apache Kafka源码分析》——server Kubernetes objects之编排对象 源码分析体会 自动化mock AIOps说的啥 《数据结构与算法之美》——算法新解 Kubernetes源码分析——controller mananger Kubernetes源码分析——apiserver Kubernetes源码分析——kubelet Kubernetes介绍 ansible学习 Kubernetes源码分析——从kubectl开始 jib源码分析之Step实现 kubernetes实践 jib源码分析之细节 线程排队 跨主机容器通信 jib源码分析及应用 为容器选择一个合适的entrypoint kubernetes yaml配置 marathon-client 源码分析 《持续交付36讲》笔记 mybatis学习 程序猿应该知道的 无锁数据结构和算法 CNI 为什么很多业务程序猿觉得数据结构和算法没用? 串一串一致性协议 当我在说PaaS时,我在说什么 《数据结构与算法之美》——数据结构笔记 swagger PouchContainer技术分享体会 harbor学习 用groovy 来动态化你的代码 《深入剖析kubernetes》笔记 精简代码的利器——lombok 学习 编程语言的动态性 rxjava3——背压 rxjava2——线程切换 spring cloud 初识 《深入拆解java 虚拟机》笔记 《how tomcat works》笔记 hystrix 学习 rxjava1——概念 Redis 学习 TIDB 学习 分布式计算系统的那些套路 Storm 学习 AQS1——论文学习 Unsafe Spark Stream 学习 linux vfs轮廓 mysql 批量操作优化 《自己动手写docker》笔记 java8 实践 中本聪比特币白皮书 细读 区块链泛谈 比特币 大杂烩 总纲——如何学习分布式系统 hbase 泛谈 forkjoin 泛谈 看不见摸不着的cdn是啥 《jdk8 in action》笔记 程序猿视角看网络 bgp初识 mesos 的一些tips mesos 集成 calico calico学习 AQS2——粗略的代码分析 我们能用反射做什么 web 跨域问题 《clean code》笔记 硬件对软件设计的影响 《Elasticsearch权威指南》笔记 mockito简介及源码分析 2017软件开发小结—— 从做功能到做系统 《Apache Kafka源码分析》——clients dns隐藏的一个坑 《mysql技术内幕》笔记2 《mysql技术内幕》笔记1 log4j学习 为什么netty比较难懂? 回溯法 apollo client源码分析及看待面向对象设计 学习并发 从一个marathon的问题开始的 docker 环境(主要运行java项目)常见问题 Scala的一些梗 OpenTSDB 入门 spring事务小结 事务一致性 javascript应用在哪里 《netty in action》读书笔记 netty对http2协议的解析 ssl证书是什么东西 http那些事 苹果APNs推送框架pushy apple 推送那些事儿 编写java框架的几大利器 java内存模型 java exception Linux IO学习 network channel network byte buffer 测试环境docker化实践 netty(七)netty在框架中的使用套路 Nginx简单使用 《Linux内核设计的艺术》小结 Go并发机制及语言层工具 mesos深入 Macvlan Linux网络源代码学习——数据包的发送与接收 《docker源码分析》小结 docker中涉及到的一些linux知识 hystrix学习 Linux网络源代码学习——整体介绍 zookeeper三重奏 数据库的一些知识 Spark 泛谈 链式处理的那些套路 netty(六)netty回顾 Thrift基本原理与实践(二) Thrift基本原理与实践(一) 回调 异步执行抽象——Executor与Future Docker0.1.0源码分析 java gc Jedis源码分析 Redis概述 机器学习泛谈 Linux网络命令操作 JTA与TCC 换个角度看待设计模式 Scala初识 向Hadoop学习NIO的使用 以新的角度看数据结构 并发控制相关的硬件与内核支持 systemd 简介 那些有用的sql语句 异构数据库表在线同步 quartz 源码分析 基于docker搭建测试环境(二) spring aop 实现原理简述 自己动手写spring(八) 支持AOP 自己动手写spring(七) 类结构设计调整 分析log日志 自己动手写spring(六) 支持FactoryBean 自己动手写spring(九) 总结 自己动手写spring(五) bean的生命周期管理 自己动手写spring(四) 整合xml与注解方式 自己动手写spring(三) 支持注解方式 自己动手写spring(二) 创建一个bean工厂 自己动手写spring(一) 使用digester varnish 简单使用 关于docker image的那点事儿 基于docker搭建测试环境 分布式配置系统 JVM内存与执行 git spring rmi和thrift maven/ant/gradle使用 再看tcp mesos简介 缓存系统 java nio的多线程扩展 《Concurrency Models》笔记 回头看Spring IOC IntelliJ IDEA使用 Java泛型 vagrant 使用 Go常用的一些库 Python初学 Goroutine 调度模型 虚拟网络 《程序员的自我修养》小结 VPN(Virtual Private Network) Kubernetes存储 Kubernetes 其它特性 访问Kubernetes上的Service Kubernetes副本管理 Kubernetes pod 组件 使用etcd + confd + nginx做动态负载均衡 如何通过fleet unit files 来构建灵活的服务 CoreOS 安装 CoreOS 使用 Go学习 JVM类加载 硬币和扑克牌问题 LRU实现 virtualbox 使用 ThreadLocal小结 docker快速入门

标签


mockito简介及源码分析

2017年12月29日

前言

健壮的代码需要良好的单元测试,单元测试需要模拟其它单元的功能,所以需要一个强大易用的mock框架。

需要了解的一些测试概念

深入理解Mockito(1)–概念介绍

深入理解Mockito(2)–Mock的基本使用

深入理解Mockito(3)–Partial Mock(部分模拟)

基本要点:

  1. 状态检测和行为检测

    • 状态检测:通过检查方法的返回值来判断方法是否运行成功
    • 行为检测:方法运行之后,通过检测方法的执行行为(或者说执行顺序)进行判断方法是否运行成功
  2. 替换对象:stub(桩)和mock(模拟对象)。前者多用于状态测试,或者多用于行为测试。
  3. 部分模拟,模拟依赖对象的部分方法, 剩下的方法能够正常的运行其内部逻辑。

mockitio

Mockito教程

Java测试框架Mockito源码分析

测试驱动的开发(Test Driven Design, TDD)要求我们先写单元测试,再写实现代码。在写单元测试的过程中,一个很普遍的问题是,要测试的类会有很多依赖,这些依赖的类/对象/资源又会有别的依赖,从而形成一个大的依赖树,要在单元测试的环境中完整地构建这样的依赖,是一件很困难的事情。 所幸,我们有一个应对这个问题的办法:Mock。简单地说就是对测试的类所依赖的其他类和对象,进行mock - 构建它们的一个假的对象,定义这些假对象上的行为,然后提供给被测试对象使用。

  1. 验证:是否调用了模拟类的方法
  2. 调用的时候传入参数,参数匹配
  3. 一个方法的执行结果,包括返回值和异常。这些mock 也可以模拟

源码分析

Java测试框架Mockito源码分析

Mockito 通过 ByteBuddy(旧版本使用cglib) 来创建 mock 类并进行实例化 proxy 对象。本质上是一个Proxy模式的应用。

cglib使用

cglib(底层基于ASM) - Byte Code Generation Library is high level API to generate and transform Java byte code. It is used by AOP, testing, data access frameworks to generate dynamic proxy objects and intercept field access.

cglib 教程 - 使用cglib实现动态代理

net.sf.cglib.proxy.Enhancer 类提供了非常简洁的API来创建代理对象,有两种回调的防方式:InvocationHandler和MethodInterceptor。mockito中使用了MethodInterceptor方式。

public class User {
    public String hello(String name){
        return "hello " + name;
    }
}

生成代理类:

Enhancer enhancer = new Enhancer();
enhancer.setSuperclass(User.class);
enhancer.setCallback(new MethodInterceptor() {
    @Override
    public Object intercept(Object obj, Method method, Object[] args, MethodProxy proxy)
            throws Throwable {
        if (method.getDeclaringClass() != Object.class && method.getReturnType() == String.class) {
            return "hello cglib!";
        } else {
            return proxy.invokeSuper(obj, args);
        }
    }
});
User proxy = (User) enhancer.create();
System.out.println(proxy.hello("abc"));

代理模式中,肯定会提供类似Object invoke(Object proxy, Method method, Object[] args) throws Throwable;的回调,用于我们扩充被代理类的执行逻辑。

mockito

本文为简化源码分析的复杂性,从mockito 1.0 版本源码入手。示例代码

List mock = Mockito.mock(List.class);
Mockito.stub(mock.add("test")).toReturn(true);
System.out.println(mock.add("test"));

mock方法的实质

public class Mockito extends Matchers {
	 public static <T> T mock(Class<T> classToMock) {
        return MockUtil.createMock(classToMock, MOCKING_PROGRESS);
    }
}

public class MockUtil { 
    public static <T> T createMock(Class<T> classToMock, MockingProgress progress) {
        MockFactory<T> proxyFactory = new MockFactory<T>();
        MockHandler<T> mockHandler = new MockHandler<T>(progress, new MatchersBinder());
        MethodInterceptorFilter<MockHandler<T>> filter = new MethodInterceptorFilter<MockHandler<T>>(classToMock, mockHandler);
        return proxyFactory.createMock(classToMock, filter);
    }
}

MockHandler 的创建,揉和一些全局对象,同时还创建了stubber对象。

proxyFactory.createMock(classToMock, filter)便是调用cglib 创建了代理对象。所以,代码的重点就转到了MockHandler(实现cglib MethodInterceptor 接口) 的实现上。

做桩及执行桩方法

  1. 第一次执行 mock.add 方法的实质。就是 MockHandler中来自MethodInterceptor接口的intercept 方法的执行。在mock.add("test")方法中

    1. 可以知道方法名是add,参数是test
    2. 将这个数据封装为 invocationMatcher,存在stubber中
    3. 创建一个OngoingStubbing(包括toReturn和toThrow 方法) 关联stubber(通过内部类实现),由MockingProgress包裹, 保存在thread local中
  2. stub方法的实质。从threadlocal中取出OngoingStubbing并返回
  3. toRetun方法的实质。OngoingStubbing 拿到与之绑定的 stubber,将结果与 invocationMatcher 关联起来。
  4. 第二次执行 mock.add 方法的实质。从stubber中 取出 对应的 invocationMatcher 的 结果。

在整个做桩的过程中,有一个MockingProgress,第一次执行mock.add时,标记做桩开始。OngoingStubbing.toReturn 或者 toThrow时,标记做桩结束。

注意,mock.业务方法都是执行两次,一次用于做桩,有一次用于执行桩方法。verify 的逻辑类似,此处不再分析。

值得学习的细节

  1. 代码中使用 Invocation存储mock.add("abc")等信息,使用InvocationMatcher封装 Invocation 是为了从Invocation剥离匹配过程。因为mock.业务方法都是执行两次,第二次执行时,能够根据Invocation 尽快的匹配 上一次存储的Invocation,尤其是 方法参数的匹配,比如Mockito.when(userDao.getUserById(1L)).thenReturn(new UserPO(1L,"user1",20)); 时,uid=1时返回mock值。uid=2时就不返回了。此处装饰模式用的很精彩
  2. MockingProgress 是一个接口,包括两个实现类MockingProgressImpl和ThreadSafeMockingProgress,MockingProgressImpl实现基本功能,而ThreadSafeMockingProgress在MockingProgressImpl 基础上实现线程安全的功能。

     public class ThreadSafeMockingProgress implements MockingProgress {
        
     	private static ThreadLocal<MockingProgress> mockingProgress = new ThreadLocal<MockingProgress>();
    
         static MockingProgress threadSafely() {
             if (mockingProgress.get() == null) {
                 mockingProgress.set(new MockingProgressImpl());
             }
             return mockingProgress.get();
         }
     	}
    

    MockingProgressImpl 不直接抛头露面,这活儿交给ThreadSafeMockingProgress,这个线程安全的技巧值得学习。

小结

mockito 源码分析汇总:

  1. 使用代理模式,构建mock类
  2. mock类的业务方法执行两次,第一次及toReturn等操作用于汇总方法的执行、返回值等信息,挂到thread local上。第二次执行,则是从threadlocal中获取 数据并返回。

一些使用建议

  1. 一般web开发是controller-service-dao,模拟service 测试Controller比较简单,mock service类的接口方法即可。但对于模拟dao 测试service,一般不使用mock,而是直接操作数据库,spring-test 支持 单元测试中事务自动回滚,清理测试数据。
  2. mockito 与 spring 整合 参见使用Mockito和SpringTest进行单元测试