cglib学习笔记

cglib简介

cglib：Code Generation Library
主页：https://github.com/cglib/cglib/
教程：https://github.com/cglib/cglib/wiki/Tutorial

cglib是java字节码生成和转换类库。它用于AOP，测试，数据访问框架，生成动态代理对象和拦截字段访问。
cglib基于ASM，通过ASM生成新的字节码。

cglib网络图片

cglib学习

Enhancer

字节码增强功能，主要用于生成新的class，spring的aop就会使用cglib生成代理类。

通过设置Enhancer属性，然后通过Enhancer#create生成新的增强类。

通过设置cglib.debugLocation可以指定生成class dump存放路径，通过查看生成的class更方便学习。

System.setProperty("cglib.debugLocation", "/Users/qiyan/cglib/classes");

首先来一个简单的POJO做为例子：

public class SampleClass {
  public String test(String input) {
    return "Hello world!";
  }
}

Enhancer使用说明：

Enhancer enhancer = new Enhancer();
//设置Enhancer属性
enhancer.create();//创建增强类

Enhancer属性说明：

//增强类集成的接口列表
Class[] interfaces;

//父类
Class superclass;

//Callback选择器 返回值为callbacks的下标
CallbackFilter filter;

//回调处理器MethodInterceptor|NoOp|LazyLoader|Dispatcher|InvocationHandler|FixedValue的实现类
Callback[] callbacks;

//回调处理器类型MethodInterceptor|NoOp|LazyLoader|Dispatcher|InvocationHandler|FixedValue的Class
Type[] callbackTypes;

//是否使用工厂类
boolean useFactory = true;

//是否允许调用代理类构造器
boolean interceptDuringConstruction = true;

//是否校验回调类型
boolean validateCallbackTypes;

//是否仅创建代理类
boolean classOnly;

//是否仅创建工厂类
boolean factoryOnly;

//参数类型
Class[] argumentTypes;

//参数
Object[] arguments;

FixedValue

使用Enhancer生成代理类，callback设置为FixedValue。
使用FixedValue以后，所有接口都会返回固定值，test,toString,hashCode都会返回固定值，但是hashCode会因为数据转换抛出异常。

public static void testFixedValue() throws Exception {
    Enhancer enhancer = new Enhancer();
    enhancer.setSuperclass(SampleClass.class);
    enhancer.setCallback(new FixedValue() {
        @Override
        public Object loadObject() throws Exception {
            return "Hello cglib!";
        }
    });
    SampleClass proxy = (SampleClass) enhancer.create();
    System.out.println(proxy.test("1"));//输出结果Hello cglib!
    System.out.println(proxy.toString());//输出结果Hello cglib!
    System.out.println(proxy.hashCode());//异常（类型转换异常）
}

cglib会生成两个class，一个工厂类，一个代理类：

import net.sf.cglib.proxy.Callback;
import net.sf.cglib.proxy.Factory;
import net.sf.cglib.proxy.FixedValue;

