compact1, compact2, compact3

java.lang.reflect

Прокси класса

java.lang. Объект

java.lang.reflect. Прокси

Все Реализованные Интерфейсы:

Сериализуемый

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);
 

Динамическим class прокси (просто называемый прокси class ниже) является class, который реализует список интерфейсов, определенных во времени выполнения, когда class создается с поведением как описано ниже. Интерфейс прокси является таким интерфейсом, который реализуется прокси class. Экземпляр прокси является экземпляром прокси class. У каждого экземпляра прокси есть связанный объект-обработчик вызова, который реализует интерфейс InvocationHandler. Вызов метода на экземпляре прокси через один из его интерфейсов прокси будет диспетчеризирован invoke метод обработчика вызова экземпляра, передавая экземпляр прокси, a java.lang.reflect.Method объект, идентифицирующий метод, который был вызван, и массив типа Object содержа параметры. Обработчик вызова обрабатывает закодированный вызов метода как соответствующий и результат, который это возвращает, будет возвращен как результат вызова метода на экземпляре прокси.

У прокси class есть следующие свойства:

• Прокси-классы являются общедоступными, заключительными, и не абстрактными, если все интерфейсы прокси общедоступны.
• Прокси-классы являются непубличными, заключительными, и не абстрактными, если какой-либо из интерфейсов прокси является непубличным.
• Неполное имя прокси class является неуказанным. Пространство имен class, которые начинаются со строки "$Proxy" должен быть, однако, зарезервирован для прокси-классов.
• Прокси class расширяется java.lang.reflect.Proxy.
• Прокси class реализует точно интерфейсы, определенные при его создании в том же самом порядке.
• Если прокси, class реализует непубличный интерфейс, то он будет определен в том же самом пакете как тот интерфейс. Иначе, пакет прокси class является также неуказанным. Отметьте, что изоляция пакета не будет предотвращать прокси class от того, чтобы быть успешно определенным в определенном пакете во времени выполнения, и ни один не будет классы, уже определенные тем же самым загрузчиком class и тем же самым пакетом с определенными подписывающими лицами.
• Начиная с прокси class реализует все интерфейсы, определенные при его создании, вызывая getInterfaces на Class объект возвратит массив, содержащий тот же самый список интерфейсов (в порядке, определенном при его создании), вызывая getMethods на Class объект возвратит массив Method объекты, которые включают все методы в тех интерфейсах, и вызов getMethod найдет методы в интерфейсах прокси, как ожидался бы.
• Proxy.isProxyClass метод возвратит true, если это передадут прокси class - class, возвращенный Proxy.getProxyClass или class объекта, возвращенного Proxy.newProxyInstance- и ложь иначе.
• java.security.ProtectionDomain из прокси class является тем же самым как тем из системных классов, загруженных начальной загрузкой загрузчик class, такой как java.lang.Object, потому что код для прокси class сгенерирован кодом достоверной системы. Этот домен защиты будут обычно предоставлять java.security.AllPermission.
• У каждого class прокси есть один общедоступный конструктор, который берет один параметр, реализацию интерфейса InvocationHandler, установить обработчик вызова для экземпляра прокси. Вместо того, чтобы иметь необходимость использовать API Reflection, чтобы получить доступ к общедоступному конструктору, экземпляр прокси может быть также быть созданным, вызывая Proxy.newProxyInstance метод, который комбинирует действия вызова Proxy.getProxyClass с вызовом конструктора с обработчиком вызова.

У экземпляра прокси есть следующие свойства:

• Учитывая экземпляр прокси proxy и один из интерфейсов, реализованных его прокси class Foo, следующее выражение возвратит true:

        proxy instanceof Foo
   

  и следующая работа броска успешно выполнится (вместо того, чтобы бросить a ClassCastException):

        (Foo) proxy
   

• У каждого экземпляра прокси есть связанный обработчик вызова, тот, который передали его конструктору. Помехи Proxy.getInvocationHandler метод возвратит обработчик вызова, связанный с экземпляром прокси, который передают как его параметр.
• Вызов метода интерфейса на экземпляре прокси будет закодирован и диспетчеризирован обработчику вызова invoke метод как описано в документации для того метода.
• Вызов hashCode, equals, или toString методы, объявленные в java.lang.Object на прокси экземпляр будет закодирован и диспетчеризирован обработчику вызова invoke метод тем же самым способом как вызовы метода интерфейса кодируется и диспетчеризируется, как описано выше. Объявление class Method объект, к которому передают invoke будет java.lang.Object. Другие открытые методы экземпляра прокси, наследованного от java.lang.Object не переопределяются прокси class, таким образом, вызовы тех методов ведут себя как, они делают для экземпляров java.lang.Object.

