【spring】AOP学习笔记
一、前言
1. 举个栗子
2. 事务控制
二、动态代理
不修改源码的基础上对方法增强
Spring正式引入代理的特点:如果是对接口代理使用JDK代理;如果对类代理使用Cglib代理。
1. JDK代理
目标对象面向接口,被代理类最少实现一个接口,如果没有则不能使用(spring默认的代理方式是JDK代理)
使用Proxy类中的newProxyInstance方法,newProxyInstance方法的参数:
- ClassLoader:类加载器
用于加载代理对象字节码。和被代理对象使用相同的类加载器。固定写法。 - Class[]:字节码数组
用于让代理对象和被代理对象有相同方法。固定写法。 - InvocationHandler:用于提供增强的代码
写代理细节。一般都是写一个该接口的实现类,通常情况下都是匿名内部类,但不是必须的。
public class Client {
public static void main(String[] args) {
final Producer producer = new ProducerImpl();
Producer proxyProducer = (Producer) Proxy.newProxyInstance(producer.getClass().getClassLoader(),
producer.getClass().getInterfaces(),
new InvocationHandler() {
/**
* 作用:执行被代理对象的任何接口方法都会经过该方法
* 方法参数的含义
* @param proxy 代理对象的引用
* @param method 当前执行的方法
* @param args 当前执行方法所需的参数
* @return 和被代理对象方法有相同的返回值
* @throws Throwable
*/
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
//提供增强的代码
Object returnValue = null;
//1.获取方法执行的参数
Float money = (Float) args[0];
//2.判断当前方法是不是销售
if ("saleProduct".equals(method.getName())) {
returnValue = method.invoke(producer, money * 0.8f);
}
return returnValue;
}
});
proxyProducer.saleProduct(10000f);
}
}
2. CGLIB代理
目标对象是类,基于子类的动态代理,被代理类不能是最终类,即用final修饰的类不能创建代理对象。
使用Enhancer类中的create方法,create方法的参数:
- Class:字节码
用于指定被代理对象的字节码。 - Callback:用于提供增强的代码
写代理的细节。一般都是写一个该接口的实现类,通常情况下都是匿名内部类,但不是必须的。
此接口的实现类都是谁用谁写,一般写的都是该接口的子接口实现类:MethodInterceptor
public class Client2 {
public static void main(String[] args) {
final Producer producer = new Producer();
Producer cglibProducer = (Producer) Enhancer.create(producer.getClass(), new MethodInterceptor() {
/**
* 执行北地阿里对象的任何方法都会经过该方法
* @param proxy
* @param method
* @param args
* 以上三个参数和基于接口的动态代理中invoke方法的参数是一样的
* @param methodProxy :当前执行方法的代理对象(不常用)
* @throws Throwable
*/
public Object intercept(Object proxy, Method method, Object[] args, MethodProxy methodProxy) throws Throwable {
//提供增强的代码
Object returnValue = null;
//1.获取方法执行的参数
Float money = (Float) args[0];
//2.判断当前方法是不是销售
if ("saleProduct".equals(method.getName())) {
returnValue = method.invoke(producer, money * 0.8f);
}
return returnValue;
}
});
cglibProducer.saleProduct(12000f);
}
}
三、重点来了
1. 概念
AOP (Aspect Oriented Programing) 称为:面向切面编程,它是一种编程思想。
AOP采取横向抽取机制,取代了传统纵向继承体系重复性代码的编写方式(应用场景:例如性能监视、事务管理、安全检查、缓存、日志记录等)
2. 相关术语
- Joinpoint(连接点):
所谓连接点是指那些被拦截到的点。在spring中,这些点指的是方法,因为spring只支持方法类型的连接点。 - Pointcut(切入点):
所谓切入点是指我们要对哪些Joinpoint进行拦截的定义。 - Advice(通知/增强):
所谓通知是指拦截到Joinpoint之后所要做的事情就是通知。
通知的类型:前置通知,后置通知,异常通知,最终通知,环绕通知。 - Target(目标对象):
代理的目标对象。 - Weaving(织入):
是指把增强应用到目标对象来创建新的代理对象的过程。
spring采用动态代理织入,而AspectJ采用编译期织入和类装载期织入。 - Proxy(代理):
一个类被AOP织入增强后,就产生一个结果代理类。 - Aspect(切面):
类,是切入点和通知(引介)的结合。 - Introduction(引介):
引介是一种特殊的通知在不修改类代码的前提下,Introduction可以在运行期为类动态地添加一些方法或Field。
3. 依赖
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
<version>1.8.7</version>
</dependency>
4. 基于XML的AOP配置步骤
- 4.1. 把通知Bean也交给spring来管理
- 4.2. 使用aop:config标签表明开始AOP的配置
- 4.3. 使用aop:aspect标签表明配置切面
id属性:是给切面提供一个唯一标识
ref属性:是指定通知类bean的Id - 4.4. 在aop:aspect标签的内部使用对应标签来配置通知的类型
假设让printLog方法在切入点方法执行之前执行:所以是前置通知
aop:before:表示配置前置通知
method属性:用于指定Logger类中哪个方法是前置通知
pointcut属性:用于指定切入点表达式,该表达式的含义指的是对业务层中哪些方法增强
切入点表达式的写法:
关键字:execution(表达式)
<!-- 配置Logger类 -->
<bean id="logger" class="com.donglei.utils.Logger"></bean>
<!--配置AOP-->
<aop:config>
<!--配置切面 -->
<aop:aspect id="logAdvice" ref="logger">
<!-- 配置通知的类型,并且建立通知方法和切入点方法的关联-->
<aop:before method="printLog" pointcut="execution(void com.donglei.service.AccountServiceImpl.saveAccount())"></aop:before>
<aop:before method="printLog" pointcut="execution(void com.donglei.service.AccountServiceImpl.updateAccount(int))"></aop:before>
<aop:before method="printLog" pointcut="execution(int com.donglei.service.AccountServiceImpl.deleteAccount())"></aop:before>
</aop:aspect>
</aop:config>
5. 切入点表达式的写法
关键字:execution(表达式)
表达式:
参数一:访问修饰符(非必填)
参数二:返回值(必填)
参数三:包名.类名(非必填)
参数四:方法名(参数)(必填)
参数五:异常(非必填)
访问修饰符 返回值 包名.包名.包名…类名.方法名(参数列表)
标准的表达式写法:
public void com.donglei.service.AccountServiceImpl.saveAccount()
访问修饰符可以省略
void com.donglei.service.AccountServiceImpl.saveAccount()
返回值可以使用通配符(*:表示任意),表示任意返回值
* com.donglei.service.AccountServiceImpl.saveAccount()
包名可以使用通配符,表示任意包。但是有几级包,就需要写几个*.
* *.*.*.*.AccountServiceImpl.saveAccount())
包名可以使用..表示当前包及其子包
* *..AccountServiceImpl.saveAccount()
类名和方法名都可以使用*来实现通配
* *..*.*()
参数列表:
可以直接写数据类型:
基本类型直接写名称 int
引用类型写包名.类名的方式 java.lang.String
可以使用通配符表示任意类型,但是必须有参数
可以使用..表示有无参数均可,有参数可以是任意类型
全通配写法:* *..*.*(..)
实际开发中切入点表达式的通常写法:切到业务层实现类下的所有方法:* com.donglei.service..*.*(..)
举例:
<aop:before method="printLog" pointcut="execution(* com.donglei.service..*.*(..))">
</aop:before>
6. 五种通知类型
前置通知、后置通知、异常通知、最终通知、环绕通知
配置
<!--配置AOP-->
<aop:config>
<!-- 配置切入点表达式 id属性用于指定表达式的唯一标识。expression属性用于指定表达式内容
此标签写在aop:aspect标签内部只能当前切面使用
它还可以写在aop:aspect外面,此时就变成了所有切面可用
-->
<aop:pointcut id="pt1" expression="execution(* com.donglei.service..*.*(..))"></aop:pointcut>
<!--配置切面 -->
<aop:aspect id="logAdvice" ref="logger">
<!-- 配置前置通知:在切入点方法执行之前执行
<aop:before method="beforePrintLog" pointcut-ref="pt1" ></aop:before>-->
<!-- 配置后置通知:在切入点方法正常执行之后值。它和异常通知永远只能执行一个
<aop:after-returning method="afterReturningPrintLog" pointcut-ref="pt1"></aop:after-returning>-->
<!-- 配置异常通知:在切入点方法执行产生异常之后执行。它和后置通知永远只能执行一个
<aop:after-throwing method="afterThrowingPrintLog" pointcut-ref="pt1"></aop:after-throwing>-->
<!-- 配置最终通知:无论切入点方法是否正常执行它都会在其后面执行
<aop:after method="afterPrintLog" pointcut-ref="pt1"></aop:after>-->
<!-- 配置环绕通知 详细的注释请看Logger类中-->
<aop:around method="aroundPringLog" pointcut-ref="pt1"></aop:around>
</aop:aspect>
</aop:config>
7. 举例:日志
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.ProceedingJoinPoint;
public class Logger {
/**
* 前置通知
*/
public void beforePrintLog(JoinPoint jp) {
System.out.println("前置通知Logger类中的beforePrintLog方法开始记录日志了。。。");
}
/**
* 后置通知
*/
public void afterReturningPrintLog(JoinPoint jp) {
System.out.println("后置通知Logger类中的afterReturningPrintLog方法开始记录日志了。。。");
}
/**
* 异常通知
*/
public void afterThrowingPrintLog(JoinPoint jp) {
System.out.println("异常通知Logger类中的afterThrowingPrintLog方法开始记录日志了。。。");
}
/**
* 最终通知
*/
public void afterPrintLog(JoinPoint jp) {
System.out.println("最终通知Logger类中的afterPrintLog方法开始记录日志了。。。");
}
/**
* 环绕通知
* 问题:
* 当我们配置了环绕通知之后,切入点方法没有执行,而通知方法执行了。
* 分析:
* 通过对比动态代理中的环绕通知代码,发现动态代理的环绕通知有明确的切入点方法调用,而我们的代码中没有。
* 解决:
* Spring框架为我们提供了一个接口:ProceedingJoinPoint。该接口有一个方法proceed(),此方法就相当于明确调用切入点方法。
* 该接口可以作为环绕通知的方法参数,在程序执行时,spring框架会为我们提供该接口的实现类供我们使用。
*
* spring中的环绕通知:
* 它是spring框架为我们提供的一种可以在代码中手动控制增强方法何时执行的方式。
*/
public Object aroundPringLog(ProceedingJoinPoint pjp) {
Object rtValue = null;
try {
Object[] args = pjp.getArgs();//得到方法执行所需的参数
System.out.println("Logger类中的aroundPringLog方法开始记录日志了。。。前置");
rtValue = pjp.proceed(args);//明确调用业务层方法(切入点方法)
System.out.println("Logger类中的aroundPringLog方法开始记录日志了。。。后置");
return rtValue;
} catch (Throwable t) {
System.out.println("Logger类中的aroundPringLog方法开始记录日志了。。。异常");
throw new RuntimeException(t);
} finally {
System.out.println("Logger类中的aroundPringLog方法开始记录日志了。。。最终");
}
}
}