1602 字
8 分钟
Java的动态代理
2025-03-14

Java中的动态代理是一种强大的机制,允许在运行时创建接口的代理实例。这种代理实例能够动态地拦截对接口方法的调用,从而可以在调用前后添加自定义的逻辑,而不需要修改原有的代码。动态代理在AOP(面向切面编程)、远程方法调用、事务管理等领域有着广泛的应用。

动态代理的基本概念#

代理对象:在运行时创建的用于替代真实对象的代理。 InvocationHandler:一个接口,其实现类负责处理代理对象的方法调用。每个代理实例都有一个关联的InvocationHandler。 Proxy类:Java提供的用于创建动态代理的类,它有一个静态方法newProxyInstance,用于生成代理对象。

创建动态代理的步骤#

  1. 定义接口:首先定义一个或多个接口,代理类将会实现这些接口。
    public interface MyInterface {
        void doSomething();
    }
    
    public class MyInterfaceImpl implements MyInterface{
        ...
            void doSomething();
        ...
    }
  2. 实现InvocationHandler:创建一个实现InvocationHandler接口的类,该类中的invoke方法将会在代理对象的方法被调用时执行。
    import java.lang.reflect.InvocationHandler;
    import java.lang.reflect.Method;
    import java.lang.reflect.Proxy;
    public class MyInvocationHandler implements InvocationHandler {
        private Object target; // 真实对象
        public MyInvocationHandler(Object target) {
            this.target = target;
        }
        @Override
        public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                /*
                 * 参数一:代理的对象
                 * 参数二:要运行的方法,如果有多个,可以都写在数组中
                 * 参数三:调用方法时,传递的实参
                 * */
            // 在调用真实对象的方法前可以添加自定义逻辑
            System.out.println("Before method execution");
            // 调用真实对象的方法
            Object result = method.invoke(target, args);
            // 在调用真实对象的方法后可以添加自定义逻辑
            System.out.println("After method execution");
            return result;
        }
    }
  3. 创建代理对象:使用Proxy.newProxyInstance方法创建代理对象。
    public class ProxyDemo {
        public static void main(String[] args) {
            MyInterface realObject = new MyInterfaceImpl();
            MyInvocationHandler handler = new MyInvocationHandler(realObject);
            // 创建代理对象
            MyInterface proxyObject = (MyInterface) Proxy.newProxyInstance(
                MyInterface.class.getClassLoader(),
                new Class<?>[] {MyInterface.class},
                handler // 用来指定生成的代理对象要干什么事情, 可以直接写匿名类new InvocationHandler(){}
            );
            // 通过代理对象调用方法
            proxyObject.doSomething();
        }
    }
    在这个例子中,MyInterfaceImplMyInterface的一个实现类。

动态代理的工作原理#

当通过代理对象调用方法时,会调用InvocationHandler的invoke方法。在这个方法中,可以添加自定义的逻辑,然后调用真实对象的方法。invoke方法的参数包括:

  • proxy:代理对象本身。
  • method:被调用的方法对象。
  • args:方法调用时传入的参数数组。

动态代理的优势#

  • 动态创建:代理类在运行时动态创建,不需要手动编写代理类。
  • 解耦:通过代理可以添加额外的逻辑,而不需要修改原有的代码,实现了关注点的分离。
  • 灵活:可以在运行时决定代理的行为。

动态代理的局限性#

  • 只能代理接口:Java的动态代理只能为接口创建代理,不能为具体的类创建代理。
  • 性能开销:相比于直接调用,通过代理调用会有额外的性能开销。

应用场景#

  • AOP:在Spring等框架中,动态代理用于实现AOP,例如事务管理、日志记录等。
  • 远程方法调用:在RMI(远程方法调用)中,动态代理用于代表远程对象。
  • 数据绑定和校验:在Web应用中,动态代理可以用于数据绑定和校验。 总之,Java中的动态代理是一种非常灵活和强大的机制,能够在不修改原有代码的情况下,动态地添加额外的逻辑。

黑马的案例#

public class Test {
    public static void main(String[] args) {
    /*
        需求:
            外面的人想要大明星唱一首歌
             1. 获取代理的对象
                代理对象 = ProxyUtil.createProxy(大明星的对象);
             2. 再调用代理的唱歌方法
                代理对象.唱歌的方法("只因你太美");
     */
        //1. 获取代理的对象
        BigStar bigStar = new BigStar("鸡哥");
        Star proxy = ProxyUtil.createProxy(bigStar);

        //2. 调用唱歌的方法
        String result = proxy.sing("只因你太美");
        System.out.println(result);
    }
}
/*
*
* 类的作用:
*       创建一个代理
*
* */
public class ProxyUtil {
    /*
    *
    * 方法的作用:
    *       给一个明星的对象,创建一个代理
    *
    *  形参:
    *       被代理的明星对象
    *
    *  返回值:
    *       给明星创建的代理
    *
    *
    *
    * 需求:
    *   外面的人想要大明星唱一首歌
    *   1. 获取代理的对象
    *      代理对象 = ProxyUtil.createProxy(大明星的对象);
    *   2. 再调用代理的唱歌方法
    *      代理对象.唱歌的方法("只因你太美");
    * */
    public static Star createProxy(BigStar bigStar){
       /* java.lang.reflect.Proxy类:提供了为对象产生代理对象的方法:
        public static Object newProxyInstance(ClassLoader loader, Class<?>[] interfaces, InvocationHandler h)
        参数一:用于指定用哪个类加载器,去加载生成的代理类
        参数二:指定接口,这些接口用于指定生成的代理长什么,也就是有哪些方法
        参数三:用来指定生成的代理对象要干什么事情
        */
        
        Star star = (Star) Proxy.newProxyInstance(
                ProxyUtil.class.getClassLoader(),//参数一:用于指定用哪个类加载器,去加载生成的代理类
                new Class[]{Star.class},//参数二:指定接口,这些接口用于指定生成的代理长什么,也就是有哪些方法
                //参数三:用来指定生成的代理对象要干什么事情
                new InvocationHandler() {
                    @Override
                    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
                        /*
                        * 参数一:代理的对象
                        * 参数二:要运行的方法 sing
                        * 参数三:调用sing方法时,传递的实参
                        * */
                        if("sing".equals(method.getName())){
                            System.out.println("准备话筒,收钱");
                        }else if("dance".equals(method.getName())){
                            System.out.println("准备场地,收钱");
                        }
                        //去找大明星开始唱歌或者跳舞
                        //代码的表现形式:调用大明星里面唱歌或者跳舞的方法
                        return method.invoke(bigStar,args);
                    }
                }
        );
        return star;
    }
}
public interface Star {
    //我们可以把所有想要被代理的方法定义在接口当中
    //唱歌
    public abstract String sing(String name);
    //跳舞
    public abstract void dance();
}
public class BigStar implements Star {
    private String name;


    public BigStar() {
    }

    public BigStar(String name) {
        this.name = name;
    }

    //唱歌
    @Override
    public String sing(String name){
        System.out.println(this.name + "正在唱" + name);
        return "谢谢";
    }

    //跳舞
    @Override
    public void dance(){
        System.out.println(this.name + "正在跳舞");
    }

    /**
     * 获取
     * @return name
     */
    public String getName() {
        return name;
    }

    /**
     * 设置
     * @param name
     */
    public void setName(String name) {
        this.name = name;
    }

    public String toString() {
        return "BigStar{name = " + name + "}";
    }
}
Java的动态代理
http://zaoweiceng.github.io/posts/java/动态代理/
作者
静惜
发布于
2025-03-14
许可协议
CC BY-NC-SA 4.0