Java 动态代理详解与实战示例

Java 动态代理详解与实战示例

Java 动态代理是 Java 提供的一种机制，它允许程序在运行时创建代理类，并在不改变代理类代码的情况下为方法调用添加额外的功能。动态代理的核心是 java.lang.reflect 包中的 Proxy 类和 InvocationHandler 接口。

1. 动态代理的基本概念

动态代理是一种在运行时创建代理对象的技术，可以在不修改原始对象代码的情况下为方法调用添加额外的行为。Java 提供了两种代理方式：

• 接口代理（基于 java.lang.reflect.Proxy）：用于代理实现了接口的类。
• 类代理（基于第三方库如 CGLIB）：用于代理没有实现接口的类。
  本文主要介绍接口代理。

2. InvocationHandler 接口

InvocationHandler 是动态代理的核心接口。它定义了 invoke 方法，代理对象的每个方法调用都会被重定向到这个 invoke 方法。

public interface InvocationHandler {
    Object invoke(Object proxy, Method method, Object[] args) throws Throwable;
}

3. Proxy 类

Proxy 类提供了静态方法 newProxyInstance 用于创建代理对象：

public static Object newProxyInstance(ClassLoader loader,
                                      Class<?>[] interfaces,
                                      InvocationHandler h)
        throws IllegalArgumentException

参数说明：

• loader：定义代理类的类加载器。
• interfaces：代理类实现的接口列表。
• h：InvocationHandler 实例。

4. 动态代理示例

4.1 定义接口和实现类

interface Hello {
    void sayHello();
}

class HelloImpl implements Hello {
    public void sayHello() {
        System.out.println("Hello, world!");
    }
}

4.2 自定义 InvocationHandler

class HelloInvocationHandler implements InvocationHandler {
    private final Object target;

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

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

4.3 创建代理对象并调用方法

public class DynamicProxyExample {
    public static void main(String[] args) {
        // 创建目标对象
        Hello hello = new HelloImpl();

        // 创建 InvocationHandler 实例
        InvocationHandler handler = new HelloInvocationHandler(hello);

        // 创建代理对象
        Hello proxy = (Hello) Proxy.newProxyInstance(
            hello.getClass().getClassLoader(),
            hello.getClass().getInterfaces(),
            handler
        );

        // 调用代理对象的方法
        proxy.sayHello();
    }
}

4.4 输出结果

Before method sayHello
Hello, world!
After method sayHello

5. 动态代理的高级用法

5.1 动态代理用于日志记录

动态代理可以用于在方法调用前后记录日志。

class LoggingInvocationHandler implements InvocationHandler {
    private final Object target;

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

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

5.2 动态代理用于性能监控

动态代理可以用于监控方法的执行时间。

class TimingInvocationHandler implements InvocationHandler {
    private final Object target;

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

    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        long start = System.nanoTime();
        Object result = method.invoke(target, args);
        long end = System.nanoTime();
        System.out.println("Execution of " + method.getName() + " took " + (end - start) + " ns");
        return result;
    }
}

6. 动态代理的优势

• 代码复用：可以通过动态代理实现常见的横切关注点（如日志记录、事务管理、性能监控等），减少重复代码。
• 解耦：通过代理对象和目标对象分离，降低模块之间的耦合度。
• 灵活性：可以在运行时动态地改变代理行为，增强程序的灵活性和扩展性。

7. 总结

Java 动态代理是一种强大的技术，可以在不修改现有代码的情况下为方法调用添加额外的行为。通过使用 InvocationHandler 和 Proxy 类，可以轻松地实现各种代理模式，如日志记录、性能监控等。这种机制在很多 Java 框架（如 Spring AOP）中得到了广泛应用。