设计模式——proxy代理模式

时间 2019-11-06

标签设计模式 proxy 代理繁體版

原文原文链接

目录html

概述

定义

代理模式顾名思义，做为某对象的表明，去作某些事情。例如海淘、转运公司，代收快递等，都是生活中的代理模式。
代理模式的英文叫作Proxy或Surrogate。
定义：代理(Proxy)是一种设计模式,为其余对象提供一个代理以控制对某个对象的访问，即经过代理对象访问目标对象。
- 这样作的好处是:能够在目标对象实现的基础上,加强额外的功能操做,即扩展目标对象的功能.
  　　+ 这里使用到编程中的一个思想:不要随意去修改别人已经写好的代码或者方法,若是需改修改,能够经过代理的方式来扩展该方法
代理模式的关键点:代理对象与目标对象.代理对象是对目标对象的扩展,并会调用目标对象

角色

代理模式包含以下角色：
- Subject: 抽象角色
- Proxy: 代理角色
- RealSubject: 真实角色

为何会有代理模式？

咱们在写一个功能函数时，常常须要在其中写入与功能不是直接相关但颇有必要的代码，如日志记录，信息发送，安全和事务支持等，这些枝节性代码虽然是必要的，但它会带来如下麻烦：
- 枝节性代码游离在功能性代码以外，它不是函数的目的，这是对OO是一种破坏
- 枝节性代码会形成功能性代码对其它类的依赖，加深类之间的耦合，可重用性下降
- 从法理上说，枝节性代码应该监视着功能性代码，而后采起行动，而不是功能性代码通知枝节性代码采起行动，这比如吟游诗人应该是主动记录骑士的功绩而不是骑士主动要求诗人记录本身的功绩

应用场景

常见的代理有:
- 远程代理(Remote Proxy)：对一个位于不一样的地址空间对象提供一个局域表明对象，如RMI中的stub
- 虚拟代理(Virtual Proxy)：根据须要将一个资源消耗很大或者比较复杂的对象，延迟加载，在真正须要的时候才建立
- 保护代理(Protect or Access Proxy)：控制对一个对象的访问权限。
- 智能引用(Smart Reference Proxy)：提供比目标对象额外的服务和功能。

示例

静态代理

静态代理在使用时,须要定义接口或者父类,被代理对象与代理对象一块儿实现相同的接口或者是继承相同父类.
关键：在编译期肯定代理对象，在程序运行前代理类的.class文件就已经存在了。
好比：在代理对象中实例化被代理对象或者将被代理对象传入代理对象的构造方法

例子

模拟保存动做,定义一个保存动做的接口:IUserDao.java,而后目标对象UserDao.java实现这个接口的方法,此时若是使用静态代理方式,就须要在代理对象(UserDaoProxy.java)中也实现IUserDao接口.调用的时候经过调用代理对象的方法来调用目标对象.
须要注意的是,代理对象与目标对象要实现相同的接口,而后经过调用相同的方法来调用目标对象的方法

接口:IUserDao.java

public interface IUserDao {
    void save();
}
目标对象类:UserDao.java

public class UserDao implements IUserDao {
    public void save() {
        System.out.println("----已经保存数据!----");
    }
}
代理对象:UserDaoProxy.java

public class UserDaoProxy implements IUserDao{
    //接收保存目标对象
    private IUserDao target;
    public UserDaoProxy(IUserDao target){
        this.target=target;
    }

    public void save() {
        System.out.println("开始事务...");
        target.save();//执行目标对象的方法
        System.out.println("提交事务...");
    }
}
测试类:App.java

public class App {
    public static void main(String[] args) {
        //目标对象
        UserDao target = new UserDao();

        //代理对象,把目标对象传给代理对象,创建代理关系
        UserDaoProxy proxy = new UserDaoProxy(target);

        proxy.save();//执行的是代理的方法
    }
}

静态代理总结: 能够作到在不修改目标对象的功能前提下,对目标功能扩展.
缺点:代理类和委托类实现相同的接口，同时要实现相同的方法。这样就出现了大量的代码重复。若是接口增长一个方法，除了全部实现类须要实现这个方法外，全部代理类也须要实现此方法。增长了代码维护的复杂度。

