设计模式之代理模式

代理模式(proxy)

1.基本介绍

• 代理模式为一个对象提供一个替身（代理对象），以控制对这个对象的访问。可以在目标对象实现基础上扩展功能（强化功能）
• 被代理的对象可能是远程对象，创建开销大的对象或者是需要安全控制的对象。
• 代理模式分几种不同的形式: 主要分为:
  • 静态代理
  • 动态代理(JDK代理)
  • Cglib代理

2.静态代理

介绍

• 静态代理在使用的时候需要定义接口或者父类，被代理对象（目标对象）与代理对象一起实现相同的接口或者继承相同的父类， 通过调用这些对应的方法对目标对象进行扩展

• 静态代理在不修改目标对象的功能前提下，通过代理对象对目标对象进行扩展

• 但是静态代理下，代理对象需要和目标对象实现一样的接口，所以可能有多个代理类，如果接口更改的话，代理对象和目标对象都要进行更改

结构图

代码演示

//接口
public interface ITeacherDao {
    void teach();//授课的方法
}
//被代理的对象(待加强的对象)
public class TeacherDao implements ITeacherDao {
    @Override
    public void teach() {
        System.out.println("老师授课中");
    }
}
//代理对象,静态代理
public class TeacherProxyDao implements ITeacherDao {
    private ITeacherDao target;//目标对象，通过接口进行依赖
    //构造器
    public TeacherProxyDao(ITeacherDao target){
        this.target = target;
    }
    @Override
    public void teach() {
        //进行对象的强化
        System.out.println("核心对象使用前做的事...");
        target.teach();
        System.out.println("核心对象使用后做的事...");
    }
}
public class Client {
    public static void main(String[] args) {
        //创建目标对象（被代理对象）
        ITeacherDao teacherDao = new TeacherDao();
        //创建代理对象，同时将被代理对象传递给代理对象
        ITeacherDao staticProxyDemo = new TeacherProxyDao(teacherDao);
        //通过代理对象，调用被代理对象的方法
        //即:执行的是代理对象，但是代理对象调用目标对象的方法
        staticProxyDemo.teach();
    }
}

运行结果

3.动态代理

介绍

• 代理对象不需要实现接口，但是目标对象需要实现接口，否则不能用动态代理
• 代理对象的生成，是利用jdk的api，动态在内存中构建代理对象
• 动态代理也称为: JDK代理，接口代理
• jdk中生成代理对象的api介绍:
  • 代理对象所在的包: java.lang.reflect.Proxy(反射机制)
  • JDK实现代理只需要使用newProxyInstance方法即可
    static Object newProxyInstance(ClassLoader loader,Class<?>[]interfaces,InvocationHandler h)

结构图

代码演示

//接口
public interface ITeacherDao {
    void teach();
    String say(String name);
}
//目标对象
public class TeacherDao implements ITeacherDao {
    @Override
    public void teach() {
        System.out.println("老师正在授课中...");
    }

    @Override
    public String say(String name) {
        return "hello"+name;
    }

}


//代理工厂
public class ProxyFactory {
    //维护一个目标对象，Object
    private Object target;

    //构造器，对target进行初始化
    public ProxyFactory(Object target) {
        this.target = target;
    }

    //给目标对象生成一个代理对象
    public Object getProxyInstance(){
        /**
         *  public static Object newProxyInstance
         *  (ClassLoader loader,Class<?>[] interfaces,InvocationHandler h)
         *
         *  1.ClassLoader loader: 指定当前目标对象使用的类加载器，获取加载器的方法固定
         *  2.interfaces:目标对象实现的接口类型，使用泛型的方式确认类型
         *  3.InvocationHandler: 事件处理，执行目标对象的方法时，会去触发事件处理器的方法，会把当前执行的目标对象方法作为参数传递(method)
         *
         *  最终返回一个代理对象，然后invoke中对代理对象进行加强（反射机制）
         *
         *
         * */
        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("核心逻辑实现前干的事");
                        //反射机制调用目标对象的方法,执行代理对象的方法
                        System.out.println("通过返回获得方法名:"+method.getName());
                        //System.out.println("通过返回获得方法参数:"+args[0]); 无参的时候可能报空指针异常
                        //方法的返回值
                        Object val = method.invoke(target,args);
                        //简单增强逻辑
                        val+="123";
                        System.out.println("核心逻辑实现后干的事");
                        return val;
                    }
                });
    }
}


