Spring前瞻——浅析Java的动态代理模式

最新推荐文章于 2022-05-22 21:05:41 发布

等一次另眼相看

最新推荐文章于 2022-05-22 21:05:41 发布

阅读量185

点赞数

分类专栏： Spring相关文章标签：动态代理

本文链接：https://blog.csdn.net/qq_44238142/article/details/90321907

版权

Spring相关专栏收录该内容

4 篇文章 0 订阅

订阅专栏

文章目录

代理模式
静态代理
java中的动态代理模式

Spring的两个主要思想就是IOC和AOP。其中最重要的AOP思想使用的就是java的动态代理模式，学习这种底层原理对于我们理解AOP思想很重要。

学习动态代理模式之前，我们要先学习静态代理模式。

如果你比较熟悉静态代理，直接跳过就可以。

代理模式

定义

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

代理模式（Proxy Pattern），最通俗的理解就是我们用一个代理类来控制另外一个类的访问，使其功能更加完善或者性能更加优越。

直接访问存在的问题

比如说：要访问的对象在远程的机器上。在面向对象系统中，有些对象由于某些原因（比如对象创建开销很大，或者某些操作需要安全控制，或者需要进程外的访问），直接访问会给使用者或者系统结构带来很多麻烦，我们可以在访问此对象时加上一个对此对象的访问层。

解决方法

使用代理模式，添加一个中间层

优点：

1、职责清晰。 2、高扩展性。 3、智能化。

缺点

1、由于在客户端和真实主题之间增加了代理对象，因此有些类型的代理模式可能会造成请求的处理速度变慢。
2、实现代理模式需要额外的工作，有些代理模式的实现非常复杂。

静态代理

案例演示

说明：提供一个Subject接口，用来提供我们想到代理的方法request，新建一个RealSubject类来实现这个接口和方法，那么RealSubject.request()需要代理的方法，我们再新建另外一个ProxySubject类也实现Subject来处理RealSubject，这个类的构造方法中一定要包含RealSbuject这个类的实例，其次，还要实现subject这个方法，然后对其进行处理。实际访问request方法时，我们需要先新建ProxySubject对象，然后给它传入一个RealSubject对象，通过ProxySubject的request方法去访问RealSubject类中的request方法。

Subject接口

public interface Subject {

    void request();
    
}

RealSubject类

public class RealSubject implements Subject {

    @Override
    public void request() {
        System.out.println("RealSubject...");
    }

}

ProxySubject类


public class ProxySubject implements Subject {
	
	// RealSubject 变量
    private RealSubject realSubject;
	
	// 无参构造，下面提供get和set方法
    public ProxySubject() {
    }

    @Override
    public void request() {
    	// 这里是关键，我们其实想要访问的是RealSubject中的request方法
    	// 但是我们会在访问前在preRequest中做一些控制
        preRequest();
        // 控制后调用原始的request方法
  		realSubject.request();
        // 执行后再做一些控制
        postRequest();

    }

    private void preRequest() {
        System.out.println("preRequest...");
      
    }

    private void postRequest() {
    
    	System.out.println("postRequest...");
    }

    public RealSubject getRealSubject() {
        return realSubject;
    }

    public void setRealSubject(RealSubject realSubject) {
        this.realSubject = realSubject;
    }
}

测试类


public class main {

    public static void main(String[] args) {

        ProxySubject proxySubject = new ProxySubject();

        proxySubject.setRealSubject(new RealSubject());

        proxySubject.request();

    }
}

// 输出：
preRequest...
RealSubject...
postRequest...

preRequest…就相当于我们做的控制，而RealSubject…就相当于被代理的方法。

这种简单的代理模式有一定的局限性，可以发现，静态代理模式下，我们的代理类ProxySubject在程序执行前已经编译完成，如果我有很多个需被代理的对象，那么岂不是针对每一个被代理的对象都要写一个与之对应的代理类，并且每个委托类中的方法还要再写相应的控制？

有没有什么方法能对这些类和方法进行统一管理呢？

下面我们来看看java中给我们提供的动态代理模式。

java中的动态代理模式

所谓动态代理，就是在运行时根据我们在Java代码中的“指示”动态生成的代理类。相比于静态代理，动态代理的优势在于可以很方便的对委托类的函数进行统一的处理，而不用修改每个委托类中的方法。

java动态代理只能对接口进行代理。

