Spring-AOP切入点表达式详解及AOP通知类型示例

229 阅读6分钟

开启掘金成长之旅!这是我参与「掘金日新计划 · 2 月更文挑战」的第 6 天,点击查看活动详情

目录

一、AOP切入点表达式语法格式

二、AOP切入点表达式通配符

三、AOP切入点表达式书写技巧

四、前置通知

五、后置通知

六、环绕通知(重点)

@Around注意事项

七、返回后通知(了解)

八、抛出异常后通知(了解)


一、AOP切入点表达式语法格式

切入点:要进行增强的方法

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

描述方式一:执行com.itheima.dao包下的BookDao接口中的无参update方法

execution(void com.itheima.dao.BookDao.update())

描述方式二:执行com.itheima.dao.impl包下的BookDaoImpl类中的无参数update方法

execution(void com.itheima.dao.impl.BookDaoImpl.update())

切入点表达式标准格式: 动作关键字(访问修饰符 返回值 包.类/接口名.方法名(参数)异常名)

execution(public User com.itheima.service.UserService.findById(int))

■ 动作关键字:描述切入点的行为动作,例如execution表示执行到指定切入点

■ 访问修饰符:public,private等,可以省略

■ 返回值

■ 包名

■ 类/接口名

■ 方法名

■ 参数

■ 异常名:方法定义中抛出异常,可以省略

二、AOP切入点表达式通配符

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

***** :单个独立的任意符号,可以独立出现,也可以作为前缀或者后缀的匹配出现

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

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

.. :多个连接的任意符号,可以独立出现,常用于简化包名与参数的书写

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

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

+ :专用于匹配子类类型

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

三、AOP切入点表达式书写技巧

书写技巧:

■ 所有代码按照标准规范开发,否则以下技巧全部失效

■ 描述切入点通常描述接口,而不描述实现类

■ 访问控制修饰符针对接口开发均采用public描述(可省略访问控制修饰符描述

■ 返回值类型对于增删改类使用精准类型加速匹配,对于查询类使用*通配快速描述

包名书写尽量不使用..匹配,效率过低,常用*做单个包描述匹配,或精准匹配

接口名/类名书写名称与模块相关的采用*匹配,例如UserService书写成*Service,绑定业务层接口名

方法名书写以动词进行精准匹配,名词采用匹配,例如getById书写成getBy,selectAll书写成selectAll

■ 参数规则较为复杂,根据业务方法灵活调整

■ 通常不使用异常作为匹配规则

AOP通知描述了抽取的共性功能,根据共性功能抽取的位置不同,最终运行代码时要将其加入到合理的位置

AOP通知共分为5种类型

■ 前置通知

■ 后置通知

■ 环绕通知(重点)

■ 返回后通知(了解)

■ 抛出异常后通知(了解)

四、前置通知

名称:@Before

类型:方法注解

位置:通知方法定义上方

作用:设置当前通知方法与切入点之间的绑定关系,当前通知方法在原始切入点方法前运行

范例:

    //@Before:前置通知,在原始方法运行之前执行
    @Before("pt()")
    public void before() {
        System.out.println("before advice ...");
    }

相关属性:value(默认):切入点方法名,格式为类名.方法名()

五、后置通知

名称:@After

类型:方法注解

位置:通知方法定义上方

作用:设置当前通知方法与切入点之间的绑定关系,当前通知方法在原始切入点方法后运行

范例:

    //@After:后置通知,在原始方法运行之后执行
    @After("pt()")
    public void after() {
        System.out.println("after advice ...");
    }

相关属性:value(默认):切入点方法名,格式为类名.方法名()

六、环绕通知(重点)

名称:@Around(重点,常用)

类型:方法注解

位置:通知方法定义上方

作用:设置当前通知方法与切入点之间的绑定关系,当前通知方法在原始切入点方法前后运行

范例:

    //@Around:环绕通知,在原始方法运行的前后执行
    @Around("pt()")
    public Object around(ProceedingJoinPoint pjp) throws Throwable {
        System.out.println("around before advice ...");
        //表示对原始操作的调用
        Object ret = pjp.proceed();
        System.out.println("around after advice ...");
        return ret;
    }

@Around注意事项

1、环绕通知必须依赖形参ProceedingJoinPoint才能实现对原始方法的调用,进而实现原始方法调用前后同时添加通知

2、通知如果未使用ProceedingJoinPoin对原始方法进行调用将跳过原始方法的执行

3、对原始方法的调用可以不接收返回值,通知方法设置成void即可,如果接收返回值,必须设定为Object类型

4、原始方法的返回值如果是void类型,通知方法的返回值类型可以设置成void,也可以设置成Object

5、由于无法预知原始方法运行后是否会抛出异常,因此环绕通知方法必须抛出Throwable对象

    @Around("pt()")
    public Object around(ProceedingJoinPoint pjp) throws Throwable {
        System.out.println("around before advice ...");
        Object ret = pjp.proceed();
        System.out.println("around after advice ...");
        return ret;
    }

七、返回后通知(了解)

名称:@AfterReturning(了解)

类型:方法注解

位置:通知方法定义上方

作用:设置当前通知方法与切入点之间的绑定关系,当前通知方法在原始切入点方法正常执行完毕后运行

范例:

    //@AfterReturning:返回后通知,在原始方法执行完毕后运行,且原始方法执行过程中未出现异常现象
    @AfterReturning("pt2()")
    public void afterReturning() {
        System.out.println("afterReturning advice ...");
    }

 相关属性:value(默认):切入点方法名,格式为类名.方法名()

八、抛出异常后通知(了解)

名称:@AfterThrowing(了解)

类型:方法注解

位置:通知方法定义上方

作用:设置当前通知方法与切入点之间的绑定关系,当前通知方法在原始切入点方法抛出异常后执行

范例:

    //@AfterThrowing:抛出异常后通知,在原始方法执行过程中出现异常后运行
    @AfterThrowing("pt2()")
    public void afterThrowing() {
        System.out.println("afterThrowing advice ...");
    }

 相关属性:value(默认):切入点方法名,格式为类名.方法名()

​ ​