public class Client {
    public static void main(String[] args) {
        //1.创建目标对象
        ITeacherDao target = new TeacherDao();

        //2.创建工厂，传入参数为target
        ProxyFactory factory = new ProxyFactory(target);
        //3.为target创建代理对象
        ITeacherDao proxyInstance = (ITeacherDao) factory.getProxyInstance();
        //4.使用代理对象（动态代理对象生成代理对象，通过反射机制生成，所以无需实现接口）
        //class com.sun.proxy.$Proxy0 内存中动态生成了代理对象
        System.out.println(proxyInstance.getClass());
        //代理对象调用目标对象的方法
        proxyInstance.teach();
        System.out.println("-----------------------------------------");
        //方法增强后
        System.out.println("增强逻辑后:"+proxyInstance.say("1z"));
    }
}

运行结果

4.Cglib代理[基于拦截器设计]

介绍

• 静态代理和JDK代理都要求目标对象实现一个接口，但是有时候目标对象如果没有实现任何的接口，这时候可以使用目标对象的子类实现代理(Cglib代理)【通过继承来代理】
• Cglib代理又称为子类代理，它是在内存中构建一个子类对象，从而实现对目标对象的功能拓展
• Cglib是一个强大的高性能代码生成包，它可以在运行期扩展java类与实现java接口，广泛被用于许多aop的框架使用，例如Spring AOP[将许多和主逻辑无关并且需要的代码用于强化核心方法，放在代理类中]
• Cglib的底层是使用字节码处理框架ASM来转换字节码，并生成新的类（字节码动态生成对象）
• 步骤:
  • 引入 cglib.jar
  • 在内存中动态构建子类，注意代理的类不能为final，否则报错 java.lang.illegalArgumentException
  • 目标对象的方法如果为final/static,那么就不会被拦截器拦截，即不会执行目标对象额外的业务方法，因此目标对象的方法不能设为final or static

结构图

代码演示

package com.liz;

//目标对象
public class TeacherDao {
    String teach() {
        System.out.println("老师正在上课");
        return "hello";
    }
}


package com.liz;
import net.sf.cglib.proxy.Enhancer;
import net.sf.cglib.proxy.MethodInterceptor;
import net.sf.cglib.proxy.MethodProxy;

import java.lang.reflect.Method;
//代理对象的生成及强化逻辑
public class ProxyFactory implements MethodInterceptor {
    //维护一个目标对象
    private Object target;

    //构造器: 传入被代理对象
    public ProxyFactory(Object target) {
        this.target = target;
    }

    //通过cglib，可以返回一个target的代理对象
    public Object getProxyInstance(){
        //1.创建一个工具类
        Enhancer enhancer = new Enhancer();
        //2.设置父类
        enhancer.setSuperclass(target.getClass());
        //3.设置回调函数
        enhancer.setCallback(this);
        //4.创建子类对象(代理对象)
        return enhancer.create();
    }

    //重写拦截方法，会调用目标对象的相关方法（此处开始强化）
    public Object intercept(Object o, Method method, Object[] args, MethodProxy methodProxy) throws Throwable {
        System.out.println("Cglib代理模式开始了");
        //拦截对象，对方法进行强化
        //方法的返回值  returnVal
        Object returnVal = method.invoke(target, args);

        //强化
        returnVal+="...强化内容";
        System.out.println(returnVal);
        System.out.println("Cglib代理模式停止了");
        return returnVal;
    }
}

//执行逻辑
public class Client {
    public static void main(String[] args) {
        //创建目标对象
        TeacherDao target = new TeacherDao();
        System.out.println(target.teach());
        System.out.println("----------开始强化------------");
        //获取到代理对象，并且将目标对象传递给代理对象
        TeacherDao instance = (TeacherDao) new ProxyFactory(target).getProxyInstance();
        System.out.println(instance.getClass());

        //执行代理对象方法，底层触发intercept拦截方法，从而实现对目标对象的调用
        System.out.println("强化结果:"+instance.teach());
    }
}

运行结果