AOP也是spring框架的第二大核心#xff0c;我们先来学习AOP的基础。

在AOP基础这个阶段#xff0c;我们首先介绍一下什么是AOP#xff0c;再通过一个快速入门程序#xff0c…SpringBoot-AOP

AOP基础

学习完spring的事务管理之后接下来我们进入到AOP的学习。

AOP也是spring框架的第二大核心我们先来学习AOP的基础。

在AOP基础这个阶段我们首先介绍一下什么是AOP再通过一个快速入门程序让大家快速体验AOP程序的开发。

最后再介绍AOP当中所涉及到的一些核心的概念。

AOP概述

Programming面向切面编程、面向方面编程其实说白了面向切面编程就是面向特定方法编程。

那什么又是面向方法编程呢为什么又需要面向方法编程呢来我们举个例子做一个说明

然而有一些业务功能执行效率比较低执行耗时较长我们需要针对于这些业务方法进行优化。

那首先第一步就需要定位出执行耗时比较长的业务方法再针对于业务方法再来进行优化。

此时我们就需要统计当前这个项目当中每一个业务方法的执行耗时。

那么统计每一个业务方法的执行耗时该怎么实现

可能多数人首先想到的就是在每一个业务方法运行之前记录这个方法运行的开始时间。

在这个方法运行完毕之后再来记录这个方法运行的结束时间。

拿结束时间减去开始时间不就是这个方法的执行耗时吗

以上分析的实现方式是可以解决需求问题的。

但是对于一个项目来讲里面会包含很多的业务模块每个业务模块又包含很多增删改查的方法如果我们要在每一个模块下的业务方法中添加记录开始时间、结束时间、计算执行耗时的代码就会让程序员的工作变得非常繁琐。

而AOP面向方法编程就可以做到在不改动这些原始方法的基础上针对特定的方法进行功能的增强。

AOP的作用在程序运行期间在不修改源代码的基础上对已有方法进行增强无侵入性:

我们要想完成统计各个业务方法执行耗时的需求我们只需要定义一个模板方法将记录方法执行耗时这一部分公共的逻辑代码定义在模板方法当中在这个方法开始运行之前来记录这个方法运行的开始时间在方法结束运行的时候再来记录方法运行的结束时间中间就来运行原始的业务方法。

而中间运行的原始业务方法可能是其中的一个业务方法比如我们只想通过

list

而如果我们是先想统计所有部门管理的业务方法执行耗时那此时所有的部门管理的业务方法都是

list

记录方法运行开始时间运行原始的业务方法那此时原始的业务方法就是

list

不论我们运行的是那个业务方法最后其实运行的就是我们定义的模板方法而在模板方法中就完成了原始方法执行耗时的统计操作

。

(那这样呢我们就通过一个模板方法就完成了指定的一个或多个业务方法执行耗时的统计)

我们所说的模板方法其实就是代理对象中所定义的方法那代理对象中的方法以及根据对应的业务需要

完成了对应的业务功能当运行原始业务方法时就会运行代理对象中的方法从而实现统计业务方法执行耗时的操作。

其实AOP面向切面编程和OOP面向对象编程一样它们都仅仅是一种编程思想而动态代理技术是这种思想最主流的实现方式。

而Spring的AOP是Spring框架的高级技术旨在管理bean对象的过程中底层使用动态代理机制对特定的方法进行编程(功能增强)。

减少重复代码提高开发效率维护方便

在了解了什么是AOP后我们下面通过一个快速入门程序体验下AOP的开发并掌握Spring中AOP的开发步骤。

实现步骤

导入依赖在pom.xml中导入AOP的依赖编写AOP程序针对于特定方法根据业务需要进行编程

为演示方便可以自建新项目或导入提供的springboot-aop-quickstart项目工程

pom.xml

dependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-aop/artifactId

Component

System.currentTimeMillis();//执行原始方法Object

result

System.currentTimeMillis();//计算方法执行耗时log.info(pjp.getSignature()执行耗时:

result;}

我们通过AOP入门程序完成了业务方法执行耗时的统计那其实AOP的功能远不止于此常见的应用场景如下

