深入浅出JDK动态代理

Posted 2020-08-16

1.何为代理
　　代理，即代替主角完成一些额外的事情。例如，明星都有经纪人，明星参演电影之前，经纪人作为明星的代理人和出资方洽谈片酬、排期等，而真正参与拍戏的还是明星本人，明星拍完戏后，由经纪人代理明星去清算片酬等。Java中的代理机制就是在目标方法执行前后执行一些额外的操作，如安全检查、记录日志等，Java中的代理分为静态代理和动态代理。

2.静态代理
　　首先看一下静态代理，直接上代码，代码模拟了登录操作。

public interface LoginService {
    void login();
}
public class LoginServiceImpl implements LoginService {
    @Override
    public void login() {
        System.out.println("login");
    }
}
public class LoginServiceProxy implements LoginService {
    private LoginService loginService;
    public LoginServiceProxy(LoginService loginService) {
        this.loginService = loginService;
    }
    @Override
    public void login() {
        beforeLogin();
        loginService.login();
        afterLogin();
    }
    private void beforeLogin() {
        System.out.println("before login");
    }
    private void afterLogin() {
        System.out.println("after login");
    }
}
public class Client {
    @Test
    public void test() {
        LoginService loginService = new LoginServiceImpl();
        LoginService loginServiceProxy = new LoginServiceProxy(loginService);
        loginServiceProxy.login();
    }
}

输出结果如下：

before login
login
after login

上面代码实现的静态代理很容易理解，使用聚合方式，在登录操作前后执行额外的操作。静态代理方式可以看得到具体代理类的代码，且代码由程序员编写，在编译之后会生成相应的class文件。使用静态代理方式的缺点，如果需要对LoginService接口中有N个方法都代理，则需要在代理类中创建N个代理方法，并且需要编写重复的代理操作代码。

3.概念解释
　　目标接口，即对目标操作的抽象，如LoginService。
　　目标类，即目标接口的实现类，如LoginServiceImpl。
　　目标对象，即目标类的实例。
　　代理类，即目标类的代理，如LoginServiceProxy。
　　代理对象，即代理类的实例。

4.动态代理
　　动态代理，即在运行时根据目标接口动态生成的代理类。动态代理方式生成的代理类在编译后不会生成实际的class文件，而是在运行时动态生成类字节码，并加载到JVM中使用。下面使用JDK的动态代理机制模拟登录操作，具体代码如下。

public interface LoginService {
    void login();
}
public class LoginServiceImpl implements LoginService {
    @Override
    public void login() {
        System.out.println("login");
    }
}
public class ProxyInvocationHandler implements InvocationHandler {
    private LoginService loginService;
    public ProxyInvocationHandler(LoginService loginService) {
        this.loginService = loginService;
    }
    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        beforeLogin();
        Object invokeResult = method.invoke(loginService, args);
        afterLogin();
        return invokeResult;
    }
    private void beforeLogin() {
        System.out.println("before login");
    }
    private void afterLogin() {
        System.out.println("after login");
    }
}
public class Client {
    @Test
    public void test() {
        LoginService loginService = new LoginServiceImpl();
        ProxyInvocationHandler proxyInvocationHandler = new ProxyInvocationHandler(loginService);
        LoginService loginServiceProxy = (LoginService) Proxy.newProxyInstance(loginService.getClass().getClassLoader(), loginService.getClass().getInterfaces(), proxyInvocationHandler);
        loginServiceProxy.login();
        createProxyClassFile();
    }
    public static void createProxyClassFile() {
        String name = "LoginServiceProxy";
        byte[] data = ProxyGenerator.generateProxyClass(name, new Class[]{LoginService.class});
        try {
            FileOutputStream out = new FileOutputStream("/Users/" + name + ".class");
            out.write(data);
            out.close();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

　　输出结果如下。

before login
login
after login

　　JDK动态代理方式实现代理的步骤如下：
　　1.编写目标接口；
　　2.编写目标类实现目标接口，实现目标方法的具体逻辑；
　　3.编写一个代理处理器类实现InvocationHandler接口，重写invoke方法，用于指定运行时将生成的代理类需要完成的具体操作，包括beforeLogin和afterLogin。代理对象调用任何代理方法时都会调用这个invoke方法；
　　4.创建代理对象，使用代理对象调用代理方法。

　　上面的步骤中主要涉及以下两个类：java.lang.reflect.InvocationHandler和java.lang.reflect.Proxy。InvocationHandler是一个接口，代理类的调用处理器，每个代理对象都具有一个关联的调用处理器，用于指定动态生成的代理类需要完成的具体操作。该接口中有一个invoke方法，代理对象调用任何目标接口的方法时都会调用这个invoke方法，在这个方法中进行目标类的目标方法的调用。Proxy提供静态方法用于创建动态代理类和代理类实例，同时，使用它提供的方法创建的代理类都是它的子类。这个类中主要关注newProxyInstance方法，该方法用于创建代理类对象，方法声明如下：

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

loader参数用于指示使用哪个类加载器加载这个代理类；interfaces表示代理类实现的接口列表；h表示使用哪个调用处理器。

　　后续文章《深入浅出JDK动态代理(二)》会深入源码分析JDK动态代理生成的代理类是什么样，为什么调用代理类的任何方法时都一定会调用invoke方法，值得期待！