设计模式 - 代理模式

2019-02-27 11:53:08来源：博客园阅读 ()

定义：为其他对象提供一种代理以控制对这个对象的访问。在某些情况下，一个对象不适合或者不能直接引用另一个对象，而代理对象可以在客户端和目标对象之间起到中介的作用。

其中代理类能在原来对象行为的基础上增加额外的行为，甚至可以完全替换原来的行为。代理模式主要可以分为两种：一个是静态代理，一个是动态代理

静态代理中代理类中需要手动的处理被代理对象中的所有行为，即使这个行为我们不希望做任何改变，也需要编写这个行为并直接调用被代理对象的行为。被代理的对象是固定的，这种代理是死的，在编译期的时候就生成了一个不可改变的代理类，以下是静态代理的一个基本类图

其中RealSubject为需要被代理的类；Proxy即为用来代理RealSubject的代理类，Proxy中保存一个RealSubject类的引用，这样可以访问被代理对象的行为；Subject定义了RealSubject和Proxy共用的接口，这样我们可以将任何使用RealSubject类的地方都可以替换为Proxy。来看下具体的代码

Subject接口

public interface Subject {
    void request();
}

RealSubject类

public class RealSubject implements Subject {
    @Override
    public void request() {
        System.out.println("真实的请求");
    }
}

Proxy类

public class Proxy implements Subject {

    private RealSubject realSubject;

    @Override
    public void request() {
        if (realSubject == null) {
            realSubject = new RealSubject();
        }
        realSubject.request();
    }
}

测试类的调用和输出

Proxy proxy = new Proxy();
proxy.request();

这个例子中被代理的对象中仅有一个方法，所以我就直接在代理类的该方法中来实例化一个被代理的对象，也可以直接在声明时或在构造器中实例化。代理类中可以直接调用被代理类的方法，不做任何的改变，如以上例子所示，当然也可以添加额外的行为或者不使用原来的方法，当Subject中拥有多个接口或者需要实现多个类似Subject接口的时候，代理类中需要代理被代理对象中的所有行为。

动态代理是比较灵活的，从上面的静态代理可以看出当被代理的对象很多或对象中的行为很多的时候，我们就需要在代理类中编写大量的代码甚至需要多个代理类，而动态代理就能轻松解决这些麻烦事，动态代理会在运行期时生成代理类，而要实现动态代理，我们需要代理类实现InvocationHandler接口，以下为具体的代码（其中Subject和RealSubject类似上面的，只是增加了方法，就不贴出来了）

public class DynamicProxy implements InvocationHandler {

    private Object source;

    public DynamicProxy(Object source) {
        this.source = source;
    }

    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        System.out.println("执行代理的方法");
        return method.invoke(source, args);
    }
}

测试类的调用和输出

Subject subject = (Subject) Proxy.newProxyInstance(
        ClassLoader.getSystemClassLoader(),
        new Class[]{Subject.class},
        new DynamicProxy(new RealSubject()));
subject.request1();
subject.request2();

当执行Proxy的静态方法newProxyInstance方法是生成了一个代理对象，代理对象中的方法都在用来的基础上增加了一条输出语句，其中若RealSubject没有实现Subject接口那代码能否正常运行，答案是否定的，因为代理类中invoke方法的参数method的class信息是接口Subject，所以若RealSubject类没有实现Subject，那执行method的invoke方法时将会出错，导致代理类的invoke方法出错，当然我们只要不执行method的invoke方法那代理的invoke方法仍然能正常执行，还有一种方法可以实现即使RealSubject不实现Subject接口也能够调用被代理类的方法，将method.invoke(source, args)替换成如下代码，可是明显比原来的复杂了点

Method sourceMethod = source.getClass().getDeclaredMethod(method.getName(), method.getParameterTypes());
sourceMethod.setAccessible(true);
sourceMethod.invoke(source, args);

可以通过点击以下链接获取代码和类图

代码和类图

接下来我们看下源码来了解一下代理类是如何生成的，首先我们当然是进入到Proxy的静态方法newProxyInstance中，代码附带注解如下

