1. Что такое CGLIB?

CGLIB — это мощный высокопроизводительный пакет генерации кода. Он предоставляет прокси для классов, не реализующих интерфейсы, и служит хорошим дополнением к динамическому прокси JDK. Обычно вы можете использовать динамический прокси Java для создания прокси, но когда проксируемый класс не реализует интерфейс или для лучшей производительности, CGLIB — хороший выбор.

Как проект с открытым исходным кодом, код CGLIB размещён на GitHub по адресу:https://github.com/cglib/cglib


2. Принцип CGLIB

Принцип CGLIB: динамически генерирует подкласс проксируемого класса, и этот подкласс переопределяет все не-final методы проксируемого класса. В подклассе используется технология перехвата методов для перехвата всех вызовов методов родительского класса, и соответственно вплетается сквозная логика. Он работает быстрее, чем динамический прокси JDK с использованием рефлексии Java.

Нижний уровень CGLIB: он использует фреймворк обработки байт-кода ASM для преобразования байт-кода и генерации новых классов. Прямое использование ASM не рекомендуется, поскольку требует от вас очень хорошего знания внутренней структуры JVM, включая формат файлов классов и набор инструкций.

Недостатки CGLIB: final-методы не могут быть проксированы.


3. Применение CGLIB

Он широко используется многими AOP-фреймворками, такими как Spring AOP и dynaop. Hibernate использует CGLIB для проксирования одиночных (many-to-one и one-to-one) ассоциаций.


4. Зачем использовать CGLIB?

Прокси CGLIB в основном работает с байт-кодом, чтобы ввести уровень косвенности для объектов и тем самым контролировать доступ к объектам. Мы знаем, что в Java есть динамический прокси, который тоже это делает; почему бы не использовать напрямую динамический прокси Java вместо CGLIB? Ответ: CGLIB мощнее динамического прокси JDK. Хотя динамический прокси JDK прост и удобен в использовании, у него есть фатальный недостаток: он может проксировать только интерфейсы. Если проксируемый класс — обычный класс без интерфейса, то динамический прокси Java использовать нельзя.


5. Структура композиции CGLIB

Нижний уровень CGLIB использует ASM (компактный и мощный фреймворк для манипулирования байт-кодом) для работы с байт-кодом и генерации новых классов. Помимо библиотеки CGLIB, скриптовые языки (такие как Groovy и BeanShell) также используют ASM для генерации байт-кода. ASM применяет SAX-подобный парсер для достижения высокой производительности. Мы не рекомендуем напрямую использовать ASM, поскольку для этого требуется достаточное понимание формата байт-кода Java.


6. API CGLIB

1. Jar-пакет:

  • cglib-nodep-2.2.jar: при использовании пакета nodep нет необходимости подключать jar-пакет ASM; jar-пакет содержит внутри классы ASM.
  • cglib-2.2.jar: при использовании этого jar-пакета необходимо подключить jar-пакет ASM; иначе возникнет ошибка времени выполнения.

2. Библиотека CGLIB:

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

В этой серии используется CGLIB версии 2.2.

  • net.sf.cglib.core: Низкоуровневые классы обработки байт-кода, большинство из которых связаны с ASM.
  • net.sf.cglib.transform: Преобразование классов и файлов классов во время компиляции или выполнения.
  • net.sf.cglib.proxy: Классы, реализующие создание прокси и перехватчики методов.
  • net.sf.cglib.reflect: Классы, реализующие быструю рефлексию и прокси в стиле C#.
  • net.sf.cglib.util: Вспомогательные классы, такие как сортировка коллекций.
  • net.sf.cglib.beans: Вспомогательные классы, связанные с JavaBean.

В этой статье рассказывается о реализации динамического прокси через MethodInterceptor и Enhancer.

1. Сначала поговорим о динамическом прокси в JDK:

Динамический прокси в JDK реализуется через класс отражения Proxy и интерфейс обратного вызова InvocationHandler. Однако класс, для которого в JDK динамически создаётся прокси, должен реализовывать интерфейс. То есть проксировать можно только методы, определённые в интерфейсе, реализуемом классом. Это накладывает определённые ограничения в реальном программировании, а эффективность использования рефлексии не очень высока.

2. Реализация с помощью CGLib:

Использование CGLib для реализации динамического прокси полностью избавляет от ограничения, согласно которому проксируемый класс должен реализовывать интерфейс. Кроме того, нижний уровень CGLib использует фреймворк генерации байт-кода ASM для создания прокси-классов с помощью технологии байт-кода, что эффективнее, чем использование Java-рефлексии. Единственное, что нужно учесть: CGLib не может проксировать методы, объявленные как final, потому что принцип CGLib — динамическая генерация подкласса проксируемого класса.

