【每天学点Spring】cglib以及JDK Dynamic Proxy介绍

【参考】

【官网】

本文基于Spring Boot 2.7.0版本。

1. cglib相关

1.1 cglib例子

我们先新建一个目标类:Cat.java

public class Cat {
    public String hello(String name) {
        return "hello " + name;
    }
}

新建一个实现cglib的MethodInterceptor接口的类:

import org.springframework.cglib.proxy.MethodInterceptor;
import org.springframework.cglib.proxy.MethodProxy;
import java.lang.reflect.Method;

public class HelloMethodInterceptor implements MethodInterceptor {
    private Object target;

    public HelloMethodInterceptor(Object target) {
        this.target = target;
    }

    @Override
    public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
        Object obj;
        try {
            System.out.println("before " + method.getName() + " invoke...");
            obj = method.invoke(target, objects);
        } finally {
            System.out.println("after " + method.getName() + " invoke....");
        }
        return obj;
    }
}

开始写测试类,目标是通过cglib的Enhancer类,将目标Cat类作为Superclass,enhancer可以set多个CallBack(至少一个)。这里的callback会在cglib的proxy类的方法被调用的时候调用。

import org.junit.jupiter.api.Test;
import org.springframework.cglib.proxy.Enhancer;
import org.springframework.cglib.proxy.MethodInterceptor;
import proxy.dynamic.Dog;

public class CatCGLIBTest {

    @Test
    public void test() {
        Enhancer enhancer = new Enhancer();
        enhancer.setSuperclass(Cat.class);
        enhancer.setCallback(new HelloMethodInterceptor(new Cat()));
        Cat proxy = (Cat) enhancer.create();
        System.out.println(proxy.hello("cglib"));
    }

控制台打印:

before hello invoke...
hello method
after hello invoke....
hello cglib

在测试方法中打断点可以看到Enhance创建的类为:
image.png
1.2 cglib的相关类为什么在org.springframework包下?

cglib也有自己的包,如:

<dependency>
    <groupId>cglib</groupId>
    <artifactId>cglib</artifactId>
    <version>3.2.4</version>
</dependency>

Spring因为考虑到别的第三方jar也可能会引用cglib(如hibernate),为了避免引起包冲突,Spring直接将cglib的相关类,放到了它自己的spring-core包下,这就是为什么上述的例子有些cglib相关类在org.springframework.cglib.proxy包下。

image.png

1.3 Spring通过cglib创建代理类

CourseServiceImpl类有@Transactional注解,所以最终Spring会通过cglib(可以通过设置使用cglib代理或是JDK动态代理)生成CourseServiceImpl的增强类:

@Service("courseService")
public class CourseServiceImpl implements CourseService {
    @Autowired
    private CourseRepository courseRepository;

    @Transactional
    public List<Course> list() {
        return courseRepository.findAll();
    }
}

通过debug可以看到,在bean = courseService在createBean的过程中,最终会调用CglibAopProxy类进行增强:

image.png

代码片断如下(位于CglibAopProxy):
创建cglib的Enhancer类:

image.png

设置Superclass

image.png

设置Callbacks,我们上述#1.1的例子中只设置了一个MethodInterceptor,Spring这里一共设置了7个:

image.png

最终创建出来的courseService则为cglib增强类:
image.png

2. JDK Dynamic Proxy相关

2.1 JDK Dynamic Proxy例子

和上述的Cat类一样,这里新建的是Dog,因为JDK动态代理是基于接口的,所以我们创建了接口Dog以及它的实现类DogImpl。

public interface Dog {
    String hello(String name);
}
public class DogImpl implements Dog {
    public String hello(String name) {
        System.out.println("hello method");
        return "hello " + name;
    }
}

Dynamic在生成proxy的时候,也需要传入一个Handler,即以下的类:

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;

public class DogInvocationHandler implements InvocationHandler {
    private Object target;

    public DogInvocationHandler(Object target) {
        this.target = target;
    }

    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        System.out.println("before invoke...");
        Object result = method.invoke(target, args);
        System.out.println("after method...");
        return result;
    }
}

开始测试,可以看到Dynamic Proxy依赖的类都在java.lang.reflect下,也就是Dynamic Proxy是JDK原生的代理。

另外,可以看到下述在生成proxy的过程中,需要传入接口类:
image.png
import org.junit.jupiter.api.Test;
import java.lang.reflect.Proxy;

public class DogDynamicProxyTest {

    @Test
    public void test() {
        Dog proxyInstance = (Dog) Proxy.newProxyInstance(
                DogDynamicProxyTest.class.getClassLoader(),
                new Class[] { Dog.class }, new DogInvocationHandler(new DogImpl()));

        System.out.println(proxyInstance.hello("test"));
    }
}

控制台打印:

before invoke...
hello method
after method...
hello test

在测试方法中打断点可以看到Enhance创建的类为:
image.png
2.2 Spring通过JDK Dynamic Proxy创建代理类

高版本的Spring Boot已经默认使用cglib做为默认的动态代理,如果要使用JDK的动态代理,需要在application.yaml中设置:

spring:
  aop:
    proxy-target-class: false

通过debug可以看到,在bean = courseService在createBean的过程中,最终会调用JdkDynamicAopProxy类进行增强:

image.png

通过java.lang.reflect.Proxy创建代理类:

image.png

最终创建出来的courseService则为JDK Dynamic Proxy增强类:
image.png

3. Spring Boot 默认的动态代理

可以查看TransactionAutoConfiguration类,在2.7.0版本中默认用的是cglib(不同版本可能不一样),想要改成JDK动态代理,请查看#2.2的设置:

image.png


更多讨论:https://stackoverflow.com/questions/10664182/what-is-the-difference-between-jdk-dynamic-proxy-and-cglib

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 162,825评论 4 377
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 68,887评论 2 308
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 112,425评论 0 255
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,801评论 0 224
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 53,252评论 3 299
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 41,089评论 1 226
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 32,216评论 2 322
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 31,005评论 0 215
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,747评论 1 250
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,883评论 2 255
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,354评论 1 265
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,694评论 3 265
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,406评论 3 246
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,222评论 0 9
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,996评论 0 201
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 36,242评论 2 287
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 36,017评论 2 281

推荐阅读更多精彩内容