Spring AOP

时间：2024-11-09 08:30:38

入门

Spring AOP快速入门：统计各个业务层方法执行耗时

概述

一般我们都会想到在方法开始结束定义一个执行毫秒值计算总耗时，但是这种方法比较繁琐，所以AOP能大大的提高该效率

思路

  1. 获取方法运行开始时间

  2. 运行原始方法

  3. 获取方法运行结束时间，计算执行耗时

实现
xml文件

导入依赖：在pomxml中导入AOP的依赖

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
</dependency>
aop类

编写AOP程序：针对于特定方法根据业务需要进行编程

@Component
@Slf4j
@Aspect // AOP类
public class TimeAspect {
​
    @Around("execution(* com.itheima.service.*.*(..))") // 切入点表达式
    public Object aopDemp(ProceedingJoinPoint point) throws Throwable {
        long begin = System.currentTimeMillis();
​
        //调用原始方法运行
        Object result = point.proceed();
​
        long end = System.currentTimeMillis();
​
​
        log.info(point.getSignature() +"方法执行耗时:{}ms",end - begin);
​
        return result;
    }
}
使用场景

aop的使用场景远不止如此

例如

  • 场景

记录操作日志 ---> 权限控制 ---> 事务管理 .........

  • 优势

代码无侵入 ---> 减少重复代码 ---> 提高开发效率 ---> 维护方便

AOP核心概念

  • 连接点：JoinPoint，可以被AOP控制的方法（暗含方法执行时的相关信息）

  • 通知：Advice，指那些重复的逻辑，也就是共性功能（最终体现为一个方法）

  • 切入点：PointCut，匹配连接点的条件，通知仅会在切入点方法执行时被应用

  • 切面：Aspect，描述通知于切入点的对应关系（通知+切入点）

  • 目标对象：Target，通知所有的对象

AOP通知类型

  1. @Around：环绕通知，此注解标注的通知方法在目标方法前，后都被执行

  2. @Before：前置通知，此注解标注的通知方法在目标方法前被执行

  3. @After：后置通知，此注解标注的通知方法在目标方法后被执行，无论是否有异常都会执行

  4. @AfterReturning：返回后通知，此主角标注的通知方法在目标方法后被执行，有异常不会执行

  5. @AfterThrowing：异常后通知，此注解标注的通知方法发生异常后执行

实现
@Component
@Slf4j
@Aspect //AOP类
public class MyAspect1 {
​
    @Before(" execution(* com.itheima.service.impl.DeptServiceImpl.*(..)) ") //切入点
    public void before(){
        log.info("前置通知");
    }
​
    @Around("execution(* com.itheima.service.impl.DeptServiceImpl.*(..))")
    public Object Around(ProceedingJoinPoint point) throws Throwable {
        Object obj = point.proceed();
        log.info("循环通知");
        return obj;
    }
​
    @After("execution(* com.itheima.service.impl.DeptServiceImpl.*(..))")
    public void After(){
        log.info("后置通知");
    }
​
    @AfterReturning("execution(* com.itheima.service.impl.DeptServiceImpl.*(..))")
    public void AfterReturning(){
        log.info("AfterReturning");
    }
​
    @AfterThrowing("execution(* com.itheima.service.impl.DeptServiceImpl.*(..))")
    public void AfterThrowing(){
        log.info("AfterThrowing");
    }
​
​
​
}
注意事项

  • @Around环绕通知需要自己调用ProceedingJoinPoint.proeed()来让原始方法执行，其他通知不需要考虑目标方法执行

  • @Around环绕通知方法的返回值，必须指定为Object，来接收原始返回值。

@PointCut

  • 该注解的作用是将公共的切点表达式抽取出来，需要用到时引用该切点表达式即可。

 

通知顺序

当有多个切面的切入点给都匹配到了目标方法，目标方法运行时，多个通知方法都会被执行

执行顺序

1.不同切面类中，默认按照切面的类名字母排序：

  • 目标方法前的通知方法：字母排名靠前的先执行

  • 目标方法后的通知方法：字母排名靠前的后执行

2.用@Order(数字)加在切面类上来控制顺序

  • 目标方法前的通知方法:数字小的先执行

  • 目标后的通知方法：数字小的后执行

切入点表达式

  • 切入点表达式：描述切入点方法的一种表达式

  • 作用：主要用来决定项目中的那些方法需要加入通知

  • 常见形式：

    1. execution(........):根据方法签名来匹配

    2. @annotation(....)：根据注解匹配

@Aspect
@Slf4j
@Component
public class MyAspect6 {
​
    @Pointcut("execution(public void com.itheima.service.impl.DeptServiceImpl.delete())")
    public void pt(){}
    @Before("pt()")
   public void before(){
        System.out.println("前置通知asdf");
    }
​
}
execution

execution主要根据方法的返回值、包名、类名、方法名、方法参数等信息来匹配，语法为：

execution(访问修饰符?返回值 包名.类名.?方法名(方法参数) throws 异常?)

  • 其中带？的表示可以省略的部分

    1. 访问修饰符：可省略（比如：public、protected）

    2. 包名.类名：可省略

    3. throws异常：可省略（注意是方法上声明抛出的异常，不是实际抛出的异常）

@Pointcut("execution(public void com.itheima.service.impl.DeptServiceImpl.delete())")
   public void before(){
        System.out.println("前置通知asdf");
    }

  • 可以使用通配符描述切入点

    1. *：单个独立的任意符号，可以通配任意返回值、包名、类名、方法名、任意类型的一个参数，也可以调配包、类、方法名的一部分

    execution(* com.*.service.*.update*(*))

    1. .. :多个连续的任意符号，可以通配任意层级的包，或任意类型、任意个数的参数

    execution(* com.itheima..DeptService.*(..))

根据业务需要，可以使用且（&&）、或（||）、非（!）来组合比较复杂的切入点表达式

@annotation

  • annotation切入点表达式，用于匹配标识有特定注解的方法

实现

MyAspect7

public class MyAspect7 {
    @Pointcut("@annotation(com.itheima.aop.tips)")
    public void pt(){}
    @Before("pt()")
    public void before(){
        System.out.println("前置通知asdf");
    }
}

tips

创建一个注解

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface tips {
​
}

DeptServiceImpl

在该方法下加上自己创建的注解

@Slf4j
@Service
public class DeptServiceImpl implements DeptService {
    @Autowired
    private DeptMapper deptMapper;
​
​
    @Override
    @tips
    public List<Dept> list() {
        List<Dept> deptList = deptMapper.list();
        return deptList;
    }
​
    @tips
    @Override
    public void delete(Integer id) {
        //1. 删除部门
        deptMapper.delete(id);
    }
}
​

连接点

  • 在Spring中用JoinPoint抽象了连接点，用它可以获取方法执行相关信息，如果目标类名、方法名、方法参数等

    1. 对于@Around通知，获取连接点信息只能使用 ProceedingJoinPoint

    2. 对于其他四种通知，获取连接点信息只能使用JoinPoint，它是ProceedingJoinPoint的父类名

相关文章