public static Object newProxyInstance(ClassLoader loader,
                                      Class<?>[] interfaces,
                                      InvocationHandler h) throws IllegalArgumentException {
    Objects.requireNonNull(h);
    //克隆接口的Class引用数组
    final Class<?>[] intfs = interfaces.clone();
    final SecurityManager sm = System.getSecurityManager();
    if (sm != null) {
        checkProxyAccess(Reflection.getCallerClass(), loader, intfs);
    }

    //生成代理类的Class引用
    Class<?> cl = getProxyClass0(loader, intfs);

    try {
        if (sm != null) {
            checkNewProxyPermission(Reflection.getCallerClass(), cl);
        }
        //获取构造器
        final Constructor<?> cons = cl.getConstructor(constructorParams);
        final InvocationHandler ih = h;
        //若代理类不是public修饰,取消构造器的访问权限限制
        if (!Modifier.isPublic(cl.getModifiers())) {
            AccessController.doPrivileged(new PrivilegedAction<Void>() {
                public Void run() {
                    cons.setAccessible(true);
                    return null;
                }
            });
        }
　　　　　//调用构造器来实例化一个代理对象
        return cons.newInstance(new Object[]{h});
    } catch (IllegalAccessException|InstantiationException e) {
        throw new InternalError(e.toString(), e);
    } catch (InvocationTargetException e) {
        Throwable t = e.getCause();
        if (t instanceof RuntimeException) {
            throw (RuntimeException) t;
        } else {
            throw new InternalError(t.toString(), t);
        }
    } catch (NoSuchMethodException e) {
        throw new InternalError(e.toString(), e);
    }
}

这个方法还是挺简单的，就是先生成一个代理类的Class引用，然后通过调用Class引用中的构造方法来实例化一个代理对象，其中的关键的代码就是如何获取代理类一个Class引用，让我们进入方法getProxyClass0

private static Class<?> getProxyClass0(ClassLoader loader,
                                           Class<?>... interfaces) {
    //接口的数量只能小于65535。。
    if (interfaces.length > 65535) {
        throw new IllegalArgumentException("interface limit exceeded");
    }
　　//若缓存中已经存在代理类的副本则直接返回,否则它将通过代理工厂类来创建代理类
    return proxyClassCache.get(loader, interfaces);
}

该方法中的proxyClassCache对象的声明如下所示，其中的ProxyClassFactory代码会在后面贴出来

private static final WeakCache<ClassLoader, Class<?>[], Class<?>>
        proxyClassCache = new WeakCache<>(new KeyFactory(), new ProxyClassFactory());

以下是proxyClassCache的get方法的实现

public V get(K key, P parameter) {
    Objects.requireNonNull(parameter);

    expungeStaleEntries();

    Object cacheKey = WeakCache.CacheKey.valueOf(key, refQueue);

    //通过上面生成的key来获取对应的value,其中value是一个map存的是上面用来实例化proxyClassCache的KeyFactory和ProxyClassFactory
    ConcurrentMap<Object, Supplier<V>> valuesMap = map.get(cacheKey);
    //若valueMap为null则初始化,若map中有旧的valueMap则赋值给valueMap
    if (valuesMap == null) {
        ConcurrentMap<Object, Supplier<V>> oldValuesMap
                = map.putIfAbsent(cacheKey,
                valuesMap = new ConcurrentHashMap<>());
        if (oldValuesMap != null) {
            valuesMap = oldValuesMap;
        }
    }

    //创建KeyFactory对象,并用此对象来获取提供代理类的对象
    Object subKey = Objects.requireNonNull(subKeyFactory.apply(key, parameter));
    Supplier<V> supplier = valuesMap.get(subKey);
    //提供代理类对象的工厂
    WeakCache.Factory factory = null;

    while (true) {
        //若supplier不为null,则获取代理类
        if (supplier != null) {
            V value = supplier.get();
            if (value != null) {
                return value;
            }
        }
        //若factory为null则实例化一个
        if (factory == null) {
            factory = new WeakCache.Factory(key, parameter, subKey, valuesMap);
        }
        //若supplier为空则赋值为factory并存到valueMap中
        if (supplier == null) {
            supplier = valuesMap.putIfAbsent(subKey, factory);
            if (supplier == null) {
                supplier = factory;
            }
        } else {
            //若替换成功则将supplier负责为factory,否则直接赋值为valueMap中存储的对象
            if (valuesMap.replace(subKey, supplier, factory)) {
                supplier = factory;
            } else {
                supplier = valuesMap.get(subKey);
            }
        }
    }
}

