compact1, compact2, compact3

java.lang.reflect

Class Proxy

java.lang.Object

java.lang.reflect.Proxy

All Implemented Interfaces:

Serializable

public class Proxy
extends Object
implements Serializable

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

为某个接口创建代理Foo ：

  InvocationHandler handler = new MyInvocationHandler(...);
     Class<?> proxyClass = Proxy.getProxyClass(Foo.class.getClassLoader(), Foo.class);
     Foo f = (Foo) proxyClass.getConstructor(InvocationHandler.class).
                     newInstance(handler); 

或更简单地：

  Foo f = (Foo) Proxy.newProxyInstance(Foo.class.getClassLoader(),
                                          new Class<?>[] { Foo.class },
                                          handler); 

动态代理类 （以下简称为代理类 ）是一个实现在类创建时在运行时指定的接口列表的类，具有如下所述的行为。 代理接口是由代理类实现的接口。 代理实例是代理类的一个实例。 每个代理实例都有一个关联的调用处理程序对象，它实现了接口InvocationHandler 。 通过其代理接口之一的代理实例上的方法调用将被分派到实例调用处理程序的invoke方法，传递代理实例， java.lang.reflect.Method被调用方法的java.lang.reflect.Method对象以及包含参数的类型Object Object的数组。 调用处理程序适当地处理编码方法调用，并且返回的结果将作为方法在代理实例上调用的结果返回。

代理类具有以下属性：

• 代理类是公共的，最终的，而不是抽象的，如果所有代理接口都是公共的。
• 如果任何代理接口是非公开的，代理类是非公开的，最终的，而不是抽象的 。
• 代理类的不合格名称未指定。 然而，以字符串"$Proxy"开头的类名空间应该保留给代理类。
• 一个代理类扩展了java.lang.reflect.Proxy 。
• 代理类完全按照相同的顺序实现其创建时指定的接口。
• 如果一个代理类实现一个非公共接口，那么它将被定义在与该接口相同的包中。 否则，代理类的包也是未指定的。 请注意，程序包密封不会阻止在运行时在特定程序包中成功定义代理类，并且类也不会由同一类加载器定义，并且与特定签名者具有相同的包。
• 由于代理类实现了在其创建时指定的所有接口， getInterfaces在其类对象上调用getInterfaces将返回一个包含相同列表接口的数组（按其创建时指定的顺序），在其类对象上调用getMethods将返回一个数组的方法对象，其中包括这些接口中的所有方法，并调用getMethod将在代理接口中找到可以预期的方法。
• Proxy.isProxyClass方法将返回true，如果它通过代理类 - 由Proxy.getProxyClass返回的类或由Proxy.newProxyInstance返回的对象的类 - 否则为false。
• 所述java.security.ProtectionDomain代理类的是相同由引导类装载程序装载系统类，如java.lang.Object ，因为是由受信任的系统代码生成代理类的代码。 此保护域通常将被授予java.security.AllPermission 。
• 每个代理类有一个公共构造一个参数，该接口的实现InvocationHandler ，设置调用处理程序的代理实例。 而不必使用反射API来访问公共构造函数，也可以通过调用Proxy.newProxyInstance方法来创建代理实例，该方法将调用Proxy.getProxyClass的操作与调用处理程序一起调用构造函数。

代理实例具有以下属性：

• 给定代理实例proxy和其代理类Foo ，以下表达式将返回true：

     proxy instanceof Foo 

  并且以下演员操作将会成功（而不是投掷一个ClassCastException ）：

     (Foo) proxy 

• 每个代理实例都有一个关联的调用处理程序，它被传递给它的构造函数。 静态Proxy.getInvocationHandler方法将返回与作为其参数传递的代理实例关联的调用处理程序。
• 代理实例上的接口方法调用将被编码并分派到调用处理程序的invoke方法，如该方法的文档所述。
• hashCode ， equals在代理实例上的toString中声明的java.lang.Object或toString或toString或toString方法将被编码并分派到调用处理程序的invoke方法，方法与接口方法调用被编码和调度相同。 传递给invoke的方法对象的声明类将为java.lang.Object 。 从java.lang.Object的代理实例的其他公共方法不会被代理类覆盖，因此这些方法的调用与java.lang.Object 。

