Java设计模式--代理模式

Posted 2020-12-19 菜鸟的奋斗之路

（1）简介

　　前段时间写的 Java 设计模式--代理模式，最近在看 Spring Aop 的时候，觉得于代理模式应该有密切的联系，于是决定了解下Spring Aop的实现原理。

　　说起AOP就不得不说下OOP了，OOP 中引入封装、继承和多态性等概念来建立一种对象层次结构，用以模拟公共行为的一个集合。但是如果我们需要为部分对象引入公共部分的时候，OOP就会引入大量重复的代码。例如：日志功能。

　　AOP技术利用一种称为“横切”的技术，解剖封装的对象内部，并将那些影响了多个类的公共行为封装到一个可重用模块，这样就能减少系统的重复代码，降低模块间的耦合度，并有利于未来的可操作性和可维护性。AOP把软件系统分为两个部分：核心关注点和横切关注点。业务处理的主要流程是核心关注点，与之关系不大的部分是横切关注点。横切关注点的一个特点是，他们经常发生在核心关注点的多处，而各处都基本相似。比如权限认证、日志、事务处理。

（2）代理模式中的角色

　　UML图解

　　

1. 抽象对象角色

　　声明了目标类及代理类对象的共同接口，这样在任何可以使用目标对象的地方都可以使用代理对象。

2. 目标对象角色

　　定义了代理对象所代表的目标对象。

3. 代理对象角色

　　代理对象内部含有目标对象的引用，从而可以在任何时候操作目标对象；代理对象和目标对象具有统一的接口，以便可以再任何时候替代目标对象。代理对象通常在客户端调用传递给目标对象之前或者之后，执行某些操作，而非单纯的将调用传递给目标对象。

（3）实现原理　　

　　前面在学习代理模式的时候，了解到代理模式分为动态代理和静态代理。现在我们就以代理模式为基础先实现我们自己的AOP框架，再来研究Spring的AOP的实现原理。

　　先以静态代理实现，静态代理关键是在代理对象和目标对象实现共同的接口，并且代理对象持有目标对象的引用。

　　公共接口代码：

public interface IHello {

    void sayHello(String str);
}

　　目标类代码：

public class Hello implements IHello {

    @Override
    public void sayHello(String str) {
        System.out.println("Hello " + str);
    }
}

　　代理类代码，我们给它添加日志记录功能，在方法开始前后执行特定的方法，是不是和AOP特别像呢？

public class ProxyHello implements IHello {

    private IHello hello;

    public ProxyHello(IHello hello) {
        this.hello = hello;
    }

    @Override
    public void sayHello(String str) {
        Logger.start();　　　　　　
        hello.sayHello(str);
        Logger.end();
    }
}

　　日志类代码：

public class Logger {

    public static void start() {
        System.out.println("date = " + new Date() + ", say hello start...");
    }

    public static void end() {
        System.out.println("date = "  + new Date() + ", say hello end...");
    }

}

　　测试代码：

public class StaticProxyTest {

    public static void main(String[] args) {
        IHello hello = new ProxyHello(new Hello()); // 如果我们需要日志功能，则使用代理类

        //IHello hello = new Hello();   // 如果我们不需要日志功能则使用目标类

        hello.sayHello("明天");
    }
    
}

　　这样我们就实现了一个最简单的AOP，但是这样会存在一个问题：如果我们像Hello这样的类很多，那么，我们是不是要去写很多个HelloProxy这样的类呢。其实也是一种很麻烦的事。在jdk1.3以后，jdk跟我们提供了一个API java.lang.reflect.InvocationHandler 的类， 这个类可以让我们在JVM调用某个类的方法时动态的为些方法做些什么事。下面我们就来实现动态代理的实现。

　　动态代理实现主要是实现 InvocationHandler，并且将目标对象注入到代理对象中，利用反射机制来执行目标对象的方法。

　　接口实现与静态代理相同，代理类代码： 

public class DynaProxyHello implements InvocationHandler{
 
    
 
     private Object target;//目标对象
 
     /**
      * 通过反射来实例化一个目标对象的代理对象
      */
     public Object bind(Object object){
         this.target = object;
         return Proxy.newProxyInstance(this.target.getClass().getClassLoader(), this.target.getClass().getInterfaces(), this);
    }
 
    @Override
     public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
         Object result = null;
         Logger.start();//添加额外的方法

         //通过反射机制来运行目标对象的方方法 
         result = method.invoke(this.target, args);
         Logger.end();
 
         return result;
    }
 
}

　　测试类代码：

public class DynaTest {

    public static void main(String[] args) {

        IHello hello = (IHello) new DynaProxyHello().bind(new Hello(), new DLogger());  // 如果我们需要日志功能，则使用代理类

        //IHello hello = new Hello();   // 如果我们不需要日志功能则使用目标类

        hello.sayHello("明天");
    }

}

　　看完上面的代码可能和Spring AOP相比有一个问题，日志类只能在方法前后打印，但是AOP应该是可以在满足条件就可以执行，所有是否可以将DynaPoxyHello对象和日志操作对象(Logger)解耦呢？

　　看下面代码实现，将 DynaPoxyHello 对象和日志操作对象(Logger)解耦：

　　我们要在被代理对象的方法前面或者后面去加上日志操作代码(或者是其它操作的代码)，那么，我们可以抽象出一个接口，这个接口里就只有两个方法：一个是在被代理对象要执行方法之前执行的方法,我们取名为start，第二个方法就是在被代理对象执行方法之后执行的方法,我们取名为end。

