模仿与学习MyBatis - 1.5 Mapper与动态代理

本文收录于模仿与学习MyBatis系列

---

简述

在本篇中，将讨论与解释动态代理是什么，以及Mapper在MyBatis中的意义。最终实现一个基础的Mapper代理类。
最终结果是一个Java Maven项目，代码存在github上。

---

动态代理

代理是一种设计模式，即对于一个类A，设计一个拥有同样接口的代理类P，负责为A进行统一的预处理、过滤、事后处理等。比如说我希望记录下对A的方法的调用时间、花费时间：

interface Base {
    void work1();
    void work2();
}
class A implements Base {
    public void work1() { System.out.println("work1"); }
    public void work2() { System.out.println("work2"); }
}

class P extends A {
    public void work1() {
        long start = new Date().getTime();
        try {
            super.work1();
        } finally {
            long end = new Date().getTime();
            System.out.println(end-start);
        }
    }

    public void work2() {
        .....
    }
}

可以看出，如果想要记录所有方法的运行时间，就要逐个写过去，是非常耗时及重复的工作——所以Java中的动态代理就派上用场了。

public class MyProxy implements InvocationHandler {  
    private Object target;  

    public Object bind(Object target) {  
        this.target = target;
        return Proxy.newProxyInstance(target.getClass().getClassLoader(),  
                target.getClass().getInterfaces(), this);
    }  

    @Override  
    public Object invoke(Object proxy, Method method, Object[] args)  
            throws Throwable {  
        System.out.println("begin");
        try {
            return method.invoke(target, args);  
        } finally {
            System.out.println("end");
        }
    }  

    public static void main(String[] args) {  
        MyProxy proxy = new MyProxy();  
        Base x = (Base) proxy.bind(new A());  
        x.work1();  
    }  
}  

这样获得的代理类x，调用完的输出结果是：

begin
work1
end

即是说此时的x，已经不再是new A()的结果了，而是A的一个代理，所有的调用方法，都变成交给public Object invoke(Object proxy, Method method, Object[] args)处理了，即先输出begin，执行方法，输出end。
这就是动态代理了。

---

Mapper与动态代理

考虑到我们生成的接口的代理，就是说原本的类什么也没实现。我们只是希望对指定的接口生成一个对象，使得执行它的时候能执行一句sql罢了。那么根据这样的需求，就有了以下代码：

public class MapperProxy<T> implements InvocationHandler {
    // 生成某个接口的mapper
    public static <T> T newInstance(Class<T> clazz) 
    {
        MapperProxy<T> proxy = new MapperProxy<>();
        // 动态代理
        return (T) Proxy.newProxyInstance(clazz.getClassLoader(), new Class[] { clazz }, proxy);
    }

    // 调用mapper方法时实际执行的内容
    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable 
    {
        System.out.println("invoke " + method.getName());
        return null;
    }
}

拥有一个newInstance方法，来生成一个指定的mapper。以及实现了invoke方法，指定在调用mapper方法时执行的事情。接下来可以试写一段测试：

public static void main(String args[]) throws Exception {
    ArticleMapper mapper = MapperProxy.newInstance(ArticleMapper.class);
    mapper.findById(12);
}
/* 输出：
 * invoke findById
 */

以上