看完以上代码后可以看出关键的代码在与supplier对象的get方法和如何实例化出来的一个代理工厂类对象，让我们继续来看下Factory类的代码

private final class Factory implements Supplier<V> {

    private final K key;
    private final P parameter;
    private final Object subKey;
    private final ConcurrentMap<Object, Supplier<V>> valuesMap;

    Factory(K key, P parameter, Object subKey,
            ConcurrentMap<Object, Supplier<V>> valuesMap) {
        this.key = key;
        this.parameter = parameter;
        this.subKey = subKey;
        this.valuesMap = valuesMap;
    }

    @Override
    public synchronized V get() { // serialize access
        // re-check
        Supplier<V> supplier = valuesMap.get(subKey);
        if (supplier != this) {
            // something changed while we were waiting:
            // might be that we were replaced by a CacheValue
            // or were removed because of failure ->
            // return null to signal WeakCache.get() to retry
            // the loop
            return null;
        }
        // else still us (supplier == this)

        // create new value
        V value = null;
        try {
            value = Objects.requireNonNull(valueFactory.apply(key, parameter));
        } finally {
            if (value == null) { // remove us on failure
                valuesMap.remove(subKey, this);
            }
        }
        // the only path to reach here is with non-null value
        assert value != null;

        // wrap value with CacheValue (WeakReference)
        WeakCache.CacheValue<V> cacheValue = new WeakCache.CacheValue<>(value);

        // try replacing us with CacheValue (this should always succeed)
        if (valuesMap.replace(subKey, this, cacheValue)) {
            // put also in reverseMap
            reverseMap.put(cacheValue, Boolean.TRUE);
        } else {
            throw new AssertionError("Should not reach here");
        }

        // successfully replaced us with new CacheValue -> return the value
        // wrapped by it
        return value;
    }
}

以上代码中我们只需要关注get方法中的valueFactory对象的apply方法，该方法才是用来生成代理类的Class对象，代码如下

private static final class ProxyClassFactory
        implements BiFunction<ClassLoader, Class<?>[], Class<?>> {
    //代理类的类名的前缀
    private static final String proxyClassNamePrefix = "$Proxy";

    //代理类的编号，防止代理类名一致
    private static final AtomicLong nextUniqueNumber = new AtomicLong();

    @Override
    public Class<?> apply(ClassLoader loader, Class<?>[] interfaces) {

        Map<Class<?>, Boolean> interfaceSet = new IdentityHashMap<>(interfaces.length);
        //遍历接口数组
        for (Class<?> intf : interfaces) {
            //验证类加载器中是否存在该接口的一个Class对象
            Class<?> interfaceClass = null;
            try {
                interfaceClass = Class.forName(intf.getName(), false, loader);
            } catch (ClassNotFoundException e) {
            }
            if (interfaceClass != intf) {
                throw new IllegalArgumentException(
                        intf + " is not visible from class loader");
            }
            //判断是否是接口
            if (!interfaceClass.isInterface()) {
                throw new IllegalArgumentException(
                        interfaceClass.getName() + " is not an interface");
            }
            //验证接口是否重复
            if (interfaceSet.put(interfaceClass, Boolean.TRUE) != null) {
                throw new IllegalArgumentException(
                        "repeated interface: " + interfaceClass.getName());
            }
        }
        //代理类的包名
        String proxyPkg = null;
        int accessFlags = Modifier.PUBLIC | Modifier.FINAL;

        //验证是否存在不是public修饰的接口在不同的包中
        for (Class<?> intf : interfaces) {
            int flags = intf.getModifiers();
            if (!Modifier.isPublic(flags)) {
                accessFlags = Modifier.FINAL;
                String name = intf.getName();
                int n = name.lastIndexOf('.');
                String pkg = ((n == -1) ? "" : name.substring(0, n + 1));
                if (proxyPkg == null) {
                    proxyPkg = pkg;
                } else if (!pkg.equals(proxyPkg)) {
                    throw new IllegalArgumentException(
                            "non-public interfaces from different packages");
                }
            }
        }

        if (proxyPkg == null) {
            //如果没有非公共的接口,则包名使用com.sun.proxy
            proxyPkg = ReflectUtil.PROXY_PACKAGE + ".";
        }

        //代理类的名称
        long num = nextUniqueNumber.getAndIncrement();
        String proxyName = proxyPkg + proxyClassNamePrefix + num;

        //生成代理类的字节码文件
        byte[] proxyClassFile = ProxyGenerator.generateProxyClass(
                proxyName, interfaces, accessFlags);
        try {
            //通过字节码文件生成一个代理类的Class对象
            return defineClass0(loader, proxyName,
                    proxyClassFile, 0, proxyClassFile.length);
        } catch (ClassFormatError e) {
            /*
             * A ClassFormatError here means that (barring bugs in the
             * proxy class generation code) there was some other
             * invalid aspect of the arguments supplied to the proxy
             * class creation (such as virtual machine limitations
             * exceeded).
             */
            throw new IllegalArgumentException(e.toString());
        }
    }
}

