SpringBoot中的Aop用法

news2025/2/24 15:18:20

目录

  • 什么是Aop
  • Aop概述
    • 相关注解
    • 相关概念
  • 实例1
  • @PointCut 表达式详解
    • execution
    • within
    • this
    • target
    • args:
    • @annotation:
    • @args:
    • 逻辑运算符
  • 实例2
  • 环绕通知

什么是Aop

主要介绍springboot中aop的使用，用过Spring框架的都知道，aop是spring框架的两大核心功能之一，还有一个就是ioc，下面我们就springboot中如何引入aop来做一下探讨

  • 引入AOP依赖包后，一般来说并不需要去做其他配置，使用过Spring注解配置方式的人会问是否需要在程序主类中增加@EnableAspectJAutoProxy来启用，实际并不需要。

  • 因为在AOP的默认配置属性中，spring.aop.auto属性默认是开启的，也就是说只要引入了AOP依赖后，默认已经增加了@EnableAspectJAutoProxy

  • Springboot中有关AOP相关的自动配置包为：AopAutoConfiguration

Aop概述

相关注解

  • @Component ：将当前类注入到Spring容器内

  • @Aspect ：表明是一个切面类

  • @Before ：前置通知，在方法执行之前执行

  • @After ：后置通知，在方法执行之后执行

  • @AfterRuturning ：返回通知，在方法返回结果之后执行

  • @AfterThrowing ：异常通知，在方法抛出异常之后执行

  • @Around ：环绕通知，围绕着方法执行

  • @Pointcut ：切入点，PointCut（切入点）表达式有很多种，其中execution用于使用切面的连接点。

上面所提到的五种通知方法中，除了环绕通知外，其他的四个通知注解中，加或者不加参数JoinPoint都可以，如果有用到JoinPoint的地方就加，用不到就可以不加。

JoinPoint：里包含了类名、被切面的方法名，参数等属性。

环绕通知：参数必须为ProceedingJoinPoint，pjp.proceed相应于执行被切面的方法。

返回通知：可以加returning = “XXX”，XXX即为被切入方法的返回值，本例中是controller类中方法的返回值。

异常通知：可以加throwing = “XXX”，供读取异常信息。

返回通知和异常通知只会执行一个，如果产生异常，返回通知就不执行，后置通知一定会执行

== 环绕通知一般单独使用，环绕通知可以替代上面的四种通知，后面单独介绍。==

相关概念

  • Joinpoint(连接点)：所谓连接点是指那些被拦截到的点，在 spring 中，这些点指的是方法,因为 spring 只支持方法类型的连接点，通俗的说就是被增强类中的所有方法

  • PointCut(切入点)：所谓切入点是指我们要对哪些 Joinpoint 进行拦截的定义，通俗的说就是被增强类中的被增强的方法，因为被增强类中并不是所有的方法都被代理了

  • Advice(通知/增强)：所谓通知是指拦截到 Joinpoint （被增强的方法）之后所要做的事情就是通知，通俗的说就是对被增强的方法进行增强的代码

  • 通知的类型：前置通知，返回通知，异常通知，后置通知，环绕通知

    • 前置通知：在被代理方法执行之前执行

    • 返回通知：在被代理方法执行之后执行

    • 异常通知：在被代理方法执行出错的时候执行

    • 后置通知：无论怎样都会执行

  • Aspect(切面)：是切入点和通知（引介）的结合，通俗的说就是建立切入点和通知方法在创建时的对应关系

注意：返回通知和异常通知只能有一个会被执行，因为发生异常执行异常通知，然后就不会继续向下执行，自然后置通知也就不会被执行，反之亦然。

实例1

使用aop来完成全局请求日志处理。
在这里插入图片描述
第一步：使用Spring Initializr快速创建一个springboot web项目，名称为testaop
第二步：引入aop相关的依赖

<!--aop相关的依赖引入-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

第三步：创建个controller

@RestController
public class HelloController {
    @RequestMapping("/helloAop")
    public Object hello(){
        return "hello aop";
    }
    @RequestMapping("/helloError")
    public Object helloError(){
        return 1/0;
    }
}

