Spring-AOP

南懿烨曦

于 2022-10-02 16:36:44 发布

阅读量647

点赞数

CC 4.0 BY-SA版权

文章标签： java spring AOP

本文链接：https://blog.youkuaiyun.com/CatCatchCap/article/details/127144069

笔记源自黑马程序员2022新版SSM框架教程

AOP简介

基础概念

AOP(Aspect Oriented Programming)面向切面编程，一种编程范式，指导开发者如何组织程序结构

作用：在不惊动原始设计的基础上为其功能进行增强

核心概念

连接点(JoinPoint)：程序执行过程中的任意位置，粒度为执行方法、抛出异常、设置变量等

在SpringAOP中理解为方法的执行

切入点(Pointcut)：匹配连接点的式子

在SpringAOP中，一个切入点可以只描述一个具体方法，也可以匹配多个方法

通知(Advice)：在切入点执行的操作，也就是共性功能

在SpringAOP中，功能最终以方法的形式呈现

通知类：定义通知的类

切面(Aspect)：描述通知与切入点的对应关系

AOP入门实例

需要的依赖

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-context</artifactId>
    <version>5.3.23</version>
</dependency>
<dependency>
    <groupId>org.aspectj</groupId>
    <artifactId>aspectjweaver</artifactId>
    <version>1.9.4</version>
</dependency>

定义切片类

@Component
@Aspect
public class MyAdvice {

  @Pointcut("execution(void com.Learning2.service.UserService.test())")
  private void pointCut(){}

  @Before("pointCut()")
  public void before(){
    System.out.println("测试。。");
  }
}

切入点定义依托一个不具有实际意义的方法进行，即无参数，无返回值，方法体无实际逻辑

@Pointcut("execution(void com.Learning2.service.UserService.test())")
private void pointCut(){}

绑定切入点与通知关系，并指定通知添加到原始连接点的具体执行位置

@Before("pointCut()")

定义通知类受Spring容器管理，并定义当前类为切片类

@Component
@Aspect

开启Spring对AOP注解驱动的支持

在SpringConfig类中加上@EnableAspectJAutoProxy注解

AOP工作流程

工作流程

1.Spring容器启动
2.读取所有切面配置中的切入点

@Before("pointCut()")

3.初始化Bean，判定Bean对应的类中的方法是否匹配到任意切入点
- 匹配失败，创建对象
- 匹配成功，创建原始对象（目标对象）的代理对象
4.获取Bean执行方法
- 获取Bean，调用方法并执行，完成操作
- 获取的Bean是代理对象，根据代理对象的运行模式运行原始方法以及增强内容，完成操作

核心概念

目标对象(Target)

原始功能去掉共性功能对应的类产生的对象，这种对象是无法直接完成最终工作的

代理(Proxy)

目标对象无法直接完成工作，需要对其进行功能回填，通过原始对象的代理对象实现

SpringAOP本质

代理模式

AOP切入点表达式

切入点：要进行增强的方法
切入点表达式：要进行增强的方法的描述方式

切入点表达式的标准格式

动作关键字(访问修饰符返回值包名.类/接口名.方法名(参数) 异常名)

动作关键字：描述切入点的行为动作，例如execution表示执行到指定切入点
访问修饰符：public，private等，默认public
返回值
包名
类/接口名
方法名
参数
异常名：方法定义中抛出指定异常，可以省略

通配符

可以使用通配符描述切入点，快速描述

*：单个独立的任意符号，可以独立出现，也可以作为前缀或者后缀的通配符出现

execution(public * com.Learning2.*.UserService.find*(*))

匹配com.Learning2包下的任意包中的UserService类或接口中所有find开头的带有一个参数的方法

…：多个连续的任意符号，可以单独出现，常用于简化包名和参数的书写

execution(public User com..UserService.findByID(..))

匹配com包下的任意包中的UserService类或接口中所有名称为findByID的方法

+：专用于匹配子类类型

execution(* *..*Service+.*(..))

书写技巧

所有代码按照标准格式开发，否则以下技巧全部失效
描述切入点通常描述接口，而不描述实现类
访问控制修饰符针对接口开发均采用public描述(可省略访问控制修饰符描述)
返回值类型对于增删改类使用精准类型加速匹配，对于查询类使用*统配快速描述
包名书写尽量不使用…匹配，效率过低，常用*做单个包描述匹配，或精准匹配
接口名/类名书写名称与模块相关的采用*匹配，例如UserService书写成*Service，绑定业务层接口名
方法名书写以动词进行精准匹配，名词采用*匹配，例如getByID书写成getBy*，selectAll书写成selectAll
参数规则较为复杂，根据业务方法灵活调整
通常不使用异常作为匹配规则

AOP通知类型

AOP通知描述了抽取的共性功能，根据共性功能抽取的位置不同，最终运行代码时要将其加入到合理的位置
AOP通知共分为5种类型
- 前置通知
- 后置通知
- 环绕通知（重点）
- 返回后通知（了解）
- 抛出异常后通知（了解）

前置通知

名称：@Before
类型：方法注解
位置：通知方法定义上方
作用：设置当前通知方法与切入点之前的绑定关系，当前通知方法在原始切入点方法前运行
范例：

  @Before("pointCut()")
  public void before(){
    System.out.println("运行前");
  }

相关属性：value（默认）：切入点方法名，格式为类名.方法名（），如果在同一个类中，类名可省略

后置通知

名称：@After
类型：方法注解
位置：通知方法定义上方
作用：设置当前通知方法与切入点之前的绑定关系，当前通知方法在原始切入点方法后运行
范例：

  @After("pointCut()")
  public void after(){
    System.out.println("运行后");
  }