Ниже приведён пример реализации динамического прокси с использованием CGLib.

1. Проксируемый класс:

Сначала определим класс, который не реализует ни один интерфейс.

package com.zghw.cglib; /** * Целевой класс, который не реализует интерфейс и требует динамического прокси CGlib. * * @author zghw * */ public class TargetObject { public String method1(String paramName) { return paramName; } public int method2(int count) { return count; } public int method3(int count) { return count; } @Override public String toString() { return "TargetObject []"+ getClass(); } }

2. Перехватчик:

Определите перехватчик. Когда вызывается целевой метод, CGLib вызовет метод интерфейса MethodInterceptor для перехвата, чтобы реализовать вашу собственную логику прокси, аналогично интерфейсу InvocationHandler в JDK.

package com.zghw.cglib; import java.lang.reflect.Method; import net.sf.cglib.proxy.MethodInterceptor; import net.sf.cglib.proxy.MethodProxy; /** * Перехватчик целевого объекта, реализует MethodInterceptor * @author zghw * */ public class TargetInterceptor implements MethodInterceptor{ /** * RewriteMethods перехватывает и добавляет бизнес-транзакцию до и после методов * Object obj — целевой объект * Method method — целевой метод * Object[] params — параметры, * MethodProxy proxy — прокси-объект методов CGLib*/ @Override public Object intercept(Object obj, Method method, Object[] params, MethodProxy proxy) throws Throwable { System.out.println("Перед вызовом"); Object result = proxy.invokeSuper(obj, params); System.out.println("После вызова"+result); return result; } }

Параметры: Object — это экземпляр прокси-класса, динамически сгенерированный CGLib, Method — это ссылка на проксируемый метод, вызываемый вышеупомянутым классом сущности, Object[] — это список значений параметров, а MethodProxy — это прокси-ссылка на метод, сгенерированный прокси-классом.

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

Среди них,proxy.invokeSuper(obj,arg)Вызывает метод суперкласса проксируемого метода на экземпляре прокси-класса (т. е. соответствующий метод в классе сущности TargetObject).

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

3. Сгенерировать динамический прокси-класс:

package com.zghw.cglib; import net.sf.cglib.proxy.Callback; import net.sf.cglib.proxy.CallbackFilter; import net.sf.cglib.proxy.Enhancer; import net.sf.cglib.proxy.NoOp; public class TestCglib { public static void main(String args[]) { Enhancer enhancer =new Enhancer(); enhancer.setSuperclass(TargetObject.class); enhancer.setCallback(new TargetInterceptor()); TargetObject targetObject2=(TargetObject)enhancer.create(); System.out.println(targetObject2); System.out.println(targetObject2.method1("mmm1")); System.out.println(targetObject2.method2(100)); System.out.println(targetObject2.method3(200)); } }

Здесь класс Enhancer — это усилитель байт-кода в CGLib. Он позволяет удобно расширять класс, который вы хотите обработать, и мы будем часто встречать его в дальнейшем.

Сначала задайте проксируемый класс TargetObject в качестве родительского класса, затем задайте перехватчик TargetInterceptor и, наконец, выполните enhancer.create(), чтобы динамически сгенерировать прокси-класс, и приведите его от Object к родительскому типу TargetObject.

Наконец, вызовите метод на прокси-классе.

4. Фильтр обратных вызовов CallbackFilter

1. Функция:

Когда CGLib выполняет обратные вызовы, можно задавать разную логику обратных вызовов для разных методов или даже вообще не выполнять обратные вызовы.

В динамическом прокси JDK нет аналогичной возможности; вызов метода интерфейса InvocationHandler действует для всех методов прокси-класса.

Определите класс, реализующий интерфейс CallbackFilter:

package com.zghw.cglib; import java.lang.reflect.Method; import net.sf.cglib.proxy.CallbackFilter; /** * Фильтрация методов обратного вызова * @author zghw * */ public class TargetMethodCallbackFilter implements CallbackFilter { /** * Методы фильтрации * Возвращаемое значение — число; индекс позиции уже сгенерированного Callback в массиве, который нужно использовать*/ @Override public int accept(Method method) { if(method.getName().equals("method1")){ System.out.println("filter method1 ==0"); return 0; } if(method.getName().equals("method2")){ System.out.println("filter method2 ==1"); return 1; } if(method.getName().equals("method3")){ System.out.println("filter method3 ==2"); return 2; } return 0; } }