　　Logger的接口：

public interface Logger {

    void start(Method method);

    void end(Method method);
}

　　Logger的接口实现：

public interface Logger {

    void start(Method method);

    void end(Method method);
}

　　动态代理类：

public class DynaProxyHello implements InvocationHandler {

    /**
     * 日志类
     */
    private Object logger;

    /**
     * 目标对象
     */
    private Object target;

    public Object bind(Object target, Object logger) {
        this.target = target;
        this.logger = logger;
        /**
         * newProxyInstance 方法有三个参数：
         * ClassLoader loader: 用哪个类加载器去加载代理对
         * Class<?>[] interfaces: 动态代理类需要实现的接口
         * InvocationHandler h: 动态代理方法在执行时，会调用h里面的invoke方法去执行
         */
        return Proxy.newProxyInstance(this.target.getClass().getClassLoader(), this.target.getClass().getInterfaces(), this);
    }

    /**
     * invoke() 三个参数：
     * Objetc proxy：就是代理对象，newProxyInstance方法的返回对象
     * Method method：调用的方法
     * Object[] args: 方法中的参数
     */
    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        Object result = null;
        // 反射得到Logger的实例
        Class clazz = this.logger.getClass();

        // 反射得到操作者的Start方法
        Method start = clazz.getDeclaredMethod("start", new Class[]{Method.class});

        // 反射执行start方法
        start.invoke(this.logger, new Object[]{method});

        // 执行要处理对象的原本方法
        method.invoke(this.target, args);

        // 反射得到操作者的end方法
        Method end = clazz.getDeclaredMethod("end", new Class[]{Method.class});

        //反射执行end方法
        end.invoke(this.logger, new Object[]{method});

        return result;
    }

}

　　测试代码：

public class DynaTest {

    public static void main(String[] args) {

        IHello hello = (IHello) new DynaProxyHello().bind(new Hello(), new DLogger());  // 如果我们需要日志功能，则使用代理类

        //IHello hello = new Hello();   // 如果我们不需要日志功能则使用目标类

        hello.sayHello("明天");
    }

}

　　通过上面例子，可以发现通过动态代理和发射技术，已经基本实现了AOP的功能，如果我们只需要在方法执行前打印日志，则可以不实现end()方法，这样就可以控制打印的时机了。如果我们想让指定的方法打印日志，我们只需要在invoke（）方法中加一个对method名字的判断，method的名字可以写在xml文件中，这样我们就可以实现以配置文件进行解耦了，这样我们就实现了一个简单的spring aop框架。

（4）静态代理和动态代理过程

　　参考链接地址：https://www.cnblogs.com/V1haoge/p/5860749.html

　　1. 首先我要说的就是接口，为什么JDK的动态代理是基于接口实现的呢？

　　因为通过使用接口指向实现类实例的多态实现方式，可以有效的将具体的实现与调用之间解耦，便于后期修改与维护。

再具体的说就是我们在代理类中创建一个私有成员变量（private修饰），使用接口来指向实现类的对象（纯种的多态体现，向上转型的体现），然后在该代理类中的方法中使用这个创建的实例来调用实现类中的相应方法来完成业务逻辑功能。

这么说起来，我之前说的“将具体实现类完全隐藏”就不怎么正确了，可以改成，将具体实现类的细节向调用方完全隐藏（调用方调用的是代理类中的方法，而不是实现类中的方法）。

　　这就是面向接口编程，利用java的多态特性，实现程序代码的解耦。

　　2. 创建代理类的过程

　　如果你了解静态代理，那么你会发现动态代理的实现其实与静态代理类似，都需要创建代理类，但是不同之处也很明显，创建方式不同！

　　不同之处体现在静态代理我们知根知底，我们知道要对哪个接口、哪个实现类来创建代理类，所以我们在编译前就直接实现与实现类相同的接口，直接在实现的方法中调用实现类中的相应（同名）方法即可；而动态代理不同，我们不知道它什么时候创建，也不知道要创建针对哪个接口、实现类的代理类（因为它是在运行时因需实时创建的）。

　　虽然二者创建时机不同，创建方式也不相同，但是原理是相同的，不同之处仅仅是：静态代理可以直接编码创建，而动态代理是利用反射机制来抽象出代理类的创建过程。

（5）JDK 动态代理和 Cglib 代理区别

　　1. JDK 动态代理

　　JDK 的动态代理依靠接口实现，如果有些类并没有实现接口，则不能使用 JDK 动态代理，这就要使用 Cglib 动态代理了。

　　2. Cglib 动态代理

　　JDK 的动态代理机制只能代理实现了接口的类，而没有实现接口的类就不能实现JDK的动态代理，Cglib 是针对类来实现代理的，他的原理是对指定的目标类生成一个子类，并覆盖其中方法实现增强，但因为采用的是继承，所以不能对 final 修饰的类进行代理。

（6）JDK动态代理步骤

　　我们总结下JDK动态代理的实现步骤：

　　　　第一步：声明接口，JDK 动态代理基于接口实现，所以接口必不可少（准备工作）

　　　　第二步：声明一个真正的委托类，实现 InvocationHandler 接口，重写 invoke 方法（准备工作）

　　　　第三步：调用 Proxy 的静态方法 newProxyInstance 方法生成代理实例（生成实例时需要提供类加载器，我们可以使用接口类的加载器即可）

　　　　第四步：使用新生成的代理实例调用某个方法实现功能。（自动的调用代理实例中的 invoke() 方法进行代理操作）