文章目录
Spring AOP
本文讲解如何通过注解实现AOP功能。
基本概念
个人认为，广义上的Spring AOP指的是Spring框架中AspectJ的使用，下面都是个人的理解，如有雷同，纯属巧合。
AspectJ中的几个概念：
- 目标（Target）
- 代理（Proxy）
- 切面（Aspect）
- 切入点（PointCut）
- 通知（Advice）
- 连接点（JoinPoint）
目标/代理
AOP的原理是代理模式，这里的目标和代理与代理模式的概念相同。
切面
AspectJ中，Aspect=PointCut+Advice。
切入点
AspectJ提供了切点函数作为切入策略，通过切点函数匹配目标方法。
通知
当目标方法执行时，执行的通知操作，AspectJ支持以下五种通知：
| 通知方法 | 注解 | 说明 |
|---|---|---|
| 前置通知 | @Before | 目标方法执行前执行 |
| 后置通知 | @After | 目标方法执行后执行，无论正常还是异常，类似finally语句 |
| 返回通知 | @AfterReturning | 目标方法正常返回后执行 |
| 异常通知 | @AfterThrowing | 目标方法出现异常执行 |
| 环绕通知 | @Around | 环绕目标方法执行，可以控制是否执行，可以修改参数，该通知可以完全替代前面4个通知 |
当方法执行未抛出异常时，通知顺序：环绕（前）->前置通知->目标方法->环绕（后）->后置通知->返回通知
当方法执行抛出异常时，通知顺序：环绕（前）->前置通知->后置通知->异常通知
当环绕通知未执行目标方法，通知顺序：环绕通知->后置通知->返回通知
连接点
通知操作执行时的状态，包括通知类型、方法名、参数等信息。可以通过将任何一个通知方法的第一个参数改为JoinPoint类型获取连接点，
环绕通知的连接点类型是ProceedingJoinPoint，继承于JoinPoint。
使用方法
大致流程如下
- 定义切面类
- 开启AOP功能
- 测试AOP
定义切面类
/**
* 1 使用@Aspect注解定义切面类，使用@Component注解注册到Spring容器
*
* @author ly
*/
@Aspect
@Component
public class ExampleAspect {
/**
* 2 定义切入点，使用切点函数指定com.example包下任意类的任意方法。
* 每个通知都支持切点函数，但统一定义pointCut()，可以统一管理切点
*/
@Pointcut("execution(* com.example..*(..))")
public void pointCut() {}
/**
* 前置通知
*/
@Before("pointCut()")
public void before() {
System.out.println("before advice");
}
/**
* 后置通知
*/
@After("pointCut()")
public void after() {
System.out.println("after advice");
}
/**
* 返回通知。通过JoinPoint参数获得连接点，通过returning指定返回值参数名，
*/
@AfterReturning(value = "pointCut()", returning = "result")
public void afterReturning(JoinPoint joinPoint, Object result) {
System.out.printf("afterReturning advice。Method：%s，Args：%s，result：%s\n",
joinPoint.getSignature().getName(),
Arrays.asList(joinPoint.getArgs()),
result);
}
/**
* 异常通知。通过JoinPoint参数获得连接点，通过throwing指定异常参数名，
*/
@AfterThrowing(value = "pointCut()", throwing = "e")
public void afterThrowing(JoinPoint joinPoint, Throwable e) {
System.out.printf("afterThrowing advice。Method：%s，Args：%s，exception：%s\n",
joinPoint.getSignature().getName(),
Arrays.asList(joinPoint.getArgs()),
e);
}
/**
* 环绕通知。通过ProceedingJoinPoint参数除了JoinPoint的功能外，还可以控制方法是否执行。
*/
@Around("pointCut()")
public Object around(ProceedingJoinPoint point) throws Throwable {
System.out.println("around advice start");
// 该方法有重载，可以修改传入参数
Object result = point.proceed();
System.out.println("around advice end");
return result;
}
}
开启AOP功能
Spring项目若需要开启AOP功能，在任意一个配置类加入EnableAspectJAutoProxy注解，或者配置文件中加入</aop:aspectj-autoproxy>。
Spring Boot项目中，当AOP相关依赖包都存在是，AOP功能默认开启，通过配置spring.aop.auto=false关闭AOP功能，查看AopAutoConfiguration源码了解详情。
测试AOP
创建目标类和测试类
@Data
public class Target {
// 通过参数，简单的控制是否抛出异常
public void target(RuntimeException e) {
if (e != null) {
throw e;
}
System.out.println("target 正常执行");
}
}
@Import(Target.class)
@SpringBootApplication
public class AopApplication {
public static void main(String[] args) {
ApplicationContext context = SpringApplication.run(AopApplication.class, args);
Target target = context.getBean(Target.class);
target.target(null);
}
}
运行结果如下
around advice start
before advice
target 正常执行
around advice end
after advice
afterReturning advice。Method：target，Args：[null]，result：null