记录系统的操作日志权限控制事务管理我们前面所讲解的Spring事务管理底层其实也是通过AOP来实现的只要添加Transactional注解之后AOP程序自动会在原始方法运行前先来开启事务在原始方法运行完毕之后提交或回滚事务

代码无侵入没有修改原始的业务方法就已经对原始的业务方法进行了功能的增强或者是功能的改变

提高开发效率

通过SpringAOP的快速入门感受了一下AOP面向切面编程的开发方式。

下面我们再来学习AOP当中涉及到的一些核心概念。

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

连接点指的是可以被aop控制的方法。

例如入门程序当中所有的业务方法都是可以被aop控制的方法。

在SpringAOP提供的JoinPoint当中封装了连接点方法在执行时的相关信息。

后面会有具体的讲解

通知Advice指哪些重复的逻辑也就是共性功能最终体现为一个方法

在入门程序中是需要统计各个业务方法的执行耗时的此时我们就需要在这些业务方法运行开始之前先记录这个方法运行的开始时间在每一个业务方法运行结束的时候再来记录这个方法运行的结束时间。

但是在AOP面向切面编程当中我们只需要将这部分重复的代码逻辑抽取出来单独定义。

抽取出来的这一部分重复的逻辑也就是共性的功能。

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

在通知当中我们所定义的共性功能到底要应用在哪些方法上此时就涉及到了切入点pointcut概念。

切入点指的是匹配连接点的条件。

通知仅会在切入点方法运行时才会被应用。

在aop的开发当中我们通常会通过一个切入点表达式来描述切入点(后面会有详解)。

假如切入点表达式改为DeptServiceImpl.list()此时就代表仅仅只有list这一个方法是切入点。

只有list()方法在运行的时候才会应用通知。

当通知和切入点结合在一起就形成了一个切面。

通过切面就能够描述当前aop程序需要针对于哪个原始方法在什么时候执行什么样的操作。

AOP的核心概念我们介绍完毕之后接下来我们再来分析一下我们所定义的通知是如何与目标对象结合在一起对目标对象当中的方法进行功能增强的。

Spring的AOP底层是基于动态代理技术来实现的也就是说在程序运行的时候会自动的基于动态代理技术为目标对象生成一个对应的代理对象。

在代理对象当中就会对目标对象当中的原始方法进行功能的增强。

AOP进阶

AOP的基础知识学习完之后下面我们对AOP当中的各个细节进行详细的学习。

主要分为4个部分

3.1

在入门程序当中我们已经使用了一种功能最为强大的通知类型Around环绕通知。

Around(execution(*

System.currentTimeMillis();//执行原始方法Object

result

System.currentTimeMillis();//计算方法执行耗时log.info(pjp.getSignature()执行耗时:

result;

}只要我们在通知方法上加上了Around注解就代表当前通知是一个环绕通知。

Around环绕通知此注解标注的通知方法在目标方法前、后都被执行Before前置通知此注解标注的通知方法在目标方法前被执行After

后置通知此注解标注的通知方法在目标方法后被执行无论是否有异常都会执行AfterReturning

返回后通知此注解标注的通知方法在目标方法后被执行有异常不会执行AfterThrowing

Slf4j

com.shisan.service.*.*(..)))public

void

com.shisan.service.*.*(..)))public

Object

proceedingJoinPoint.proceed();//原始方法如果执行时有异常环绕通知中的后置代码不会在执行了log.info(around

after

result;}//后置通知After(execution(*

com.shisan.service.*.*(..)))public

void

...);}//返回后通知程序在正常执行的情况下会执行的后置通知AfterReturning(execution(*

com.shisan.service.*.*(..)))public

void

joinPoint){log.info(afterReturning

...);}//异常通知程序在出现异常的情况下执行的后置通知AfterThrowing(execution(*

com.shisan.service.*.*(..)))public

void

joinPoint){log.info(afterThrowing

...);}

程序没有发生异常的情况下AfterThrowing标识的通知方法不会执行。

出现异常情况下

}重新启动SpringBoot服务测试发生异常情况下通知的执行

查看idea中控制台日志输出

AfterReturning标识的通知方法不会执行AfterThrowing标识的通知方法执行了

Around环绕通知中原始方法调用时有异常通知中的环绕后的代码逻辑也不会在执行了

