一文搞懂Spring AOP的五大通知类型

 更新时间:2022年06月17日 08:46:39   作者:倔强的牛角  
本文将详细为大家介绍Spring AOP的五种通知类型(前置通知、后置通知、返回通知、异常通知、环绕通知),感兴趣的朋友可以了解一下

一、通知类型

Advice 直译为通知,也有人翻译为 “增强处理”,共有 5 种类型,如下表所示。

通知类型注解说明
before(前置通知)@Before通知方法在目标方法调用之前执行
after(后置通知)@After通知方法在目标方法返回或异常后调用
after-returning(返回通知)@AfterReturning通知方法会在目标方法返回后调用
after-throwing(异常通知)@AfterThrowing通知方法会在目标方法抛出异常后调用
around(环绕通知)@Around通知方法会将目标方法封装起来

二、环境准备

添加AOP依赖

pom.xml文件里添加Spring AOPAspectJ的jar包依赖

<dependencies>
    <!--包含Spring AOP:有基本的AOP功能-->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>5.2.10.RELEASE</version>
    </dependency>
    <!--AspectJ框架有更强大的AOP功能-->
    <dependency>
        <groupId>org.aspectj</groupId>
        <artifactId>aspectjweaver</artifactId>
        <version>1.9.5</version>
    </dependency>
</dependencies>

创建目标接口和实现类

/*UserDao接口*/
public interface UserDao {
    public void save();
    public int update();
}
/*UserDaoImpl实现类*/
@Repository
public class UserDaoImpl implements UserDao {
    @Override
    public void save() {
        System.out.println("正在执行 UserDao 的 save 方法");
    }
    @Override
    public int update() {
        System.out.println("正在执行 UserDao 的 update 方法");
        return 1;
    }
}

创建通知类

创建通知类,并指定切入点

/*通知类*/
@Component//将这个类定义成 Bean
@Aspect//将这个Bean定义为切面
public class MyAdvice {
    //指定UserDao类中的save方法为切入点
    @Pointcut("execution(void com.bighorn.dao.UserDao.save())")
    private void pt1(){}
    //指定UserDao类中的update方法为切入点
    @Pointcut("execution(int com.bighorn.dao.UserDao.update())")
    private void pt2(){}
}

创建Spring核心配置类

/*Spring核心配置类*/
@Configuration
@ComponentScan("com.bighorn") //开启注解扫描
@EnableAspectJAutoProxy //开启 AspectJ 的自动代理
public class SpringConfig {
}

编写运行程序

public class App {
    public static void main(String[] args) throws SQLException {
        //获取配置类初始化容器
        ApplicationContext context = new AnnotationConfigApplicationContext(SpringConfig.class);
        //从容器中获取UserDao对象
        UserDao userDao = context.getBean(UserDao.class);
        //调用userDao的方法
        userDao.save();
    }
}

三、添加通知

普通通知

MyAdvice这个通知类中添加前置通知后置通知返回后通知异常后通知及相关注解。

//前置通知
@Before("pt1()")
public void before() {
    System.out.println("before advice ...");
}
//后置通知
@After("pt1()")
public void after() {
    System.out.println("after advice ...");
}
//返回后通知
@AfterReturning("pt1()")
public void afterReturning() {
    System.out.println("afterReturning advice ...");
}
//异常后通知
@AfterThrowing("pt1()")
public void afterThrowing() {
    System.out.println("afterThrowing advice ...");
}

观察运行App程序后的截图,发现并没有显示异常后通知

手动在save()方法中添加一行代码:int i = 1/0,造成异常后再次运行App。

发现异常后通知有了,但是运行后通知却消失了。

综上所述: 前置通知和后置通知是一定会执行的,而返回后通知是需要在原始方法正常执行后才会被执行,异常后通知是需要原始方法抛出异常才会被执行

环绕通知(重点)

环绕通知是非常强大的通知,能够完成上述四种通知的所有功能。

/**
     * 环绕通知需要携带ProceedingJoinPoint类型的参数
     * 环绕通知类似于动态代理的全过程:ProceedingJoinPoint类型的参数可以决定是否执行目标方法
     * 环绕通知必须要有返回值,返回值即为目标方法的返回值
     * @param pjp
     * @return Object
     */