第四步：创建一个aspect切面类

@Aspect
@Component
public class MyAop {
    //切入点：待增强的方法
    @Pointcut("execution(public * com.aismall.testaop.controller.*.*(..))")
    //切入点签名
    public void log(){
        System.out.println("pointCut签名。。。");
    }
    //前置通知
    @Before("log()")
    public void deBefore(JoinPoint jp) throws Throwable {
        // 接收到请求，记录请求内容
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        // 记录下请求内容
        System.out.println("URL : " + request.getRequestURL().toString());
        System.out.println("HTTP_METHOD : " + request.getMethod());
        System.out.println("CLASS_METHOD : " + jp);
        System.out.println("ARGS : " + Arrays.toString(jp.getArgs()));

    }
    //返回通知
    @AfterReturning(returning = "ret", pointcut = "log()")
    public void doAfterReturning(Object ret) throws Throwable {
        // 处理完请求，返回内容
        System.out.println("返回通知：方法的返回值 : " + ret);
    }

    //异常通知
    @AfterThrowing(throwing = "ex", pointcut = "log()")
    public void throwss(JoinPoint jp,Exception ex){
        System.out.println("异常通知：方法异常时执行.....");
        System.out.println("产生异常的方法："+jp);
        System.out.println("异常种类："+ex);
    }

    //后置通知
    @After("log()")
    public void after(JoinPoint jp){
        System.out.println("后置通知：最后且一定执行.....");
    }
}

第六步：启动项目

  • 请求链接：http://localhost:8080/helloAop
  • 控制台返回的结果：
URL : http://localhost:8080/helloAop
HTTP_METHOD : GET
CLASS_METHOD : execution(Object com.aismall.testaop.controller.HelloController.hello())
ARGS : []
返回通知：方法的返回值 : hello aop
后置通知：最后且一定执行.....
  • 请求链接：http://localhost:8080/helloError
  • 控制台返回的结果（部分）：
URL : http://localhost:8080/helloError
HTTP_METHOD : GET
CLASS_METHOD : execution(Object com.aismall.testaop.controller.HelloController.helloError())
ARGS : []
异常通知：方法异常时执行.....
产生异常的方法execution(Object com.aismall.testaop.controller.HelloController.helloError())
异常种类java.lang.ArithmeticException: / by zero
后置通知：最后且一定执行.....

分析：返回通知和异常通知只会执行一个，后置通知一定会执行。

@PointCut 表达式详解

  • PointCut：切入点，指哪些方法需要被执行AOP，PointCut表达式可以有一下几种方式

execution

execution(表达式)

  • 表达式：访问修饰符 返回值 包名.包名.包名…类名.方法名(参数列表)
  • 标准的表达式写法范例：
public void com.aismall.testaop.controller.HelloController.helloAop()
  • 访问修饰符可以省略
void com.aismall.testaop.controller.HelloController.helloAop()
  • 返回值可以使用通配符*，表示任意返回值
* com.aismall.testaop.controller.HelloController.helloAop()
  • 包名可以使用通配符，表示任意包，但是有几级包，就需要写几个*.
* *.*.*.*.HelloController.helloAop()
  • 包名可以使用…表示当前包及其子包
* *...HelloController.helloAop()
  • 类名和方法名都可以使用*来实现通配
* *..*.*()

  • 参数列表：

    • 可以直接写数据类型：

      • 基本类型直接写名称 ：例如，int

      • 引用类型写包名.类名的方式 ：例如，java.lang.String

      • 可以使用通配符*表示任意类型，但是必须有参数

      • 可以使用…表示有无参数均可，有参数可以是任意类型

  • 全通配写法:* ….*(…)

within

within(表达式)：是用来指定类型的，指定类型中的所有方法将被拦截

  • 表达式：包名.包名.包名…类名
  • 标准的表达式写法范例：
com.aismall.testaop.controller.HelloController
  • 举例：匹配HelloController类对应对象的所有方法，并且只能是HelloController的对象，不能是它的子对象。
within(com.aismall.testaop.controller.HelloController)
  • 也可以使用通配符 * ：匹配com.aismall包及其子包下面的所有类的所有方法。
