您的位置 首页 java

Java中的原生动态代理和CGLIB动态代理的原理，我不信你全知道

智云科技发布于 2023年1月14日评论关闭阅读(182)

点击上方 “程序员小乐”关注, 星标或置顶一起成长

每天凌晨00点00分, 第一时间与你相约

每日英文

The sign of maturity is not when you start speaking big things,But, actually it is, When you start understanding Small things.

成熟的标志不是会说大道理，而是你开始去理解，身边的小事情。

每日掏心话

你去了很多地方，做了很多事情，认识了很多人。有人相信你，有人质疑你，但你错了，你一直在不停地向很多人解释你做过的一些事情。

来自：CarpenterLee | 责编：乐乐

链接：cnblogs.com/CarpenterLee/p/8241042.html

程序员小乐(ID:study_tech)第 836 次推文 图片来自百度

往日回顾：基于 token 的多平台身份认证架构设计

正文

动态代理在Java中有着广泛的应用，比如Spring AOP，Hibernate数据查询、测试框架的后端mock、RPC，Java注解对象获取等。静态代理的代理关系在编译时就确定了，而动态代理的代理关系是在编译期确定的。静态代理实现简单，适合于代理类较少且确定的情况，而动态代理则给我们提供了更大的灵活性。今天我们来探讨Java中两种常见的动态代理方式：JDK原生动态代理和CGLIB动态代理。

JDK原生动态代理

先从直观的示例说起，假设我们有一个接口Hello和一个简单实现HelloImp：

// 接口
interface Hello{
String sayHello(String str);
}
// 实现
class HelloImp implements Hello{
@Override
public String sayHello(String str) {
return “HelloImp: ” + str;
}
}

这是Java种再常见不过的场景，使用接口制定协议，然后用不同的实现来实现具体行为。假设你已经拿到上述类库，如果我们想通过日志记录对sayHello()的调用，使用静态代理可以这样做：

// 静态代理方式
class StaticProxiedHello implements Hello{
…
private Hello hello = new HelloImp();
@Override
public String sayHello(String str) {
logger.info(“You said: ” + str);
return hello.sayHello(str);
}
}
上例中静态代理类StaticProxiedHello作为HelloImp的代理，实现了相同的Hello接口。用Java动态代理可以这样做：

  • 首先实现一个InvocationHandler，方法调用会被转发到该类的invoke()方法。

  • 然后在需要使用Hello的时候，通过JDK动态代理获取Hello的代理对象。

  • // Java Proxy

  • // 1. 首先实现一个InvocationHandler，方法调用会被转发到该类的invoke()方法。

  • class LogInvocationHandler implements InvocationHandler{

  • …

  • private Hello hello;

  • public LogInvocationHandler(Hello hello) {

  • this.hello = hello;

  • }

  • @Override

  • public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {

  • if(“sayHello”.equals(method.getName())) {

  • logger.info(“You said: ” + Arrays.toString(args));

  • }

  • return method.invoke(hello, args);

  • }

  • }

  • // 2. 然后在需要使用Hello的时候，通过JDK动态代理获取Hello的代理对象。

  • Hello hello = (Hello)Proxy.newProxyInstance(

  • getClass().getClassLoader(), // 1. 类加载器

  • new Class<?>[] {Hello.class}, // 2. 代理需要实现的接口，可以有多个

  • new LogInvocationHandler(new HelloImp()));// 3. 方法调用的实际处理者

  • System.out.println(hello.sayHello(“I love you!”));

运行上述代码输出结果：

日志信息: You said: [I love you!]
HelloImp: I love you!

上述代码的关键是Proxy.newProxyInstance(ClassLoader loader, Class[] interfaces, InvocationHandler handler)方法，该方法会根据指定的参数动态创建代理对象。三个参数的意义如下：

  • loader，指定代理对象的类加载器；

  • interfaces，代理对象需要实现的接口，可以同时指定多个接口；

  • handler，方法调用的实际处理者，代理对象的方法调用都会转发到这里（*注意1）。