@Around("pt2()")
public Object around(ProceedingJoinPoint pjp) {
    Object result = null;
    try {
        System.out.println("这是环绕通知中的前置通知......");
        //执行目标方法
        result = pjp.proceed();
        System.out.println("这是环绕通知中的返回通知......");
    } catch (Throwable e) {
        System.out.println("这是环绕通知中的异常通知......");
    }
    System.out.println("这是环绕通知中的后置通知......");
    return result;
}

修改App类,调用UserDao的update()方法,运行程序,观察结果。

public class App {
    public static void main(String[] args) throws SQLException {
        //获取配置类初始化容器
        ApplicationContext context = new AnnotationConfigApplicationContext(SpringConfig.class);
        //从容器中获取UserDao对象
        UserDao userDao = context.getBean(UserDao.class);
        //调用userDao的update方法
        userDao.update();
    }
}

运行结果如下

注意点

使用环绕通知必须传入形参ProceedingJoinPoint,并使用pjp.proceed()方法实现对原始方法的调用,进而实现原始方法调用前后同时添加通知

通知中如果未使用使用pjp.proceed()方法实现对原始方法的调用,则将跳过原始方法的执行

原始方法的返回值类型决定环绕通知的返回值类型。原始方法若不接收返回值,通知方法的返回值类型可以设置成void,也可以设置成Object;如果接收返回值,最好设定为Object类型

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

以上就是一文搞懂Spring AOP的五大通知类型的详细内容,更多关于Spring AOP通知类型的资料请关注脚本之家其它相关文章!

相关文章

  • Java的动态代理和静态代理详解

    Java的动态代理和静态代理详解

    这篇文章主要为大家详细介绍了Python实现学生成绩管理系统,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-03-03
  • PowerJob的QueryConvertUtils工作流程源码解读

    PowerJob的QueryConvertUtils工作流程源码解读

    这篇文章主要为大家介绍了PowerJob的QueryConvertUtils工作流程源码解读,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2024-01-01
  • Springboot自定义mybatis拦截器实现扩展

    Springboot自定义mybatis拦截器实现扩展

    本文主要介绍了Springboot自定义mybatis拦截器实现扩展,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-12-12
  • 使用SpringBoot自定义starter详解

    使用SpringBoot自定义starter详解

    这篇文章主要介绍了使用Spring Boot自定义starter详解,文中有非常详细的代码示例,对正在学习java的小伙伴们有很好地帮助哟,需要的朋友可以参考下
    2021-05-05
  • rocketmq消费负载均衡--push消费详解

    rocketmq消费负载均衡--push消费详解

    这篇文章主要介绍了rocketmq消费负载均衡--push消费详解,本文介绍了DefaultMQPushConsumerImpl消费者,客户端负载均衡相关知识点。,需要的朋友可以参考下
    2019-06-06
  • Java接口和抽象类的区别深入剖析

    Java接口和抽象类的区别深入剖析

    这篇文章主要介绍了Java接口和抽象类的区别,对于Java的初学者来说是需要准确掌握的概念!
    2014-07-07
  • springboot 实战:异常与重定向问题

    springboot 实战:异常与重定向问题

    这篇文章主要介绍了springboot实战:异常与重定向问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-12-12
  • Java如何正确处理下载文件时HTTP头的编码问题

    Java如何正确处理下载文件时HTTP头的编码问题

    这篇文章主要介绍了Java如何正确处理下载文件时HTTP头的编码问题,
    通常HTTP消息包括客户机向服务器的请求消息和服务器向客户机的响应消息,今天来讲解下正确处理下载文件时HTTP头的编码问题,需要的朋友可以参考下
    2023-07-07
  • 详解Java中Collector接口的组成

    详解Java中Collector接口的组成

    今天给大家带来的是关于Java基础的相关知识,文章围绕着Collector接口的组成展开,文中有非常详细的介绍及代码示例,需要的朋友可以参考下
    2021-06-06
  • 详解使用spring cloud config来统一管理配置文件

    详解使用spring cloud config来统一管理配置文件

    这篇文章主要介绍了详解使用spring cloud config来统一管理配置文件,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-12-12

最新评论