Java设计模式—代理模式（Proxy）

代理模式

代理模式基本介绍

• 为对象提供替身，控制对这个对象的访问，通过代理对象访问这个对象；好处是，可以在目标对象实现的基础上，增强额外的功能操作，扩展目标的功能
• 被代理的对象可以是远程对象，创建开销大的对象，或需要安全控制的对象
• 代理模式的形式主要三种，静态代理，动态代理（JDK代理、接口代理），cglib代理（可以在内存中动态创建对象，且不需要接口），cglib代理属于动态代理范畴

静态代理

静态代理基本介绍

• 静态代理使用时，需要定义接口或者父类，
• 代理对象与被代理对象实现相同接口或继承相同父类
• 调用时通过调用代理对象的方法来调用被代理的对象
• 实现共同接口是为了对外可以统一类型，统一方法，减少对原有代码的影响

代码实现

共同接口

public interface ITeacher {
    // 授课方法
    void teach();
}

被代理类

public class TeacherDao implements ITeacher{
    @Override
    public void teach() {
        System.out.println("老师在授课");
    }
}

代理类

// 静态代理
public class TeacherDaoProxy implements ITeacher{
    // 通过接口来聚合目标对象
    private ITeacher iTeacher;
    // 构造器
    public TeacherDaoProxy(ITeacher iTeacher) {
        this.iTeacher = iTeacher;
    }
    @Override
    public void teach() {
        System.out.println("开始代理...");
        iTeacher.teach();
        System.out.println("代理结束...");
    }
}

客户端

public class Client {
    public static void main(String[] args) {
        // 被代理对象
        ITeacher teacherDao = new TeacherDao();
        // 被代理对象
        ITeacher teacherDaoProxy = new TeacherDaoProxy(teacherDao);
        teacherDaoProxy.teach();
    }
}

静态代理优缺点

• 优点：在不修改目标对象功能的前提下，通过代理对象对目标功能进行扩展
• 缺点：因为代理对象需要与目标对象实现相同接口，所以如果目标类实现了可能会有很多代理类
• 一旦接口增加方法，目标对象与代理对象都要维护

动态代理

动态代理基本介绍

• 代理对象不需要实现接口，但是目标对象需要实现接口，否则无法使用动态代理
• 代理对象的生成，使用了JDK的API，利用反射机制，动态在内存中构建代理对象
• 动态代理也叫做，JDK代理，接口代理

JDK生成代理对象

• 代理类所在包 java.lang.reflect.Proxy
• 需要使用newProxyInstance方法，该方法需要接受三个参数

代码实现

被代理类实现的接口

public interface ITeacher {
    // 授课方法
    void teach();
    // 打招呼
    void hello();
}

被代理类

public class TeacherDao implements ITeacher{
    @Override
    public void teach() {
        System.out.println("老师在授课");
    }
    @Override
    public void hello() {
        System.out.println("老师打招呼");
    }
}

代理工厂，注意理解Proxy.newProxyInstance的参数含义，InvocationHandler的含义

public class ProxyFactory {
    // 引入目标对象，object即可
    private Object target;
    // 构造器
    public ProxyFactory(Object target) {
        this.target = target;
    }
    // 给目标对象生成代理对象
    // ClassLoader loader,指定当前目标使用的类加载器，获取方法是固定的
    // Class<?>[] interfaces,目标对象实现的接口，使用泛型方法确认类型
    // InvocationHandler h,事件处理，执行目标对象的方法时会触发事件处理器方法
    public Object getProxyInstance() {
        return Proxy.newProxyInstance(target.getClass().getClassLoader(),
                target.getClass().getInterfaces(), new InvocationHandler() {
                    @Override
                    public Object invoke(Object proxy, Method method, Object[] args)
                            throws Throwable {
                        System.out.println("JDK代理开始...");
                        // 利用反射机制调用目标方法
                        Object returnVal = method.invoke(target, args);
                        System.out.println("JDK代理结束...");
                        return returnVal;
                    }
                });
    }
}

客户端

public class Client {
    public static void main(String[] args) {
        // 创建目标对象
        ITeacher target = new TeacherDao();
        // 代理工厂创建代理对象
        ITeacher proxyInstance = (ITeacher) new ProxyFactory(target).getProxyInstance();
        // 内存中动态生成了代理对象，$表示代理对象
        System.out.println("proxyInstance="+proxyInstance.getClass());
        // 通过代理对象调用目标对象的方法
        // 代理对象在这里可以使用接口的所有方法，Proxy.newProxyInstance中的事件监听器都能找到对应的被代理的方法
        proxyInstance.teach();
        System.out.println("=========================");
        proxyInstance.hello();
    }
}

Cglib代理

Cglib代理基本介绍

• 静态代理和JDK代理模式都要求目标对象实现一个接口，如果目标对象没有实现任何接口，可也以使用目标对象子类来实现代理——cglib代理
• Cglib代理也叫子类代理，是在内存中构建一个子类对象，从而实现功能扩展，也有人将Cglib代理归属于动态代理
• Cglib是一个强大的高性能的代码生成包，他可以在运行期扩展Java类与实现Java接口，它广泛被许多AOP的框架使用，如，Spring AOP，实现方法拦截
• 在AOP编程中如何选择代理模式
  • 目标对象需要实现接口，用JDK代理
  • 目标对象不需要实现接口，用Cglib代理
• Cglib包的底层是通过使用字节码处理框架ASM来转换字节码并生成新的类
• Cglib代理的类不能是final修饰，因为不能再有子类了；如果目标对象的方法为final/static，则不会被拦截（Java底层原理），即不会执行目标对象额外的业务方法

代码实现

目标类，被代理类

public class TeacherDao {
    void teach() {
        System.out.println("老师授课中,没有实现接口");
    }
}

代理工厂

public class ProxyFactory implements MethodInterceptor {
    // 目标对象
    private Object target;
    // 构造器引入目标对象
    public ProxyFactory(Object target) {
        this.target = target;
    }
    // 返回target的代理对象
    public Object getProxyInstance() {
        // 创建工具类
        Enhancer enhancer = new Enhancer();
        // 设置父类
        enhancer.setSuperclass(target.getClass());
        // 设置回调函数
        enhancer.setCallback(this);
        // 创建子类对象,即代理对象
        return enhancer.create();
    }

    // 重写接口方法，调用目标对象方法，和invoke很像
    @Override
    public Object intercept(Object o, Method method, Object[] args, MethodProxy methodProxy)
            throws Throwable {
        System.out.println("cglib代理开始...");
        Object invoke = method.invoke(target, args);
        System.out.println("cglib代理结束...");
        return invoke;
    }
}

客户端

public class Client {
    public static void main(String[] args) {
        // 目标对象
        TeacherDao target = new TeacherDao();
        // 代理对象
        TeacherDao proxyInstance = (TeacherDao) new ProxyFactory(target).getProxyInstance();
        // 执行代理对象的方法，触发intercept方法，从而实现对目标对象的拦截
        proxyInstance.teach();
    }
}

代理模式变体

• 防火墙代理
  • 内网通过代理穿透防火墙，实现对公网的访问
• 缓存代理
  • 请求图片文件资源时，先缓存代理取，如果取到资源则ok，取不到则到公网或数据库获取，再缓存
• 远程代理
• 远程对象的本地代表，通过它可以把远程对象当本地对象来调用，远程代理通过网络和真正的远程对象沟通信息
• 同步代理
  • 主要使用在多线程编程中，完成多线程间同步工作