java动态代理

 

 GOF的23种设计模式之一(结构型模式)。

所谓静态代理， 就是程序运行前就已经存在的编译好的代理类。

 

相反，如果代理类程序运行前并不存在，需要在程序运行时动态生成(无需手工编写代理类源码)，那就是今天要说的动态代理了。

 

如何生成的：根据Java的反射机制动态生成。

 

 

 

目标接口TargetInterface:

 

public interface TargetInterface {
    public int targetMethodA(int number);
    public int targetMethodB(int number);
}

 

很简单，一个普通的接口，里面有若干方法(此处写2个示范一下)

 

实现该接口的委托类ConcreteClass:

 

public class ConcreteClass implements TargetInterface{

    public int targetMethodA(int number) {
        System.out.println("开始调用目标类的方法targetMethodA...");
        System.out.println("操作-打印数字:"+number);
        System.out.println("结束调用目标类的方法targetMethodA...");
        return number;
    }

    public int targetMethodB(int number){
        System.out.println("开始调用目标类的方法targetMethodB...");
        System.out.println("操作-打印数字:"+number);
        System.out.println("结束调用目标类的方法targetMethodB...");
        return number;
    }

}

 

很简单，一个普通的类，实现了目标接口。

 

代理处理器类ProxyHandler:

 

public class ProxyHandler implements InvocationHandler{
    private Object concreteClass;

    public ProxyHandler(Object concreteClass){
        this.concreteClass=concreteClass;
    }

    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        System.out.println("proxy:"+proxy.getClass().getName());
        System.out.println("method:"+method.getName());
        System.out.println("args:"+args[0].getClass().getName());

        System.out.println("Before invoke method...");
        Object object=method.invoke(concreteClass, args);//普通的Java反射代码,通过反射执行某个类的某方法
        //System.out.println(((ConcreteClass)concreteClass).targetMethod(10)+(Integer)args[0]);
        System.out.println("After invoke method...");
        return object;
    }

}

 

该类实现了Java反射包中的InvocationHandler接口。代理实例调用方法时，将对方法调用指派到它的代理处理器程序的invoke方法中。invoke方法内部实现预处理，对委托类方法调用，事后处理等逻辑。

 

最后是入口程序:

 

public class DynamicProxyExample {
    public static void main(String[] args){
         ConcreteClass c=new ConcreteClass();//元对象(被代理对象)
         InvocationHandler ih=new ProxyHandler(c);//代理实例的调用处理程序。
         //创建一个实现业务接口的代理类,用于访问业务类(见代理模式)。
         //返回一个指定接口的代理类实例，该接口可以将方法调用指派到指定的调用处理程序，如ProxyHandler。
         TargetInterface targetInterface=
             (TargetInterface)Proxy.newProxyInstance(c.getClass().getClassLoader(),c.getClass().getInterfaces(),ih);
         //调用代理类方法,Java执行InvocationHandler接口的方法.
         int i=targetInterface.targetMethodA(5);
         System.out.println(i);
         System.out.println();
         int j=targetInterface.targetMethodB(15);
         System.out.println(j);
    }
}

 

首先创建委托类对象，将其以构造函数传入代理处理器，代理处理器ProxyHandler中会以Java反射方式调用该委托类对应的方法。然后使用 Java反射机制中的Proxy.newProxyInstance方式创建一个代理类实例，创建该实例需要指定该实例的类加载器，需要实现的接口(即目 标接口)，以及处理代理实例接口调用的处理器。

 

最后，调用代理类目标接口方法时，会自动将其转发到代理处理器中的invoke方法内，invoke方法内部实现预处理，对委托类方法调用，事后处理等逻辑。

 

 

 

使用Java动态代理机制的好处：

 

1、减少编程的工作量：假如需要实现多种代理处理逻辑，只要写多个代理处理器就可以了，无需每种方式都写一个代理类。

 

2、系统扩展性和维护性增强，程序修改起来也方便多了(一般只要改代理处理器类就行了)。

 

 

 