动态代理

动态代理有如下特色:
- 在运行期，经过反射机制建立一个实现了一组给定接口的新类
- 在运行时生成的class，必须提供一组interface给它，而后该class就宣称它实现了这些 interface。该class的实例能够看成这些interface中的任何一个来用。可是这个Dynamic Proxy其实就是一个Proxy，它不会替你做实质性的工做，在生成它的实例时你必须提供一个handler，由它接管实际的工做。
- 动态代理也叫作:JDK代理,接口代理
- 接口中声明的全部方法都被转移到调用处理器一个集中的方法中处理（InvocationHandler.invoke）。这样，在接口方法数量比较多的时候，咱们能够进行灵活处理，而不须要像静态代理那样每个方法进行中转。并且动态代理的应用使咱们的类职责更加单一，复用性更强

JDK中生成代理对象的API

　　代理类所在包:java.lang.reflect.Proxy
　　JDK实现代理只须要使用newProxyInstance方法,可是该方法须要接收三个参数,完整的写法是:java

static Object newProxyInstance(ClassLoader loader, Class [] interfaces, InvocationHandler handler)
　　注意该方法是在Proxy类中是静态方法,且接收的三个参数依次为:

ClassLoader loader:指定当前目标对象使用类加载器,用null表示默认类加载器
Class [] interfaces:须要实现的接口数组
InvocationHandler handler:调用处理器,执行目标对象的方法时,会触发调用处理器的方法,从而把当前执行目标对象的方法做为参数传入

java.lang.reflect.InvocationHandler：这是调用处理器接口，它自定义了一个 invoke 方法，用于集中处理在动态代理类对象上的方法调用，一般在该方法中实现对委托类的代理访问。编程

// 该方法负责集中处理动态代理类上的全部方法调用。第一个参数既是代理类实例，第二个参数是被调用的方法对象
// 第三个方法是调用参数。
Object invoke(Object proxy, Method method, Object[] args)

代码示例:

接口类IUserDao.java以及接口实现类UserDao是同样的.在这个基础上,增长一个代理工厂类(ProxyFactory.java),将代理类写在这个地方,而后在测试类中先创建目标对象和代理对象的联系,而后使用代理对象中的同名方法segmentfault

代理工厂类:ProxyFactory.java

/**
 * 建立动态代理对象
 * 动态代理不须要实现接口,可是须要指定接口类型
 */
public class ProxyFactory{
//维护一个目标对象
private Object target;
public ProxyFactory(Object target){
    this.target=target;
}
//给目标对象生成代理对象
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("开始事务2");
                    //执行目标对象方法
                    Object returnValue = method.invoke(target, args);
                    System.out.println("提交事务2");
                    return returnValue;
                }
            }
    );
}
}
测试类:App.java

/**
 * 测试类
*/
public class App {
public static void main(String[] args) {
    // 目标对象
    IUserDao target = new UserDao();
    // 【原始的类型 class cn.itcast.b_dynamic.UserDao】
    System.out.println(target.getClass());

    // 给目标对象，建立代理对象
    IUserDao proxy = (IUserDao) new ProxyFactory(target).getProxyInstance();
    // class $Proxy0   内存中动态生成的代理对象
    System.out.println(proxy.getClass());

    // 执行方法   【代理对象】
    proxy.save();
  }
}

总结:

代理对象不须要实现接口,可是目标对象必定要实现接口,不然不能用动态代理
代理中的异常信息，须要特殊处理，抛出真实的异常信息

@Override
public Object invoke(Object instance, Method method, Object[] args) throws Throwable {
    String clazz = manager.getClass().getName();
    String methodName = method.getName();
    if (args==null)
    {
        try {
            return method.invoke(manager, args);
        } catch (InvocationTargetException e) {
            throw e.getCause();// 关键在于要抛出真实的异常，若是多层次代理调用，则须要循环处理
        }
    }
    ...
}

代码示例2

使用动态代理，增长接口的权限验证
PrivilegeValidationProxy代理类，代理调用时，增长权限验证valid
DatasetManager，真实对象

