徒手撸一个Mock框架（一）——如何创建一个mock对象

自从老夫换了一个新厂之后，单测就写个不停，因为新厂对单测的要求还是比较高的。

在撸单测的过程中，用Mockito, JMocki和PowerMock比较多，感觉这些是一个很神奇的工具。于是我就花时间看了一下源码，领略了一下其中的精髓。

这些单测工具，都具备两个特点：

利用了非常多的语言特性。这些特性在业务开发中是基本不会碰的，在一般性的框架中也是基本不会碰的；
是一个典型的Domain Specific Language框架；

这两个东西都是我从去年开始的一个学习重点。按照一般的套路我应该是写个什么源码解析什么的。

但是我这种妖艳贱货的画风就不太一样，于是就有了StupidMock这个想法，这个想法就是从零开始，一点点撸一个功能脆弱但是完整的mock框架，带领大家一步步领略这种mock框架设计的精髓。

这里使用的JDK是OpenJDK 11，操作系统是macOS 10.14.4。项目地址StupidMock，代码在0.0.1分支上

首先，我们得有一个Mock对象

写过单测的小伙伴都知道，在单测里面，最经常用的就是mock各种对象。举例来说，一般的使用方法都是：

SimpleObject mockObj = mock(SimpleObject.class);
        when(mockObj.doSomething("Hello, ", "world")).thenReturn("I'm not the world");

我们现在就来考虑一下，该如何创建一个mock对象。

首先，接口我们定义成一个泛型接口，接收一个Class对象，而后返回该Class的一个实例。

    public static <T> T mock(Class<T> tClass) {
        //todo
        return null;
    }

最简单的做法是直接用反射技术，创建实例:

    public static <T> T mock(Class<T> tClass) {
        //todo
        try {
            return tClass.getConstructor(String.class).newInstance("");
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

在这种做法之下，会有几个问题无法解决：

抽象类和接口，无法直接创建实例；
无法准备构造函数所需要的参数；
无法对mock对象进行修改；

第三点比如说，常见的mock行为是不管你在调用某个方法时传递什么参数，我都返回一个特定的返回值，即when().then()。

所以，我们需要一个别的方法。很显然，这个方法就是代理。

创建一个代理

代理大体上有两种，一种是JDK自带的动态代理，另外一种就是第三方库提供的代理，比如cglib。

考虑到JDK的动态代理只能处理接口，于是我们选择创建cglib代理。

引入cglib依赖：

<dependency>
    <groupId>cglib</groupId>
    <artifactId>cglib</artifactId>
    <version>3.2.12</version>
</dependency>

使用Enhancer创建代理：

    public static <T> T mock(Class<T> tClass) {
        Enhancer enhancer = new Enhancer();
        if (tClass.isInterface()) {
            enhancer.setInterfaces(new Class[]{tClass});
        } else {
            enhancer.setSuperclass(tClass);
        }
        enhancer.setCallback(NoOp.INSTANCE);
        return (T) enhancer.create();
    }

这里只是简单的区分了一下接口和类。而且Callback只是设置了一个NoOp，即什么都不敢。

而Callback是一个关键点，后面我们使用mock对象来模拟行为的时候，就是需要在Callback里面完成。

构造函数

然而，上面的那段代码其实是有问题的。如果tClass代表的类没有无参数构造函数，那么在enhancer.create()那里会抛出IllegalStateException。

一些人可能会问，为什么不用enhancer.create(...)这个函数来创建代理呢？该方法是允许我们传递构造函数的参数的。

问题还是在于，我们是一个mock框架，用户很可能就是不知道怎么创建这个对象，才需要mock。我们并不能要求用户将所需的参数传下来，即

    public static <T> T mock(Class<T> tClass, Object...params) {
        Enhancer enhancer = new Enhancer();
        if (tClass.isInterface()) {
            enhancer.setInterfaces(new Class[]{tClass});
        } else {
            enhancer.setSuperclass(tClass);
        }
        enhancer.setCallback(NoOp.INSTANCE);
        return (T) enhancer.create(params);
    }

这种搞法是不行的。

为了解决这个问题，我们需要给enhancer一个构造函数，而且这个构造函数里面，必须要调用父类的某一个构造函数。

这里可以说的是，cglib并不直接支持添加一个构造函数。好在有一个库objenesis支持这种东西，所以我们暂时使用这个库来完成。等后面我们再回过头来去掉objenesis库，自己实现一个简单版本。

引入objenesis依赖:

        <dependency>
            <groupId>org.objenesis</groupId>
            <artifactId>objenesis</artifactId>
            <version>3.0.1</version>
        </dependency>

之后，使用APi添加一个构造函数。

    public static <T> T mock(Class<T> tClass) {
        Enhancer enhancer = new Enhancer();

        if (tClass.isInterface()) {
            enhancer.setInterfaces(new Class[]{tClass});
        } else {
            enhancer.setSuperclass(tClass);
        }
        enhancer.setCallbackType(MethodInterceptor.class);
        Objenesis objenesis = new ObjenesisStd(true);
        return (T) objenesis.newInstance(enhancer.createClass());
    }

这里要注意的是，在newInstance方法里面，我们传入的是enhancer创建的代理类，而不是原始类，这是因为我们需要在后面mock行为的时候，对mock对象进行扩展。

另外一个注意点是，我们不再直接传入Callback对象，而是调用setCallbackType里面传入了MethodInterceptor.class。因为enhancer.createClass调用不允许传入Callback实例。

到现在，我们就可以长出一口气，我们已经把mock方法搞定了了。

遗留问题

前面的这种写法，我们的确是能够得到一个代理，但是却会有一个问题，一个很关键的问题：

我们无法创建final类的代理

在Java里面，使用final关键字代表着一个类无法成为父类。在我们前面的cglib代理里面，要创建一个类的代理，本质上在于继承这个类。所以直接使用setSuperClass将无法创建出来代理。

我们需要额外的方法。

这种方法也不难想到，就是修改类定义。这种修改，并不是说用户去把类上面的final关键字去掉，而是只在我们mock一个对象的时候，修改这个final类的定义。

很显然，这个方法就是自定义一个类加载器，并且在加载的时候，去掉这个final修饰符。

所以，欲知后事如何如何，且听下回分解。

沙雕程序猿的日常