Java 设计模式（结构型）

代理设计模式（Proxy）

Posted by 余腾 on 2019-08-08
Estimated Reading Time 8 Minutes
Words 2.1k In Total
Viewed Times

什么是代理设计模式？

代理设计模式 —> 结构型模式

代理模式：为一个对象提供一个替身，以控制对这个对象的访问，可以详细访问某个对象的方法。即通过代理对象访问目标对象，这样做的好处是可以在目标对象实现的基础上，增强额外的功能操作，即扩展目标对象的功能。

分类：

  • 静态代理
  • 动态代理（JDK代理、接口代理）— javaassist 字节码操作
  • CGLib 代理（Code Generation Library，动态代理范畴，在内存动态创建对象，不需要实现接口）

静态代理（Static Proxy）

静态代理在使用时，需要定义接口或者父类，被代理对象(即目标对象)与代理对象一起实现相同的接口或者是继承相同父类。然后通过调用相同的方法来调用目标对象的方法。

定义接口 static

1
2
3
public interface ITeacherDao {
    void teach();
}

被代理对象 static

1
2
3
4
5
6
public class TeacherDao implements ITeacherDao {
    @Override
    public void teach() {
        System.out.println("老师授课！");
    }
}

代理对象 static

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
//静态代理
public class TeacherDaoProxy implements ITeacherDao {

    private TeacherDao target;

    //构造器
    public TeacherDaoProxy(TeacherDao target) {
        this.target = target;
    }

    @Override
    public void teach() {
        System.out.println("代理对象...开始！---> 提前完成一些事情！");
        target.teach();//TODO 执行目标方法
        System.out.println("代理对象...结束！---> 提交");
    }
}

使用代理对象 static

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
public class Client {

    public static void main(String[] args) {

        //创建目标，被代理对象
        TeacherDao teacherDao = new TeacherDao();

        //创建 代理对象，同时把被代理对象传给代理对象
        TeacherDaoProxy teacherDaoProxy = new TeacherDaoProxy(teacherDao);

        //通过代理对象的方法，调用被代理对象的方法
        teacherDaoProxy.teach();
    }
}

//TODO
代理对象...开始！---> 提前完成一些事情！
老师授课！
代理对象...结束！---> 提交
  • 优点：在不修改目标对象的功能前提下，能通过代理对象对目标功能扩展。
  • 缺点：因为代理对象需要与目标对象实现一样的接口，所以会有很多代理类，一旦接口增加方法，目标对象与代理对象都要维护。

JDK 动态代理（Dynamic Proxy）

动态代理也叫做：JDK代理（反射机制） or 接口代理

  • 代理类所在包：java.lang.reflect.Proxy

    • JDK 实现代理只需要使用 newProxyInstance方法，但是该方法需要接受三个参数。

  • 代理对象，不需要实现接口，但是目标对象(被代理对象)要实现接口，否则不能用动态代理；

  • 代理对象的生成，是利用 JDK 的API，动态的在内存中构建代理对象。

    • 通过为 Proxy 类指定 ClassLoader 对象和一组 Class<?>[] interfaces来创建动态代理；
    • 通过实现 InvocationHandler 接口创建自己的调用处理器；
    • 通过反射机制获取动态代理类的构造函数，其唯一参数类型就是调用处理器接口类型；
    • 通过构造函数创建动态代理类实例，构造时调用处理器对象作为参数传入；

定义接口 Dynamic

1
2
3
4
5
6
public interface ITeacherDao {

    void teach();

    String write(String name);
}

被代理对象 Dynamic

1
2
3
4
5
6
7
8
9
10
11
12
public class TeacherDao implements ITeacherDao {
    @Override
    public void teach() {
        System.out.println("老师授课！");
    }

    @Override
    public String write(String name) {
        System.out.println("name:" + name);
        return "success！";
    }
}

代理对象 Dynamic

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
import java.lang.reflect.Proxy;

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、Class<?>[] interfaces：目标对象实现的接口类型，使用泛型方法确实类型
         * 3、InvocationHandler h：事情处理，执行目标对象的方法时，会触发事件处理器方法，会把当前执行的目标对象方法作为参数传入
         */
        return Proxy.newProxyInstance(target.getClass().getClassLoader(),
                target.getClass().getInterfaces(), (proxy, method, args) -> {
                    System.out.println("JDK 代理！");
                    Object invoke = method.invoke(target, args);
                    System.out.println("JDK 代理结束！");
                    return invoke;
                });
    }
}

