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(), new Class[] { Foo.class });
     Foo f = (Foo) proxyClass.
         getConstructor(new Class[] { InvocationHandler.class }).
         newInstance(new Object[] { handler });
 

или более просто:

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

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

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

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

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

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

       proxy instanceof Foo
   

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

       (Foo) proxy
   

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

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

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

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

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

С тех пор:

1.3

См. Также:

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

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

Поля

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

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

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

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

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

Методы

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

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

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

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

h

protected InvocationHandler h

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

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

Прокси

protected Proxy(InvocationHandler h)

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

Параметры:

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

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

getProxyClass

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

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

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

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

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

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

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

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

Параметры:

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

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

Возвраты:

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

Броски:

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

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

newProxyInstance

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

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

     Proxy.getProxyClass(loader, interfaces).
         getConstructor(new Class[] { InvocationHandler.class }).
         newInstance(new Object[] { handler });
 

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

Параметры:

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

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

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

Возвраты:

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

Броски:

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

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

isProxyClass

public static boolean isProxyClass(Class<?> cl)

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

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

Параметры:

cl - класс теста

Возвраты:

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

Броски:

NullPointerException - если cl null

getInvocationHandler

public static InvocationHandler getInvocationHandler(Object proxy)
                                              throws IllegalArgumentException

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

Параметры:

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

Возвраты:

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

Броски:

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