Java的动态代理的理解 .

Java动态代理类位于java.lang.reflect包下，一般主要涉及到以下两个类（接口算作特殊类）：

(1)Interface InvocationHandler：该接口中仅定义了一个方法

 //在代理实例上处理方法调用并返回结果。

public object invoke(Object obj,Method method, Object[] args)

在实际使用时，第一个参数obj一般是指代理类，method是被代理的方法，如上例中的request()，args为该方法的参数数组。 这个抽象方法在代理类中动态实现。

具体的说：

obj - 在其调用方法的代理实例
method - 对应于在代理实例上调用的接口方法的 Method 实例。Method 对象的声明类将是在其中声明方法的接口，该接口可以是代理类赖以继承方法的代理接口的超接口。
args - 包含传入代理实例上方法调用的参数值的对象数组，如果接口方法不使用参数，则为 null。基本类型的参数被包装在适当基本包装器类（如 java.lang.Integer 或 java.lang.Boolean）的实例中。

 

(2)Proxy：该类即为动态代理类，作用类似于上例中的ProxySubject，其中主要包含以下内容：

 

protected Proxy(InvocationHandler h)：构造函数，用于给内部的h赋值；

 

static Class getProxyClass (ClassLoader loader, Class[] interfaces)：获得一个代理类，其中loader是类装载器，interfaces是真实类所拥有的全部接口的数组；

 

static Object newProxyInstance(ClassLoader loader, Class[] interfaces, InvocationHandler h)：返回代理类的一个实例，返回后的代理类可以当作被代理类使用(可使用被代理类的在Subject接口中声明过的方法)。

 

所谓Dynamic Proxy是这样一种class：它是在运行时生成的class，在生成它时你必须提供一组interface给它，然后该class就宣称它实现了这些 interface。你当然可以把该class的实例当作这些interface中的任何一个来用。当然，这个Dynamic Proxy其实就是一个Proxy，它不会替你作实质性的工作，在生成它的实例时你必须提供一个handler，由它接管实际的工作。

 

下面例子讲述了一个动态代理Subject.java，RealSubject.java，DynamicSubject.java和Client.java，把他们放在一个包下，代码如下：

Subject.java代码

1. //抽象角色(之前是抽象类，此处应改为接口)      
2. public interface Subject      
3. {      
4.     public void request();      
5. }  

//抽象角色(之前是抽象类，此处应改为接口)
public interface Subject
{
public void request();
}

 

Realsubject.java代码

1. //具体角色      
2. public class RealSubject implements Subject      
3. {      
4.      
5.     public RealSubject()      
6.     {      
7.     }      
8.      
9.     public void request()      
10.     {      
11.         System.out.println("真正做事的。");      
12.     }      
13. }  

//具体角色
public class RealSubject implements Subject
{
public RealSubject()
{
}
public void request()
{
System.out.println("真正做事的。");
}
}

 

Dynamicsubject.java代码

//代理处理器      

1. /**     
2.  * 该代理类的内部属性为Object类，实际使用时通过该类的构造函数DynamicSubject(Object obj)对其赋值；     
3.  * 此外，在该类还实现了invoke方法，该方法中的 method.invoke(sub,args);     
4.  * 其实就是调用被代理对象的将要被执行的方法，方法参数sub是实际的被代理对象，     
5.  * args为执行被代理对象相应操作所需的参数。     
6.  * 通过动态代理类，我们可以在调用之前或之后执行一些相关操作     
7.  */     
8.      
9. public class DynamicSubject implements InvocationHandler      
10. {      
11.     private Object sub;      
12.      
13.     public DynamicSubject()      
14.     {      
15.     }      
16.      
17.     public DynamicSubject(Object obj)      
18.     {      
19.         sub = obj;      
20.     }      
21.      
22.     public Object invoke(Object proxy, Method method, Object[] args) throws Throwable      
23.     {      
24.         System.out.println("调用前" + method);      
25.      
26.         method.invoke(sub, args);      
27.      
28.         System.out.println("调用后 " + method);      
29.      
30.         return null;      
31.     }      
32. }   

//代理处理器
/**
* 该代理类的内部属性为Object类，实际使用时通过该类的构造函数DynamicSubject(Object obj)对其赋值；
* 此外，在该类还实现了invoke方法，该方法中的 method.invoke(sub,args);
* 其实就是调用被代理对象的将要被执行的方法，方法参数sub是实际的被代理对象，
* args为执行被代理对象相应操作所需的参数。
* 通过动态代理类，我们可以在调用之前或之后执行一些相关操作
*/
public class DynamicSubject implements InvocationHandler
{
private Object sub;
public DynamicSubject()
{
}
public DynamicSubject(Object obj)
{
sub = obj;
}
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable
{
System.out.println("调用前" + method);
method.invoke(sub, args);
System.out.println("调用后 " + method);
return null;
}
} 

 

