SpringBoot中的Aop用法

什么是Aop

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

引入AOP依赖包后，一般来说并不需要去做其他配置，使用过Spring注解配置方式的人会问是否需要在程序主类中增加@EnableAspectJAutoProxy来启用，实际并不需要。
因为在AOP的默认配置属性中，spring.aop.auto属性默认是开启的，也就是说只要引入了AOP依赖后，默认已经增加了@EnableAspectJAutoProxy
Springboot中有关AOP相关的自动配置包为：AopAutoConfiguration

Aop概述

实例1

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

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

第三步：创建个controller

@RestControllerpublicclassHelloController{@RequestMapping("/helloAop")publicObjecthello(){return"hello aop";}@RequestMapping("/helloError")publicObjecthelloError(){return1/0;}}

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

@Aspect@ComponentpublicclassMyAop{//切入点：待增强的方法@Pointcut("execution(public * com.aismall.testaop.controller.*.*(..))")//切入点签名publicvoidlog(){System.out.println("pointCut签名。。。");}//前置通知@Before("log()")publicvoiddeBefore(JoinPoint jp)throwsThrowable{// 接收到请求，记录请求内容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()")publicvoiddoAfterReturning(Object ret)throwsThrowable{// 处理完请求，返回内容System.out.println("返回通知：方法的返回值 : "+ ret);}//异常通知@AfterThrowing(throwing ="ex", pointcut ="log()")publicvoidthrowss(JoinPoint jp,Exception ex){System.out.println("异常通知：方法异常时执行.....");System.out.println("产生异常的方法："+jp);System.out.println("异常种类："+ex);}//后置通知@After("log()")publicvoidafter(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(表达式)

表达式：访问修饰符返回值包名.包名.包名…类名.方法名(参数列表)
标准的表达式写法范例：

publicvoidcom.aismall.testaop.controller.HelloController.helloAop()

访问修饰符可以省略

voidcom.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@interfaceMyLogAnnotation{//定义一个变量，可以接受参数Stringdesc()default" ";}

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

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

第三步：切面类

@Aspect@ComponentpublicclassMyAopAnnotation{//切入点：增强标有MyLogAnnotation注解的方法@Pointcut(value="@annotation(com.aismall.testaop.MyAnnotation.MyLogAnnotation)")//切入点签名publicvoidlogAnnotation(){System.out.println("pointCut签名。。。");}//前置通知@Before("logAnnotation()")publicvoiddeBefore(JoinPoint jp)throwsThrowable{// 接收到请求，记录请求内容ServletRequestAttributes attributes =(ServletRequestAttributes)RequestContextHolder.getRequestAttributes();HttpServletRequest request = attributes.getRequest();// 记录下请求内容System.out.println("URL : "+ request.getRequestURL().toString());}//返回通知@AfterReturning(returning ="ret", pointcut ="logAnnotation()")publicvoiddoAfterReturning(Object ret)throwsThrowable{// 处理完请求，返回内容System.out.println("返回通知：方法的返回值 : "+ ret);}//异常通知@AfterThrowing(throwing ="ex", pointcut ="logAnnotation()")publicvoidthrowss(JoinPoint jp,Exception ex){System.out.println("异常通知：方法异常时执行.....");System.out.println("产生异常的方法："+jp);System.out.println("异常种类："+ex);}//后置通知@After("logAnnotation()")publicvoidafter(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")publicObjecthelloAround(){System.out.println("helloAround执行了。。。");return"hello around";}

第二步：切面类

@Aspect@ComponentpublicclassMyAroundAop{//切入点：待增强的方法@Pointcut("execution(public * com.aismall.testaop.controller.*.*(..))")//切入点签名publicvoidlogAround(){System.out.println("pointCut签名。。。");}//环绕通知,环绕增强，相当于MethodInterceptor@Around("logAround()")publicObjectaroundAdvice(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方法执行了。。异常");thrownewRuntimeException(e);}finally{System.out.println("通知类中的aroundAdvice方法执行了。。后置");}}}

第三步：启动项目

请求链接：http://localhost:8080/helloAround
控制台返回的结果：

通知类中的aroundAdvice方法执行了。。前置
helloAround执行了。。。
通知类中的aroundAdvice方法执行了。。返回
返回通知：hello around
通知类中的aroundAdvice方法执行了。。后置

标签： spring boot spring java

本文转载自: https://blog.csdn.net/weixin_42193830/article/details/128398703
版权归原作者 这很张扬 所有，如有侵权，请联系我们删除。

SpringBoot中的Aop用法

目录

什么是Aop

Aop概述

相关注解

相关概念

实例1

@PointCut 表达式详解

execution

within

this

target

args:

@annotation:

@args:

逻辑运算符

实例2

环绕通知

发表评论

“SpringBoot中的Aop用法”的评论:

关于作者

overfit同步小助手

相关阅读

文章导航