上述代码中defineClass0是一个本地方法，可以将字节码文件生成我们需要的Class对象，而ProxyGenerator的generateProxyClass方法是用来生成字节码文件(比较复杂)，不进行源码分析。我们通过以下的代码来看下通过这个方法生成的文件内容是什么

byte[] classFile = ProxyGenerator.generateProxyClass("SubjectProxy", new Class[]{Subject.class});
File file = new File("D:/SubjectProxy.class");
FileOutputStream fos = new FileOutputStream(file);
fos.write(classFile);
fos.flush();
fos.close();

生成的文件内容

import com.ghaien.pattern.proxy.dynamic.Subject;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.lang.reflect.UndeclaredThrowableException;

public final class SubjectProxy extends Proxy implements Subject {
    private static Method m1;
    private static Method m4;
    private static Method m2;
    private static Method m3;
    private static Method m0;

    public SubjectProxy(InvocationHandler var1) throws  {
        super(var1);
    }

    public final boolean equals(Object var1) throws  {
        try {
            return (Boolean)super.h.invoke(this, m1, new Object[]{var1});
        } catch (RuntimeException | Error var3) {
            throw var3;
        } catch (Throwable var4) {
            throw new UndeclaredThrowableException(var4);
        }
    }

    public final void request2() throws  {
        try {
            super.h.invoke(this, m4, (Object[])null);
        } catch (RuntimeException | Error var2) {
            throw var2;
        } catch (Throwable var3) {
            throw new UndeclaredThrowableException(var3);
        }
    }

    public final String toString() throws  {
        try {
            return (String)super.h.invoke(this, m2, (Object[])null);
        } catch (RuntimeException | Error var2) {
            throw var2;
        } catch (Throwable var3) {
            throw new UndeclaredThrowableException(var3);
        }
    }

    public final void request1() throws  {
        try {
            super.h.invoke(this, m3, (Object[])null);
        } catch (RuntimeException | Error var2) {
            throw var2;
        } catch (Throwable var3) {
            throw new UndeclaredThrowableException(var3);
        }
    }

    public final int hashCode() throws  {
        try {
            return (Integer)super.h.invoke(this, m0, (Object[])null);
        } catch (RuntimeException | Error var2) {
            throw var2;
        } catch (Throwable var3) {
            throw new UndeclaredThrowableException(var3);
        }
    }

    static {
        try {
            m1 = Class.forName("java.lang.Object").getMethod("equals", Class.forName("java.lang.Object"));
            m4 = Class.forName("com.ghaien.pattern.proxy.dynamic.Subject").getMethod("request2");
            m2 = Class.forName("java.lang.Object").getMethod("toString");
            m3 = Class.forName("com.ghaien.pattern.proxy.dynamic.Subject").getMethod("request1");
            m0 = Class.forName("java.lang.Object").getMethod("hashCode");
        } catch (NoSuchMethodException var2) {
            throw new NoSuchMethodError(var2.getMessage());
        } catch (ClassNotFoundException var3) {
            throw new NoClassDefFoundError(var3.getMessage());
        }
    }
}