代理与动态代理

概述

代理

生活中的代理：比如暴雪又新出了一款游戏，作为一个中国用户，没有很好的方式直接从美国拿到游戏产品，就需要等到中国的某个代理商被暴雪授权代理，才可以玩上暴雪新出的这款游戏，那么代理的作用也就显而易见了，就是为了方便的适应一些不同地区的用户而产生的中间媒介，通过代理，可以更有效的将一些产品发行出去，生活中这样代理的例子比比皆是

程序中的代理：如果一些实现了同一接口的类在实现方法的时候，有了新的需求，需要增加一些异常处理、日志、计算方法的运行时间、事务管理等操作，但是我们又不能去修改源代码，这样严重影响了程序的扩展性，这个时候，我们就可以使用代理，代理与目标类实现同一个接口，代表着代理类与目标类具有同名的方法，调用者不需要直接调用目标对象，而是使用代理间接调用目标对象的方法，并在这个过程中加入自己的处理代码，这就是程序中的代理

代理实现图示

代理可以处理的问题

系统中存在交叉业务，一个交叉业务就是要切入到系统中的一个方面，如下所示：

用具体的程序代码描述交叉业务：

 

交叉业务的编程问题即为面向方面的编程（Aspect oriented program ,简称AOP），AOP的目标就是要使交叉业务模块化。可以采用将切面代码移动到原始方法的周围，这与直接在方法中编写切面代码的运行效果是一样的，如下所示：

使用代理技术正好可以解决这种问题，代理是实现AOP功能的核心和关键技术。

代理类的各个方法中通常除了要调用目标的相应方法和对外返回目标返回的结果外，还可以在代理方法中的如下四个位置加上系统功能代码：

1. 在调用目标方法之前
2. 在调用目标方法之后
3. 在调用目标方法前后
4. 在处理目标方法异常的catch块中

动态代理

了解了代理之后，我们知道代理类要实现与目标类相同的接口，那么现存的已知接口与其子类那么多，我们不可能一个个的手动实现他们的代理类，这个时候，java.lang.reflect中的Proxy类为我们提供了可以动态生成代理类的方法，也就是所谓的动态代理技术

动态代理就是不需要手动，而是通过JVM自动生成一份字节码，这份字节码实现了需要被代理的类的父类接口，这样就使得创建代理类变成了一件模块化的事情

利用动态代理实现一个简单代理过程

public class Proxy

extends Object

implements Serializable

Proxy 提供用于创建动态代理类和实例的静态方法，它还是由这些方法创建的所有动态代理类的超类。

static InvocationHandler
getInvocationHandler(Object proxy)
          返回指定代理实例的调用处理程序。

static Class<?>
getProxyClass(ClassLoader loader, Class<?>... interfaces)
          返回代理类的 java.lang.Class 对象，并向其提供类加载器和接口数组。

static boolean
isProxyClass(Class<?> cl)
          当且仅当指定的类通过 getProxyClass 方法或 newProxyInstance 方法动态生成为代理类时，返回 true。

static Object
newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler h)
          返回一个指定接口的代理类实例，该接口可以将方法调用指派到指定的调用处理程序。

以上是Proxy代理类的一些方法，其中，getProxyClass可以获得生成好的代理类字节码，而newProxyInstance可以直接获得一个动态代理类的对象

这里我们考虑，生成一个代理类，具体需要哪些东西？

• 一份父类接口的字节码
• 一个用于加载生成的代理类的类加载器
• 一系列的对目标对象的操作

这也就是newProxyInstance的参数含义，其中对目标对象的操作封装在InvocationHandler类中

public interface InvocationHandler

InvocationHandler 是代理实例的调用处理程序 实现的接口。

Object
invoke(Object proxy, Method method, Object[] args)
          在代理实例上处理方法调用并返回结果。

这个类就是封装了操作目标对象的具体实现代码，也就是说，将功能也模块化

InvocationHandler中只有一个方法，需要实现的其他功能以及对目标对象的操作，需要在这里完成

然后将这个对象作为参数传递给newProxyInstance方法，从而构造代理类

下面的例子通过newProxyInstance方法实现动态代理

首先是一个公共接口

public interface Speak {
    public void sayHello();
}

以及一个该接口的子类

public class MySpeak implements Speak{
    @Override
    public void sayHello() {
        // TODO Auto-generated method stub
        System.out.println("Hello,World!");
    }
}

