第六章结构型模式—代理模式
文章目录
- 代理模式
- 解决的问题
- 概念
- 结构
- 静态代理
- 动态代理
- 织入的概念
- JDK 动态代理
- JDK 动态代理分析
- CGLIB 动态代理
- 三种代理的对比
- JDK 和 CGLIB 的区别
- 动态代理和静态代理的对比
- 代理模式的优缺点
- 使用场景
结构型模式描述如何将类或对象按某种布局组成更大的结构，有以下两种：
-
类结构型模式：采用继承机制来组织接口和类。
-
对象结构型模式：釆用组合或聚合来组合对象。
由于组合关系或聚合关系比继承关系耦合度低，满足 “合成复用原则”，所以对象结构型模式比类结构型模式具有更大的灵活性。
结构型模式分为以下 7 种：
-
代理模式
-
适配器模式
-
装饰者模式
-
桥接模式
-
外观模式
-
组合模式
-
享元模式
代理模式
解决的问题
计数器的接口
public interface Calculator {
int add(int i, int j);
int sub(int i, int j);
int mul(int i, int j);
int div(int i, int j);
}
- 有四个功能 加减乘除
计数器的普通实现类
public class CalculatorImpl implements Calculator {
@Override
public int add(int i, int j) {
int result = i + j;
System.out.println("方法内部 result = " + result);
return result;
}
@Override
public int sub(int i, int j) {
int result = i - j;
System.out.println("方法内部 result = " + result);
return result;
}
@Override
public int mul(int i, int j) {
int result = i * j;
System.out.println("方法内部 result = " + result);
return result;
}
@Override
public int div(int i, int j) {
int result = i / j;
System.out.println("方法内部 result = " + result);
return result;
}
}
带有日志功能的计算机实现类
public class CalculatorLogImpl implements Calculator {
@Override
public int add(int i, int j) {
System.out.println("[日志] add 方法开始了，参数是：" + i + "," + j);
int result = i + j;
System.out.println("方法内部 result = " + result);
System.out.println("[日志] add 方法结束了，结果是：" + result);
return result;
}
@Override
public int sub(int i, int j) {
System.out.println("[日志] add 方法开始了，参数是：" + i + "," + j);
int result = i - j;
System.out.println("方法内部 result = " + result);
System.out.println("[日志] add 方法结束了，结果是：" + result);
return result;
}
@Override
public int mul(int i, int j) {
System.out.println("[日志] add 方法开始了，参数是：" + i + "," + j);
int result = i * j;
System.out.println("方法内部 result = " + result);
System.out.println("[日志] add 方法结束了，结果是：" + result);
return result;
}
@Override
public int div(int i, int j) {
System.out.println("[日志] add 方法开始了，参数是：" + i + "," + j);
int result = i / j;
System.out.println("方法内部 result = " + result);
System.out.println("[日志] add 方法结束了，结果是：" + result);
return result;
}
}
提出问题
现有代码缺陷 针对带日志功能的实现类，我们发现有如下缺陷：
- 对核心业务功能有干扰，导致程序员在开发核心业务功能时分散了精力
- 我们计算机中，加减乘除是我们的核心业务，日志功能则不是，如果在开发计算机还需要去关心日志功能的实现，是不好的
- 附加功能分散在各个业务功能方法中，不利于统一维护
- 我们的每个方法中，都需要去写相似的代码，很冗余
解决思路
- 解决这两个问题，核心就是：解耦。我们需要把附加功能从业务功能代码中抽取出来。
遇到的困难
解决问题的困难：要抽取的代码在方法内部，靠以前把子类中的重复代码抽取到父类的方式没法解决。所以需要引入新的技术。
- 把子类重复的代码抽取到父类，是我们面对对象的思想，但是面对对象是
必须抽取一段连续的代码进行封装，是纵向继承的 - 但是类似我们上面的日志功能的代码是分散在代码中，是无法通过面对对象的思想进行抽取
概念
二十三种设计模式中的一种，属于结构型模式。它的作用就是通过提供一个代理类，让我们在调用目标方法的时候，不再是直接对目标方法进行调用，而是通过代理类间接调用。让不属于目标方法核心逻辑的代码从目标方法中剥离出来——解耦。调用目标方法时调用代理对象的方法，减少对目标方法的调用和打扰，同时让附加功能能够集中在一起也有利于统一维护。
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-gSB9uK3e-1682961402470)(C:\Users\lsc07\Desktop\学习资料\19typora笔记\15设计模式\第六章结构型模式—代理模式.assets\未命名绘图.drawio4.png)]
-
当访问对象不适合或者不能直接引用目标对象，可以提供一个代理以控制对该对象的访问，代理对象作为访问对象和目标对象之间的中介。
-
Java 中的代理按照代理类生成时机不同又分为静态代理和动态代理；
-
静态代理代理类在编译期就生成，而动态代理代理类则是在 Java 运行时动态生成；
-
动态代理又有 JDK 代理和 CGLib 代理两种。
-
生活中的代理
- 我们去旅游，可以直接去买门票，也可以找旅游团，找旅游团就是代理模式，结果最后都是去到一个地方旅游，我们找旅游团，是包接送和吃饭的
结构
代理（Proxy）模式分为三种角色：
- 抽象主题类： 通过接口或抽象类声明真实主题和代理对象实现的业务方法。
- 真实主题类： 实现了抽象主题中的具体业务，是代理对象所代表的真实对象，是最终要引用的对象。
- 代理类 ： 提供了与真实主题相同的接口，其内部含有对真实主题的引用，它可以访问、控制或扩展真实主题的功能。
例如买电脑时，是通过 “旅游团” 代理 “黄山旅游” 和 “泰山旅游” 进行旅游。
“旅游的规范（旅游时需要做什么事）”就是抽象主题类，“黄山旅游” 和 “泰山旅游” 就是 真实主题类，”旅游团“ 就是代理类。
相关术语
- 代理：将非核心逻辑剥离出来以后，封装这些非核心逻辑的类、对象、方法。
- 目标：被代理“套用”了核心逻辑代码的类、对象、方法
静态代理
public class CalculatorStaticProxy implements Calculator {
private CalculatorImpl calculator= new CalculatorImpl();
@Override
public int add(int i, int j) {
System.out.println("[日志] add 方法开始了，参数是：" + i + "," + j);
int result=calculator.add(1,2);
System.out.println("[日志] add 方法结束了，结果是：" + result);
return result;
}
@Override
public int sub(int i, int j) {
System.out.println("[日志] add 方法开始了，参数是：" + i + "," + j);
int result=calculator.sub(1,2);
System.out.println("[日志] add 方法结束了，结果是：" + result);
return result;
}
}
- 静态代理确实实现了解耦，但是由于代码都写死了，完全不具备任何的灵活性。就拿日志功能来说，将来其他地方也需要附加日志，那还得再声明更多个静态代理类，那就产生了大量重复的代码，日志功能还是分散的，没有统一管理。
- 提出进一步的需求：将日志功能集中到一个代理类中，将来有任何日志需求，都通过这一个代理类来实现。这就需要使用动态代理技术了。
动态代理
织入的概念
织入（Weaving）：代理的生成时机，织入是把切面应用到目标对象并创建新的代理对象的过程，切面在指定的连接点被织入到目标对象中。在目标对象的生命周期里有多个点可以进行织入：
-
编译期：切面在目标类编译时被织入。这种方式需要特殊的编译器。AspectJ的织入编译器就是以这种方式织入切面的。
-
类加载器：切面在目标类加载到JVM时被织入。这种方式需要特殊的类加载器（ClassLoader）,它可以在目标类被引入应用之前增强该目标类的字节码。AspectJ5的加载时织入（load-timeweaving. LTW）就支持以这种方式织入切面。
-
运行期：切面在应用运行的某一时刻被织入。一般情况下，在织入切面时，AOP容器会为目标对象动态创建一个代理对象。SpringAOP就是以这种方式织入切面的。
此种实现在设计模式上称为动态代理模式，在实现的技术手段上，都是在 class 代码运行期，动态的织入字节码。
我们学习 Spring 框架中的AOP，主要基于两种方式：JDK 及 CGLIB 的方式。这两种方式的代理目标都是被代理类中的方法，在运行期，动态的织入字节码生成代理类。
- CGLIB是Java中的动态代理框架，主要作用就是根据目标类和方法，动态生成代理类。
- Java中的动态代理框架，几乎都是依赖字节码框架（如 ASM，Javassist 等)实现的。
- 字节码框架是直接操作 class 字节码的框架。可以加载已有的class字节码文件信息，修改部分信息，或动态生成一个 class。
我们使用动态代理实现上面案例，先说说 JDK 提供的动态代理。
JDK 动态代理
Java 中提供了一个动态代理类 Proxy，Proxy 并不是我们上述所说的代理对象的类，而是提供了一个创建代理对象的静态方法（newProxyInstance 方法）来获取代理对象。
注：JDK 动态代要求必须定义接口，因为它只能对接口进行代理。
计数器接口
public interface Calculator {
int add(int i, int j);
int sub(int i, int j);
int mul(int i, int j);
int div(int i, int j);
}
计算器接口实现类
public class CalculatorImpl implements Calculator{
@Override
public int add(int i, int j) {
int result = i + j;
System.out.println("方法内部 result = " + result);
return result;
}
@Override
public int sub(int i, int j) {
int result = i - j;
System.out.println("方法内部 result = " + result);
return result;
}
@Override
public int mul(int i, int j) {
int result = i * j;
System.out.println("方法内部 result = " + result);
return result;
}
@Override
public int div(int i, int j) {
int result = i / j;
System.out.println("方法内部 result = " + result);
return result;
}
}
InvocationHandler 接口创建方法调用处理器
public class HandlerByJDK implements InvocationHandler {
private Object target;
public HandlerByJDK(Object target) {
this.target = target;
}
@Override
/**
* @param proxy 代理对象, 和我们根据newProxyInstance获得的代理对象是同一个对象,在invoke方法中基本不用
* @param method 对接口中的方法进行封装的method对象
* @param args 调用方法的实际参数
* @return 方法的返回值
*/
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
// * proxy：代理对象
// * method：代理对象需要实现的方法，即其中需要重写的方法
// * args：method所对应方法的参数
Object result = null;
try {
System.out.println("日志，方法：" + method.getName() + "，参数：" + Arrays.toString(args));
//proxy表示代理对象，method表示要执行的方法，args表示要执行的方法到的参数列表
result = method.invoke(target, args);//target表示目标对象 由我们的new HandlerByJDK(calculator)构造方法传入进来
System.out.println("日志，方法：" + method.getName() + "，结果：" + result);
} catch (Exception e) {
e.printStackTrace();
System.out.println("日志，方法：" + method.getName() + "，异常：" + e);
} finally {
System.out.println("日志，方法：" + method.getName() + "，方法执行完毕");
}
return result;
}
}
- 就是靠这个类来实现如何代理的具体实现
产生代理对象的工厂类
public class ProxyFactoryByJDK {
//目标对象 由我们构造方法进行传入
private Object calculator;
public ProxyFactoryByJDK(Object calculator){
this.calculator=calculator;
}
//获得代理对象
public Object getProxyCalculator(){
//ClassLoader loader,指定加载动态生成的代理类的类加载器
// Class<?>[] interfaces,获取目标对象实现的所有接口的class对象的数组
// InvocationHandler h设置代理对象实现目标对象方法的过程，即代理类中如何重写接口中的抽象方法
ClassLoader classLoader = calculator.getClass().getClassLoader();
Class<?>[] interfaces =calculator.getClass().getInterfaces();
HandlerByJDK handlerByJDK = new HandlerByJDK(calculator);
return Proxy.newProxyInstance(classLoader,interfaces,handlerByJDK);
}
}
Proxy.newProxyInstance(classLoader,interfaces,h)——创建一个代理类对象
- ClassLoader loader,指定加载动态生成的代理类的类加载器
- 可以通过我们的目标对象来获取类加载器
- Class<?>[] interfaces,获取目标对象实现的所有接口的class对象的数组
- InvocationHandler 设置代理对象实现目标对象方法的过程，即代理类中如何重写接口中的抽象方法,用invoke重写
- 代理对象调用处理程序
测试
public class Client {
public static void main(String[] args) {
ProxyFactoryByJDK proxyFactoryByJDK = new ProxyFactoryByJDK(new CalculatorImpl());
Calculator proxyCalculator = (Calculator) proxyFactoryByJDK.getProxyCalculator();
proxyCalculator.add(1,2);
}
}
//输出结果
日志，方法：add，参数：[1, 2]
方法内部 result = 3
日志，方法：add，结果：3
日志，方法：add，方法执行完毕
JDK 动态代理分析
卖火车票的接口类
public interface SellTickets {
void sell();
}
火车站类：火车票具有卖票功能，实现 SellTickets 接口
public class TrainStation implements SellTickets {
public void sell() {
System.out.println("火车站卖票");
}
}
获取代理对象的工厂类
public class ProxyFactory {
// 目标对象
private TrainStation station = new TrainStation();
// 获取代理对象
public SellTickets getProxyObject() {
// 返回代理对象
/*
ClassLoader loader: 类加载器,用于加载代理类,可以通过目标对象获取类加载器
Class<?>[] interfaces: 代理类实现的接口的字节码对象
InvocationHandler h: 代理对象调用处理程序
*/
SellTickets proxyObject = (SellTickets) Proxy.newProxyInstance(
station.getClass().getClassLoader(), // 类加载器,用于加载代理类
station.getClass().getInterfaces(), // 代理类实现的接口的字节码对象
//使用匿名内部类实现
new InvocationHandler() {
/**
* @param proxy 代理对象, 和proxyObject是同一个对象,在invoke方法中基本不用
* @param method 对接口中的方法进行封装的method对象
* @param args 调用方法的实际参数
* @return 方法的返回值
*/
@Override
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
System.out.println("代售点收取一定的服务费用(jdk动态代理 )");
// 执行目标对象的方法
Object obj = method.invoke(station, args);
return obj;
}
}
);
return proxyObject;
}
}
测试类：
public class Client {
public static void main(String[] args) {
// 获取代理对象
// 1, 创建代理工厂对象
ProxyFactory factory = new ProxyFactory();
// 2, 使用factory对象的方法获取代理对象
SellTickets proxyObject = factory.getProxyObject();
// 3, 调用代理对象的方法
proxyObject.sell();
}
}
思考以下问题：
ProxyFactory 是代理类吗？
- ProxyFactory 不是代理模式中所说的代理类，而是程序在运行过程中用来动态的在内存中生成的代理类的类。
通过阿里巴巴开源的 Java 诊断工具（Arthas【阿尔萨斯】）查看代理类的结构：（去除其他代码）
// 程序运行过程中动态生成的代理类
public final class $Proxy0 extends Proxy implements SellTickets {
private static Method m3;
public $Proxy0(InvocationHandler invocationHandler) {
super(invocationHandler);
}
static {
m3 = Class.forName("com.itheima.proxy.dynamic.jdk.SellTickets").getMethod("sell", new Class[0]);
return;
}
public final void sell() {
this.h.invoke(this, m3, null);
}
}
从上面的类中，我们可以看到以下几个信息：
- 代理类 $Proxy0 实现了 SellTickets 接口，这也就印证了真实类和代理类实现同样的接口。
- 代理类 $Proxy0 将我们提供了的匿名内部类对象传递给了父类。
动态代理的执行流程是什么样？
摘取整个流程的重点代码：
// 程序运行过程中动态生成的代理类
public final class $Proxy0 extends Proxy implements SellTickets {
private static Method m3;
public $Proxy0(InvocationHandler invocationHandler) {
super(invocationHandler);
}
static {
m3 = Class.forName("com.itheima.proxy.dynamic.jdk.SellTickets").getMethod("sell", new Class[0]);
}
// ② 根据多态的特性，执行的是代理类 $Proxy0 中的 sell() 方法
public final void sell() {
// ③ 代理类 $Proxy0 中的 sell() 方法中又调用了 InvocationHandler 接口的子实现类对象的 invoke 方法
this.h.invoke(this, m3, null);
}
}
// Java提供的动态代理相关类
public class Proxy implements Serializable {
protected InvocationHandler h;
protected Proxy(InvocationHandler h) {
this.h = h;
}
}
// 代理工厂类
public class ProxyFactory {
private TrainStation station = new TrainStation();
public SellTickets getProxyObject() {
SellTickets sellTickets = (SellTickets) Proxy.newProxyInstance(
station.getClass().getClassLoader(),
station.getClass().getInterfaces(),
new InvocationHandler() {
// ④ invoke 方法通过反射执行了真实对象所属类 TrainStation 中的 sell() 方法
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
System.out.println("代理点收取一些服务费用(JDK动态代理方式)");
Object result = method.invoke(station, args);
return result;
}
});
return sellTickets;
}
}
// 测试访问类
public class Client {
public static void main(String[] args) {
// 获取代理对象
ProxyFactory factory = new ProxyFactory();
// ① 在测试类中通过代理对象调用 sell() 方法
SellTickets proxyObject = factory.getProxyObject();
proxyObject.sell();
}
}
执行流程如下：
① 在测试类中通过代理对象调用 sell() 方法
② 根据多态的特性，执行的是代理类 $Proxy0 中的 sell() 方法
- 因为我们的动态生成的$Proxy0 中重写了sell方法
③ 代理类 $Proxy0 中的 sell() 方法中又调用了 InvocationHandler 接口的子实现类对象的 invoke 方法
- 因为我们的$Proxy0不存在的InvocationHandler 类型的对象，所以使用继承来自Proxy的InvocationHandler h这个对象
- 而这个h就是我们在Proxy.newProxyInstance(）时传入的对象
- this.h.invoke(this, m3, null)——invoke(Object proxy, Method method, Object[] args)
- 所以说这个proxy就是我们的代理对象
- method就是目标对象中的sell方法
- args是对应传入的参数
④ invoke 方法通过反射执行了真实对象所属类 TrainStation 中的 sell() 方法
- method.invoke(station, args) 就是执行了对应的TrainStation 类的方法，因为method对应
- Class.forName(“com.itheima.proxy.dynamic.jdk.SellTickets”).getMethod(“sell”, new Class[0]);
CGLIB 动态代理
上面的案例中，如果没有定义 SellTickets 接口，只定义了 TrainStation 火车站类。则 JDK 代理无法使用，因为 JDK 动态代理要求必须定义接口，它只能对接口进行代理。
CGLIB 是一个功能强大，高性能的代码生成包，它可以为没有实现接口的类提供代理，为 JDK 的动态代理提供了很好的补充。
CGLIB 是第三方提供的包，所以需要引入依赖：
<dependency>
<groupId>cglib</groupId>
<artifactId>cglib</artifactId>
<version>3.3.0</version>
</dependency>
需要被代理的类
public class UserService {
public void service(){
System.out.println("在方法内部——正在服务");
}
}
实现MethodInterceptor接口的类
public class InterceptorByCglib implements MethodInterceptor {
//定义目标对象
private Object target;
//通过构造方法来导入目标对象
public InterceptorByCglib(Object target) {
this.target = target;
}
@Override
public Object intercept(Object o, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
Object result=null;
try {
System.out.println("日志，方法："+method.getName()+"，参数："+ Arrays.toString(objects));
result = method.invoke(target, objects);
System.out.println("日志，方法："+method.getName()+"，结果："+ result);
}catch (Exception e){
e.printStackTrace();
System.out.println("日志，方法："+method.getName()+"，异常："+ e);
}finally {
System.out.println("日志，方法："+method.getName()+"，方法执行完毕");
}
return result;
}
}
- 主要就是靠这个类来实现具体如何代理的实现
产生对应代理类对象的工厂类
public class CglibFactory {
//定义目标对象
private Object target;
//通过构造方法注入目标对象
public CglibFactory(Object target) {
this.target = target;
}
public Object create(){
InterceptorByCglib interceptor=new InterceptorByCglib(target);
Object o = Enhancer.create(target.getClass(), interceptor);//产生对应的代理对象
return o;
}
}
//输出结果
日志，方法：service，参数：[]
在方法内部——正在服务
日志，方法：service，结果：null
日志，方法：service，方法执行完毕
三种代理的对比
JDK 和 CGLIB 的区别
- JDK 实现，
要求被代理类必须实现接口，之后是通过 InvocationHandler 及 Proxy，在运行时动态的在内存中生成了代理类对象，该代理对象是通过实现同样的接口实现（类似静态代理接口实现的方式），只是该代理类是在运行期时，动态的织入统一的业务逻辑字节码来完成。- 生成的类 在com.sun.proxy包下，类名为$proxy加一个数字
- CGLIB 实现，被代理类可以不实现接口，是通过继承被代理类，在运行时动态的生成代理类对象
- cglib动态代理，最终生成的代理类会继承目标类，并且和目标类在相同的包下
CGLib 动态代理，底层采用 ASM 字节码生成框架，使用字节码技术生成代理类，在 JDK1.6 之前比使用 JDK 动态代理的效率要高。唯一需要注意的是，CGLib 不能对声明为 final 的类或者方法进行代理，因为CGLib 的原理是动态生成被代理类的子类。
JDK1.6、JDK1.7、JDK1.8 逐步对 JDK 动态代理优化之后，在调用次数较少的情况下，JDK 代理效率高于 CGLib 代理效率；只有当进行大量调用的时候，JDK1.6 和 JDK1.7 比 CGLib 代理效率低一点，但是到 JDK1.8 的时候，JDK 代理效率高于 CGLib 代理。
所以，JDK1.8 以后，如果有接口就使用 JDK 动态代理，没有接口就使用 CGLib 代理。
动态代理和静态代理的对比
- 动态代理与静态代理相比较，最大的好处是接口中声明的所有方法都被转移到调用处理器一个集中的方法中处理 (InvocationHandler.invoke)。这样，在接口方法数量比较多的时候，我们可以进行灵活处理，而不需要像静态代理那样每一个方法进行中转。
- 如果接口增加一个方法，静态代理模式除了所有实现类需要实现这个方法外，所有代理类也需要实现此方法，增加了代码维护的复杂度，而动态代理不会出现该问题。
代理模式的优缺点
优点：
- 代理模式在客户端与目标对象之间起到一个中介作用和保护目标对象的作用；
- 代理对象可以扩展目标对象的功能；
- 代理模式能将客户端与目标对象分离，在一定程度上降低了系统的耦合度；
- 保护、增强、解耦
缺点：
- 增加了系统的复杂度；
使用场景
远程（Remote）代理
-
本地服务通过网络请求远程服务。为了实现本地到远程的通信，我们需要实现网络通信，处理其中可能的异常。为良好的代码设计和可维护性，我们将网络通信部分隐藏起来，只暴露给本地服务一个接口，通过该接口即可访问远程服务提供的功能，而不必过多关心通信部分的细节。
- RPC 的思想
防火墙（Firewall）代理
- 当你将浏览器配置成使用代理功能时，防火墙就将你的浏览器的请求转给互联网；当互联网返回响应时，代理服务器再把它转给你的浏览器。
VPN 的思想
- 保护（Protect or Access）代理控制对一个对象的访问，如果需要，可以给不同的用户提供不同级别的使用权限。