newProxyInstance()会返回一个实现了指定接口的代理对象，对该对象的所有方法调用都会转发给InvocationHandler.invoke()方法。理解上述代码需要对Java反射机制有一定了解。动态代理神奇的地方就是：

  • 代理对象是在程序运行时产生的，而不是编译期；

  • 对代理对象的所有接口方法调用都会转发到InvocationHandler.invoke()方法，在invoke()方法里我们可以加入任何逻辑，比如修改方法参数，加入日志功能、安全检查功能等；之后我们通过某种方式执行真正的方法体，示例中通过反射调用了Hello对象的相应方法，还可以通过RPC调用远程方法。

  • 注意1：对于从Object中继承的方法，JDK Proxy会把hashCode()、equals()、toString()这三个非接口方法转发给InvocationHandler，其余的Object方法则不会转发。详见JDK Proxy官方文档。如果对JDK代理后的对象类型进行深挖，可以看到如下信息：# Hello代理对象的类型信息

  • class=class jdkproxy.$Proxy0

  • superClass=class java.lang.reflect.Proxy

  • interfaces:

  • interface jdkproxy.Hello

  • invocationHandler=jdkproxy.LogInvocationHandler@a09ee92

代理对象的类型是jdkproxy.$Proxy0，这是个动态生成的类型，类名是形如$ProxyN的形式；父类是java.lang.reflect.Proxy，所有的JDK动态代理都会继承这个类；同时实现了Hello接口，也就是我们接口列表中指定的那些接口。扩展：Java面试题内容聚合

如果你还对jdkproxy.$Proxy0具体实现感兴趣，它大致长这个样子：

// JDK代理类具体实现
public final class $Proxy0 extends Proxy implements Hello
{
…
public $Proxy0(InvocationHandler invocationhandler)
{
super(invocationhandler);
}
…
@Override
public final String sayHello(String str){
…
return super.h.invoke(this, m3, new Object[] {str});// 将方法调用转发给invocationhandler
…
}
…
}

这些逻辑没什么复杂之处，但是他们是在运行时动态产生的，无需我们手动编写。更多详情，可参考:

Java动态代理为我们提供了非常灵活的代理机制，但Java动态代理是基于接口的，如果对象没有实现接口我们该如何代理呢？CGLIB登场。

CGLIB动态代理

CGLIB(Code Generation Library)是一个基于ASM的字节码生成库，它允许我们在运行时对字节码进行修改和动态生成。CGLIB通过继承方式实现代理。

来看示例，假设我们有一个没有实现任何接口的类HelloConcrete：

public class HelloConcrete {
public String sayHello(String str) {
return “HelloConcrete: ” + str;
}
}
因为没有实现接口该类无法使用JDK代理，通过CGLIB代理实现如下：

  • 首先实现一个MethodInterceptor，方法调用会被转发到该类的intercept()方法。

  • 然后在需要使用HelloConcrete的时候，通过CGLIB动态代理获取代理对象。

  • // CGLIB动态代理

  • // 1. 首先实现一个MethodInterceptor，方法调用会被转发到该类的intercept()方法。

  • class MyMethodInterceptor implements MethodInterceptor{

  • …

  • @Override

  • public Object intercept(Object obj, Method method, Object[] args, MethodProxy proxy) throws Throwable {

  • logger.info(“You said: ” + Arrays.toString(args));

  • return proxy.invokeSuper(obj, args);

  • }

  • }

  • // 2. 然后在需要使用HelloConcrete的时候，通过CGLIB动态代理获取代理对象。

  • Enhancer enhancer = new Enhancer();

  • enhancer.setSuperclass(HelloConcrete.class);

  • enhancer.setCallback(new MyMethodInterceptor());

  • HelloConcrete hello = (HelloConcrete)enhancer.create();

  • System.out.println(hello.sayHello(“I love you!”));

  • 运行上述代码输出结果：日志信息: You said: [I love you!]

  • HelloConcrete: I love you!

上述代码中，我们通过CGLIB的Enhancer来指定要代理的目标对象、实际处理代理逻辑的对象，最终通过调用create()方法得到代理对象，对这个对象所有非final方法的调用都会转发给MethodInterceptor.intercept()方法，在intercept()方法里我们可以加入任何逻辑，比如修改方法参数，加入日志功能、安全检查功能等；

通过调用MethodProxy.invokeSuper()方法，我们将调用转发给原始对象，具体到本例，就是HelloConcrete的具体方法。CGLIG中MethodInterceptor的作用跟JDK代理中的InvocationHandler很类似，都是方法调用的中转站。