Методы, Дублированные в Многократных Интерфейсах Прокси

Когда два или больше интерфейса прокси, class содержит метод с тем же самым именем и подписью параметра, порядком интерфейсов class прокси, становятся существенными. Когда такой двойной метод вызывается на экземпляр прокси, Method объект, который передают к обработчику вызова, не обязательно будет тем, объявление которого class присваиваемо от ссылочного типа интерфейса, что метод прокси был вызван через. Это ограничение существует, потому что соответствующая реализация метода в сгенерированном прокси, который не может определить class, какой интерфейс это было вызвано через. Поэтому, когда двойной метод вызывается на экземпляр прокси, Method объект для метода в передовом интерфейсе, который содержит метод (или непосредственно или наследованный через суперинтерфейс) в списке class прокси интерфейсов, передают к обработчику вызова invoke метод, независимо от ссылочного типа, через который произошел вызов метода.

Если интерфейс прокси содержит метод с тем же самым именем и подписью параметра как hashCode, equals, или toString методы java.lang.Object, когда такой метод вызывается на экземпляр прокси, Method объект, который передают к обработчику вызова, будет иметь java.lang.Object как его объявление class. Другими словами, общественность, незаключительные методы java.lang.Object логически предшествуйте всем интерфейсам прокси для определения который Method возразите, чтобы передать к обработчику вызова.

Отметьте также это, когда двойной метод диспетчеризируется обработчику вызова, invoke метод может только бросить проверенные типы исключения, которые присваиваемы одному из исключения, вводит throws пункт метода во всех интерфейсах прокси, что это может быть вызвано через. Если invoke метод выдает проверенное исключение, которое не присваиваемо любому из типов исключения, объявленных методом в одном из интерфейсов прокси, что это может быть вызвано через, затем непроверенное UndeclaredThrowableException будет брошен вызовом на экземпляре прокси. Это ограничение означает что не все типы исключения, возвращенные, вызывая getExceptionTypes на Method объект, который передают к invoke метод может обязательно быть брошен успешно invoke метод.

С тех пор:

1.3

См. Также:

InvocationHandler, Сериализированная Форма

Полевая Сводка

Поля

Модификатор и Тип	Поле и Описание
protected InvocationHandler	h обработчик вызова для этого экземпляра прокси.

Сводка конструктора

Конструкторы

Модификатор	Конструктор и Описание
protected	Proxy(InvocationHandler h) Создает новое Proxy экземпляр от подкласса (обычно, динамический прокси class) с указанным значением для его обработчика вызова.

Сводка метода

Модификатор и Тип	Метод и Описание
static InvocationHandler	getInvocationHandler(Object proxy) Возвращает обработчик вызова для указанного экземпляра прокси.
static Class<?>	getProxyClass(ClassLoader loader, Class<?>... interfaces) Возвраты java.lang.Class объект для прокси class, данный загрузчик class и массив интерфейсов.
static boolean	isProxyClass(Class<?> cl) Возвращает true, если и только если указанный class был динамически сгенерирован, чтобы быть прокси class, используя getProxyClass метод или newProxyInstance метод.
static Object	newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler h) Возвращает экземпляр прокси class для указанных интерфейсов, который диспетчеризирует вызовы метода указанному обработчику вызова.

Методы, наследованные от class java.lang. Объект

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

Полевая Деталь

h

protected InvocationHandler h

обработчик вызова для этого экземпляра прокси.

Деталь конструктора

Прокси

protected Proxy(InvocationHandler h)

Создает новое Proxy экземпляр от подкласса (обычно, динамический прокси class) с указанным значением для его обработчика вызова.

Параметры:

h - обработчик вызова для этого экземпляра прокси

Броски:

NullPointerException - если данный обработчик вызова, h, null.

Деталь метода

getProxyClass

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

Возвраты java.lang.Class объект для прокси class, данный загрузчик class и массив интерфейсов. Прокси class будет определен указанным загрузчиком class и реализует все предоставленные интерфейсы. Если какой-либо из данных интерфейсов будет непубличным, прокси, то class будет непубличным. Если прокси, class для той же самой перестановки интерфейсов был уже определен загрузчиком class, то существующий прокси class будет возвращен; иначе, прокси class для тех интерфейсов будет сгенерирован динамически и определен загрузчиком class.

Есть несколько ограничений на параметры, к которым можно передать Proxy.getProxyClass:

• Весь из Class объекты в interfaces массив должен представить интерфейсы, не классы или типы примитивов.
• Никакие два элемента в interfaces массив может обратиться к идентичному Class объекты.
• Все типы интерфейса должны быть видимыми по имени через указанный загрузчик class. Другими словами, для загрузчика class cl и каждый интерфейс i, следующее выражение должно быть истиной:

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