within(com.aismall…*)

this

  • SpringAOP是基于代理的，this就代表代理对象，语法是this(type)，当生成的代理对象可以转化为type指定的类型时表示匹配。

  • this(com.aismall.testaop.controller.HelloController) 匹配生成的代理对象是HelloController类型的所有方法的外部调用

target

  • SpringAOP是基于代理的，target表示被代理的目标对象，当被代理的目标对象可以转换为指定的类型时则表示匹配。
  • target(com.aismall.testaop.controller.HelloController) 匹配所有被代理的目标对象能够转化成HelloController类型的所有方法的外部调用。

args:

args用来匹配方法参数

  • args() 匹配不带参数的方法
  • args(java.lang.String) 匹配方法参数是String类型的
  • ==args(…) == 带任意参数的方法
  • args(java.lang.String,…) 匹配第一个参数是String类型的，其他参数任意。最后一个参数是String的同理。

@annotation:

带有相应注解的方法，比如对标有@Transactional注解的方法进行增强

@annotation(org.springframework.transaction.annotation.Transactional)

  • @within和 @target针对类的注解

  • @annotation 针对方法的注解

@args:

参数带有相应标注的任意方法，比如@Transactional

@args(org.springframework.transaction.annotation.Transactional)

逻辑运算符

表达式可由多个切点函数通过逻辑运算组成

  • 基本使用：使用log()方法相当于直接使用上面的表达式
//PointCut表达式
@Pointcut("execution(public * com.aismall.testaop.controller.HelloController.*(..))")
//PointCut签名
public void log(){
}
  • PointCut中的运算符：PointCut中可以使用 && 、|| 、! 运算
@Pointcut("execution(public * com.aismall.testaop.controller.HelloController.*(..))")
public void cutController(){
}

@Pointcut("execution(public * com.aismall.testaop.service.UserService.*(..))")
public void cutService(){
}

//使用 && 运算符，则cutAll()的作用等同于cutController 和 cutService 之和
@Pointcut("cutController() && cutService()")
public void cutAll(){
}

实例2

@annotation方式
在这里插入图片描述
第一步：编写一个自定义注解

//表示次注解可以标注在类和方法上
@Target({ElementType.METHOD, ElementType.TYPE})
//运行时生效
@Retention(RetentionPolicy.RUNTIME)
public @interface MyLogAnnotation {
    //定义一个变量，可以接受参数
    String desc() default " ";
}

第二步：在HelloController类中添加一个方法

@RequestMapping("helloAnnotation")
//标有这个注解的方法会被增强
@MyLogAnnotation(desc = "@Annotation")
public Object helloAnnotation() {
    return "hello annotation";
}

第三步：切面类

@Aspect
@Component
public class MyAopAnnotation {
    //切入点：增强标有MyLogAnnotation注解的方法
    @Pointcut(value="@annotation(com.aismall.testaop.MyAnnotation.MyLogAnnotation)")
    //切入点签名
    public void logAnnotation(){
        System.out.println("pointCut签名。。。");
    }
    //前置通知
    @Before("logAnnotation()")
    public void deBefore(JoinPoint jp) throws Throwable {
        // 接收到请求，记录请求内容
        ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
        HttpServletRequest request = attributes.getRequest();
        // 记录下请求内容
        System.out.println("URL : " + request.getRequestURL().toString());
    }
    //返回通知
    @AfterReturning(returning = "ret", pointcut = "logAnnotation()")
    public void doAfterReturning(Object ret) throws Throwable {
        // 处理完请求，返回内容
        System.out.println("返回通知：方法的返回值 : " + ret);
    }

    //异常通知
    @AfterThrowing(throwing = "ex", pointcut = "logAnnotation()")
    public void throwss(JoinPoint jp,Exception ex){
        System.out.println("异常通知：方法异常时执行.....");
        System.out.println("产生异常的方法："+jp);
        System.out.println("异常种类："+ex);
    }

    //后置通知
    @After("logAnnotation()")
    public void after(JoinPoint jp){
        System.out.println("后置通知：最后且一定执行.....");
    }
}