相关属性：value（默认）：切入点方法名，格式为类名.方法名（），如果在同一个类中，类名可省略

环绕通知

名称：@Around
类型：方法注解
位置：通知方法定义上方
作用：设置当前通知方法与切入点之前的绑定关系，当前通知方法在原始切入点方法前后运行
范例：

  @Around("pointCut()")
  public Object around(ProceedingJoinPoint pjp) throws Throwable{
    System.out.println("运行前");
    Object ret = pjp.proceed();
    System.out.println("运行后");
    return ret;
  }

@Around注意事项
- 1.环绕通知必须依赖参数ProceedingJoinPoint才能实现对原始方法的调用，进而实现原始方法调用前后同时添加通知
- 2.通知中如果未使用ProceedingJoinPoint对原始方法进行调用将跳过原始方法的执行
- 3.对原始方法的调用可以不接受返回值，通知方法设置成void即可，如果接受返回值，必须设定为Object类型
- 4.原始方法的返回值如果是void类型，通知方法的返回值类型可以设置成void，也可以设置成Object
- 5.由于无法预知原始方法运行后是否会抛出异常，因此环绕通知方法必须抛出Throwable对象

返回后通知（了解）

名称：@After
类型：方法注解
位置：通知方法定义上方
作用：设置当前通知方法与切入点之前的绑定关系，当前通知方法在正常执行完毕后运行
范例：

  @AfterReturning("pointCut()")
  public void afterReturning(){
    System.out.println("运行完毕后");
  }

相关属性：value（默认）：切入点方法名，格式为类名.方法名（），如果在同一个类中，类名可省略

抛出异常后通知（了解）

名称：@AfterThrowing
类型：方法注解
位置：通知方法定义上方
作用：设置当前通知方法与切入点之前的绑定关系，当前通知方法在原始切入点方法运行抛出异常后执行
范例：

  @AfterThrowing("pointCut()")
  public void afterThrowing(){
    System.out.println("运行抛出异常后");
  }

相关属性：value（默认）：切入点方法名，格式为类名.方法名（），如果在同一个类中，类名可省略

案例测试

测试Service类中的方法的运行时间

@Component
@Aspect
public class MyAdvice {

  //service包下的所有以Service为后缀的类的所有方法
  @Pointcut("execution(* com.Learning2.service.*Service.*(..))")
  private void pointCut(){}

  @Around("pointCut()")
  public Object around(ProceedingJoinPoint pjp) throws Throwable{
    //代表了一次执行的签名信息，封装了这一次的执行过程
    Signature signature = pjp.getSignature();
    String className = signature.getDeclaringTypeName();
    String method = signature.getName();

    long start = System.currentTimeMillis();
    Object ret = pjp.proceed();
    long end = System.currentTimeMillis();
    System.out.println("执行时间："+className+"."+method+"---->"+(end-start)+"ms");
    return ret;
  }
}

测试类

public class App {

  public static void main(String[] args) {
    ApplicationContext applicationContext = new AnnotationConfigApplicationContext(SpringConfig.class);

    UserService userService = applicationContext.getBean(UserService.class);

    userService.test();
    userService.findAll();
  }
}

运行结果

This is Service
执行时间：com.Learning2.service.UserService.test---->0ms
十月 02, 2022 3:56:30 下午 com.alibaba.druid.support.logging.JakartaCommonsLoggingImpl info
信息: {dataSource-1} inited
执行时间：com.Learning2.service.UserService.findAll---->2397ms

Process finished with exit code 0

AOP通知获取数据

获取切入点方法的参数

JoinPoint：适用于前置、后置、返回后、抛出异常后通知
ProceedingJoinPoint：适用于环绕通知

JoinPoint对象描述了连接点方法的运行状态，可以获取到原始方法的调用参数

  @Before("pointCut()")
  public void before(JoinPoint jp){
    Object[] args = jp.getArgs();
    System.out.println(Arrays.toString(args));
  }

ProceedingJoinPoint是JoinPoint的子类

  @Around("pointCut()")
  public Object around(ProceedingJoinPoint pjp) throws Throwable{
    Object[] args = pjp.getArgs();
    System.out.println(Arrays.toString(args));
    Object ret = pjp.proceed();
    return ret;
  }

获取切入点方法返回值

返回后通知
环绕通知

返回后通知可以获取切入点方法中的返回信息，使用形参可以接受对应的返回值

  @AfterReturning(value = "pointCut()",returning = "ret")
  public void afterReturning(Object ret){
    System.out.println("afterReturning ..."+ret);
  }

环绕通知中可以手工书写对原始方法的调用，得到的结果即为原始方法的返回值

  @Around("pointCut()")
  public Object around(ProceedingJoinPoint pjp) throws Throwable{
    Object ret = pjp.proceed();
    return ret;
  }

获取切入点方法运行异常信息

抛出异常后通知
环绕通知

抛出异常后通知可以获取切入点方法中出现的异常信息，使用形参可以接受对应的异常对象

  @AfterThrowing(value = "pointCut()",throwing = "throwable")
  public void afterThrowing(Throwable throwable){
    System.out.println("afterThrowing..."+throwable);
  }

在环绕通知中可以直接用try catch来接收异常

  @Around("pointCut()")
  public Object around(ProceedingJoinPoint pjp){
    Object ret = null;
    try {
      ret = pjp.proceed();
    } catch (Throwable e) {
      e.printStackTrace();
    }
    return ret;
  }