• Все непубличные интерфейсы должны быть в том же самом пакете; иначе, для прокси class не было бы возможно реализовать все интерфейсы, независимо от того, в каком пакете это определяется.
• Для любого набора задействованных методов указанных интерфейсов, у которых есть та же самая подпись:
  • Если тип возврата какого-либо из методов является типом примитива или пусто, то у всех методов должен быть тот же самый тип возврата.
  • Иначе, у одного из методов должен быть тип возврата, который присваиваем всем типам возврата остальной части методов.
• Получающийся прокси class не должен превысить пределы, наложенные на классы виртуальной машиной. Например, VM может ограничить число интерфейсов, которые class может реализовать к 65535; в этом случае, размер interfaces массив не должен превысить 65535.

Если какое-либо из этих ограничений нарушается, Proxy.getProxyClass бросит IllegalArgumentException. Если interfaces параметр массива или любой из его элементов null, a NullPointerException будет брошен.

Отметьте, что порядок указанных интерфейсов прокси является существенным: два запроса на прокси class с той же самой комбинацией интерфейсов, но в различном порядке приведут к двум отличным прокси-классам.

Параметры:

loader - загрузчик class, чтобы определить прокси class

interfaces - список интерфейсов для прокси class, чтобы реализовать

Возвраты:

прокси class, который определяется в указанном загрузчике class и это реализует указанные интерфейсы

Броски:

IllegalArgumentException - если любое из ограничений на параметры, к которым можно передать getProxyClass нарушаются

SecurityException - если менеджер безопасности, s, присутствует, и любое из следующих условий встречается:

• данный loader null и загрузчик class вызывающей стороны не null и вызов s.checkPermission с RuntimePermission("getClassLoader") разрешение лишает доступа.
• загрузчик class вызывающей стороны не является тем же самым как или предок загрузчика class для текущего class и вызова s.checkPackageAccess() лишает доступа к любому из данных интерфейсов прокси.

NullPointerException - если interfaces параметр массива или любой из его элементов null

newProxyInstance

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

Возвращает экземпляр прокси class для указанных интерфейсов, который диспетчеризирует вызовы метода указанному обработчику вызова.

Proxy.newProxyInstance броски IllegalArgumentException по тем же самым причинам это Proxy.getProxyClass делает.

Параметры:

loader - загрузчик class, чтобы определить прокси class

interfaces - список интерфейсов для прокси class, чтобы реализовать

h - обработчик вызова, чтобы диспетчеризировать вызовы метода

Возвраты:

экземпляр прокси с указанным обработчиком вызова прокси class, который определяется указанным загрузчиком class и это реализует указанные интерфейсы

Броски:

IllegalArgumentException - если любое из ограничений на параметры, к которым можно передать getProxyClass нарушаются

SecurityException - если менеджер безопасности, s, присутствует, и любое из следующих условий встречается:

• данный loader null и загрузчик class вызывающей стороны не null и вызов s.checkPermission с RuntimePermission("getClassLoader") разрешение лишает доступа;
• загрузчик class вызывающей стороны не является тем же самым как или предок загрузчика class для текущего class и вызова s.checkPackageAccess() лишает доступа к любому из данных интерфейсов прокси.
• любой из данных интерфейсов прокси является непубличным и вызывающая сторона, из которой class не находится в том же самом пакете времени выполнения как непубличный интерфейс и вызов s.checkPermission с ReflectPermission("newProxyInPackage.{package name}") разрешение лишает доступа.

NullPointerException - если interfaces параметр массива или любой из его элементов null, или если обработчик вызова, h, null

isProxyClass

public static boolean isProxyClass(Class<?> cl)

Возвращает true, если и только если указанный class был динамически сгенерирован, чтобы быть прокси class, используя getProxyClass метод или newProxyInstance метод.

Надежность этого метода важна для возможности использовать это, чтобы принять решения безопасности, таким образом, ее реализация не должна просто протестировать, если рассматриваемый class расширяется Proxy.

Параметры:

cl - class, чтобы протестировать

Возвраты:

true если class является прокси class и false иначе

Броски:

NullPointerException - если cl null

getInvocationHandler

public static InvocationHandler getInvocationHandler(Object proxy)
                                              throws IllegalArgumentException

Возвращает обработчик вызова для указанного экземпляра прокси.

Параметры:

proxy - экземпляр прокси, чтобы возвратить обработчик вызова для

Возвраты:

обработчик вызова для экземпляра прокси

Броски:

IllegalArgumentException - если параметром не является экземпляр прокси