Client.java代码

1. //客户端      
2. public class Client      
3. {      
4.     static public void main(String[] args) throws Throwable      
5.     {      
6.      
7.         RealSubject rs = new RealSubject(); // 在这里指定被代理类      
8.         InvocationHandler ds = new DynamicSubject(rs);      
9.         Class<?> cls = rs.getClass();      
10.      
11.         // 以下是一次性生成代理      
12.      
13.         Subject subject = (Subject) Proxy.newProxyInstance(      
14.                 cls.getClassLoader(), cls.getInterfaces(), ds);      
15.      
16.         subject.request();      
17.     }      
18. }  

//客户端
public class Client
{
static public void main(String[] args) throws Throwable
{
RealSubject rs = new RealSubject(); // 在这里指定被代理类
InvocationHandler ds = new DynamicSubject(rs);
Class<?> cls = rs.getClass();
// 以下是一次性生成代理
Subject subject = (Subject) Proxy.newProxyInstance(
cls.getClassLoader(), cls.getInterfaces(), ds);
subject.request();
}
}

 

这个程序中把静态代理类的抽象类改变为一个接口，而实际类实现这个接口。是因为Proxy类的newProxyInstance方法传入需要提供一个接口，这个是Java动态代理框架给我们设计好的了。本例的ProxySubject类实现了InvocationHandler接口及实现invoke方法，并且提供一个带参数的构造方法，通过Client类动态的调用真实类。

 

 Client类通过DynamicSubject类生成真实类的代理对象，并经由Proxy类的newProxyInstance方法实现生成“一个能做真实类做的事的代理”，并由该代理直接调用真实类所具有的方法。

 

 OK，也许还会有些迷惑，不过不要紧，没有什么高端的知识能够一次就成功的，要勤于练习。

 

下面这个类作为参考，代码如下：

Vectorproxy.java代码

1. import java.lang.reflect.InvocationHandler;      
2. import java.lang.reflect.Method;      
3. import java.lang.reflect.Proxy;      
4. import java.util.List;      
5. import java.util.Vector;      
6.      
7. public class VectorProxy implements InvocationHandler      
8. {      
9.     private Object proxyobj;      
10.      
11.     public VectorProxy(Object obj)      
12.     {      
13.         proxyobj = obj;      
14.     }      
15.      
16.     public static Object factory(Object obj)      
17.     {      
18.         Class<?> cls = obj.getClass();      
19.      
20.         return Proxy.newProxyInstance(cls.getClassLoader(),      
21.                 cls.getInterfaces(), new VectorProxy(obj));      
22.     }      
23.      
24.     public Object invoke(Object proxy, Method method, Object[] args)      
25.             throws Throwable      
26.     {      
27.         System.out.println("before calling " + method);      
28.      
29.         if (args != null)      
30.         {      
31.             for (int i = 0; i < args.length; i++)      
32.             {      
33.                 System.out.println(args[i] + "");      
34.             }      
35.         }      
36.         Object object = method.invoke(proxyobj, args);      
37.      
38.         System.out.println("after calling " + method);      
39.         return object;      
40.     }      
41.      
42.     @SuppressWarnings("unchecked")      
43.     public static void main(String[] args)      
44.     {      
45.         List<String> v = (List<String>) factory(new Vector<String>(10));      
46.      
47.         v.add("New");      
48.         v.add("York");      
49.         System.out.println(v);      
50.      
51.         v.remove(0);      
52.         System.out.println(v);      
53.     }      
54. }  

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.util.List;
import java.util.Vector;
public class VectorProxy implements InvocationHandler
{
private Object proxyobj;
public VectorProxy(Object obj)
{
proxyobj = obj;
}
public static Object factory(Object obj)
{
Class<?> cls = obj.getClass();
return Proxy.newProxyInstance(cls.getClassLoader(),
cls.getInterfaces(), new VectorProxy(obj));
}
public Object invoke(Object proxy, Method method, Object[] args)
throws Throwable
{
System.out.println("before calling " + method);
if (args != null)
{
for (int i = 0; i < args.length; i++)
{
System.out.println(args[i] + "");
}
}
Object object = method.invoke(proxyobj, args);
System.out.println("after calling " + method);
return object;
}
@SuppressWarnings("unchecked")
public static void main(String[] args)
{
List<String> v = (List<String>) factory(new Vector<String>(10));
v.add("New");
v.add("York");
System.out.println(v);
v.remove(0);
System.out.println(v);
}
}

 

这个类看不明白不要紧，慢慢来。

 

下面也是一个演示程序，作为扩展知识用，一共五个类，在同一包下，代码如下：

 

 五个类Foo.java， FooImpl.java， FooImpl2.java， CommonInvocationHandler.java和Demo.java。

