1. Qu'est-ce que CGLIB ?

CGLIB est un puissant package de génération de code hautes performances. Il fournit des proxys pour les classes qui n'implémentent pas d'interfaces et constitue un bon complément au proxy dynamique du JDK. Habituellement, vous pouvez utiliser le proxy dynamique de Java pour créer des proxys, mais lorsque la classe à proxifier n'implémente pas d'interface ou pour de meilleures performances, CGLIB est un bon choix.

En tant que projet open source, le code de CGLIB est hébergé sur GitHub à l'adresse :https://github.com/cglib/cglib


2. Principe de CGLIB

Principe de CGLIB: génère dynamiquement une sous-classe de la classe à proxifier, et la sous-classe redéfinit toutes les méthodes non finales de la classe à proxifier. Dans la sous-classe, une technologie d'interception de méthodes est utilisée pour intercepter tous les appels aux méthodes de la classe parente, et la logique transversale y est tissée en conséquence. Il est plus rapide que le proxy dynamique du JDK utilisant la réflexion Java.

Couche sous-jacente de CGLIB: il utilise le framework de traitement de bytecode ASM pour transformer le bytecode et générer de nouvelles classes. L'utilisation directe d'ASM est déconseillée, car elle exige que vous connaissiez très bien la structure interne de la JVM, y compris le format des fichiers de classe et le jeu d'instructions.

Inconvénients de CGLIB: Les méthodes finales ne peuvent pas être proxifiées.


3. Applications de CGLIB

Il est largement utilisé par de nombreux frameworks AOP, tels que Spring AOP et dynaop. Hibernate utilise CGLIB pour proxyfier les associations à extrémité unique (plusieurs-à-un et un-à-un).


4. Pourquoi utiliser CGLIB ?

Le proxy CGLIB opère principalement sur le bytecode pour introduire un niveau d'indirection pour les objets, afin de contrôler l'accès aux objets. Nous savons que Java dispose d'un proxy dynamique qui fait également cela, alors pourquoi ne pas utiliser directement le proxy dynamique Java et utiliser plutôt CGLIB ? La réponse est que CGLIB est plus puissant que le proxy dynamique JDK. Bien que le proxy dynamique JDK soit simple et facile à utiliser, il présente un défaut fatal : il ne peut proxyfier que des interfaces. Si la classe à proxyfier est une classe ordinaire sans interface, alors le proxy dynamique Java ne peut pas être utilisé.


5. Structure de composition de CGLIB

La couche sous-jacente de CGLIB utilise ASM (un framework compact et puissant de manipulation de bytecode) pour opérer sur le bytecode et générer de nouvelles classes. En plus de la bibliothèque CGLIB, des langages de script (tels que Groovy et BeanShell) utilisent également ASM pour générer du bytecode. ASM utilise un analyseur de type SAX pour atteindre des performances élevées. Nous n'encourageons pas l'utilisation directe d'ASM car elle nécessite une compréhension suffisante du format du bytecode Java.


6. API CGLIB

1. Paquet Jar :

  • cglib-nodep-2.2.jar: Lors de l'utilisation du paquet nodep, il n'est pas nécessaire d'associer le paquet Jar ASM ; le paquet Jar contient en interne les classes ASM.
  • cglib-2.2.jar: Lors de l'utilisation de ce paquet Jar, vous devez associer le paquet Jar ASM ; sinon, une erreur d'exécution se produira.

2. Bibliothèque CGLIB :

Étant donné que le code sous-jacent est minimal, il est quelque peu difficile à apprendre, principalement en raison du manque de documentation et d'exemples, ce qui est également une lacune de CGLIB.

La version de CGLIB utilisée dans cette série est 2.2.

  • net.sf.cglib.core: classes de traitement de bytecode de bas niveau, dont la plupart sont liées à ASM.
  • net.sf.cglib.transform: transformation de classes et de fichiers de classes au moment de la compilation ou à l’exécution
  • net.sf.cglib.proxy: classes qui implémentent la création de proxys et les intercepteurs de méthodes
  • net.sf.cglib.reflect: classes qui implémentent la réflexion rapide et les proxys de style C#
  • net.sf.cglib.util: classes utilitaires telles que le tri de collections
  • net.sf.cglib.beans: classes utilitaires liées à JavaBean

Cet article présente la mise en œuvre d’un proxy dynamique via MethodInterceptor et Enhancer.

1. Tout d’abord, parlons du proxy dynamique dans JDK :

Le proxy dynamique dans JDK est implémenté au moyen de la classe de réflexion Proxy et de l’interface de rappel InvocationHandler. Cependant, la classe à proxifier dynamiquement dans JDK doit implémenter une interface. Autrement dit, seules les méthodes définies dans l’interface implémentée par la classe peuvent être proxifiées. Cela présente certaines limites en programmation réelle, et l’efficacité de l’utilisation de la réflexion n’est pas très élevée.

