Java设计模式-代理模式

本篇文章来学习一下代理模式。

代理模式从字面上讲“代理”是通过中间人来完成的，譬如我想去拿快递，但是现在我很忙没空，请小明去拿一下，这个小明就充当代理的角色。接下来我们从软件方面来详细了解一下代理模式。

代理模式

需要注意的有下面几点：

用户只关心接口功能，而不在乎谁提供了功能。上图中接口是 Subject。
接口真正实现者是上图的 RealSubject，但是它不与用户直接接触，而是通过代理。
代理就是上图中的 ProxySubject，由于它实现了 Subject 接口，所以它能够直接与用户接触。
用户调用 Proxy 的时候，Proxy 内部调用了 RealSubject。所以，Proxy 是中介者，它可以增强 RealSubject 操作。

代理模板代码：

Subject接口，提供功能。

123	public interface { void visit();}

RealSubject，但是它不与用户直接接触，而是通过代理。

public class RealSubject implements  {        public void visit() {        System.out.println("实现了Subject接口，不与用户直接交流，通过代理！");    }}

ProxySubject，由于它实现了 Subject 接口，所以它能够直接与用户接触。

1234567891011121314

public class ProxySubject implements  {    RealSubject subject;    ProxySubject(RealSubject subject) {        this.subject = subject;    }        public void visit() {                subject.visit();    }}

用户调用 Proxy 的时候，Proxy 内部调用了 RealSubject。所以，Proxy 是中介者，它可以增强 RealSubject 操作。

public class Client {    public static void main(String[] args) {        RealSubject realSubject = new RealSubject();        ProxySubject proxySubject = new ProxySubject(realSubject);        proxySubject.visit();    }}

以上便是一个简单的代理模式的通用代码模板，接下来我们详细了解一下代理模式。

代理模式分类

代理模式主要分为静态代理和动态代理。我们通过一个简单的实例来说明代理模式。就拿朋友圈做微商的例子来说明。

静态代理

假设小丽在朋友圈代理各种产品进行卖。我们可以实现一个卖的接口。

1234	//代理各种产品，朋友圈兜售。public interface ISell { void sell();}

接着我们需要一个具体的产品，比如卖面膜

public class Mianmo implements ISell {        public void sell() {        System.out.println("卖面膜！有需要联系。");    }}

接着我们需要一个代理商，小丽这个角色。

123456789101112

public class Xiaoli implements ISell {    Mianmo mianmo;    Xiaoli(Mianmo mianmo) {        this.mianmo = mianmo;    }        public void sell() {        System.out.println("我是小丽，我现在在做微商。");        mianmo.sell();    }}

最后我们进行测试

123456789

public class Client {    public static void main(String[] args) {        Mianmo mianmo = new Mianmo();        Xiaoli xiaoli = new Xiaoli(mianmo);        xiaoli.sell();    }}

打印结果如下：

我们如果要买面膜的话，一般情况下不会直接从生产商那里去买，而是通过中介如小丽或者柜台等代理商来购买，这样就实现了代理的方式。

以上便是静态代理的代码。

动态代理

动态代理和静态代理相反，通过反射机制来实现动态地生成代理者的对象，也就是说在运行前我们也不知道需要代理的是什么，譬如是卖面膜还是买衣服或者口红之类的。动态代理通过一个接口InvocationHandler，我们还是拿小丽这个例子来解释一下动态代理。

卖产品的接口ISell

123	public interface ISell { void sell();}

接着通过反射InvocationHandler来调用

123456789101112131415