下面我们可以创建对该子类对象具体操作的InvocationHandler子类了

public class SpeakHandler implements InvocationHandler {
    //需要操作的目标对象
    private Object obj;

    public SpeakHandler(Object obj) {
        super();
        this.obj = obj;
    }

    /* (non-Javadoc)
     * @see java.lang.reflect.InvocationHandler#invoke(java.lang.Object, java.lang.reflect.Method, java.lang.Object[])
     */
    @Override
    public Object invoke(Object proxy, Method method, Object[] args)
            throws Throwable {
        //执行目标方法前的代码
        before();

        //利用反射执行目标对象的对应方法
        Object retVal = method.invoke(obj, args);

        //执行目标方法后的代码
        after();

        return retVal;
    }

    private void before(){
        System.out.println("before");
    }

    private void after(){
        System.out.println("after");
    }
}

好了，准备工作完成了，这样就可以利用Proxy类获取我们的代理类对象了

public class ProxyTest {

    /**
     * @param args
     */
    public static void main(String[] args) {

        //生成目标对象
        MySpeak ms = new MySpeak();

        //生成Handler对象
        SpeakHandler speakHandler = new SpeakHandler(ms);

        //构造代理类，获取对象
        Speak speak = (Speak)Proxy.newProxyInstance(
                Speak.class.getClassLoader(),
                new Class[]{Speak.class},
                speakHandler);

        //执行代理类实现的接口方法
        speak.sayHello();
    }
}

打印结果

before
Hello,World!
after

推测代理类内部代码实现方式

根据Invocation的invoke方法的三个参数，我们基本可以推测出内部实现的代码应该是这样的：

sayHello(){

handler.invoke(this,this.getClass().getMethod(“sayHello”,null),null);

}

所以整个类的运行过程图示为：

模块化的代理

了解上面创建代理类的过程，我们可以抽取一些硬编码进去的功能，提高程序的扩展性

首先，我们要有一个接口用来表示建议执行的额外功能

public interface Advice {
    //目标对象执行前的操作
    void beforeMethod();
    //目标对象执行后的操作
    void afterMethod();
}

然后，就可以完成我们的一步构造代理类对象的方法了

public class ProxyTest2 {

    /**
     * @param args
     */
    public static void main(String[] args) {

        Collection col = (Collection)getProxy(new ArrayList(),new Advice() {

            @Override
            public void beforeMethod() {
                // TODO Auto-generated method stub
                System.out.println("before!");
            }

            @Override
            public void afterMethod() {
                // TODO Auto-generated method stub
                System.out.println("after!");
            }
        });

        col.add(1);
        col.add(2);
        System.out.println(col.size());
        System.out.println(col.getClass());

    }

    public static Object getProxy(final Object obj,final Advice advice){
        //获取代理类对象
        Object retObj = Proxy.newProxyInstance(
                obj.getClass().getClassLoader(),//根据对象得到类加载器
                obj.getClass().getInterfaces(),//根据对象得到接口列表
                new InvocationHandler() {

                    @Override
                    public Object invoke(Object proxy, Method method, Object[] args)
                            throws Throwable {
                        //建议的系统功能
                        advice.beforeMethod();

                        Object retVal = method.invoke(obj, args);

                        //建议的系统功能
                        advice.afterMethod();

                        return retVal;

                    }
                });
        return retObj;
    }

}

这样，我们就将系统建议的功能以及需要操作的目标对象都暴露在外面供调用者使用，其他全部封装起来

注意：

这里col.getClass打印的结果为$Proxy

这是因为代理类在执行继承自Object的方法时，只有执行到hashCode, equals, 或toString，才会将方法传递到目标对象，也就是说只有执行到这三个方法时，才会返回目标对象方法的返回值，而其他的继承自Object的方法目标则是代理类对象本身

实现AOP功能的封装与配置

上面提到了动态代理是解决AOP的核心技术，那么我们来实现一个简单的框架

BeanFactory类通过类中的getBean方法产生需求的对象

配置文件中配置一系列key value值，如下

#ArrayList=java.util.ArrayList
ArrayList=proxy.ProxyFactoryBean
ArrayList.target=java.util.ArrayList
ArrayList.advice=proxy.aopframework.MyAdvice

当value值不是一个ProxyFactoryBean对象时，直接返回读取到的类的对象