2. Implémentation avec CGLib :

L’utilisation de CGLib pour implémenter un proxy dynamique s’affranchit complètement de la restriction selon laquelle la classe proxy doit implémenter une interface. De plus, la couche sous-jacente de CGLib utilise le framework de génération de bytecode ASM pour générer des classes proxy à l’aide de la technologie de bytecode, ce qui est plus efficace que l’utilisation de la réflexion Java. La seule chose à noter est que CGLib ne peut pas proxifier les méthodes déclarées comme final, car le principe de CGLib est de générer dynamiquement une sous-classe de la classe proxifiée.

Ci-dessous, un exemple est utilisé pour présenter l'implémentation d'un proxy dynamique à l'aide de CGLib.

1. Classe proxifiée :

Tout d'abord, définissez une classe qui n'implémente aucune interface.

package com.zghw.cglib; /** * Une classe cible qui n'implémente aucune interface et nécessite un proxy dynamique 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. Intercepteur :

Définissez un intercepteur. Lorsque la méthode cible est appelée, CGLib rappellera la méthode de l'interface MethodInterceptor pour l'interception afin d'implémenter votre propre logique de proxy, similaire à l'interface InvocationHandler dans JDK.

package com.zghw.cglib; import java.lang.reflect.Method; import net.sf.cglib.proxy.MethodInterceptor; import net.sf.cglib.proxy.MethodProxy; /** * Intercepteur d'objet cible, implémente MethodInterceptor * @author zghw * */ public class TargetInterceptor implements MethodInterceptor{ /** * RewriteMethods intercepte avant et après les méthodes pour ajouter une logique métier * Object obj est l'objet cible * Method method est la méthode cible * Object[] params sont les paramètres, * MethodProxy proxy est un substitut d'objet pour les méthodes CGlib*/ @Override public Object intercept(Object obj, Method method, Object[] params, MethodProxy proxy) throws Throwable { System.out.println("Avant l'appel"); Object result = proxy.invokeSuper(obj, params); System.out.println("Après l'appel"+result); return result; } }

Paramètres : Object est l'instance de classe proxy générée dynamiquement par CGLib, Method est la référence à la méthode proxifiée appelée par la classe d'entité ci-dessus, Object[] est la liste des valeurs des paramètres, et MethodProxy est la référence proxy à la méthode générée par la classe proxy.

Retour : La valeur renvoyée par l'appel de méthode sur l'instance proxy.

Parmi eux,proxy.invokeSuper(obj,arg)Invoque la méthode de la superclasse de la méthode proxy sur l'instance de la classe proxy (c'est-à-dire la méthode correspondante dans la classe d'entité TargetObject).

Dans cet exemple, une seule phrase est imprimée avant et après l'appel de la méthode de la classe proxifiée. Bien sûr, dans la programmation réelle, il peut s'agir d'une autre logique complexe.

3. Générer la classe proxy dynamique :

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

Ici, la classe Enhancer est un enhanceur de bytecode dans CGLib. Elle peut étendre facilement la classe que vous souhaitez traiter, et nous la verrons souvent plus tard.

Définissez d'abord la classe proxifiée TargetObject comme classe parente, puis définissez l'intercepteur TargetInterceptor, et enfin exécutez enhancer.create() pour générer dynamiquement une classe proxy, et castez-la de Object vers le type parent TargetObject.

Enfin, appelez la méthode sur la classe proxy.

4. Filtre de rappel CallbackFilter

1. Fonction :

Lorsque CGLib effectue des rappels, vous pouvez définir une logique de rappel différente pour différentes méthodes, ou même ne pas effectuer de rappel du tout.

Il n'existe pas de fonctionnalité similaire dans le proxy dynamique JDK ; l'appel à la méthode de l'interface InvocationHandler s'applique à toutes les méthodes de la classe proxy.

Définissez une classe qui implémente l'interface CallbackFilter :

package com.zghw.cglib; import java.lang.reflect.Method; import net.sf.cglib.proxy.CallbackFilter; /** * Filtrage des méthodes de rappel * @author zghw * */ public class TargetMethodCallbackFilter implements CallbackFilter { /** * Méthodes de filtrage * La valeur de retour est un nombre, représentant l'index de position dans le tableau du rappel à utiliser.*/ @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; } }