public class PrivilegeValidationProxy<T extends MetaBean> implements InvocationHandler {

    protected MetaManager<T> manager;
    public PrivilegeValidationProxy(MetaManager<T> manager) {
        super();
        this.manager = manager;
    }

    @Override
    public Object invoke(Object instance, Method method, Object[] args) throws Throwable {
        ...
        // 验证权限
        valid();
        method.invoke(manager, args);
        
    }
}

public class DatasetManager extends MetaManager<DatasetBean> implements DatasetManagerI {
    public static DatasetManagerI instance = newInstance();
    public static DatasetManagerI getInstance() {
        return instance;
    }
    public static DatasetManagerI newInstance() {
        DatasetManager manager = new DatasetManager();
        return (DatasetManagerI) Proxy.newProxyInstance(manager.getClass().getClassLoader(),
                new Class[] { DatasetManagerI.class }, new PrivilegeValidationProxy<DatasetBean>(manager));
    }
}

Cglib代理

适用于被代理的对象未实现任何接口；
上面的静态代理和动态代理模式都是要求目标对象实现一个接口或者多个接口,可是有时候目标对象只是一个单独的对象,并无实现任何的接口,这个时候就可使用构建目标对象子类的方式实现代理,这种方法就叫作:Cglib代理
Cglib代理,也叫做子类代理,它是在内存中构建一个子类对象从而实现对目标对象功能的扩展.
- Cglib是一个强大的高性能的代码生成包,它能够在运行期扩展java类与实现java接口.它普遍的被许多AOP的框架使用,例如Spring + AOP和synaop,为他们提供方法的interception(拦截)
- Cglib包的底层是经过使用字节码处理框架ASM来转换字节码并生成新的子类.
- 代理的类不能为final,不然报错；目标对象的方法若是为final/static,那么就不会被拦截,即不会执行目标对象额外的业务方法.

代码示例

目标对象类:UserDao.java

/**
 * 目标对象,没有实现任何接口
 */
public class UserDao {

    public void save() {
        System.out.println("----已经保存数据!----");
    }
}
Cglib代理工厂:ProxyFactory.java

/**
 * Cglib子类代理工厂
* 对UserDao在内存中动态构建一个子类对象
*/
public class ProxyFactory implements MethodInterceptor{
     //维护目标对象
    private Object target;

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

   //给目标对象建立一个代理对象
    public Object getProxyInstance(){
        //1.工具类
        Enhancer en = new Enhancer();
       //2.设置父类
        en.setSuperclass(target.getClass());
        //3.设置回调函数
        en.setCallback(this);
        //4.建立子类(代理对象)
        return en.create();
    }

    @Override
    public Object intercept(Object obj, Method method, Object[] args, MethodProxy proxy) throws Throwable {
        System.out.println("开始事务...");
        //执行目标对象的方法
        Object returnValue = method.invoke(target, args);
        System.out.println("提交事务...");
        return returnValue;
    }
}
测试类:

/**
 * 测试类
 */
public class App {

    @Test
    public void test(){
        //目标对象
        UserDao target = new UserDao();

        //代理对象
        UserDao proxy = (UserDao)new ProxyFactory(target).getProxyInstance();

        //执行代理对象的方法
        proxy.save();
    }
}

AOP（AspectOrientedProgramming）：

　　将日志记录，性能统计，安全控制，事务处理，异常处理等代码从业务逻辑代码中划分出来，经过对这些行为的分离，咱们但愿能够将它们独立到非业务逻辑的方法中，进而改变这些行为的时候不影响业务逻辑的代码---解耦。
**在Spring的AOP编程中:设计模式

若是加入容器的目标对象有实现接口,用JDK代理
若是目标对象没有实现接口,用Cglib代理**

参考

大部分参考自：https://segmentfault.com/a/1190000009235245
http://design-patterns.readthedocs.io/zh_CN/latest/structural_patterns/proxy.html https://upload.wikimedia.org/wikipedia/commons/thumb/7/75/Proxy_pattern_diagram.svg/400px-Proxy_pattern_diagram.svg.png