文章目录
- 引入案例
- 提出问题
- 解决思路
- 遇到的困难
- 代理模式
- 概念
- 生活中的代理
- 相关术语
- 静态代理
- 动态代理
- 织入的概念
- 基于JDK的动态代理
- 基于Cglib的动态代理
- JDK 和 CGLIB 的区别
引入案例
计数器的接口
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;
}
}
提出问题
现有代码缺陷 针对带日志功能的实现类,我们发现有如下缺陷:
- 对核心业务功能有干扰,导致程序员在开发核心业务功能时分散了精力
- 我们计算机中,加减乘除是我们的核心业务,日志功能则不是,如果在开发计算机还需要去关心日志功能的实现,是不好的
- 附加功能分散在各个业务功能方法中,不利于统一维护
- 我们的每个方法中,都需要去写相似的代码,很冗余
解决思路
解决这两个问题,核心就是:解耦。我们需要把附加功能从业务功能代码中抽取出来。
遇到的困难
解决问题的困难:要抽取的代码在方法内部,靠以前把子类中的重复代码抽取到父类的方式没法解决。所以需要引入新的技术。
- 把子类重复的代码抽取到父类,是我们面对对象的思想,但是面对对象是必须抽取一段连续的代码进行封装,是纵向继承的
- 但是类似我们上面的日志功能的代码是分散在代码中,是无法通过面对对象的思想进行抽取
代理模式
概念
二十三种设计模式中的一种,属于结构型模式。它的作用就是通过提供一个代理类,让我们在调用目标方法的时候,不再是直接对目标方法进行调用,而是通过代理类间接调用。让不属于目标方法核心逻辑的代码从目标方法中剥离出来——解耦
。调用目标方法时先调用代理对象的方法,减少对目标方法的调用和打扰,同时让附加功能能够集中在一起也有利于统一维护。
生活中的代理
- 我们去旅游,可以直接去买门票,也可以找旅游团,找旅游团就是代理模式,结果最后都是去到一个地方旅游,我们找旅游团,是包接送和吃饭的
相关术语
- 代理:将非核心逻辑剥离出来以后,封装这些非核心逻辑的类、对象、方法。
- 目标:被代理“套用”了非核心逻辑代码的类、对象、方法
静态代理
public class CalculatorStaticProxy implements Calculator {
private CalculatorImpl calculator;
@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的动态代理
**InvocationHandler 接口创建方法调用处理器 **
public class HandlerByJDK implements InvocationHandler {
private Object target;
public HandlerByJDK(Object target) {
this.target = target;
}
@Override
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);
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;
}
}
- 其中的invoke方法就是为了实现我们代理类中执行方法的重写
- proxy:代理对象
- method:代理对象需要实现的方法,即其中需要重写的方法
- args:method所对应方法的参数
产生代理类对象的工厂类
public class ProxyFactoryByJDK {
private Object target;
public ProxyFactoryByJDK(Object target) {
this.target = target;
}
public Object getProxyObj(){
// ClassLoader loader,指定加载动态生成的代理类的类加载器
// Class<?>[] interfaces,获取目标对象实现的所有接口的class对象的数组
// InvocationHandler h设置代理对象实现目标对象方法的过程,即代理类中如何重写接口中的抽象方法
ClassLoader classLoader=target.getClass().getClassLoader();
Class<?>[] interfaces = target.getClass().getInterfaces();
InvocationHandler handler=new HandlerByJDK(target);
return Proxy.newProxyInstance(classLoader,interfaces,handler);
}
}
Proxy.newProxyInstance(classLoader,interfaces,h)——创建一个代理类对象
- ClassLoader loader,指定加载动态生成的代理类的类加载器
- Class<?>[] interfaces,获取目标对象实现的所有接口的class对象的数组
- InvocationHandler 设置代理对象实现目标对象方法的过程,即代理类中如何重写接口中的抽象方法,用invoke重写
测试
public class FactoryProxyTest {
public static void main(String[] args) {
ProxyFactory proxyFactory=new ProxyFactory(new CalculatorImpl());
Calculator proxyObj =(Calculator) proxyFactory.getProxyObj();//利用对应的接口类型进行接收
proxyObj.add(1,2);
}
}
//输出结果
日志,方法:add,参数:[1, 2]
方法内部 result = 3
日志,方法:add,结果:3
日志,方法:add,方法执行完毕
- 一定要用被代理对象的父类接口来接收对象
基于Cglib的动态代理
要被代理的类
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;
}
}
- 实现方法拦截器,其中的intercept方法就是为了实现我们代理类中执行方法的重写
对应代理类对象的工厂类
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;
}
}
测试
public class CglibTest {
public static void main(String[] args) {
UserService userService=new UserService();
CglibFactory cglibFactory=new CglibFactory(userService);
UserService userService1 = (UserService) cglibFactory.create();
userService1.service();
}
}
//输出结果
日志,方法:service,参数:[]
在方法内部——正在服务
日志,方法:service,结果:null
日志,方法:service,方法执行完毕
JDK 和 CGLIB 的区别
- JDK 实现,
要求被代理类必须实现接口
,之后是通过 InvocationHandler 及 Proxy,在运行时动态的在内存中生成了代理类对象,该代理对象是通过实现同样的接口实现(类似静态代理接口实现的方式),只是该代理类是在运行期时,动态的织入统一的业务逻辑字节码来完成。- 生成的类 在com.sun.proxy包下,类名为$proxy加一个数字
- CGLIB 实现,被代理类可以不实现接口,是通过继承被代理类,在运行时动态的生成代理类对象
- cglib动态代理,最终生成的代理类会继承目标类,并且和目标类在相同的包下