Java | 通过一个demo理解代理

作者: heyikan | 来源:发表于2017-04-02 15:08 被阅读219次

    2017/4/2 | 周日 | 晴


    背景

    如果你有使用过Mybatis或者JPA,可能有过这样的体验:声明了一个接口用来读写数据表,使用注解或者xml文件配置sql语句。然后居然就可以直接从spring容器中接受接口实例的注入,而且可以使用。但是你明明没有实现过这个接口!这里用的就是代理的机制。

    这里就模拟这个过程,来写一个demo。

    类图讲解

    Paste_Image.png

    这里涉及到2个包,java.lang.reflect是jdk库中的包,com.heyikan.demojava.base是我们自己的包。

    整个过程是这样的:首先我们定义自己的接口Repository,然后我们调用Proxy.newProxyInstance方法获得一个代理的实例,也就是$Proxy0。然后我们就可以使用这个实例,来进行数据表的读写了。

    :这里我们省略了与表对应的model类,使用Object来代替了。

    调用Proxy.newProxyInstance的方法时,需要传入3个参数:类加载器-loader,接口数组-interfaces,handler-处理器。

    关于类加载器,如果要创造java库里的接口的代理实现,直接传入null就可以了,会使用默认的加载器。如果要创造第三方框架接口或者自己接口的代理实例,就使用Repository.class.getClassLoader()获得的类加载器。这个和类加载器的机制有关,如果你没有正确的使用,可能会抛出这种异常

    关于接口数组,是代理类所需要实现的接口,可以同时实现多个接口。这里我们就实现一个接口Repository。

    关于处理器,它用来定义代理类的具体实现。Proxy在为我们生成代理类时,只是将所有需要实现的方法都转接到了处理器上。所以你调用代理类的任何一个方法,底层都是调用处理器的invoke方法。这个方法有三个参数:代理实例-proxy,所调用的方法-method,调用方法时传入的参数-args,所以这个方法可以知道当前是调用了哪个代理类的哪个方法,并且知道传入的参数是什么。

    但是,具体invoke怎么实现,还是需要我们自己来做。

    讲到这里,会有一个很别扭的问题:既然我们怎么样都需要自己去实现,为什么不直接实现Repository接口,还要使用代理机制呢?回想一下你使用jdbc读写数据库的经历,大部分都是一样的流程:获取连接 - 预编译sql语句 - 绑定变量 - 执行sql - 解析、封装结果 - 释放连接。一般每一个表都会定义一个Repository接口,每一个接口都需要有一个实现,而所有的实现都是同一个套路。但是如果我们能把这个套路中不变的东西抽离出来,定义成一个模板,那么这个模板就可以用于所有的实现。InvocationHandler的工作就是去实现一个模板。

    现在我们进行模板的抽离,在上面一个套路中,基本的流程是不变的,变化的是sql语句、绑定变量、结果的封装。sql语句可以通过注解来指定,在invoke方法中,我们可以通过反射从method获取注解的sql语句;绑定变量可以通过方法的参数来指定,在invoke方法中,我们获取到的args就是;结果的封装类型,可以通过反射从method的返回类型来获取。

    一旦我们的模板写出来了,所有的数据表读写都可以复用这个模板。结合代理机制,我们只需要为数据表定义一个个接口,为每个方法注解sql语句,我们就可以直接使用生成的代理类进行数据库访问。甚至我们可以做出一个数据库交互层的框架,当然,会遇到很多细节的问题需要攻克。

    从这里,我们可以看出代理的其中一个优点:抽象,简化我们的开发。

    补充

    • $Proxy0是Proxy动态生成的代理类,它的奇怪的类名我们不需要关注。
    • sql语句除了可以通过注解来指定,还可以通过xml文件来配置,还可以根据约定从Repository的方法签名进行解析。
      比如:List<User> queryByName(String name),可以解析出sql语句:select * from user where name = ?
    • 系统框架设计人员可能会经常遇到代理,而应用程序设计人员很少会用到。

    代码

    package com.heyikan.demojava.base;
    
    import java.lang.reflect.InvocationHandler;
    import java.lang.reflect.Method;
    import java.lang.reflect.Proxy;
    import java.util.Arrays;
    
    /**
     * @see /uml/proxy-class.puml
     */
    public class ProxyDemo {
    
        public static void main(String[] args) {
            proxyRepository();
        }
    
        public static void proxyRepository() {
            // 1. 生成代理,一般由系统框架来做
            ClassLoader classLoader = Repository.class.getClassLoader();
            Repository proxy = (Repository) Proxy.newProxyInstance(classLoader, new Class[]{Repository.class}, new InvocationHandler() {
                @Override
                public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                    System.out.println(method.getName() + "(" + Arrays.toString(args) + ")");
                    String sql = "a sql"; // 一般从xml配置文件中,或者方法的注解中获取
                    Object result; // // 一般是执行上面的sql语句返回的结果
    
                    Class<?> returnType = method.getReturnType();
                    if (returnType == Integer.class) {
                        result = 1;
                    } else {
                        result = "a domain";
                    }
                    return result;
                }
            });
    
    //        System.out.println(proxy.getClass());
    
            // 2. 使用代理,一般由应用程序来做
            Object domain = "a domain";
            Integer insert = proxy.insert(domain);
            System.out.println("insert的结果是:" + insert);
    
            Integer update = proxy.update(domain);
            System.out.println("update的结果是:" + update);
    
            Integer delete = proxy.deleteById(1);
            System.out.println("delete的结果是:" + delete);
    
            Object query = proxy.queryById(1);
            System.out.println("query的结果是:" + query);
        }
    }
    
    interface Repository {
        Integer insert(Object domain);
    
        Integer update(Object domain);
    
        Integer deleteById(Integer id);
    
        Object queryById(Integer id);
    }
    

    这里并没有去真的实现一个数据库访问层的框架,相关的部分都进行了简化。

    Java代理机制最主要的两个类:Proxy和InvocationHandler,试着对它们的作用进行总结吧。

    相关文章

      网友评论

        本文标题:Java | 通过一个demo理解代理

        本文链接:https://www.haomeiwen.com/subject/ewsgottx.html