public class DynamicProxy implements InvocationHandler {	//各种产品    private Object object;    DynamicProxy(Object object) {        this.object = object;    }        public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {        Object result = method.invoke(object, args);        return result;    }}

接着如果需要卖面膜的话，我们需要实现ISell接口

public class Mianmo implements ISell {    @Override    public void sell() {        System.out.println("卖面膜！有需要联系。");    }}

如果需要卖鞋子的话，同样的操作

public class Shoes implements ISell {    @Override    public void sell() {        System.out.println("卖鞋子！有需要联系。");    }}

最后我们进行就可以进行代理卖了

123456789101112131415161718

public class DynamicTest {    public static void main(String[] args) {        //卖面膜        Mianmo mianmo = new Mianmo();        InvocationHandler handler = new DynamicProxy(mianmo);        ISell iSell = (ISell) Proxy.newProxyInstance(Mianmo.class.getClassLoader(), Mianmo.class.getInterfaces(), handler);        iSell.sell();        //卖鞋子        Shoes shoes = new Shoes();        InvocationHandler handler1 = new DynamicProxy(shoes);        ISell iSell1 = (ISell) Proxy.newProxyInstance(Shoes.class.getClassLoader(), Shoes.class.getInterfaces(), handler1);        iSell1.sell();    }}

最后打印输出结果

动态代理并没有像静态代理那样为面膜和鞋子各自生成一个代理类，而是通过 Proxy.newProxyInstance 的方法来动态生成一个代理类。如果我们需要卖化妆品啊、卖电脑、手表之类的，只需要实现 ISell 接口就行了。

代理模式源码简析

我们在静态代理中会手动生成一个代理类，但是在动态代理中却没有，而是通过 Proxy.newProxyInstance 生成的，这里面肯定会自动给你生成一个 new ISell() 的操作。接下来我们就得进入源码中分析，看看是否是这样的。

首先进入 newProxyInstance 方法中去看下

1234567891011121314151617181920212223242526272829303132333435363738

@CallerSensitive   public static Object newProxyInstance(ClassLoader loader,                                         Class<?>[] interfaces,                                         InvocationHandler h)       throws IllegalArgumentException   {       Objects.requireNonNull(h);       final Class<?>[] intfs = interfaces.clone();       final SecurityManager sm = System.getSecurityManager();       if (sm != null) {           checkProxyAccess(Reflection.getCallerClass(), loader, intfs);       }       //生成代理类       Class<?> cl = getProxyClass0(loader, intfs);       /*        * Invoke its constructor with the designated invocation handler.        */       try {           if (sm != null) {               checkNewProxyPermission(Reflection.getCallerClass(), cl);           }           final Constructor<?> cons = cl.getConstructor(constructorParams);           final InvocationHandler ih = h;           if (!Modifier.isPublic(cl.getModifiers())) {               AccessController.doPrivileged(new PrivilegedAction<Void>() {                   public Void run() {                       cons.setAccessible(true);                       return null;                   }               });           }           return cons.newInstance(new Object[]{h});       }    }

newProxyInstance 的确创建了一个实例，它是通过 cl 这个 Class 文件的构造方法反射生成。cl 由 getProxyClass0() 方法获取。

123456789

private static Class<?> getProxyClass0(ClassLoader loader,                                          Class<?>... interfaces) {       if (interfaces.length > 65535) {           throw new IllegalArgumentException("interface limit exceeded");       }       //从缓存中获取，如果不存在则通过 ProxyClassFactory 生成       return proxyClassCache.get(loader, interfaces);   }

ProxyClassFactory 这个方法内容很长，

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899

private static final class ProxyClassFactory        implements BiFunction<ClassLoader, Class<?>[], Class<?>>    {        // prefix for all proxy class names        private static final String proxyClassNamePrefix = "$Proxy";        // next number to use for generation of unique proxy class names        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) {                /*                 * Verify that the class loader resolves the name of this                 * interface to the same Class object.                 */                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");                }                /*                 * Verify that the Class object actually represents an                 * interface.                 */                if (!interfaceClass.isInterface()) {                    throw new IllegalArgumentException(                        interfaceClass.getName() + " is not an interface");                }                /*                 * Verify that this interface is not a duplicate.                 */                if (interfaceSet.put(interfaceClass, Boolean.TRUE) != null) {                    throw new IllegalArgumentException(                        "repeated interface: " + interfaceClass.getName());                }            }            String proxyPkg = null;     // package to define proxy class in            int accessFlags = Modifier.PUBLIC | Modifier.FINAL;            /*             * Record the package of a non-public proxy interface so that the             * proxy class will be defined in the same package.  Verify that             * all non-public proxy interfaces are in the same package.             */            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) {                // if no non-public proxy interfaces, use com.sun.proxy package                proxyPkg = ReflectUtil.PROXY_PACKAGE + ".";            }            /*             * Choose a name for the proxy class to generate.             */            long num = nextUniqueNumber.getAndIncrement();            String proxyName = proxyPkg + proxyClassNamePrefix + num;            /*             * Generate the specified proxy class.             */            byte[] proxyClassFile = ProxyGenerator.generateProxyClass(                proxyName, interfaces, accessFlags);            try {                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());            }        }    }

这个方法，通过类加载器和 interfaces 来生成一个代理类，代理类的命名规则是“包名+前缀+id”

123	// prefix for all proxy class namesprivate static final String proxyClassNamePrefix = "$Proxy";String proxyName = proxyPkg + proxyClassNamePrefix + num;

在这里就可以动态生成代理类了。

我们接下来验证一下是否是这样子。在上面的测试 main 方法中添加以下代码：

123	System.out.println("dynamicProxy class name:"+iSell.getClass().getName());System.out.println("dynamicProxy1 class name:"+iSell1.getClass().getName());

打印结果为：