第四步：启动项目

  • 请求链接：http://localhost:8080/helloAnnotation
  • 控制台返回的结果：
URL : http://localhost:8080/helloAnnotation
返回通知：方法的返回值 : hello annotation
后置通知：最后且一定执行.....

环绕通知

spring的通知（Advice）中 一共有五种通知，之前已经介绍了四种，为什么不把环绕通知和它们放在一起说，因为环绕通知可以把前面的四种通知都表示出来，而且环绕通知一般单独使用

环绕通知的使用：

  • Spring框架为我们提供了一个接口：ProceedingJoinPoint，该接口有一个方法proceed()，此方法就相当于明确调用切入点方法。
  • 该接口作为环绕通知的方法参数，在程序执行时，spring框架会为我们提供该接口的实现类供我们使用。
  • 增强代码写在调用proceed()方法之前为前置通知，之后为返回通知，写在catch中为异常通知，写在finally中为后置通知
    在这里插入图片描述
    第一步：在HelloController类中添加一个方法
@RequestMapping("/helloAround")
public Object helloAround(){
    System.out.println("helloAround执行了。。。");
    return "hello around";
}

第二步：切面类

@Aspect
@Component
public class MyAroundAop {
    //切入点：待增强的方法
    @Pointcut("execution(public * com.aismall.testaop.controller.*.*(..))")
    //切入点签名
    public void logAround() {
        System.out.println("pointCut签名。。。");
    }

    //环绕通知,环绕增强，相当于MethodInterceptor
    @Around("logAround()")
    public Object aroundAdvice(ProceedingJoinPoint pjp) {
        Object rtValue = null;
        try {
            Object[] args = pjp.getArgs();//得到方法执行所需的参数

            System.out.println("通知类中的aroundAdvice方法执行了。。前置");

            rtValue = pjp.proceed(args);//明确调用切入点方法（切入点方法）

            System.out.println("通知类中的aroundAdvice方法执行了。。返回");
            System.out.println("返回通知："+rtValue);

            return rtValue;
        } catch (Throwable e) {
            System.out.println("通知类中的aroundAdvice方法执行了。。异常");
            throw new RuntimeException(e);
        } finally {
            System.out.println("通知类中的aroundAdvice方法执行了。。后置");
        }
    }
}

第三步：启动项目

  • 请求链接：http://localhost:8080/helloAround
  • 控制台返回的结果：
通知类中的aroundAdvice方法执行了。。前置
helloAround执行了。。。
通知类中的aroundAdvice方法执行了。。返回
返回通知：hello around
通知类中的aroundAdvice方法执行了。。后置

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/105904.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

「实操」适配 NebulaGraph 新版本与压测实践

「实操」适配 NebulaGraph 新版本与压测实践

本文来自邦盛科技-知识图谱团队-繁凡&#xff0c;本文以 NebulaGraph v3.1.0 为例。 前言 NebulaGraph v3.1 版本已经发布有一段时间了&#xff0c;但是我们的项目之前是基于 v2.6.1 版本开发的&#xff0c;由于一直在做功能相关的工作&#xff0c;所以一直没有对图库进行升级…
阅读更多...
一个简单的步骤让你的 Python 代码更干净

一个简单的步骤让你的 Python 代码更干净

说起来容易做起来难&#xff0c;我们都知道代码可读性非常重要&#xff0c;但是写的时候总是随心所欲&#xff0c;不考虑类型提示、import 排序、PEP8 规范。今天分享一个小技巧&#xff0c;通过一个简单的步骤就可以让你的 Python 代码更干净。 这就是 pre-commit&#xff1a…
阅读更多...
pyQt5和pySide2 环境配置以及部分问题解决方案

pyQt5和pySide2 环境配置以及部分问题解决方案

首先介绍需要安装的内容&#xff1a; 1、Qt 2、python3.7.5&#xff08;查找资料过程中有注意到说是3.8及3.8以上版本Qt可能不兼容&#xff09;【记得勾选添加到环境变量中选项】 3、pip&#xff08;主要用来下载使用&#xff09; 4、pySide2、PyQt5、pyqt5-tools 5、如果有使…
阅读更多...
vue 前端国际化方案