public class SampleClass$$EnhancerByCGLIB$$9bebc1cf
  implements Factory
{
  private boolean CGLIB$BOUND;
  public static Object CGLIB$FACTORY_DATA;
  private static final ThreadLocal CGLIB$THREAD_CALLBACKS;
  private static final Callback[] CGLIB$STATIC_CALLBACKS;
  private FixedValue CGLIB$CALLBACK_0;
  
  public static void CGLIB$SET_THREAD_CALLBACKS(Callback[] paramArrayOfCallback)
  {
    CGLIB$THREAD_CALLBACKS.set(paramArrayOfCallback);
  }
  
  public static void CGLIB$SET_STATIC_CALLBACKS(Callback[] paramArrayOfCallback)
  {
    CGLIB$STATIC_CALLBACKS = paramArrayOfCallback;
  }
  
  private static final void CGLIB$BIND_CALLBACKS(Object paramObject)
  {
    9bebc1cf local9bebc1cf = (9bebc1cf)paramObject;
    if (!local9bebc1cf.CGLIB$BOUND)
    {
      local9bebc1cf.CGLIB$BOUND = true;
      Object tmp23_20 = CGLIB$THREAD_CALLBACKS.get();
      if (tmp23_20 == null)
      {
        tmp23_20;
        CGLIB$STATIC_CALLBACKS;
      }
      local9bebc1cf.CGLIB$CALLBACK_0 = (tmp31_28 == null ? tmp31_28 : (FixedValue)((Callback[])tmp23_20)[0]);
    }
  }
  
  public Object newInstance(Callback[] paramArrayOfCallback)
  {
    SampleClass..EnhancerByCGLIB..354348a.CGLIB$SET_THREAD_CALLBACKS(paramArrayOfCallback);
    SampleClass..EnhancerByCGLIB..354348a.CGLIB$SET_THREAD_CALLBACKS(null);
    return new SampleClass..EnhancerByCGLIB..354348a();
  }
  
  public Object newInstance(Callback paramCallback)
  {
    SampleClass..EnhancerByCGLIB..354348a.CGLIB$SET_THREAD_CALLBACKS(new Callback[] { paramCallback });
    SampleClass..EnhancerByCGLIB..354348a.CGLIB$SET_THREAD_CALLBACKS(null);
    return new SampleClass..EnhancerByCGLIB..354348a();
  }
  
  /* Error */
  public Object newInstance(Class[] arg1, Object[] arg2, Callback[] arg3)
  {
    // Byte code:
    //   0: aload_3
    //   1: invokestatic 52 cglib/SampleClass$$EnhancerByCGLIB$$354348a:CGLIB$SET_THREAD_CALLBACKS  ([Lnet/sf/cglib/proxy/Callback;)V
    //   4: new 50  cglib/SampleClass$$EnhancerByCGLIB$$354348a
    //   7: dup
    //   8: aload_1
    //   9: dup
    //   10: arraylength
    //   11: tableswitch    default:+24->35, 0:+17->28
    //   28: pop
    //   29: invokespecial 53   cglib/SampleClass$$EnhancerByCGLIB$$354348a:<init>  ()V
    //   32: goto +17 -> 49
    //   35: goto +3 -> 38
    //   38: pop
    //   39: new 59 java/lang/IllegalArgumentException
    //   42: dup
    //   43: ldc 61
    //   45: invokespecial 64   java/lang/IllegalArgumentException:<init>   (Ljava/lang/String;)V
    //   48: athrow
    //   49: aconst_null
    //   50: invokestatic 52    cglib/SampleClass$$EnhancerByCGLIB$$354348a:CGLIB$SET_THREAD_CALLBACKS  ([Lnet/sf/cglib/proxy/Callback;)V
    //   53: areturn
  }
  
  public Callback getCallback(int paramInt)
  {
    CGLIB$BIND_CALLBACKS(this);
    switch (paramInt)
    {
    case 0: 
      break;
    }
    return null;
  }
  
  public void setCallback(int paramInt, Callback paramCallback)
  {
    switch (paramInt)
    {
    case 0: 
      this.CGLIB$CALLBACK_0 = ((FixedValue)paramCallback);
      break;
    }
  }
  
  public Callback[] getCallbacks()
  {
    CGLIB$BIND_CALLBACKS(this);
    return new Callback[] { this.CGLIB$CALLBACK_0 };
  }
  
  public void setCallbacks(Callback[] paramArrayOfCallback)
  {
    this.CGLIB$CALLBACK_0 = ((FixedValue)paramArrayOfCallback[0]);
  }
}

cglib生成的代理类：

import net.sf.cglib.proxy.Callback;
import net.sf.cglib.proxy.Factory;
import net.sf.cglib.proxy.FixedValue;