Возвращаемое значение — это индекс позиции каждого метода проксируемого класса в массиве обратных вызовов Callback[] (см. ниже).

package com.zghw.cglib; import net.sf.cglib.proxy.Callback; import net.sf.cglib.proxy.CallbackFilter; import net.sf.cglib.proxy.Enhancer; import net.sf.cglib.proxy.NoOp; public class TestCglib { public static void main(String args[]) { Enhancer enhancer =new Enhancer(); enhancer.setSuperclass(TargetObject.class); CallbackFilter callbackFilter = new TargetMethodCallbackFilter(); /** * (1)callback1: Methods перехватывает device (2)NoOp.INSTANCE: этот NoOp означает отсутствие операции, т.е. какая бы операция ни была, ничего не делает; прокси-класс напрямую вызывает метод проксируемого класса, не входя в перехват. (3)FixedValue: представляет фиксированное возвращаемое значение метода; независимо от того, какое значение возвращает метод проксируемого класса, все callback Methods возвращают Fixed value.*/ Callback noopCb=NoOp.INSTANCE; Callback callback1=new TargetInterceptor(); Callback fixedValue=new TargetResultFixed(); Callback[] cbarray=new Callback[]{callback1,noopCb,fixedValue}; //enhancer.setCallback(new TargetInterceptor()); enhancer.setCallbacks(cbarray); enhancer.setCallbackFilter(callbackFilter); TargetObject targetObject2=(TargetObject)enhancer.create(); System.out.println(targetObject2); System.out.println(targetObject2.method1("mmm1")); System.out.println(targetObject2.method2(100)); System.out.println(targetObject2.method3(100)); System.out.println(targetObject2.method3(200)); } }
package com.zghw.cglib; import net.sf.cglib.proxy.FixedValue; /** Указывает на фиксацию возвращаемого значения метода: независимо от того, что возвращает метод проксируемого класса, метод обратного вызова всегда возвращает фиксированное значение. * @author zghw * */ public class TargetResultFixed implements FixedValue{ /** * Этот класс реализует интерфейс FixedValue, при этом LockDecideCallbackValue равно 999 * (integer, CallbackFilter определяет использование FixedValue типа callback-метода getConcreteMethodFixedValue, этот метод возвращает значение типа integer)。*/ @Override public Object loadObject() throws Exception { System.out.println("Заблокированный результат"); Объект obj = 999; return obj; } }

5. Ленивая загрузка объектов

1. Функция:

Говоря о ленивой загрузке, вы, вероятно, часто с ней сталкиваетесь, особенно при использовании Hibernate. В этой статье реализация ленивой загрузки будет разобрана на примере. Интерфейс LazyLoader наследует Callback, поэтому он также является разновидностью Callback в CGLib.

Другой интерфейс ленивой загрузки — Dispatcher.

Интерфейс Dispatcher также наследуется от Callback и тоже является разновидностью обратного вызова.

Но разница между Dispatcher и LazyLoader заключается в том, что LazyLoader вызывает метод обратного вызова прокси-класса только при первом обращении к лениво загружаемому свойству, тогда как Dispatcher вызывает метод обратного вызова прокси-класса при каждом обращении к лениво загружаемому свойству.

II. Пример:

Сначала определим класс сущности LoaderBean. У этого Bean есть свойство PropertyBean, требующее ленивой загрузки.

package com.zghw.cglib; import net.sf.cglib.proxy.Enhancer; public class LazyBean { private String name; private int age; private PropertyBean propertyBean; private PropertyBean propertyBeanDispatcher; public LazyBean(String name, int age) { System.out.println("ленивая инициализация бина"); this.name = name; this.age = age; this.propertyBean = createPropertyBean(); this.propertyBeanDispatcher = createPropertyBeanDispatcher(); } /** * Ленивая загрузка только при первом обращении * @return */ private PropertyBean createPropertyBean() { /** * Используйте cglib для ленивой загрузки. Добавьте прокси к объекту, которому нужна ленивая загрузка. При получении свойств объекта сначала инициализируйте объект через callback-метод прокси-класса. * Когда объект не нужно загружать, пока не осуществляется доступ к свойствам внутри объекта, объект не будет инициализирован (в реализации CGLib, как только происходит обращение к getter-методам свойств объекта, * callback прокси-класса будет вызван автоматически).*/ Enhancer enhancer = new Enhancer(); enhancer.setSuperclass(PropertyBean.class); PropertyBean pb = (PropertyBean) enhancer.create(PropertyBean.class, new ConcreteClassLazyLoader()); return pb; } /** * Ленивая загрузка каждый раз * @return */ private PropertyBean createPropertyBeanDispatcher() { Enhancer enhancer = new Enhancer(); enhancer.setSuperclass(PropertyBean.class); PropertyBean pb = (PropertyBean) enhancer.create(PropertyBean.class, new ConcreteClassDispatcher()); return pb; } public String getName() { return name; } public void setName(String name) { this.name = name; } public int getAge() { return age; } public void setAge(int age) { this.age = age; } public PropertyBean getPropertyBean() { return propertyBean; } public void setPropertyBean(PropertyBean propertyBean) { this.propertyBean = propertyBean; } public PropertyBean getPropertyBeanDispatcher() { return propertyBeanDispatcher; } public void setPropertyBeanDispatcher(PropertyBean propertyBeanDispatcher) { this.propertyBeanDispatcher = propertyBeanDispatcher; } @Override public String toString() { return "LazyBean [name=" + name + ", age=" + age + ", propertyBean=" + propertyBean + "]"; } }
package com.zghw.cglib; public class PropertyBean { private String key; private Object value; public String getKey() { return key; } public void setKey(String key) { this.key = key; } public Object getValue() { return value; } public void setValue(Object value) { this.value = value; } @Override public String toString() { return "PropertyBean [key=" + key + ", value=" + value + "]" +getClass(); } }
package com.zghw.cglib; import net.sf.cglib.proxy.LazyLoader; public class ConcreteClassLazyLoader implements LazyLoader { /** * Добавьте прокси к объекту, для которого требуется ленивая загрузка. При получении свойств объекта сначала инициализируйте объект через callback-метод прокси-класса. * Когда объект не нужно загружать, пока не осуществляется доступ к свойствам внутри объекта, объект не будет инициализирован (в реализации CGLib, как только происходит доступ к getter-методам свойств объекта, * callback прокси-класса будет вызван автоматически).*/ @Override public Object loadObject() throws Exception { System.out.println("до lazyLoader..."); PropertyBean propertyBean = new PropertyBean(); propertyBean.setKey("zghw"); propertyBean.setValue(new TargetObject()); System.out.println("после lazyLoader..."); return propertyBean; } }
package com.zghw.cglib; import net.sf.cglib.proxy.Dispatcher; public class ConcreteClassDispatcher implements Dispatcher{ @Override public Object loadObject() throws Exception { System.out.println("перед Dispatcher..."); PropertyBean propertyBean = new PropertyBean(); propertyBean.setKey("xxx"); propertyBean.setValue(new TargetObject()); System.out.println("после Dispatcher..."); return propertyBean; } }

6. InterfaceMaker - Генератор интерфейса

I. Функция:

InterfaceMaker динамически генерирует интерфейс, который содержит все методы, определённые указанным классом.

II. Пример:

package com.zghw.cglib; import java.lang.reflect.InvocationTargetException; import java.lang.reflect.Method; import net.sf.cglib.proxy.Enhancer; import net.sf.cglib.proxy.InterfaceMaker; import net.sf.cglib.proxy.MethodInterceptor; import net.sf.cglib.proxy.MethodProxy; public class TestInterfaceMaker { public static void main(String[] args) throws NoSuchMethodException, SecurityException, IllegalAccessException, IllegalArgumentException, InvocationTargetException { InterfaceMaker interfaceMaker =new InterfaceMaker(); //Извлечь методы класса для генерации методов интерфейса. interfaceMaker.add(TargetObject.class); Class<?> targetInterface=interfaceMaker.create(); for(Method method : targetInterface.getMethods()){ System.out.println(method.getName()); } //Прокси интерфейса и настройка перехвата методов интерфейса прокси. Object object = Enhancer.create(Object.class, new Class[]{targetInterface}, new MethodInterceptor(){ @Override public Object intercept(Object obj, Method method, Object[] args, MethodProxy methodProxy) throws Throwable { if(method.getName().equals("method1")){ System.out.println("фильтр method1 "); return "mmmmmmmmm"; } if(method.getName().equals("method2")){ System.out.println("фильтр method2 "); return 1111111; } if(method.getName().equals("method3")){ System.out.println("фильтр method3 "); return 3333; } return "default"; }}); Method targetMethod1=object.getClass().getMethod("method3",new Class[]{int.class}); int i=(int)targetMethod1.invoke(object, new Object[]{33}); Method targetMethod=object.getClass().getMethod("method1",new Class[]{String.class}); System.out.println(targetMethod.invoke(object, new Object[]{"sdfs"})); } }

Исходный адрес:

https://blog.csdn.net/zghwaicsdn/article/details/50957474

https://blog.csdn.net/danchu/article/details/70238002