当value值为一个ProxyFactoryBean对象时，通过ProxyFactoryBean中的getProxy生成目标类的代理类对象，并返回

这样就实现了一个简单的获取对象的框架

我们需要做的就只是编写自己需要用到的类，并配置到配置文件中，即可。

下面是实现过程

BeanFactory类

/**
 * @author Shawn
 * Bean工厂
 */
public class BeanFactory {
    Properties props = new Properties();

    public BeanFactory(InputStream ips){
        try {
            //载入配置文件读取流
            props.load(ips);
        } catch (IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }

    //主要方法，根据key值生成对象
    public Object getBean(String name){
        Object obj = null;
        String className = props.getProperty(name);
        try {
            Class beanClass = Class.forName(className);
            obj = beanClass.newInstance();
        } catch (Exception e1) {
            // TODO Auto-generated catch block
            e1.printStackTrace();
        }
        //如果需要生成的是代理类对象
        if(obj instanceof ProxyFactoryBean){
            Object retObj = null;
            try {
                //读取对应的Advice系统功能类，并创建对象
                Advice advice = (Advice)Class.forName(props.getProperty(name+".advice")).newInstance();
                //读取对应的target目标类，并生成对象
                Object target = Class.forName(props.getProperty(name+".target")).newInstance();
                ProxyFactoryBean proxyObj = (ProxyFactoryBean)obj;
                //为ProxyFactoryBean对象set相关属性
                proxyObj.setAdvice(advice);
                proxyObj.setTarget(target);
                //通过getProxy方法获得代理类对象
                retObj = proxyObj.getProxy();
            } catch (Exception e) {
                // TODO Auto-generated catch block
                e.printStackTrace();
            }
            return retObj;
        }
        else
            return obj;
    }
}

ProxyFactoryBean类

/**
 * @author Shawn
 * 代理工厂
 */
public class ProxyFactoryBean {
    //目标类
    private Object target;
    //系统建议的方法
    private Advice advice;


    public Object getTarget() {
        return target;
    }

    public void setTarget(Object target) {
        this.target = target;
    }


    public Advice getAdvice() {
        return advice;
    }


    public void setAdvice(Advice advice) {
        this.advice = advice;
    }

    //获取代理类对象
    public Object getProxy() {

        Object retObj = Proxy.newProxyInstance(
                target.getClass().getClassLoader(),//根据对象得到类加载器
                target.getClass().getInterfaces(),//根据对象得到接口列表
                new InvocationHandler() {

                    @Override
                    public Object invoke(Object proxy, Method method, Object[] args)
                            throws Throwable {
                        //建议的系统功能
                        advice.beforeMethod();

                        Object retVal = method.invoke(target, args);

                        //建议的系统功能
                        advice.afterMethod();

                        return retVal;

                    }
                });
        return retObj;
    }

}

下面进行测试，编写自己的MyAdvice类，实现Advice接口，表示系统建议的功能

/**
 * @author Shawn
 *
 */
public class MyAdvice implements Advice {

    /* (non-Javadoc)
     * @see proxy.Advice#afterMethod()
     */
    @Override
    public void afterMethod() {
        // TODO Auto-generated method stub
        System.out.println("after");

    }

    /* (non-Javadoc)
     * @see proxy.Advice#beforeMethod()
     */
    @Override
    public void beforeMethod() {
        // TODO Auto-generated method stub
        System.out.println("before");

    }
}

配置文件

#ArrayList=java.util.ArrayList
ArrayList=proxy.aopframework.ProxyFactoryBean
ArrayList.target=java.util.ArrayList
ArrayList.advice=proxy.aopframework.MyAdvice

测试类

public class AopFrameworkTest {

    /**
     * @param args
     */
    public static void main(String[] args) {

        //载入配置文件
        InputStream ips = AopFrameworkTest.class.getResourceAsStream("config.properties");

        //创建Bean工厂
        BeanFactory factory = new BeanFactory(ips);

        //获得对象
        Collection list = (Collection)factory.getBean("ArrayList");

        list.add(1);
        list.add(2);
        System.out.println(list);
    }
}

这样就完成了一个简单的框架

配置文件中

ArrayList=java.util.ArrayList时，得到的是目标类对象

ArrayList=proxy.aopframework.ProxyFactoryBean时，得到的是目标类的代理类对象