注意：对于从Object中继承的方法，CGLIB代理也会进行代理，如hashCode()、equals()、toString()等，但是getClass()、wait()等方法不会，因为它是final方法，CGLIB无法代理。

如果对CGLIB代理之后的对象类型进行深挖，可以看到如下信息：

# HelloConcrete代理对象的类型信息
class=class cglib.HelloConcrete$$EnhancerByCGLIB$$e3734e52
superClass=class lh.HelloConcrete
interfaces:
interface net.sf.cglib.proxy.Factory
invocationHandler=not java proxy class

我们看到使用CGLIB代理之后的对象类型是cglib.HelloConcrete$$EnhancerByCGLIB$$e3734e52，这是CGLIB动态生成的类型；父类是HelloConcrete，印证了CGLIB是通过继承实现代理；同时实现了net.sf.cglib.proxy.Factory接口，这个接口是CGLIB自己加入的，包含一些工具方法。

注意，既然是继承就不得不考虑final的问题。我们知道final类型不能有子类，所以CGLIB不能代理final类型，遇到这种情况会抛出类似如下异常：

java.lang.IllegalArgumentException: Cannot subclass final class cglib.HelloConcrete

同样的，final方法是不能重载的，所以也不能通过CGLIB代理，遇到这种情况不会抛异常，而是会跳过final方法只代理其他方法。

如果你还对代理类cglib.HelloConcrete$$EnhancerByCGLIB$$e3734e52具体实现感兴趣，它大致长这个样子：

// CGLIB代理类具体实现
public class HelloConcrete$$EnhancerByCGLIB$$e3734e52
extends HelloConcrete
implements Factory
{
…
private MethodInterceptor CGLIB$CALLBACK_0; // ~~
…

public final String sayHello(String paramString)
{
…
MethodInterceptor tmp17_14 = CGLIB$CALLBACK_0;
if (tmp17_14 != null) {
// 将请求转发给MethodInterceptor.intercept()方法。
return (String)tmp17_14.intercept(this,
CGLIB$sayHello$0$Method,
new Object[] { paramString },
CGLIB$sayHello$0$Proxy);
}
return super.sayHello(paramString);
}
…
}

上述代码我们看到，当调用代理对象的sayHello()方法时，首先会尝试转发给MethodInterceptor.intercept()方法，如果没有MethodInterceptor就执行父类的sayHello()。这些逻辑没什么复杂之处，但是他们是在运行时动态产生的，无需我们手动编写。

更多关于CGLIB的介绍可以参考：

dzone.com/articles/cglib-missing-manual

结语

本文介绍了Java两种常见动态代理机制的用法和原理，JDK原生动态代理是Java原生支持的，不需要任何外部依赖，但是它只能基于接口进行代理；CGLIB通过继承的方式进行代理，无论目标对象有没有实现接口都可以代理，但是无法处理final的情况。动态代理是Spring AOP(Aspect Orient Programming, 面向切面编程)的实现方式，了解动态代理原理，对理解Spring AOP大有帮助。

欢迎在留言区留下你的观点，一起讨论提高。如果今天的文章让你有新的启发，学习能力的提升上有新的认识，欢迎转发分享给更多人。

猜你还想看

阿里、腾讯、百度、华为、京东最新面试题汇集

从上帝视角看Java如何运行

手把手带你实现线上环境部署概览

IDEA-2020.1 版本针对调试器和代码分析器的改进，值得期待

关注订阅号「程序员小乐」，收看更多精彩内容
嘿，你在看吗？

标签:
打赏 点赞(2)

文章来源：智云一二三科技

文章标题：Java中的原生动态代理和CGLIB动态代理的原理，我不信你全知道

文章地址：https://www.zhihuclub.com/191584.shtml

关于作者: 智云科技

相关文章

热门文章

1分享新浪图床上传接口源码

点赞(872)阅读(58,444)

2PHP简单实现路由Route功能

点赞(1.09K)阅读(35,905)

3Tideways、xhprof 和 xhgui 打造 PHP 非侵入式监控平台

点赞(296)阅读(4,250)

4centos系统如何查看是否安装了mysql

点赞(472)阅读(3,722)

5curl 工具简述

点赞(445)阅读(2,944)
网站地图