多代理接口中复制的方法

当代理类的两个或多个接口包含具有相同名称和参数签名的方法时，代理类接口的顺序变得重要。 当在代理实例上调用这种重复方法时，传递给调用处理程序的方法对象不一定是其声明类可以通过调用代理方法的接口的引用类型进行分配的对象。 存在此限制，因为生成的代理类中的相应方法实现无法确定其调用的接口。 因此，当在代理实例上调用重复的方法时，代理类的方法列表中包含方法（直接或通过超级接口继承）的最重要的接口中的方法的Method对象被传递给调用处理程序的invoke方法，而不管方法调用发生的引用类型。

如果代理接口包含具有相同的名称和参数签名的方法hashCode ， equals ，或toString的方法java.lang.Object ，当这种方法在代理实例调用时， 方法传递到调用处理程序对象将有java.lang.Object为申报班 换句话说， java.lang.Object的公共非最终方法java.lang.Object上先于所有代理接口，以确定哪个方法对象传递给调用处理程序。

还要注意，当将一个重复的方法分派到调用处理程序时， invoke方法可能只会将可分配给所有可以调用的所有代理接口中的方法的throws子句中的一种异常类型的检查异常类型抛出通过。 如果invoke方法抛出经过检查的异常是不能分配给任何通过它可以通过调用代理接口中的方法声明的异常类型，那么选中UndeclaredThrowableException将通过代理实例调用抛出。 此限制意味着，并非所有通过调用返回的异常类型getExceptionTypes上方法传递给对象invoke方法一定可以成功地抛出invoke方法。

从以下版本开始：

1.3

另请参见：

InvocationHandler ， Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected InvocationHandler	h 该代理实例的调用处理程序。

构造方法摘要

构造方法

Modifier	Constructor and Description
protected	Proxy(InvocationHandler h) 从一个子类（通常是一个动态代理类）构造一个新的 Proxy实例，具有指定的调用处理程序的值。

方法摘要

Modifier and Type	Method and Description
static InvocationHandler	getInvocationHandler(Object proxy) 返回指定代理实例的调用处理程序。
static 类<?>	getProxyClass(ClassLoader loader, 类<?>... interfaces) 给出类加载器和接口数组的代理类的 java.lang.Class对象。
static boolean	isProxyClass(类<?> cl) 如果且仅当使用 getProxyClass方法或 newProxyInstance方法将指定的类动态生成为代理类时，则返回true。
static Object	newProxyInstance(ClassLoader loader, 类<?>[] interfaces, InvocationHandler h) 返回指定接口的代理类的实例，该接口将方法调用分派给指定的调用处理程序。

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细信息

h

protected InvocationHandler h

该代理实例的调用处理程序。

构造方法详细信息

Proxy

protected Proxy(InvocationHandler h)

从一个子类（通常是一个动态代理类）构造一个新的 Proxy实例，该实例具有调用处理程序的指定值。

参数

h - 此代理实例的调用处理程序

异常

NullPointerException - 如果给定的调用处理程序 h是 null 。

方法详细信息

getProxyClass

public static 类<?> getProxyClass(ClassLoader loader,
                                     类<?>... interfaces)
                              throws IllegalArgumentException

给定类加载器和接口数组的代理类的java.lang.Class对象。 代理类将由指定的类加载器定义，并将实现所有提供的接口。 如果任何给定的接口是非公开的，则代理类将是非公开的。 如果类加载器已经定义了接口相同置换的代理类，那么将返回现有的代理类; 否则，这些接口的代理类将被动态生成并由类加载器定义。

对可能传递给Proxy.getProxyClass的参数有几个Proxy.getProxyClass ：

• interfaces数组中的所有类对象都必须表示接口，而不是类或原始类型。
• interfaces数组中没有两个元素可能是指相同的类对象。
• 所有的接口类型必须通过指定的类加载器的名称可见。 换句话说，对于类加载器cl和每个接口i ，以下表达式必须为真：

    Class.forName(i.getName(), false, cl) == i 