来让原始方法执行其他通知不需要考虑目标方法执行Around环绕通知方法的返回值必须指定为Object来接收原始方法的返回值否则原始方法执行完毕是获取不到返回值的。

五种常见的通知类型我们已经测试完毕了此时我们再来看一下刚才所编写的代码有什么问题吗

Before(execution(*

com.shisan.service.*.*(..)))//环绕通知

Around(execution(*

com.shisan.service.*.*(..)))//后置通知

After(execution(*

com.shisan.service.*.*(..)))//返回后通知程序在正常执行的情况下会执行的后置通知

com.shisan.service.*.*(..)))//异常通知程序在出现异常的情况下执行的后置通知

com.shisan.service.*.*(..)))我们发现啊每一个注解里面都指定了切入点表达式而且这些切入点表达式都一模一样。

此时我们的代码当中就存在了大量的重复性的切入点表达式假如此时切入点表达式需要变动就需要将所有的切入点表达式一个一个的来改动就变得非常繁琐了。

Spring提供了PointCut注解该注解的作用是将公共的切入点表达式抽取出来需要用到时引用该切入点表达式即可。

Slf4j

{//切入点方法公共的切入点表达式Pointcut(execution(*

com.shisan.service.*.*(..)))private

void

pt(){}//前置通知引用切入点Before(pt())public

void

proceedingJoinPoint.proceed();//原始方法在执行时发生异常//后续代码不在执行log.info(around

after

result;}//后置通知After(pt())public

void

...);}//返回后通知程序在正常执行的情况下会执行的后置通知AfterReturning(pt())public

void

joinPoint){log.info(afterReturning

...);}//异常通知程序在出现异常的情况下执行的后置通知AfterThrowing(pt())public

void

joinPoint){log.info(afterThrowing

...);}

}需要注意的是当切入点方法使用private修饰时仅能在当前切面类中引用该表达式

当外部其他切面类中也要引用当前类中的切入点表达式就需要把private改为public而在引用的时候具体的语法为

全类名.方法名()具体形式如下

{//引用MyAspect1切面类中的切入点表达式Before(com.shisan.aspect.MyAspect1.pt())public

void

讲解完了Spring中AOP所支持的5种通知类型之后接下来我们再来研究通知的执行顺序。

当在项目开发当中我们定义了多个切面类而多个切面类中多个切入点都匹配到了同一个目标方法。

此时当目标方法在运行的时候这多个切面类当中的这些通知方法都会运行。

下面我们通过程序来验证这里呢我们就定义两种类型的通知进行测试一种是前置通知Before一种是后置通知After

定义多个切面类

com.shisan.service.*.*(..)))public

void

com.shisan.service.*.*(..)))public

void

com.shisan.service.*.*(..)))public

void

com.shisan.service.*.*(..)))public

void

com.shisan.service.*.*(..)))public

void

com.shisan.service.*.*(..)))public

void

把DeptServiceImpl实现类中模拟异常的代码删除或注释掉。

注释掉其他切面类(把Aspect注释即可)仅保留MyAspect2、MyAspect3、MyAspect4

使用postman测试查询所有部门数据

通过以上程序运行可以看出在不同切面类中默认按照切面类的类名字母排序

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

修改切面类的类名这种方式非常繁琐、而且不便管理使用Spring提供的Order注解

Slf4j

com.shisan.service.*.*(..)))public

void

com.shisan.service.*.*(..)))public

void

com.shisan.service.*.*(..)))public

void

com.shisan.service.*.*(..)))public

void

com.shisan.service.*.*(..)))public

void

com.shisan.service.*.*(..)))public

void

不同的切面类当中默认情况下通知的执行顺序是与切面类的类名字母排序是有关系的可以在切面类上面加上Order注解来控制不同的切面类通知的执行顺序

3.3

从AOP的入门程序到现在我们一直都在使用切入点表达式来描述切入点。

下面我们就来详细的介绍一下切入点表达式的具体写法。

切入点表达式

首先我们先学习第一种最为常见的execution切入点表达式。

3.3.1

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

execution(访问修饰符?

com.shisan.service.impl.DeptServiceImpl.delete(java.lang.Integer)))可以使用通配符描述切入点

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

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