参照上面的静态代理对象，我们想一下，要实现动态代理都要有哪些必须的因素？首先，接口和接口实现类肯定要有吧（可以是一个，也可以是多个），那么针对委托类中的方法肯定要有相应的处理程序吧，处理程序和委托类怎么关联起来呢？答案就是代理类。不过，我们既然叫做动态代理类，那么它就一定不能写死喽，所以，java中的动态代理机制就是我们用调用方法的形式去创建代理类对象，代理类我们就不用自己写了，把控制放在处理程序中完成就可以了，即所谓的动态代理。

那么问题来了：

怎么创建处理程序？实现InvocationHandler接口。
怎么新建动态代理对象？调用Proxy类的方法来创建。

所以，java中的动态代理模式总是和Proxy类和InvocationHandler接口息息相关。

InvocationHandler 接口

这是API中关于这个接口的解释：

InvocationHandler是由代理实例的调用处理程序实现的接口。
每个代理实例都有一个关联的调用处理程序。当在代理实例上调用方法时，方法调用将被编码并分派到其调用处理程序的invoke方法。

上面我们已经讲到了，这个接口就是专门来写处理程序的，它有一个需要处理程序重写的方法，就是invoke方法。

invoke方法是干嘛的？

每一个代理类的实例都有一个关联的调用处理程序handler。当我们通过代理对象调用委托对象的方法的时候，这个方法的调用就会被转发为代理对象所关联的InvocationHandler处理程序invoke 方法来进行调用。

举个例子，你的委托类中有一个A方法，那么通过代理类来调用A方法时，代理类就会把这个调用转发给与之关联的处理程序，处理程序的invoke方法就是负责来调用原始委托类的A方法。

接下来想一下，invoke方法要调用另外一个类的方法，需要什么参数呢？很简单：

类名
方法名
方法的参数

invoke Object invoke(Object proxy,Method method,Object[] args)throws Throwable

invoke方法的三个形参就对应我们刚才分析的三个必须的因素：

proxy - 指我们要代理的那个委托类的真实对象
method - 指委托类中的方法对象，方法在真实对象实现的接口中定义。
args - 指上面method对象中的参数，如果方法没有参数可以为null

invoke方法会从委托类的方法中调用返回的值。（为什么？反射机制了解一下）

值得注意的是，如果返回值是基础数据类型，就必须用其对应的包装类来包装。如果此方法返回的值是null和接口方法的返回类型是基本类型，那么NullPointerException将由代理实例的方法调用抛出。

Proxy类

好了，处理程序有了，那么动态代理类的对象怎么来的呢？

Proxy这个类是java中专门来生成动态代理对象的类：

public class Proxy extends Object implements SerializableProxy

Proxy 类提供了创建动态代理类和实例的静态方法，它本身也是由这些方法创建的所有动态代理类的超类。

我们要把委托类和处理程序关联起来，那么这两个参数必须要有吧，实际上还需要另外一个参数，就是委托类实现的接口列表。（为什么？原理分析见。）

Proxy提供了很多方法，常用的是newProxyInstance()这个方法：

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

返回指定接口的代理类的实例，该接口将方法调用分派给指定的调用处理程序。

它有三个参数，分别来看一下：

ClassLoader loader - 使用类加载器来加载委托类
Class<?>[] interfaces - 委托类实现的接口列表
InvocationHandler h - 动态代理类对象需要关联的InvocationHandler对象

案例模拟

和静态代理一样，我们要有一个接口和一个接口的实现类，这个实现类就是我们的代理对象：

Subject-接口

public interface Subject {

    void request();
    
}

RealSubject-接口实现类

public class RealSubject implements Subject {

    @Override
    public void request() {
        System.out.println("RealSubject...");
    }

}

InvocationHandler-处理程序

package com.xx.test;

import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;

public class MyInvocationHandler implements InvocationHandler {

    // 定义代理对象
    private Object subject;

    // 提供处理器的构造方法
    public MyInvocationHandler(Object subject) {
        this.subject = subject;
    }

    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {

        // 模仿控制，你也可把控制写在invoke方法外边，然后在这里调用
        // invoke最关键的作用在于调用原方法
        
        System.out.println("before MyInvocationHandler...");

        // 当代理对象调用真实对象的方法时，会自动跳转到代理对象关联的handler对象的invoke方法来调用原方法
        method.invoke(subject, args);

        // 模仿控制
        System.out.println("after MyInvocationHandler....");

        return null;
    }

}

测试类：

package com.xx.test;

import java.lang.reflect.Proxy;

public class main2 {