使用代理对象 Dynamic

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
public class Client {
    public static void main(String[] args) {

        //创建目标，被代理对象
        TeacherDao target = new TeacherDao();

        //给目标对象创建代理对象
        //返回用接口接收，因为只有接口才能保证代理对象和目标对象方法一致
        ITeacherDao proxyInstance = (ITeacherDao) new ProxyFactory(target).getProxyInstance();

        //class com.sun.proxy.$Proxy0 内存中生成的代理对象
        System.out.println(proxyInstance.getClass());
        proxyInstance.teach();
        System.out.println("=====================");
        String str = proxyInstance.write("余腾");
        System.out.println(str);
    }
}

//TODO
class com.sun.proxy.$Proxy0
JDK 代理！
老师授课！
JDK 代理结束！
=====================
JDK 代理！
name:余腾
JDK 代理结束！
success！

CGLib 代理（Code Generation Library）

静态代理 和 JDK代理 都要求目标对象是实现一个接口，但是有时候目标对象只是一个单独的对象，并没有实现任何的接口，这个时候可使用目标对象子类来实现代理，这就是Cglib代理。

  • CGLib 代理也叫作子类代理，CGLib可以为一个类创建一个子类，在子类中采用方法拦截的技术拦截所有父类方法的调用并顺势织入横切逻辑。在内存中构建一个子类对象从而实现对目标对象功能扩展，有些书也将CGLib 代理归属到动态代理。
  • CGLib 是一个强大的高性能的代码生成包，它可以在运行期扩展 java类 与 实现java接口。它广泛的被许多AOP的框架使用，例如Spring AOP，实现方法拦截。
  • 在AOP编程中如何选择代理模式
    • 目标对象需要实现接口，用JDK代理；
    • 目标对象不需要实现接口，用CGLib代理；
  • CGLib包的底层是通过使用字节码处理框架ASM来转换字节码并生成新的类。

使用

  • 1、需要 CGLib Jar 包；

  • 2、在内存中动态构建子类，注意代理的类不能为 Final，否则报错。

    • java.lang. llgalArgumentException

  • 3、目标对象的方法如果为 final/static，那么就不会被拦截，即不会执行目标对象额外的业务方法。

引入 Jar 包

1
2
3
4
5
6
<!--CGLib 动态代理-->
<dependency>
    <groupId>cglib</groupId>
    <artifactId>cglib</artifactId>
    <version>3.1</version>
</dependency>

被代理对象 CGLib

1
2
3
4
5
6
7
8
9
10
11
public class TeacherDao {

    public void teach() {
        System.out.println("老师授课！");
    }

    public String write(String name) {
        System.out.println("name:" + name);
        return "success！";
    }
}

代理对象 CGLib

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
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 {

    //维护一个目标对象，Object
    private Object target;

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

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

    @Override
    public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
        System.out.println("CGLib 代理！");
        Object invoke = method.invoke(target, objects);
        System.out.println("CGLib 代理结束！");
        return invoke;
    }
}

使用代理对象 CGLib

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
public class Client {
    public static void main(String[] args) {

        //创建目标，被代理对象
        TeacherDao target = new TeacherDao();

        //创建代理对象，将目标对象传递给代理对象
        TeacherDao proxyInstance = (TeacherDao) new ProxyFactory(target).getProxyInstance();

        System.out.println(proxyInstance.getClass());
        proxyInstance.teach();
        System.out.println("=====================");
        String str = proxyInstance.write("余腾");
        System.out.println(str);
    }
}

//TODO
class Proxy.CGLibProxy.TeacherDao$$EnhancerByCGLIB$$b5ad6712
CGLib 代理！
老师授课！
CGLib 代理结束！
=====================
CGLib 代理！
name:余腾
CGLib 代理结束！
success！

代理变体

  • 防火墙代理：内网通过代理穿透防火墙，实现对公网的访问。

  • 缓存代理：当请求图片文件等资源时，先到缓存代理取，如果取到资源则ok，如果取不到资源，再到公网或者数据库取，然后缓存。

  • 远程代理：远程对象的本地代表，通过它可以把远程对象当本地对象来调用。远程代理通过网络和真正的远程对象沟通信息。

  • 安全代理：屏蔽对真实角色的直接访问。

  • 延迟加载：先加载轻量级的代理对象，真正需要再加载真实对象。

  • 同步代理：主要使用在多线程编程中，完成多线程间同步工作。

感谢阅读

If you like this blog or find it useful for you, you are welcome to comment on it. You are also welcome to share this blog, so that more people can participate in it. If the images used in the blog infringe your copyright, please contact the author to delete them. Thank you !

FEATURED TAGS
Java 设计模式（结构型）
FRIENDS
ESC