Spring学习之AOP
程序员文章站
2022-05-24 23:44:45
...
Spring学习之AOP
spring AOP的概述
在软件业，AOP为Aspect Oriented Programming的缩写，意为：面向切面编程，通过预编译方 式和运行期动态代理实现程序功能的统一维护的一种技术。AOP是OOP的延续，是软件开发中的一个热点，也是Spring框架中的一个重要内容，是函数式编程的一种衍生范型。利用AOP可以对业务逻辑的各个部分进行隔离，从而使得业务逻辑各部分之间的耦合度降低，提高程序的可重用性，同时提高开发效率。
AOP相关术语
Joinpoint(连接点): 被拦截到的方法.
Pointcut(切入点): 我们对其进行增强的方法.
Advice(通知/增强): 对切入点进行的增强操作
包括前置通知,后置通知,异常通知,最终通知,环绕通知
Weaving(织入): 是指把增强应用到目标对象来创建新的代理对象的过程。
Aspect(切面): 是切入点和通知的结合
项目代码的冗余
public List<Account> findAllAccount() {
try {
//1.开启事务
txManager.beginTransaction();
//2.执行操作
List<Account> allAccount = accountDao.findAllAccount();
//3.提交事务
txManager.commit();
//4.返回结果
return allAccount;
}catch (Exception e){
//5.回滚操作
txManager.rollback();
throw new RuntimeException();
}finally {
//6.释放连接
txManager.release();
}
}
public Account findAccountById(Integer id) {
try {
//1.开启事务
txManager.beginTransaction();
//2.执行操作
Account accountById = accountDao.findAccountById(id);
//3.提交事务
txManager.commit();
//4.返回结果
return accountById;
}catch (Exception e){
//5.回滚操作
txManager.rollback();
throw new RuntimeException();
}finally {
//6.释放连接
txManager.release();
}
}
我们发现出现了两个问题:
业务层方法变得臃肿了,里面充斥着很多重复代码.
业务层方法和事务控制方法耦合了. 若提交,回滚,释放资源中任何一个方法名变更,都需要修改业务层的代码.
因此我们引入了装饰模式解决代码冗余和耦合现象.
使用动态代理解决代码冗余现象
这就是两种代理方式
package com.wh.proxy;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
/**
* 模拟一个消费者
*/
public class Client {
public static void main(String[] args) {
final Producer producer = new Producer();
/**
* 动态代理
* 特点：字节码随用随创建，随用随加载
* 作用：不修改源码的基础上对方法增强
* 分类：
* 基于接口的动态代理
* 基于子类的动态代理
* 基于接口的动态代理：
* 设计的类：proxy
* 提供者：jdk官网
* 如何创建代理：
* 使用Proxy类中的newProxyInstance方法
* 创建代理对象的要求：
* 被代理类最少实现一个接口，如果没有则不使用
*
* newProxyInstance方法的参数：
* classLoader：类加载器
* 它适用于加载代理对象字节码的。和被代理对象使用相同的类加载器。固定写法
* class[]：字节码数组
* 它适用于让代理对象和被代理对象有相同的方法。固定写法
* InvocationHandler：用于提供增强的代码
* 它是让外面写如何代理。我们一般都是写一个该接口的实现类，通常是匿名内部类，但是不是必须的
* 此接口的实现类都是谁用谁写
*
*/
IProducer proxyProducer = (IProducer) 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);
}
}
package com.wh.cglib;
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 Client {
public static void main(String[] args) {
final Producer producer = new Producer();
/**
* 动态代理
* 特点：字节码随用随创建，随用随加载
* 作用：不修改源码的基础上对方法增强
* 分类：
* 基于接口的动态代理
* 基于子类的动态代理
* 基于子类的动态代理：
* 设计的类：Enhancer
* 提供者：第三方
* 如何创建代理：
* 使用Enhancer类中的create方法
* 创建代理对象的要求：
* 被代理类不能是最终类
*
* create方法的参数：
* class：字节码
* 它是用于指定被代理对象的字节码
* Callback：用于提供增强的代码
* 它是让外面写如何代理。我们一般都是写一个该接口的实现类，通常是匿名内部类，但是不是必须的
* 此接口的实现类都是谁用谁写
* 我们一般写的都是该接口的子接口的实现类：MethodInterceptor
*
*/
Producer cglibProducer = (Producer) Enhancer.create(producer.getClass(), new MethodInterceptor() {
/**
* 执行被代理对象的任何方法都会经过该方法
* @param proxy
* @param method
* @param args
* 以上三个参数和基于接口的动态代理中的invoke方法的参数一样的
* @param methodProxy：当前执行方法的代理对象
* @return
* @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);
}
}
在我们代码中如何运用到代理的东西呢
通过创建一个动态代理的工厂
public IAccountService getAccountService() {
IAccountService iAccountService = (IAccountService) Proxy.newProxyInstance(accountService.getClass().getClassLoader(),
accountService.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 rtValue = null;
try {
//1.开启事务
txManager.beginTransaction();
//2.执行操作
rtValue = method.invoke(accountService, args);
//3.提交事务
txManager.commit();
//4.返回结果
return rtValue;
} catch (Exception e) {
//5.回滚操作
txManager.rollback();
throw new RuntimeException(e);
} finally {
//6.释放连接
txManager.release();
}
}
});
return iAccountService;
}
然后在配置文件中将代理注入spring的容器中
<!--配置代理的service-->
<bean id="proxyAccountService" factory-bean="beanFactory" factory-method="getAccountService"></bean>
<!--配置-->
<bean id="beanFactory" class="com.wh.factory.BeanFactory">
<!--注入accountService对象-->
<property name="accountService" ref="accountService"></property>
<!--注入ConnectionUtils-->
<property name="txManager" ref="txManager"></property>
</bean>
然后在每次只要调用业务层代码它都会经过动态代理的工厂的加强，为我们解决了代码冗余现象
Spring aop 解决了代码冗余
它的配置文件
<!--配置spring的ioc，把service对象配置进来-->
<bean id="accountService" class="com.wh.service.impl.AccountServiceImpl"></bean>
<!--把spring中基于xml的aop配置步骤
1.把通知bean也交给spring来管理
2.使用app：config标签表明开始AOP的配置
3.使用aop：aspect标签表明配置切面
id属性：是给切面提供一个唯一表示
ref属性：是指定通知类bean的id
4.在aop：aspect标签的内部使用对应标签来配置通知的类型
我们现在示例是让printLog方法在切入点方法执行之前之前：所以是前置
通知aop：before：表示配置前置通知
method属性:用于指定Logger类中哪个方法是前置通知
pointcut属性：用于指定切入点表达式，该表达式的含义指的是对业务成那些方法增强
切入点表达式的写法：
关键字：execution
表达式：
访问修饰符 返回值 包名.包名.包名.包名....类名.方法名
标准的表达式写法：
public void com.wh.service.impl.AccountServiceImpl.saveAccount()
访问修饰符可以省略
void com.wh.service.impl.AccountServiceImpl.saveAccount()
返回值可以使用通配符，表示任意返回值
* com.wh.service.impl.AccountServiceImpl.saveAccount()
包名可以使用通配符，表示任意包。但是又几级包，就写几个*
* *.*.*.*.AccountServiceImpl.saveAccount()
包名可以使用..表示当前包及其子包
* *..AccountServiceImpl.saveAccount()
类名个方法名都可以使用*号进行通配
* *..*.*()
参数列表：
可以直接写数据类型：
基本类型直接写 int
引用类型写包名.类名的方式 java.lang.String
可以使用通配符但是必须有参数
可以使用..表示有无参数均可以，有参数可以是任意类型
全通配写法：
* *..*.*(..)
实际开发中切入点表达式的通常写法：
切到业务层实现类下的所以方法
* com.wh.service.impl.*.*(..)
-->
<!--配置Logger类-->
<bean id="logger" class="com.wh.utils.Logger"></bean>
<!--配置aop-->
<aop:config>
<!--配置切入点表达式： id属性用于指定表达式的唯一标识。expression属性用于指定表达式内容
此标签写在aop:aspect标签内部只能当前切面使用
它还可以写在aop:aspect外面，此时就变成了所有切面可用
-->
<aop:pointcut id="pt1" expression="execution(* com.wh.service.impl.*.*(..))"/>
<aop:aspect id="logAdvice" ref="logger">
<!--前置通知：在切入点方法执行之前执行-->
<aop:before method="beforePrintLog" pointcut-ref="pt1"></aop:before>
<!--后置通知：在切入点方法执行之后执行。它永远和异常通知只能执行一个-->
<aop:after-returning method="afterReturnPrintLog" 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>
<<!--配置环绕通知-->
<aop:around method="aroundPrintLog" pointcut-ref="pt1"></aop:around>
</aop:aspect>
</aop:config>
环绕通知
package com.wh.utils;
import org.aspectj.lang.ProceedingJoinPoint;
/**
* 用于记录日志的工具类，它里面提供了公共代码
*/
public class Logger {
/**
* 前置通知
*/
public void beforePrintLog(){
System.out.println("前置通知:Logger类中的beforePrintLog方法开始记录日志了");
}
/**
* 后置通知
*/
public void afterReturnPrintLog(){
System.out.println("后置通知:Logger类中的afterReturnPrintLog方法开始记录日志了");
}
/**
* 异常通知
*/
public void afterThrowingPrintLog(){
System.out.println("异常通知:Logger类中的afterThrowingPrintLog方法开始记录日志了");
}
/**
* 最终通知
*/
public void afterPrintLog(){
System.out.println("最终通知：Logger类中的afterPrintLog方法开始记录日志了");
}
/**
* 环绕通知
* 问题：
* 当我们配置了环绕通知之后，切入点方法没有执行，而通知方法执行了
* 分析：
* 通过对比动态代理中的环绕通知代码，发现动态代理的环绕通知有名确的切入点方法调用，而我们代码中没有
* 解决：
* Spring框架为我们提供了一个接口ProceedingJoinPoint。该接口有一个proceed()，此方法就相当于明确切入点方法
* 该接口可以作为环绕通知的方法参数，在程序执行时，spring框架会为我们提供该接口的实现类供我们使用
*
* Spring中的环绕通知：
* 它是spring框架为我们提供的一种可以在代码中手动控制增强方法何时执行的方式
*/
public Object aroundPrintLog(ProceedingJoinPoint pjp){
Object rtValue = null;
try {
Object [] args = pjp.getArgs();
System.out.println("环绕通知：Logger类中的aroundPrintLog方法开始记录日志了 前置");
rtValue = pjp.proceed(args);
System.out.println("环绕通知：Logger类中的aroundPrintLog方法开始记录日志了 后置");
return rtValue;
}catch (Throwable t){
System.out.println("环绕通知：Logger类中的aroundPrintLog方法开始记录日志了 异常");
throw new RuntimeException(t);
}finally {
System.out.println("环绕通知：Logger类中的aroundPrintLog方法开始记录日志了 最终");
}
}
}
使用注解配置AOP
配置bean.xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:aop="http://www.springframework.org/schema/aop"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/aop
http://www.springframework.org/schema/aop/spring-aop-4.0.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-4.0.xsd">
<!--配置Spring创建容器时要扫的包-->
<context:component-scan base-package="com.wh"></context:component-scan>
<!--配置Spring开启注解AOP的支持-->
<aop:aspectj-autoproxy></aop:aspectj-autoproxy>
</beans>
具体的使用
package com.wh.utils;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.stereotype.Component;
/**
* 用于记录日志的工具类，它里面提供了公共代码
*/
@Component("logger")
@Aspect//表示当前类时一个切面
public class Logger {
@Pointcut("execution(* com.wh.service.impl.*.*(..))")
private void pt1(){}
/**
* 前置通知
*/
// @Before("pt1()")
public void beforePrintLog(){
System.out.println("前置通知:Logger类中的beforePrintLog方法开始记录日志了");
}
/**
* 后置通知
*/
// @AfterReturning("pt1()")
public void afterReturnPrintLog(){
System.out.println("后置通知:Logger类中的afterReturnPrintLog方法开始记录日志了");
}
/**
* 异常通知
*/
// @AfterThrowing("pt1()")
public void afterThrowingPrintLog(){
System.out.println("异常通知:Logger类中的afterThrowingPrintLog方法开始记录日志了");
}
/**
* 最终通知
*/
// @After("pt1()")
public void afterPrintLog(){
System.out.println("最终通知：Logger类中的afterPrintLog方法开始记录日志了");
}
/**
* 环绕通知
* 问题：
* 当我们配置了环绕通知之后，切入点方法没有执行，而通知方法执行了
* 分析：
* 通过对比动态代理中的环绕通知代码，发现动态代理的环绕通知有名确的切入点方法调用，而我们代码中没有
* 解决：
* Spring框架为我们提供了一个接口ProceedingJoinPoint。该接口有一个proceed()，此方法就相当于明确切入点方法
* 该接口可以作为环绕通知的方法参数，在程序执行时，spring框架会为我们提供该接口的实现类供我们使用
*
* Spring中的环绕通知：
* 它是spring框架为我们提供的一种可以在代码中手动控制增强方法何时执行的方式
*/
@Around("pt1()")
public Object aroundPrintLog(ProceedingJoinPoint pjp){
Object rtValue = null;
try {
Object [] args = pjp.getArgs();
System.out.println("环绕通知：Logger类中的aroundPrintLog方法开始记录日志了 前置");
rtValue = pjp.proceed(args);
System.out.println("环绕通知：Logger类中的aroundPrintLog方法开始记录日志了 后置");
return rtValue;
}catch (Throwable t){
System.out.println("环绕通知：Logger类中的aroundPrintLog方法开始记录日志了 异常");
throw new RuntimeException(t);
}finally {
System.out.println("环绕通知：Logger类中的aroundPrintLog方法开始记录日志了 最终");
}
}
}
注意的是：在使用aop的时候 他的异常通知和后置通知事能出现一个，在注解的使用的时候，他的最终通知是是在后置通知之前的。
总结
这个就是springaop 我只是把我自己学习的东西记录一下，如果有错误大家可以指出
最后贴一下在B站看的视频，如果大家感兴趣也可以去看一下
https://www.bilibili.com/video/av47952931