public class SampleClass$$EnhancerByCGLIB$$354348a
  extends SampleClass
  implements Factory
{
  private boolean CGLIB$BOUND;
  public static Object CGLIB$FACTORY_DATA;
  private static final ThreadLocal CGLIB$THREAD_CALLBACKS;
  private static final Callback[] CGLIB$STATIC_CALLBACKS;
  private FixedValue CGLIB$CALLBACK_0;
  
  /* Error */
  static void CGLIB$STATICHOOK1()
  {
    // Byte code:
    //   0: new 21  java/lang/ThreadLocal
    //   3: dup
    //   4: invokespecial 24    java/lang/ThreadLocal:<init>    ()V
    //   7: putstatic 26    cglib/SampleClass$$EnhancerByCGLIB$$354348a:CGLIB$THREAD_CALLBACKS  Ljava/lang/ThreadLocal;
    //   10: return
    //   11: athrow
  }
  
  public final String test(String paramString)
  {
    FixedValue tmp4_1 = this.CGLIB$CALLBACK_0;
    if (tmp4_1 == null)
    {
      tmp4_1;
      CGLIB$BIND_CALLBACKS(this);
    }
    return (String)this.CGLIB$CALLBACK_0.loadObject();
  }
  
  public final boolean equals(Object paramObject)
  {
    FixedValue tmp4_1 = this.CGLIB$CALLBACK_0;
    if (tmp4_1 == null)
    {
      tmp4_1;
      CGLIB$BIND_CALLBACKS(this);
    }
    Object tmp22_17 = this.CGLIB$CALLBACK_0.loadObject();
    tmp22_17;
    return tmp22_17 == null ? false : ((Boolean)tmp22_17).booleanValue();
  }
  
  public final String toString()
  {
    FixedValue tmp4_1 = this.CGLIB$CALLBACK_0;
    if (tmp4_1 == null)
    {
      tmp4_1;
      CGLIB$BIND_CALLBACKS(this);
    }
    return (String)this.CGLIB$CALLBACK_0.loadObject();
  }
  
  public final int hashCode()
  {
    FixedValue tmp4_1 = this.CGLIB$CALLBACK_0;
    if (tmp4_1 == null)
    {
      tmp4_1;
      CGLIB$BIND_CALLBACKS(this);
    }
    Object tmp22_17 = this.CGLIB$CALLBACK_0.loadObject();
    tmp22_17;
    return tmp22_17 == null ? 0 : ((Number)tmp22_17).intValue();
  }
  
  protected final Object clone()
    throws CloneNotSupportedException
  {
    FixedValue tmp4_1 = this.CGLIB$CALLBACK_0;
    if (tmp4_1 == null)
    {
      tmp4_1;
      CGLIB$BIND_CALLBACKS(this);
    }
    return this.CGLIB$CALLBACK_0.loadObject();
  }
  
  public SampleClass$$EnhancerByCGLIB$$354348a()
  {
    CGLIB$BIND_CALLBACKS(this);
  }
  
  public static void CGLIB$SET_THREAD_CALLBACKS(Callback[] paramArrayOfCallback)
  {
    CGLIB$THREAD_CALLBACKS.set(paramArrayOfCallback);
  }
  
  public static void CGLIB$SET_STATIC_CALLBACKS(Callback[] paramArrayOfCallback)
  {
    CGLIB$STATIC_CALLBACKS = paramArrayOfCallback;
  }
  
  private static final void CGLIB$BIND_CALLBACKS(Object paramObject)
  {
    354348a local354348a = (354348a)paramObject;
    if (!local354348a.CGLIB$BOUND)
    {
      local354348a.CGLIB$BOUND = true;
      Object tmp23_20 = CGLIB$THREAD_CALLBACKS.get();
      if (tmp23_20 == null)
      {
        tmp23_20;
        CGLIB$STATIC_CALLBACKS;
      }
      local354348a.CGLIB$CALLBACK_0 = (tmp31_28 == null ? tmp31_28 : (FixedValue)((Callback[])tmp23_20)[0]);
    }
  }
  
  public Object newInstance(Callback[] paramArrayOfCallback)
  {
    CGLIB$SET_THREAD_CALLBACKS(paramArrayOfCallback);
    CGLIB$SET_THREAD_CALLBACKS(null);
    return new 354348a();
  }
  
  public Object newInstance(Callback paramCallback)
  {
    CGLIB$SET_THREAD_CALLBACKS(new Callback[] { paramCallback });
    CGLIB$SET_THREAD_CALLBACKS(null);
    return new 354348a();
  }
  
  /* Error */
  public Object newInstance(Class[] arg1, Object[] arg2, Callback[] arg3)
  {
    // Byte code:
    //   0: aload_3
    //   1: invokestatic 83 cglib/SampleClass$$EnhancerByCGLIB$$354348a:CGLIB$SET_THREAD_CALLBACKS  ([Lnet/sf/cglib/proxy/Callback;)V
    //   4: new 2   cglib/SampleClass$$EnhancerByCGLIB$$354348a
    //   7: dup
    //   8: aload_1
    //   9: dup
    //   10: arraylength
    //   11: tableswitch    default:+24->35, 0:+17->28
    //   28: pop
    //   29: invokespecial 84   cglib/SampleClass$$EnhancerByCGLIB$$354348a:<init>  ()V
    //   32: goto +17 -> 49
    //   35: goto +3 -> 38
    //   38: pop
    //   39: new 90 java/lang/IllegalArgumentException
    //   42: dup
    //   43: ldc 92
    //   45: invokespecial 95   java/lang/IllegalArgumentException:<init>   (Ljava/lang/String;)V
    //   48: athrow
    //   49: aconst_null
    //   50: invokestatic 83    cglib/SampleClass$$EnhancerByCGLIB$$354348a:CGLIB$SET_THREAD_CALLBACKS  ([Lnet/sf/cglib/proxy/Callback;)V
    //   53: areturn
  }
  
  public Callback getCallback(int paramInt)
  {
    CGLIB$BIND_CALLBACKS(this);
    switch (paramInt)
    {
    case 0: 
      break;
    }
    return null;
  }
  
  public void setCallback(int paramInt, Callback paramCallback)
  {
    switch (paramInt)
    {
    case 0: 
      this.CGLIB$CALLBACK_0 = ((FixedValue)paramCallback);
      break;
    }
  }
  
  public Callback[] getCallbacks()
  {
    CGLIB$BIND_CALLBACKS(this);
    return new Callback[] { this.CGLIB$CALLBACK_0 };
  }
  
  public void setCallbacks(Callback[] paramArrayOfCallback)
  {
    this.CGLIB$CALLBACK_0 = ((FixedValue)paramArrayOfCallback[0]);
  }
  
  static {}
}