使用Java动态代理机制的限制：

 

目前根据GOF的代理模式，代理类和委托类需要都实现同一个接口。也就是说只有实现了某个接口的类可以使用Java动态代理机制。但是，事实上使用 中并不是遇到的所有类都会给你实现一个接口。因此，对于没有实现接口的类，目前无法使用该机制。有人说这不是废话吗，本来Proxy模式定义的就是委托类 要实现接口的啊！但是没有实现接口的类，该如何实现动态代理呢？

 

当然不是没有办法，这也是我后面抽时间要继续整理和总结原先使用过的一件神器，相关Blog会不定期发上来。那就是大名鼎鼎的CGLib...

 

 

二、使用CGLib实现：

使用CGLib实现动态代理，完全不受代理类必须实现接口的限制，而且CGLib底层采用 ASM字节码生成框架，使用字节码技术生成代理类，比使用Java反射效率要高。唯一需要注意的是，CGLib不能对声明为final的方法进行代理，因 为CGLib原理是动态生成被代理类的子类。

下面，将通过一个实例介绍使用CGLib实现动态代理。

1、被代理类：

首先，定义一个类，该类没有实现任何接口，包含两个方法。

public class ConcreteClassNoInterface {
    public String getConcreteMethodA(String str){
        System.out.println("ConcreteMethod A ... "+str);
        return str;
    }
    public int getConcreteMethodB(int n){
        System.out.println("ConcreteMethod B ... "+n);
        return n+10;
    }
}

2、拦截器：

定义一个拦截器。在调用目标方法时，CGLib会回调MethodInterceptor接口方法拦截，来实现你自己的代理逻辑，类似于JDK中的InvocationHandler接口。

public class ConcreteClassInterceptor implements MethodInterceptor{
    public Object intercept(Object obj, Method method, Object[] arg, MethodProxy proxy) throws Throwable {
        System.out.println("Before:"+method);
        Object object=proxy.invokeSuper(obj, arg);
        System.out.println("After:"+method);
        return object;
    }
}

参数：Object为由CGLib动态生成的代理类实例，Method为上文中实体类所调用的被代理的方法引用，Object[]为参数值列表，MethodProxy为生成的代理类对方法的代理引用。

返回：从代理实例的方法调用返回的值。

其中，proxy.invokeSuper(obj,arg)：

调用代理类实例上的proxy方法的父类方法（即实体类ConcreteClassNoInterface中对应的方法）

在这个示例中，只在调用被代理类方法前后各打印了一句话，当然实际编程中可以是其它复杂逻辑。

3、生成动态代理类：

Enhancer enhancer=new Enhancer();
enhancer.setSuperclass(ConcreteClassNoInterface.class);
enhancer.setCallback(new ConcreteClassInterceptor());
ConcreteClassNoInterface ccni=(ConcreteClassNoInterface)enhancer.create();

这里Enhancer类是CGLib中的一个字节码增强器，它可以方便的对你想要处理的类进行扩展，以后会经常看到它。

首先将被代理类ConcreteClassNoInterface设置成父类，然后设置拦截器ConcreteClassInterceptor， 最后执行enhancer.create()动态生成一个代理类，并从Object强制转型成父类型ConcreteClassNoInterface。

最后，在代理类上调用方法：

ccni.getConcreteMethodA("shensy");
ccni.getConcreteMethodB(0);

查看控制台输出：

Before :public java.lang.String generic.cglib.proxy.ConcreteClassNoInterface.getConcreteMethodA(java.lang.String)
ConcreteMethod A ... shensy
After :public java.lang.String generic.cglib.proxy.ConcreteClassNoInterface.getConcreteMethodA(java.lang.String)
Before :public int generic.cglib.proxy.ConcreteClassNoInterface.getConcreteMethodB(int)
ConcreteMethod B ... 0
After :public int generic.cglib.proxy.ConcreteClassNoInterface.getConcreteMethodB(int)

可以看到，拦截器在调用被代理类方法前后都执行了print操作。