    public static void main(String[] args) {

        // 被代理的对象
        RealSubject realSubject = new RealSubject();

        // 我们的处理程序，把realSubject这个类传进去，
        // 在处理程序做完控制后，invoke方法调用的是realSubject这个类的方法
        MyInvocationHandler handler = new MyInvocationHandler(realSubject);

        // 生成动态代理类对象，返回指定接口的实现类对象
        // realSubject.getClass().getClassLoader() 加载我们的委托对象
        // realSubject.getClass().getInterfaces() 委托对象实现的接口
        // handler 关联的处理程序
        Subject proxySubject = (Subject) Proxy.newProxyInstance(realSubject.getClass().getClassLoader(), realSubject.getClass().getInterfaces(), handler);

        // 由动态代理类来调用request方法，由处理程序来处理
        proxySubject.request();
        

    }
}

运行结果：

before MyInvocationHandler...
RealSubject...
after MyInvocationHandler....

可以看到，我们通过生成的代理类对象调用request方法，既调用了原方法，又分别在调用前和调用后做了相应的控制，这就是java的动态代理。

原理浅析

invoke方法很好理解，它的实现利用了java的反射机制，通过类名，方法名，参数就可以执行相关的方法，那么这个动态代理类究竟是怎样运作的呢？

Subject proxySubject = (Subject) Proxy.newProxyInstance(
	realSubject.getClass().getClassLoader(),
	realSubject.getClass().getInterfaces(), 
	handler);

我们刚刚就是通过这行代码创建出的动态代理对象，打印一下类名来看看：

System.out.println(proxySubject.getClass().getName());

打印出：com.sun.proxy.$Proxy0

再打印下真实对象的类名比较一下：

System.out.println(proxySubject.getClass().getName());

打印出：com.xx.test.RealSubject

Emmmm……很奇怪是吧，这个代理类为什么会是这么个名字，我们为什么又可以把它转成Subject类型的呢？首先要清除一点，这个类并不是我们程序运行前写好的，而是在jvm运行时动态生成的。

这是newProxyInstance的原码，它封装了创建代理类的过程：

 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);
        }

        /*
         * Look up or generate the designated proxy class.
         */
        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});
        } 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<?> cl = getProxyClass0(loader, intfs);

这行代码生成了我们所谓的代理类对象，loader和intfs就是我们的真实对象和它实现的接口列表，这样就不难理解为什么可以把代理类对象转成Subject类型了，显然，动态代理类在创建时一定也会实现我们委托实现的接口。我们再进入getProxyClass0()这个方法：

private static Class<?> getProxyClass0(ClassLoader loader,
                                           Class<?>... interfaces) {
        if (interfaces.length > 65535) {
            throw new IllegalArgumentException("interface limit exceeded");
        }

        // If the proxy class defined by the given loader implementing
        // the given interfaces exists, this will simply return the cached copy;
        // otherwise, it will create the proxy class via the ProxyClassFactory
        return proxyClassCache.get(loader, interfaces);
    }

哈哈哈，发现了一个有趣的东西，就是你的真实对象实现的接口必须小于65535个，以前不知道吧？！言归正传，这个方法返回return proxyClassCache.get(loader, interfaces);看来还得朝下走，不过在这之前，我们看看官方的注释，它是说：如果给定的加载器定义的代理类实现了给定的接口，那么这个方法将只返回缓存的副本; 否则，它将通过ProxyClassFactory创建代理类：

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

WeakCache方法应该就是它说的缓存，我们不用关心，我们关心的是ProxyClassFactory，好，点进去看看：

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());
            }
        }
    }

好吧，终于找到我们那个奇怪的名字来源了：

// 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();

/*
* Choose a name for the proxy class to generate.
*/
long num = nextUniqueNumber.getAndIncrement();
String proxyName = proxyPkg + proxyClassNamePrefix + num;

既然动态代理类是在运行时生成的，必须要保证他的类名唯一，那么就通过这种算法来保证。getAndIncrement()方法就是来计算代理类的个数的，从0开始，每有一个代理类，那么就给类名后缀+1，我们上面的$Proxy0就是第一个。

这个动态生成的代理类会继承Proxy类并实现Subject接口，这也是java动态代理只能对接口进行代理的原因。

能力有限，暂时只能到这个地步了，后面有时间再深入研究，谢谢。

等一次另眼相看

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Spring前瞻——浅析Java的动态代理模式

Spring的两个主要思想就是IOC和AOP。其中最重要的AOP思想使用的就是java的动态代理模式，学习这种底层原理对于我们理解AOP思想很重要。学习动态代理模式之前，我们要先学习代理模式。代理模式定义为其他对象提供一种代理以控制对这个对象的访问。在某些情况下，一个对象不适合或者不能直接引用另一个对象，而代理对象可以在客户端和目标对象之间起到中介的作用。代理模式（Proxy P...
复制链接

扫一扫