MethodInterceptor

高级一点的回调方法：

public static void testMethodInterceptor() throws Exception {
    Enhancer enhancer = new Enhancer();
    enhancer.setSuperclass(SampleClass.class);
    enhancer.setCallback(new MethodInterceptor() {
        @Override
        public Object intercept(Object obj, Method method, Object[] args, MethodProxy proxy)
                throws Throwable {
            if (method.getDeclaringClass() != Object.class && method.getReturnType() == String.class) {
                return "Hello cglib!";
            } else {
                return proxy.invokeSuper(obj, args);
            }
        }
    });
    SampleClass proxy = (SampleClass) enhancer.create();
    System.out.println(proxy.test("1"));//输出结果Hello cglib!
    System.out.println(proxy.toString());//输出结果cglib.SampleClass$$EnhancerByCGLIB$$e7ad6a0f@53e25b76
    System.out.println(proxy.hashCode());//输出结果1407343478
}

生成的代理方法：

 public final String test(String paramString)
  {
    MethodInterceptor tmp4_1 = this.CGLIB$CALLBACK_0;
    if (tmp4_1 == null)
    {
      tmp4_1;
      CGLIB$BIND_CALLBACKS(this);
    }
    MethodInterceptor tmp17_14 = this.CGLIB$CALLBACK_0;
    if (tmp17_14 != null) {
      return (String)tmp17_14.intercept(this, CGLIB$test$0$Method, new Object[] { paramString }, CGLIB$test$0$Proxy);
    }
    return super.test(paramString);
  }

InvocationHandler

public static void testInvocationHandler() throws Exception {
    Enhancer enhancer = new Enhancer();
    enhancer.setSuperclass(SampleClass.class);
    enhancer.setCallback(new InvocationHandler() {
        @Override
        public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
            if(method.getReturnType() == String.class) {
                System.out.print("cglib -> "+method.toGenericString());
                return "Hello cglib!";
            } else {
                throw new RuntimeException("Do not know what to do.");
            }
        }
    });
    SampleClass proxy = (SampleClass) enhancer.create();
    System.out.println(proxy.test("1"));//输出结果cglib -> public java.lang.String cglib.SampleClass.test(java.lang.String)Hello cglib!
    System.out.println(proxy.toString());//cglib -> public java.lang.String java.lang.Object.toString()Hello cglib!
    System.out.println(proxy.hashCode());//异常（java.lang.RuntimeException: Do not know what to do.）
}

NoOp|LazyLoader|Dispatcher

NoOp|LazyLoader|Dispatcher就不重复了，生成的类细节可以自行去class dump的目录查看。

Immutable bean

生成不可变对象，可以用于参数传递时防止对象参数修改的场景。

原始对象是可以继续修改的，并且修改的值会影响不可变的对象。

例子：

public class SampleBean {
  private String value;
  public String getValue() {
    return value;
  }
  public void setValue(String value) {
    this.value = value;
  }
}

测试方法：

 public static void testImmutableBean() throws Exception {
    SampleBean bean = new SampleBean();
    bean.setValue("Hello world!");
    SampleBean immutableBean = (SampleBean) ImmutableBean.create(bean);
    System.out.println(immutableBean.getValue());//Hello world!
    bean.setValue("Hello world, again!");
    System.out.println(immutableBean.getValue());//Hello world, again!
    immutableBean.setValue("Hello cglib!"); // 抛出异常
}