方法的访问修饰符可以省略返回值可以使用*号代替任意返回值类型包名可以使用*号代替代表任意包一层包使用一个*使用..配置包名标识此包以及此包下的所有子包类名可以使用*号代替标识任意类方法名可以使用*号代替表示任意方法可以使用

切入点表达式示例

com.shisan.service.impl.DeptServiceImpl.delete(java.lang.Integer))使用*代替返回值类型

execution(*

com.shisan.service.impl.DeptServiceImpl.delete(java.lang.Integer))使用*代替包名一层包使用一个*

execution(*

com.shisan.*.*.DeptServiceImpl.delete(java.lang.Integer))使用..省略包名

execution(*

com..DeptServiceImpl.delete(java.lang.Integer))

使用*代替类名

com..*.delete(java.lang.Integer))

使用*代替方法名

com.shisan.service.impl.DeptServiceImpl.delete(*))使用..省略参数

execution(*

com.shisan.service.DeptService.list(..))

execution(*

com.itheima.service.DeptService.delete(..))切入点表达式的书写建议

所有业务方法名在命名时尽量规范方便切入点表达式快速匹配。

如查询类方法都是

find

}//匹配DeptServiceImpl类中以find开头的方法

execution(*

com.shisan.service.impl.DeptServiceImpl.find*(..))描述切入点方法通常基于接口描述而不是直接描述实现类增强拓展性

execution(*

com.shisan.service.DeptService.*(..))在满足业务需要的前提下尽量缩小切入点的匹配范围。

如包名匹配尽量不使用

…使用

com.shisan.*.*.DeptServiceImpl.find*(..))3.3.2

annotation

已经学习了execution切入点表达式的语法。

那么如果我们要匹配多个无规则的方法比如list()和

delete()这两个方法。

这个时候我们基于execution这种切入点表达式来描述就不是很方便了。

而在之前我们是将两个切入点表达式组合在了一起完成的需求这个是比较繁琐的。

我们可以借助于另一种切入点表达式annotation来描述这一类的切入点从而来简化切入点表达式的书写。

实现步骤

Retention(RetentionPolicy.RUNTIME)

public

删除部门deptMapper.delete(id);}Overridepublic

void

{dept.setCreateTime(LocalDateTime.now());dept.setUpdateTime(LocalDateTime.now());deptMapper.save(dept);}Overridepublic

Dept

deptMapper.getById(id);}Overridepublic

void

{dept.setUpdateTime(LocalDateTime.now());deptMapper.update(dept);}

}切面类

{//针对list方法、delete方法进行前置通知和后置通知//前置通知Before(annotation(com.shisan.anno.MyLog))public

void

...);}//后置通知After(annotation(com.shisan.anno.MyLog))public

void

}重启SpringBoot服务测试查询所有部门数据查看控制台日志

execution切入点表达式

根据我们所指定的方法的描述信息来匹配切入点方法这种方式也是最为常用的一种方式如果我们要匹配的切入点方法的方法名不规则或者有一些比较特殊的需求通过execution切入点表达式描述比较繁琐

annotation

基于注解的方式来匹配切入点方法。

这种方式虽然多一步操作我们需要自定义一个注解但是相对来比较灵活。

我们需要匹配哪个方法就在方法上加上对应的注解就可以了

3.4

讲解完了切入点表达式之后接下来我们再来讲解最后一个部分连接点。

我们前面在讲解AOP核心概念的时候我们提到过什么是连接点连接点可以简单理解为可以被AOP控制的方法。

我们目标对象当中所有的方法是不是都是可以被AOP控制的方法。

而在SpringAOP当中连接点又特指方法的执行。

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

对于Around通知获取连接点信息只能使用ProceedingJoinPoint类型

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

示例代码

{Pointcut(annotation(com.shisan.anno.MyLog))private

void

joinPoint){log.info(joinPoint.getSignature().getName()

MyAspect7

joinPoint){log.info(joinPoint.getSignature().getName()

MyAspect7

pjp.getTarget().getClass().getName();log.info(目标类名{},name);//目标方法名String

methodName

pjp.getSignature().getName();log.info(目标方法名{},methodName);//获取方法执行时需要的参数Object[]

args

pjp.getArgs();log.info(目标方法参数{},

Arrays.toString(args));//执行原始方法Object

returnValue