La valeur de retour est l'indice de position de chaque méthode de la classe proxifiée dans le tableau de rappels Callback[] (voir ci-dessous).

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 intercepte device (2)NoOp.INSTANCE:Ce NoOp ne représente aucune opération, c'est-à-dire qu'aucune opération n'est effectuée, la classe proxy appelle directement la méthode proxy sans passer par l'interception. (3)FixedValue:Représente une méthode à valeur de retour fixe ; quelle que soit la valeur renvoyée par la méthode de la classe proxy, les méthodes de rappel renvoient toutes une valeur fixe.*/ 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; /** Indique le verrouillage de la valeur de retour de la méthode : quelle que soit la valeur retournée par la méthode de la classe proxifiée, la méthode de callback retourne toujours une valeur fixe. * @author zghw * */ public class TargetResultFixed implements FixedValue{ /** * cette classe implémente l'interface FixedValue,en même temps Lock décide que la valeur de callback est 999 * (entier,la méthode de callback de type FixedValue définie dans CallbackFilter est getConcreteMethodFixedValue, cette méthode retourne une valeur entière)。*/ @Override public Object loadObject() throws Exception { System.out.println("Résultat verrouillé"); Object obj = 999; return obj; } }

5. Chargement différé des objets

1. Fonction :

En parlant de chargement différé, vous devriez souvent le rencontrer, surtout lorsque vous utilisez Hibernate. Cet article analysera l'implémentation du chargement différé à travers un exemple. L'interface LazyLoader hérite de Callback, c'est donc aussi un type de Callback dans CGLib.

Une autre interface de chargement différé est Dispatcher.

L'interface Dispatcher hérite également de Callback et est aussi un type de callback.

Mais la différence entre Dispatcher et LazyLoader est la suivante : LazyLoader ne déclenche la méthode de callback de la classe proxy que lorsque la propriété à chargement différé est accédée pour la première fois, tandis que Dispatcher déclenche la méthode de callback de la classe proxy chaque fois que la propriété à chargement différé est accédée.

II. Exemple :

Tout d'abord, définissez une classe d'entité LoaderBean. Ce Bean possède une propriété PropertyBean qui nécessite un chargement différé.

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("initialisation différée du bean"); this.name = name; this.age = age; this.propertyBean = createPropertyBean(); this.propertyBeanDispatcher = createPropertyBeanDispatcher(); } /** * Chargement différé uniquement la première fois * @return */ private PropertyBean createPropertyBean() { /** * Utilisez cglib pour le chargement différé. Ajoutez un proxy à l'objet qui nécessite un chargement différé. Lors de l'obtention des propriétés de l'objet, initialisez d'abord l'objet via la méthode de rappel de la classe proxy. * Lorsque l'objet n'a pas besoin d'être chargé, tant que les propriétés à l'intérieur de l'objet ne sont pas accédées, l'objet ne sera pas initialisé (dans l'implémentation de CGLib, tant que les méthodes getter des propriétés de l'objet sont accédées, * le rappel de la classe proxy sera déclenché automatiquement).*/ Enhancer enhancer = new Enhancer(); enhancer.setSuperclass(PropertyBean.class); PropertyBean pb = (PropertyBean) enhancer.create(PropertyBean.class, new ConcreteClassLazyLoader()); return pb; } /** * Chargement différé à chaque fois * @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() { return name; } public⟧void⟧setName⟧String⟧name 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 { /** * Ajouter un proxy à l'objet qui nécessite un chargement différé. Lors de l'obtention des propriétés de l'objet, initialiser d'abord l'objet via la méthode de rappel de la classe proxy. * Lorsque l'objet n'a pas besoin d'être chargé, tant que les propriétés à l'intérieur de l'objet ne sont pas accédées, l'objet ne sera pas initialisé (dans l'implémentation de CGLib, tant que les méthodes getter des propriétés de l'objet sont accédées, * le rappel de la classe proxy sera déclenché automatiquement).*/ @Override public Object loadObject() throws Exception { System.out.println("avant lazyLoader..."); PropertyBean propertyBean = new PropertyBean(); propertyBean.setKey("zghw"); propertyBean.setValue(new TargetObject()); System.out.println("après 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("avant Dispatcher..."); PropertyBean propertyBean = new PropertyBean(); propertyBean.setKey("xxx"); propertyBean.setValue(new TargetObject()); System.out.println("après Dispatcher..."); return propertyBean; } }

6. InterfaceMaker - Générateur d'interface

I. Fonction :

InterfaceMaker génère dynamiquement une interface qui contient toutes les méthodes définies par la classe spécifiée.

II. Exemple :

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(); //Extraire les méthodes d'une classe pour générer des méthodes d'interface. interfaceMaker.add(TargetObject.class); Class<?> targetInterface=interfaceMaker.create(); for(Method method : targetInterface.getMethods()){ System.out.println(method.getName()); } //Proxy d'interface et définir l'interception des méthodes de l'interface proxy. 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("filter method1 "); return "mmmmmmmmm"; } if(method.getName().equals("method2")){ System.out.println("filter method2 "); return 1111111; } if(method.getName().equals("method3")){ System.out.println("filter 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"})); } }

Adresse d'origine :

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

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