一文搞懂Java常见的三种代理模式(静态代理、动态代理和cglib代理)

 更新时间:2023年08月09日 10:35:25   作者:半亩方塘立身  
Java中常见的三种代理模式是静态代理模式、动态代理模式和CGLIB代理模式,本文就来给大家详细的讲解一下这三种代理模式,感兴趣的小伙伴跟着小编一起来看看吧

Java静态代理

Java中的静态代理是一种设计模式,它通过创建一个代理类来代替原始类,从而控制对原始类的访问。代理类和原始类都实现相同的接口,使得客户端在使用时无需关心具体的实现细节。静态代理在编译时就已经确定代理类和原始类的关系,因此称为静态代理。

下面是Java静态代理UML类图:

image.png

示例代码: 假设有一个文件上传的接口 FileUploader ,其真实实现为 RealFileUploader ,我们需要在上传文件前后记录日志,这时就可以使用静态代理。

首先,定义抽象接口 FileUploader

public interface FileUploader {
    void upload(String file);
}

然后,实现真实上传 RealFileUploader

public class RealFileUploader implements FileUploader {
    @Override
    public void upload(String file) {
        // 实际的文件上传逻辑
        System.out.println("Uploading file: " + file);
    }
}

接下来,实现代理 ProxyFileUploader

public class ProxyFileUploader implements FileUploader {
    private FileUploader realFileUploader;
    public ProxyFileUploader(FileUploader realFileUploader) {
        this.realFileUploader = realFileUploader;
    }
    @Override
    public void upload(String file) {
        // 额外的处理,比如记录日志
        System.out.println("Before uploading: " + file);
        // 调用真实主题的上传方法
        realFileUploader.upload(file);
        // 额外的处理,比如记录日志
        System.out.println("After uploading: " + file);
    }
}

在使用时,我们可以这样创建代理类并进行文件上传:

public class Main {
    public static void main(String[] args) {
        // 创建真实主题
        FileUploader realFileUploader = new RealFileUploader();
        // 创建代理主题,并将真实主题传入
        FileUploader proxyFileUploader = new ProxyFileUploader(realFileUploader);
        // 通过代理主题进行文件上传
        proxyFileUploader.upload("example.txt");
    }
}

运行上述代码,输出将会是:

Before uploading: example.txt
Uploading file: example.txt
After uploading: example.txt

Java动态代理

Java动态代理是一种在运行时创建代理类的机制,它允许在不提前知道代理类的具体类型的情况下,动态地创建一个代理对象来代替原始类。相比于静态代理,动态代理更加灵活,可以代理任意的接口类型,不需要为每个被代理的类编写专门的代理类,而是通过Java的反射机制在运行时动态生成代理类。动态代理主要使用 java.lang.reflect.Proxy 类和 java.lang.reflect.InvocationHandler 接口来实现。动态代理又被称为JDK代理或接口代理。

下面看下动态代理的UML图:

java动态代理 (1).png

示例代码: 与前面的静态代理示例相同,我们仍然使用文件上传的接口 FileUploader ,其真实实现为 RealFileUploader 。接下来,我们将通过动态代理在上传文件前后记录日志。

首先,定义抽象主题接口 FileUploader 和实现真实主题 RealFileUploader ,与之前相同,不再重复。

然后,实现 InvocationHandler 接口,创建动态代理的处理器类 DynamicProxyHandler

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
public class DynamicProxyHandler implements InvocationHandler {
    private Object realObject;
    public DynamicProxyHandler(Object realObject) {
        this.realObject = realObject;
    }
    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        // 额外的处理,比如记录日志
        System.out.println("Before invoking: " + method.getName());
        // 调用真实主题的对应方法
        Object result = method.invoke(realObject, args);
        // 额外的处理,比如记录日志
        System.out.println("After invoking: " + method.getName());
        return result;
    }
}

在使用时,我们可以这样创建动态代理对象并进行文件上传:

import java.lang.reflect.Proxy;
public class Main {
    public static void main(String[] args) {
        // 创建真实主题
        FileUploader realFileUploader = new RealFileUploader();
        // 创建动态代理的处理器
        InvocationHandler handler = new DynamicProxyHandler(realFileUploader);
        // 创建代理类
        FileUploader proxyFileUploader = (FileUploader) Proxy.newProxyInstance(
                FileUploader.class.getClassLoader(),
                new Class[]{FileUploader.class},
                handler
        );
        // 通过动态代理进行文件上传
        proxyFileUploader.upload("example.txt");
    }
}

运行上述代码,输出将会是:

Before invoking: upload
Uploading file: example.txt
After invoking: upload

同样,通过动态代理,我们在文件上传前后成功添加了额外的处理(记录日志),同时客户端代码无需关心具体的日志记录逻辑,实现了解耦。动态代理在很多场景下非常有用,例如AOP(面向切面编程)等。

CGLIB代理

CGLIB(Code Generation Library)是一个开源的第三方库,用于在Java运行时生成字节码并创建代理类。与Java标准库中的动态代理(基于接口)不同,CGLIB代理可以代理普通类,即使它们没有实现任何接口。CGLIB使用ASM库来生成字节码,并通过继承的方式创建代理类,因此也被称为子类代理。CGLIB广泛用于各种框架和库中,如Spring AOP。

下面详细介绍CGLIB代理的结构和示例:

  1. 示例代码: 假设有一个简单的类 Calculator ,我们希望在其方法执行前后记录日志,可以使用CGLIB代理。