cglib生成的不可变对象：

public class SampleBean$$ImmutableBeanByCGLIB$$b26aa907
  extends SampleBean
{
  private final SampleBean CGLIB$RWBean;
  
  public SampleBean$$ImmutableBeanByCGLIB$$b26aa907(Object paramObject)
  {
    this.CGLIB$RWBean = ((SampleBean)paramObject);
  }
  
  public String getValue()
  {
    return this.CGLIB$RWBean.getValue();
  }
  
  public void setValue(String paramString)
  {
    throw new IllegalStateException("Bean is immutable");
  }
}

Bean generator

用于运行时动态生成class。

例子：

public static void testBeanGenerator() throws Exception {
    BeanGenerator beanGenerator = new BeanGenerator();
    beanGenerator.addProperty("value", String.class);
    Object myBean = beanGenerator.create();
    Method setter = myBean.getClass().getMethod("setValue", String.class);
    setter.invoke(myBean, "Hello cglib!");
    Method getter = myBean.getClass().getMethod("getValue");
    System.out.println(getter.invoke(myBean));
}

cglib生成的class：

package net.sf.cglib.empty;

public class Object$$BeanGeneratorByCGLIB$$60b0c82c
{
  private String $cglib_prop_value;
  
  public String getValue()
  {
    return this.$cglib_prop_value;
  }
  
  public void setValue(String paramString)
  {
    this.$cglib_prop_value = paramString;
  }
}

Bean copier

Bulk bean

Bean map

Key factory

Mixin

String switcher

Interface maker

Method delegate

Multicast delegate

Constructor delegate

Parallel sorter

Fast class and fast members

最后编辑于：2018.09.10 16:47:26

人面猴
序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
沈念sama阅读 213,099评论 6赞 492
死咒
序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
沈念sama阅读 90,828评论 3赞 387
救了他两次的神仙让他今天三更去死
文/潘晓璐我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
开封第一讲书人阅读 158,540评论 0赞 348
道士缉凶录：失踪的卖姜人
文/不坏的土叔我叫张陵，是天一观的道长。经常有香客问我，道长，这世上最难降的妖魔是什么？我笑而不...
开封第一讲书人阅读 56,848评论 1赞 285
港岛之恋（遗憾婚礼）
正文为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
茶点故事阅读 65,971评论 6赞 385
恶毒庶女顶嫁案：这布局不是一般人想出来的
文/花漫我一把揭开白布。她就那样静静地躺着，像睡着了一般。火红的嫁衣衬着肌肤如雪。梳的纹丝不乱的头发上，一...
开封第一讲书人阅读 50,132评论 1赞 291
城市分裂传说
那天，我揣着相机与录音，去河边找鬼。笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。我是一名探鬼主播，决...
沈念sama阅读 39,193评论 3赞 412
双鸳鸯连环套：你想象不到人心有多黑
文/苍兰香墨我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
开封第一讲书人阅读 37,934评论 0赞 268
万荣杀人案实录
序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
沈念sama阅读 44,376评论 1赞 303
护林员之死
正文独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋以下内容为张勋视角年9月15日...
茶点故事阅读 36,687评论 2赞 327
白月光启示录
正文我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
茶点故事阅读 38,846评论 1赞 341
活死人
序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
沈念sama阅读 34,537评论 4赞 335
日本核电站爆炸内幕
正文年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
茶点故事阅读 40,175评论 3赞 317
男人毒药：我在死后第九天来索命
文/蒙蒙一、第九天我趴在偏房一处隐蔽的房顶上张望。院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
开封第一讲书人阅读 30,887评论 0赞 21
一桩弑父案，背后竟有这般阴谋
文/苍兰香墨我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。一阵脚步声响...
开封第一讲书人阅读 32,134评论 1赞 267
情欲美人皮
我被黑心中介骗来泰国打工，没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。一个月前我还...
沈念sama阅读 46,674评论 2赞 362
代替公主和亲
正文我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
茶点故事阅读 43,741评论 2赞 351

cglib学习笔记

cglib学习笔记

cglib简介

cglib学习

Enhancer

FixedValue

MethodInterceptor

InvocationHandler

NoOp|LazyLoader|Dispatcher

Immutable bean

Bean generator

Bean copier

Bulk bean

Bean map

Key factory

Mixin

String switcher

Interface maker

Method delegate

Multicast delegate

Constructor delegate

Parallel sorter

Fast class and fast members

推荐阅读更多精彩内容