代理模式
二十三种设计模式中的一种,属于结构型模式。它的作用就是通过提供一个代理类,让我们在调用目标方法的时候,不再是直接对目标方法进行调用,而是通过代理类间接调用。让不属于目标方法核心逻辑的代码从目标方法中剥离出来——解耦。调用目标方法时先调用代理对象的方法,减少对目标方法的调用和打扰,同时让附加功能能够集中在一起也有利于统一维护。
可以将重复的非核心的代码写在代理类中,将核心的代码写在目标方法中,每次通过调用代理类的方法来间接调用目标方法,以方便统一管理重复的非核心的代码。
静态代理
每个目标方法都有其对应的代理类中的代理方法,重复的非核心的代码都写在代理类中,例:
public class StaticProxyCalculator implements Calculator {
private Calculator calculator;
public StaticProxyCalculator(Calculator calculator) {
this.calculator = calculator;
}
@Override
public int add(int i, int j) {
System.out.println("i = " + i + ", j = " + j);
int result = calculator.add(i,j);
System.out.println("result = " + result);
return result;
}
@Override
public int sub(int i, int j) {
System.out.println("i = " + i + ", j = " + j);
int result = calculator.sub(i,j);
System.out.println("result = " + result);
return result;
}
@Override
public int mul(int i, int j) {
System.out.println("i = " + i + ", j = " + j);
int result = calculator.mul(i,j);
return result;
}
@Override
public int div(int i, int j) {
System.out.println("i = " + i + ", j = " + j);
int result = calculator.div(i,j);
System.out.println("result = " + result);
return 0;
}
}
但是这种方法还是有大量重复,也没有很好地解决统一管理的问题,也不具备灵活性,所以要使用动态代理的方法
动态代理
动态代理技术分类
- JDK动态代理:JDK原生的实现方式,需要被代理的目标类必须实现接口,他会根据目标类的接口动态生成一个代理对象,代理对象和目标对象有相同的接口。
- cglib:通过继承被代理的目标类实现代理,所以不需要目标类实现接口。
以jdk代理为例(了解即可)
代理类:
public class ProxyFactory {
private Object target;
public ProxyFactory(Object target) {
this.target = target;
}
public Object getProxy(){
/**
* newProxyInstance():创建一个代理实例
* 其中有三个参数:
* 1、classLoader:加载动态生成的代理类的类加载器
* 2、interfaces:目标对象实现的所有接口的class对象所组成的数组
* 3、invocationHandler:设置代理对象实现目标对象方法的过程,即代理类中如何重写接口中的抽象方法
*/
ClassLoader classLoader = target.getClass().getClassLoader();
Class<?>[] interfaces = target.getClass().getInterfaces();
InvocationHandler invocationHandler = new InvocationHandler() {
@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));
result = method.invoke(target, args);
System.out.println("[动态代理][日志] "+method.getName()+",结果:"+ result);
} catch (Exception e) {
e.printStackTrace();
System.out.println("[动态代理][日志] "+method.getName()+",异常:"+e.getMessage());
} finally {
System.out.println("[动态代理][日志] "+method.getName()+",方法执行完毕");
}
return result;
}
};
return Proxy.newProxyInstance(classLoader, interfaces, invocationHandler);
}
}
public class Test {
/**
* 静态代理
*/
@org.junit.jupiter.api.Test
public void test1(){
Calculator target = new CalculatorPureImpl();
Calculator calculator = new StaticProxyCalculator(target);
calculator.add(3,4);
}
/**
* 动态代理
*/
@org.junit.jupiter.api.Test
public void test2(){
//创建目标对象
Calculator target = new CalculatorPureImpl();
//获取代理对象
ProxyFactory factory = new ProxyFactory(target);
Calculator proxy = (Calculator) factory.getProxy();
proxy.add(3,4);
}
}
不需要编写代理代码,我们可以使用Spring AOP实现代理
面向切面编程(AOP)
面向切面编程(Aspect Oriented Programming)是对面向对象编程的补充和完善。面向对象编程是通过纵向的继承和实现来实现功能的管理。而面向切面编程是将代码中的重复的非核心的业务提取到一个公共的地方,通过动态代理技术横向插入到各个方法中去。解决非核心代码的冗余问题。
关于AOP的几个名词
横切关注点
从每一个方法中抽取出来的同一类非核心业务。业务处理的主要流程是核心关注点,其他非主要流程就是横切关注点。
通知(增强)
每一个横切关注点上要做的事情都需要一个方法来实现,这样的方法称之为通知方法
- 前置通知:在被代理的目标方法前执行
- 返回通知:在被代理的目标方法成功结束后执行
- 异常通知:在被代理的目标方法异常结束后执行
- 后置通知:在被代理的目标方法最终结束后执行
- 环绕通知:使用try...catch...finally结构围绕整个被代理的目标方法,包括上面四种通知对应的所有位置
连接点
指那些被拦截的点,在Spring中,指可以被动态代理拦截目标类的方法
切入点
定位连接点的方式,被选中的连接点
切面(aspect)
切入点和通知的结合,指的是通知类
目标(target)
被代理的目标对象
代理(proxy)
向目标对象通知之后创建的代理对象
织入(weave)
指把通知应用到目标上,生成代理对象的过程。可以再编译期间织入,也可以再运行期间织入,spring使用运行期间织入
Spring AOP框架
Spring AOP框架,是基于AOP编程思维,封装动态代理技术,简化动态代理技术实现的框架。SpringAOP内部帮助实现动态代理,只需写少量的配置,指定生效范围即可,即可完成面向切面思维编程的实现
aop只能对ioc容器内的对象创建代理对象,代理对象会存储到ioc容器
基于注解方式实现
底层技术组成
- 动态代理(InvocationHandler):JDK原生的实现方式,需要被代理的目标类必须实现接口。因为这个技术要求代理对象和目标对象实现同样的接口。
- cglib:通过继承被代理的目标类实现代理,所以不需要目标类实现接口。
- AspectJ:早期的AOP实现的框架,SpringAOP借用了AspectJ中的AOP注解。
aop的实现步骤:
- 正常写核心业务和配置ioc
- 定义增强类,定义增强方法
- 配置增强类
- 开启aop的配置
aop大致实现例子:
增强类:
/**
*内部存储增强代码
*/
@Component
@Aspect
public class LogAdvice {
@Before("execution(public int com.ergou.service.impl.CalculatorPureImpl.add(int,int))")
public void start(){
System.out.println("方法开始了");
}
@After("execution(public int com.ergou.service.impl.CalculatorPureImpl.add(int,int))")
public void after(){
System.out.println("方法结束了");
}
@AfterThrowing("execution(public int com.ergou.service.impl.CalculatorPureImpl.add(int,int))")
public void error(){
System.out.println("方法报错了");
}
}
配置类配置aop
@Configuration
@ComponentScan("com.ergou")
//让程序允许使用AspectJ注解
@EnableAspectJAutoProxy
public class JavaConfig {
}
xml文件配置aop(和配置类二选一)
<context:component-scan base-package="com.ergou"/>
<aop:aspectj-autoproxy/>
原来的业务代码不需要做改动
测试:
@SpringJUnitConfig(value = JavaConfig.class)
public class Test {
//
@Autowired
private Calculator calculator;
@org.junit.jupiter.api.Test
public void test1(){
int add = calculator.add(3,4);
System.out.println(add);
}
}
注:使用jdk的动态代理,代理类和目标对象会有同样的接口,要使用代理功能,要用目标对象的接口获取ioc容器中的对象(获取到的将会是代理对象而不是目标对象,也证明ioc中真正存储的对象是代理对象而不是目标对象)
cglib的生效场景是目标方法的类没有实现接口
五种常见的通知注解
- @Before: 前置通知
- @AfterReturning:后置通知
- @Around: 环绕通知
- @AfterThrowing:异常通知
- @After :最终通知
获取通知细节信息
需要获取方法签名、传入的实参等信息时,可以在通知方法声明JoinPoint类型的形参。
- JoinPoint 接口通过 getSignature() 方法获取目标方法的签名(方法声明时的完整信息)
- 通过目标方法签名对象获取方法名
- 通过 JoinPoint 对象获取外界调用目标方法时传入的实参列表组成的数组
@Before("execution(* com.ergou.service.impl.*.*(..))")
public void start(JoinPoint joinPoint){
//获取方法所属的目标类的信息
String simpleName = joinPoint.getTarget().getClass().getSimpleName();
System.out.println(simpleName);
//获取方法名称
String name = joinPoint.getSignature().getName();
System.out.println(name);
//获取访问修饰符
int modifiers = joinPoint.getSignature().getModifiers();
String s = Modifier.toString(modifiers);
//获取参数列表
Object[] args = joinPoint.getArgs();
for (Object o :
args) {
System.out.println(o);
}
}
获取返回结果,要在@AfterReturning注解标注的方法内进行,先在方法的形参列表中加一个Object类型的形参变量(假设变量名取为result)用来接收返回值信息,在@AfterReturning注解中,加上属性returning,其值为接收返回值信息的形参变量名result,例:
@AfterReturning(value = "execution(* com.ergou.service.impl.*.*(..))",
returning = "result")
public void afterReturning(JoinPoint joinPoint,Object result){
System.out.println(result);
}
获取异常信息,与获取返回结果类似。要在@AfterThrowing注解标注的方法内进行,先在方法的形参列表中加一个Throwable类型的形参变量(假设变量名取为throwable)用来接收异常信息,在@AfterThrowing注解中加上属性throwing,其值为接收异常信息的形参变量名throwable,例:
@AfterThrowing(value = "execution(* com.ergou.service.impl.*.*(..))",
throwing = "throwable")
public void afterThrowing(JoinPoint joinPoint,Throwable throwable){
throwable.getStackTrace();
}
切点表达式
切点表达式作用
AOP切点表达式(Pointcut Expression)是一种用于指定切点的语言,它可以通过定义匹配规则,来选择需要被切入的目标对象。
切点表达式写在通知注解的value属性中,如果没有其他属性,可以省略value=
切点表达式语法
语法细节
- ..不能作为开头,可以写做*..
- 参数列表部分,如果写做(String..),意思是参数列表只要开头的第一个参数是String类型的即可,后面随意。(..String)即为结尾为String类型的参数,前面随意。(String..int)同理。
切点表达式的提取和复用
当前类中提取:
步骤:
- 定义一个空方法,加上@Pointcut,在注解的括号中写入指定的切点表达式
- 在通知注解中的value属性中直接写@Pointcut注解标记的方法的方法名加括号即可
例:
@Aspect
@Component
public class MyAdvice {
@Pointcut("execution(* com.ergou.service.impl.*.*(..))")
public void pc(){
}
@Before("pc()")
public void start(JoinPoint joinPoint){
//获取方法所属的目标类的信息
String simpleName = joinPoint.getTarget().getClass().getSimpleName();
System.out.println(simpleName);
//获取方法名称
String name = joinPoint.getSignature().getName();
System.out.println(name);
//获取访问修饰符
int modifiers = joinPoint.getSignature().getModifiers();
String s = Modifier.toString(modifiers);
//获取参数列表
Object[] args = joinPoint.getArgs();
for (Object o :
args) {
System.out.println(o);
}
}
@AfterReturning(value = "pc()",
returning = "result")
public void afterReturning(JoinPoint joinPoint,Object result){
System.out.println(result);
}
@After("pc()")
public void after(){
}
@AfterThrowing(value = "pc()",
throwing = "throwable")
public void afterThrowing(JoinPoint joinPoint,Throwable throwable){
throwable.getStackTrace();
}
}
创建一个存储切点的类单独维护切点表达式:
- 创建一个类,用来存储切点表达式,里面同样用@Pointcut注解来存储切点表达式
- 通知注解中的value属性中写上要引用的切点表达式所在类的全限定符加上.方法名加括号
例:
@Component
public class MyPointcut {
@Pointcut("execution(* com.ergou.service.impl.*.*(..))")
public void pc(){
}
}
这个存储切点表达式的类同样也要放进ioc容器
@AfterReturning(value = "com.ergou.pointcut.MyPointcut.pc()",
returning = "result")
public void afterReturning(JoinPoint joinPoint,Object result){
System.out.println(result);
}
环绕通知
环绕通知对应整个 try...catch...finally 结构,包括前面四种通知的所有功能。
环绕通知使用步骤:
- 在通知类中写一个环绕通知方法,参数列表中写一个ProceedingJoinPoint类型的参数,此参数会自动接收目标方法的信息。并在此环绕通知方法上方写上@Around注解,其value属性指定切点表达式
- 环绕通知需要在通知中,定义目标方法的执行。目标方法的执行代码为Object result = joinPoint.proceed(args)。其中,result是用来接收目标方法的返回值的对象,因为result最后还要被环绕通知方法返回;args是传入目标方法的参数,通过调用joinPoint对象的相关方法来获取。
- 用 try...catch...finally 结构将执行代码围绕起来,就可以在相应的位置放通知功能的代码
- 最后return返回接收了目标方法的返回值的result对象
例:
/**
*环绕通知需要在通知中,定义目标方法的执行
* @paramjoinPoint接收了目标方法的信息 比起之前的JoinPoint类型的对象,多了一个执行的功能
* @return
*/
@Around("com.ergou.pointcut.MyPointcut.pc()")
public Object transaction(ProceedingJoinPoint joinPoint){
Object[] args = joinPoint.getArgs();
Object result = null;
try {
//前置通知代码
System.out.println("开启事务");
result = joinPoint.proceed(args);
//后置通知代码
System.out.println("提交事务");
} catch (Throwable e) {
//异常通知代码
System.out.println("事务回滚");
throw new RuntimeException(e);
} finally {
//最终通知代码
System.out.println("必须执行的代码");
}
return result;
}
切面优先级设置
切面优先级是指要调用目标方法时,如果有多个切面,优先级高的切面的通知方法是在外层。
使用@Order注解标记在通知类上,在其中指定一个数字,值越小,优先级越高。
@Component
@Aspect
//值越小,优先级越高
@Order(2)
public class TxAdvice {
@Before("com.ergou.pointcut.MyPointcut.pc()")
public void begin(){
}
@AfterReturning("com.ergou.pointcut.MyPointcut.pc()")
public void commit(){
}
@AfterThrowing("com.ergou.pointcut.MyPointcut.pc()")
public void rollback(){
}
}
优先级高的因为在外层,所以前置先执行,后置后执行
xml方式配置aop
了解即可,主要使用注解方式
<!-- 配置目标类的bean -->
<bean id="calculatorPure" class="com.atguigu.aop.imp.CalculatorPureImpl"/>
<!-- 配置切面类的bean -->
<bean id="logAspect" class="com.atguigu.aop.aspect.LogAspect"/>
<!-- 配置AOP -->
<aop:config>
<!-- 配置切入点表达式 -->
<aop:pointcut id="logPointCut" expression="execution(* *..*.*(..))"/>
<!-- aop:aspect标签:配置切面 -->
<!-- ref属性:关联切面类的bean -->
<aop:aspect ref="logAspect">
<!-- aop:before标签:配置前置通知 -->
<!-- method属性:指定前置通知的方法名 -->
<!-- pointcut-ref属性:引用切入点表达式 -->
<aop:before method="printLogBeforeCore" pointcut-ref="logPointCut"/>
<!-- aop:after-returning标签:配置返回通知 -->
<!-- returning属性:指定通知方法中用来接收目标方法返回值的参数名 -->
<aop:after-returning
method="printLogAfterCoreSuccess"
pointcut-ref="logPointCut"
returning="targetMethodReturnValue"/>
<!-- aop:after-throwing标签:配置异常通知 -->
<!-- throwing属性:指定通知方法中用来接收目标方法抛出异常的异常对象的参数名 -->
<aop:after-throwing
method="printLogAfterCoreException"
pointcut-ref="logPointCut"
throwing="targetMethodException"/>
<!-- aop:after标签:配置后置通知 -->
<aop:after method="printLogCoreFinallyEnd" pointcut-ref="logPointCut"/>
<!-- aop:around标签:配置环绕通知 -->
<!--<aop:around method="……" pointcut-ref="logPointCut"/>-->
</aop:aspect>
</aop:config>
根据类型装配 bean
-
情景一
- bean 对应的类没有实现任何接口
- 根据 bean 本身的类型获取 bean
-
测试:IOC容器中同类型的 bean 只有一个
正常获取到 IOC 容器中的那个 bean 对象
-
测试:IOC 容器中同类型的 bean 有多个
会抛出 NoUniqueBeanDefinitionException 异常,表示 IOC 容器中这个类型的 bean 有多个
-
-
情景二
- bean 对应的类实现了接口,这个接口也只有这一个实现类
- 测试:根据接口类型获取 bean
- 测试:根据类获取 bean
- 结论:上面两种情况其实都能够正常获取到 bean,而且是同一个对象
- bean 对应的类实现了接口,这个接口也只有这一个实现类
-
情景三
- 声明一个接口
- 接口有多个实现类
- 接口所有实现类都放入 IOC 容器
-
测试:根据接口类型获取 bean
会抛出 NoUniqueBeanDefinitionException 异常,表示 IOC 容器中这个类型的 bean 有多个
-
测试:根据类获取bean
正常
-
-
情景四(jdk代理情景)
-
声明一个接口
-
接口有一个实现类
-
创建一个切面类,对上面接口的实现类应用通知
-
测试:根据接口类型获取bean
正常
-
测试:根据类获取bean
无法获取 原因分析:
-
-
应用了切面后,真正放在IOC容器中的是代理类的对象
-
目标类并没有被放到IOC容器中,所以根据目标类的类型从IOC容器中是找不到的
-
-
情景五(cglib代理场景)
- 声明一个类
- 创建一个切面类,对上面的类应用通知
- 测试:根据类获取 bean,能获取到