Foo.java代码

1. public interface Foo      
2. {      
3.     void doAction();      
4. }   

public interface Foo
{
void doAction();
} 

 

Fooimpl.java代码

1. public class FooImpl implements Foo      
2. {      
3.     public FooImpl()      
4.     {      
5.     }      
6.      
7.     public void doAction()      
8.     {      
9.         System.out.println("in FooImp1.doAction()");      
10.     }      
11. }   

public class FooImpl implements Foo
{
public FooImpl()
{
}
public void doAction()
{
System.out.println("in FooImp1.doAction()");
}
} 

 

Fooimpl2.java代码

1. public class FooImpl2 implements Foo      
2. {      
3.     public FooImpl2()      
4.     {      
5.     }      
6.      
7.     public void doAction()      
8.     {      
9.         System.out.println("in FooImp2.doAction()");      
10.     }      
11. }  

public class FooImpl2 implements Foo
{
public FooImpl2()
{
}
public void doAction()
{
System.out.println("in FooImp2.doAction()");
}
}

 

Commoninvocationhandler.java代码

1. import java.lang.reflect.InvocationHandler;      
2. import java.lang.reflect.Method;      
3.      
4. public class CommonInvocationHandler implements InvocationHandler      
5. {      
6.      
7.     // 动态执行对象，需要回调的对象      
8.     private Object target;      
9.      
10.     // 支持构造子注射      
11.     public CommonInvocationHandler()      
12.     {      
13.      
14.     }      
15.      
16.     // 支持构造子注射      
17.     public CommonInvocationHandler(Object target)      
18.     {      
19.         setTarget(target);      
20.     }      
21.      
22.     /**     
23.      *      
24.      * 采用setter方法注射     
25.      *      
26.      * @param target     
27.      *      
28.      */     
29.     public void setTarget(Object target)      
30.     {      
31.         this.target = target;      
32.     }      
33.      
34.     /**     
35.      *      
36.      * 调用proxy中指定的方法method，并传入参数列表args     
37.      *      
38.      * @param proxy     
39.      *            代理类的类型，例如定义对应method的代理接口     
40.      *      
41.      * @param method     
42.      *            被代理的方法     
43.      *      
44.      * @param args     
45.      *            调用被代理方法的参数     
46.      *      
47.      * @return     
48.      *      
49.      * @throws java.lang.Throwable     
50.      *      
51.      */     
52.     public Object invoke(Object proxy, Method method, Object[] args) throws Throwable      
53.     {      
54.         return method.invoke(target, args);      
55.     }      
56. }  

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
public class CommonInvocationHandler implements InvocationHandler
{
// 动态执行对象，需要回调的对象
private Object target;
// 支持构造子注射
public CommonInvocationHandler()
{
}
// 支持构造子注射
public CommonInvocationHandler(Object target)
{
setTarget(target);
}
/**
*
* 采用setter方法注射
*
* @param target
*
*/
public void setTarget(Object target)
{
this.target = target;
}
/**
*
* 调用proxy中指定的方法method，并传入参数列表args
*
* @param proxy
*            代理类的类型，例如定义对应method的代理接口
*
* @param method
*            被代理的方法
*
* @param args
*            调用被代理方法的参数
*
* @return
*
* @throws java.lang.Throwable
*
*/
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable
{
return method.invoke(target, args);
}
}

 

Demo.java代码

1. import java.lang.reflect.Proxy;      
2.      
3. public class Demo      
4. {      
5.     public static void main(String[] args)      
6.     {      
7.      
8.         // 1.通用的动态代理实现      
9.      
10.         CommonInvocationHandler handler = new CommonInvocationHandler();      
11.      
12.         Foo f;      
13.      
14.         // 2.接口实现1      
15.      
16.         handler.setTarget(new FooImpl());      
17.      
18.         // 方法参数说明：代理类、代理类实现的接口列表、代理类的处理器      
19.      
20.         // 关联代理类、代理类中接口方法、处理器，当代理类中接口方法被调用时，会自动分发到处理器的invoke方法      
21.      
22.         // 如果代理类没有实现指定接口列表，会抛出非法参数异常      
23.      
24.         f = (Foo) Proxy.newProxyInstance(Foo.class.getClassLoader(),      
25.      
26.         new Class[] { Foo.class },      
27.      
28.         handler);      
29.      
30.         f.doAction();      
31.      
32.         // 3.接口实现2      
33.      
34.         handler.setTarget(new FooImpl2());      
35.      
36.         f = (Foo) Proxy.newProxyInstance(Foo.class.getClassLoader(),      
37.      
38.         new Class[] { Foo.class },      
39.      
40.         handler);      
41.      
42.         f.doAction();      
43.     }      
44. }