vue 前端国际化方案

方案介绍&#xff1a; 1.使用i18n&#xff08;使用步骤可百度&#xff0c;要注意版本问题&#xff09; 2.整合ele-ui的国际化方案&#xff08;百度&#xff0c;几行添加一下即可&#xff09; 3.数据信息的配置&#xff08;重头戏&#xff0c;以下详细介绍&#xff09;excel转j…
阅读更多...
中科院高分区盘点：1区新刊，影响因子即将突破7分（含IEEE）

中科院高分区盘点：1区新刊，影响因子即将突破7分（含IEEE）

高分新刊——计算机领域 1区人工智能类SCI&EI 【出版社】IEEE 【自引率】4.30%&#xff08;低&#xff09; 【国人占比】13.40% 【期刊简介】IF:6.5-7.0&#xff0c;JCR1区&#xff0c;中科院3区 【检索情况】SCI&EI 双检&#xff0c;正刊 【参考周期】3-5个月左…
阅读更多...
Hierarchical Fusion Model （2019 ACL）三种模态的层次融合

Hierarchical Fusion Model （2019 ACL）三种模态的层次融合

论文题目&#xff08;Title&#xff09;&#xff1a;Multi-Modal Sarcasm Detection in Twitter with Hierarchical Fusion Model 研究问题&#xff08;Question&#xff09;&#xff1a;主要研究了推特中由文本和图像组成的推文的多模态讽刺检测 研究动机&#xff08;Motiva…
阅读更多...
二肽Phe-Pro，7669-65-0，FP

二肽Phe-Pro，7669-65-0，FP

Substrate for skin fibroblast prolidase.皮肤成纤维细胞prolida酶的底物。 编号: 131185中文名称: 二肽Phe-Pro英文名: Phe-ProCAS号: 7669-65-0单字母: H2N-FP-OH三字母: H2N-Phe-Pro-COOH氨基酸个数: 2分子式: C14H18N2O3平均分子量: 262.3精确分子量: 262.13等电点(PI): 6…
阅读更多...
【学习笔记02】vue指令学习

【学习笔记02】vue指令学习

目录 一、常用的指令 &#xff08;一&#xff09;v-bind 1、绑定样式 2、$event &#xff08;二&#xff09;v-on 1、v-on修饰符 2、按键修饰符 3、案例&#xff1a;Todolist &#xff08;三&#xff09;v-model 1、 v-model和v-bind的区别 2、案例&#xff1a;数…
阅读更多...
wy的leetcode刷题记录_Day60

wy的leetcode刷题记录_Day60

wy的leetcode刷题记录_Day60 声明 本文章的所有题目信息都来源于leetcode 如有侵权请联系我删掉! 时间&#xff1a;2022-12-21 前言 这几天身体不舒服&#xff0c;现在重新开始更新。 目录wy的leetcode刷题记录_Day60声明前言1753. 移除石子的最大得分题目介绍思路代码收获…
阅读更多...
Java 异常（Exceptions）

Java 异常（Exceptions）

目录 1、什么是异常&#xff1f; 2、捕获并处理异常 try-with-resources 语句 3、通过方法抛出异常 自定义异常 1、什么是异常&#xff1f; 定义&#xff1a;异常是在程序执行过程中发生的一种事件&#xff0c;它会中断程序指令的正常流程。 当方法中发生错误时&#xff0…
阅读更多...
2022年我国止血药行业市场规模不断增长 激活凝血因子活性药是主流产品

2022年我国止血药行业市场规模不断增长 激活凝血因子活性药是主流产品

根据观研报告网发布的《中国止血药市场现状深度研究与发展前景分析报告&#xff08;2022-2029年&#xff09;》显示&#xff0c;止血药主要是指凡能够制止体内外出血的药物&#xff0c;主要适用于各部位出血病症&#xff0c;如咯血、衄血、吐血、尿血、便血、崩漏、紫癜及创伤出…
阅读更多...
记录一次使用 Ubuntu 编译 Wakaama 踩坑过程

记录一次使用 Ubuntu 编译 Wakaama 踩坑过程