首先,引入CGLIB库,可以通过Maven添加依赖:

<dependency>
    <groupId>cglib</groupId>
    <artifactId>cglib</artifactId>
    <version>版本号</version>
</dependency>

然后,定义普通类 Calculator

public class Calculator {
    public int add(int a, int b) {
        return a + b;
    }
}

接下来,创建一个代理类生成器 CalculatorProxyGenerator

import net.sf.cglib.proxy.Enhancer;
import net.sf.cglib.proxy.MethodInterceptor;
import net.sf.cglib.proxy.MethodProxy;
import java.lang.reflect.Method;
public class CalculatorProxyGenerator implements MethodInterceptor {
    private Object target;
    public CalculatorProxyGenerator(Object target) {
        this.target = target;
    }
    public Object createProxy() {
        Enhancer enhancer = new Enhancer();
        enhancer.setSuperclass(target.getClass());
        enhancer.setCallback(this);
        return enhancer.create();
    }
    @Override
    public Object intercept(Object obj, Method method, Object[] args, MethodProxy proxy) throws Throwable {
        System.out.println("Before invoking: " + method.getName());
        Object result = proxy.invokeSuper(obj, args);
        System.out.println("After invoking: " + method.getName());
        return result;
    }
}

intercept 方法中,我们执行了代理类的方法(通过 proxy.invokeSuper(obj, args) ),在方法执行前后添加了额外的处理。

最后,在使用时,我们可以这样创建代理对象并调用方法:

public class Main {
    public static void main(String[] args) {
        Calculator calculator = new Calculator();
        CalculatorProxyGenerator proxyGenerator = new CalculatorProxyGenerator(calculator);
        Calculator proxyCalculator = (Calculator) proxyGenerator.createProxy();
        int result = proxyCalculator.add(3, 5);
        System.out.println("Result: " + result);
    }
}

运行上述代码,输出将会是:

Before invoking: add
After invoking: add
Result: 8

这样,通过CGLIB代理,我们成功在方法执行前后添加了额外的处理(记录日志),实现了解耦。CGLIB代理在不需要接口的情况下也能很好地完成代理任务,但由于它是通过继承的方式生成代理类,可能会影响某些场景,比如无法代理 final 方法。

动态代理与CGLIB代理的区别

Spring在5.X之前默认的动态代理实现一直是jdk动态代理。但是从5.X开始,spring就开始默认使用Cglib来作为动态代理实现。并且springboot从2.X开始也转向了Cglib动态代理实现。

为什么spring体系整体转投Cglib呢,jdk动态代理又有什么缺点呢?

  • jdk动态代理只能基于接口,代理生成的对象只能赋值给接口变量,而Cglib就不存在这个问题,Cglib是通过生成子类来实现的,代理对象既可以赋值给实现类,又可以赋值给接口。
  • Cglib速度比jdk动态代理更快,性能更好。

以上就是一文搞懂Java的三种代理模式(静态代理、动态代理和cglib代理)的详细内容,更多关于Java代理模式的资料请关注脚本之家其它相关文章!

相关文章

  • Java实现读取163邮箱,qq邮箱的邮件内容

    Java实现读取163邮箱,qq邮箱的邮件内容

    这篇文章主要利用Java语言实现读取163邮箱和qq邮箱的邮件内容,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起动手试一试
    2022-02-02
  • Java按值传递和按址传递(面试常见)

    Java按值传递和按址传递(面试常见)

    这篇文章主要介绍了Java按值传递和按址传递(面试常见)知识,在面试笔试题中经常会遇到,今天小编给大家详细介绍下,需要的朋友可以参考下
    2017-02-02
  • Java 通过AQS实现数据组织

    Java 通过AQS实现数据组织

    这篇文章主要介绍了通过AQS实现数据组织,想了解AQS的同学可以参考下
    2021-04-04
  • SpringBoot 集成 Nebula的操作过程

    SpringBoot 集成 Nebula的操作过程

    这篇文章主要介绍了SpringBoot 集成 Nebula的操作过程,通过示例代码介绍了java 环境下如何对 Nebula Graph 进行操作,感兴趣的朋友跟随小编一起看看吧
    2024-05-05
  • 20秒教你学会java List函数排序操作示例

    20秒教你学会java List函数排序操作示例

    这篇文章主要为大家介绍了20秒教你学会List函数排序操作示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-09-09
  • 如何使用Java中的Optional

    如何使用Java中的Optional

    这篇文章主要介绍了如何使用Java中的Optional,帮助大家更好的理解和使用Java,感兴趣的朋友可以了解下
    2020-11-11
  • ShardingSphere如何进行sql重写示例详解

    ShardingSphere如何进行sql重写示例详解

    这篇文章主要为大家介绍了ShardingSphere如何进行sql重写示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-09-09
  • Java与MySQL时间不一致问题解决

    Java与MySQL时间不一致问题解决

    本文主要介绍了Java与MySQL时间不一致问题解决,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-01-01
  • Java通过CMD方式读取注册表任意键值对代码实践

    Java通过CMD方式读取注册表任意键值对代码实践

    这篇文章主要介绍了Java通过CMD方式读取注册表任意键值对代码实践,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,,需要的朋友可以参考下
    2019-06-06
  • Java中CompletableFuture 的详细介绍

    Java中CompletableFuture 的详细介绍

    这篇文章主要介绍了Java中的CompletableFuture,通过创建 CompletableFuture 的对象的工厂方法展开详细的内容介绍,需要的小伙伴可以参考一下
    2022-05-05

最新评论