• 所有非公共接口必须在同一个包中; 否则代理类将不可能实现所有接口，而不管其中定义了什么包。
• 对于具有相同签名的指定接口的任何成员方法集合：
  • 如果任何方法的返回类型是原始类型或void，则所有方法必须具有相同的返回类型。
  • 否则，其中一个方法必须具有一个返回类型，该类型可以分配给其余方法的所有返回类型。
• 生成的代理类不能超过虚拟机对类施加的任何限制。 例如，VM可以将类可以实现的接口数量限制为65535; 在这种情况下， interfaces阵列的大小不得超过65535。

如果任何这些限制被违反， Proxy.getProxyClass将抛出一个IllegalArgumentException 。 如果interfaces数组参数或其任何元素为null ，则将抛出一个NullPointerException 。

请注意，指定的代理接口的顺序是重要的：具有相同组合的接口但不同顺序的代理类的两个请求将导致两个不同的代理类。

参数

loader - 类加载器来定义代理类

interfaces - 要实现的代理类的接口列表

结果

在指定的类加载器中定义并实现指定接口的代理类

异常

IllegalArgumentException - 如果对可能传递给 getProxyClass的参数的任何 getProxyClass被违反

SecurityException - 如果存在安全管理员s ，并且满足以下任何条件：

• 给定的loader是null ，并且调用者的类加载器不是null ，并且调用s.checkPermission与RuntimePermission("getClassLoader")权限被拒绝访问。
• 对于每个代理接口， intf ，呼叫者的类加载器是不一样的或类加载器的一个祖先intf和调用s.checkPackageAccess()拒绝访问intf 。

NullPointerException - 如果 interfaces数组参数或其任何元素是 null

newProxyInstance

public static Object newProxyInstance(ClassLoader loader,
                                      类<?>[] interfaces,
                                      InvocationHandler h)
                               throws IllegalArgumentException

返回指定接口的代理类的实例，该接口将方法调用分派给指定的调用处理程序。

Proxy.newProxyInstance因为与IllegalArgumentException相同的原因而Proxy.getProxyClass 。

参数

loader - 类加载器来定义代理类

interfaces - 代理类实现的接口列表

h - 调度方法调用的调用处理函数

结果

具有由指定的类加载器定义并实现指定接口的代理类的指定调用处理程序的代理实例

异常

IllegalArgumentException - 如果对可能传递给 getProxyClass有任何 getProxyClass被违反

SecurityException -如果安全管理器，S存在任何下列条件得到满足：

• 给定的loader是null ，并且调用者的类加载器不是null ，并且调用s.checkPermission与RuntimePermission("getClassLoader")权限拒绝访问;
• 对于每个代理接口， intf ，呼叫者的类加载器是不一样的或类加载器的祖先intf和调用s.checkPackageAccess()拒绝访问intf ;
• 任何给定的代理接口的是非公和呼叫者类是不在同一runtime package作为非公共接口和调用s.checkPermission与ReflectPermission("newProxyInPackage.{package name}")权限拒绝访问。

NullPointerException - 如果 interfaces数组参数或其任何元素是 null ，或者如果调用处理程序 h是 null

isProxyClass

public static boolean isProxyClass(类<?> cl)

如果且仅当使用getProxyClass方法或newProxyInstance方法将指定的类动态生成为代理类时，则返回true。

这种方法的可靠性对于使用它来做出安全决策的能力很重要，所以它的实现不应该只是测试所讨论的类是否扩展了Proxy 。

参数

cl - 要测试的班级

结果

true如果该类是代理类， false false

异常

NullPointerException - 如果 cl是 null

getInvocationHandler

public static InvocationHandler getInvocationHandler(Object proxy)
                                              throws IllegalArgumentException

返回指定代理实例的调用处理程序。

参数

proxy - 用于返回调用处理程序的代理实例

结果

代理实例的调用处理程序

异常

IllegalArgumentException - 如果参数不是代理实例

SecurityException -如果安全管理器 ，S存在，并且调用者的类加载器是不一样或类加载器的调用处理程序和调用的祖先 s.checkPackageAccess()拒绝访问到调用处理程序的类。