1. 背景 公司项目需要使用 LwM2M 协议&#xff0c;由于是个相对冷门的小众协议&#xff0c;客户端模拟器几乎没有&#xff0c;只有 Eclipse Wakaama 相对来说功能齐全、易用&#xff0c;但是这个软件没有编译好的程序包&#xff0c;只能从 Github 拉取源码手动编译运行。 不知道…
阅读更多...
操作系统期末知识点复习

操作系统期末知识点复习

操作系统知识点总结 参考用书&#xff1a;计算机操作系统&#xff08;第四版&#xff09;汤小丹等著 1、必考知识点 第一章 操作系统引论 操作系统的概念及特征操作系统的运行环境 第二章 进程的描述与控制 进程状态与转换同步与互斥的基本概念信号量信号量的基本应用生产者消…
阅读更多...
Nacos的配置中心的了解

Nacos的配置中心的了解

目录 1. 为何需要配置中心 2. nacos的配置中心 2.1 配置示例 2.2 多环境配置 2.3 GROUP 2.4 namespace 1. 为何需要配置中心 没有配置中心的情况下会出现什么情况&#xff1a; 如果没有配置中心&#xff0c;则各个服务的配置文件分散在各个项目中&#xff0c;不方便维护…
阅读更多...
不用光盘重装系统如何操作

不用光盘重装系统如何操作

​光盘重装系统是之前十分常用的系统安装方法,随着科技的飞速发展,现如今重装系统的方法五花八门,一键重装系统以及U盘重装系统等方法的出现取代了光盘重装系统,这里就来介绍一下不用光盘重装系统操作方法。 工具/原料&#xff1a; 系统版本&#xff1a;windows10系统 品牌型…
阅读更多...
Kotlin协程笔记：CoroutineScope管理协程

Kotlin协程笔记：CoroutineScope管理协程

CoroutineScope 是实现协程结构化并发的关键。使用 CoroutineScope&#xff0c;可以批量管理同一个作用域下面所有的协程。 CoroutineScope 与 结构化并发 launch、async 被定义成了 CoroutineScope 扩展函数。在调用 launch 之前&#xff0c;必须先获取 CoroutineScope。 pub…
阅读更多...
高级又高效的属性表编辑技术，你值得拥有！

高级又高效的属性表编辑技术，你值得拥有！

当你要按关键词选择内容，无从下手？ 当你要修改字段的部分内容，不知所措？ 当你要提取出字段的某些内容，毫无头绪？ 当你要按照位数来提取字符内容，力不从心？ 当你要为字段补充一些新的内容，目瞪口呆？ 当你要把一个字段分割成多个字段，抓耳挠腮？ ...... 属性表的…
阅读更多...
CUDA ~ WarpReduce

CUDA ~ WarpReduce

又是一篇关于cuda的 要好好学学哦, CUDA 编程进阶分享&#xff0c;一些 warp 的使用 如何实现一个高效的Softmax CUDA kernel&#xff1f;多少还是有些细节没有理解&#xff0c;恰好最近要做一个类似的 ReduceScale Kernel&#xff0c;原理机制还是比较相似的&#xff0c;所以…
阅读更多...
CSS -- 10. 移动WEB开发之rem布局

CSS -- 10. 移动WEB开发之rem布局

文章目录移动WEB开发之rem布局1 rem基础2 媒体查询2.1 什么是媒体查询2.2 语法规范2.3 mediatype 查询类型2.4 关键字2.5 媒体特性2.6 案例&#xff1a;根据页面宽度改变背景颜色2.7 媒体查询rem实现元素动态大小变化2.8 针对不同的屏幕尺寸引入不同的样式文件3 Less基础3.1 维…
阅读更多...
8000字详解Thread Pool Executor

8000字详解Thread Pool Executor

摘要&#xff1a;Java是如何实现和管理线程池的?本文分享自华为云社区《JUC线程池: ThreadPoolExecutor详解》&#xff0c;作者&#xff1a;龙哥手记 。 带着大厂的面试问题去理解 提示 请带着这些问题继续后文&#xff0c;会很大程度上帮助你更好的理解相关知识点。pdai …
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023