
- 衍生范型
- 函数式编程
- 又 意
- 葡萄酒
- 简 称
- AOP
- 中文名
- 面向切面编程
- 属 性
- 软件开发技术
- 外文名
- Aspect Oriented Programming
-
AOP
2019-04-10 14:07:17AOP(Aspect Oriented Programming),是面向切面编程的技术。AOP基于IOC基础,是对OOP的有益补充。 AOP将应用系统拆分为个部分:核心业务逻辑及横向的通用逻辑,也就是所谓的切面。 举例:所有大中型应用都要涉及到...AOP(Aspect Oriented Programming),是面向切面编程的技术。AOP基于IOC基础,是对OOP的有益补充。
AOP将应用系统拆分为个部分:核心业务逻辑及横向的通用逻辑,也就是所谓的切面。
举例:所有大中型应用都要涉及到的持久化管理、事务管理、权限管理、日志管理和调试管理等。使用AOP技术可以让开发人员只专注核心业务,而通用逻辑则使用AOP技术进行横向切入,由专人去处理这些通用逻辑,会使得任务简单明了,提高开发和调试的效率。
Target:目标类
Joinpoint:连接点是指所有可能织入通知的方法理论上大部分方法都是连接点
Pointcut:切入点,已经被增强的方法
Advice:通知,增强的方法
Aspect:切面,通知所在的类就叫切面。
Weaving:织入,将通知应用到目标对象来创建新的代理对象的过程。
通知的类型: 前置通知 后置通知 返回通知 异常通知 环绕通知
各类通知的执行顺序: 前置通知 2.执行目标方法 3.执行后置通知 4.返回通知||异常通知
前置通知,后置通知,返回通知,异常通知都可以接受一个JoinPoint类型的对象作为参数。该对象封装了连接点的相关信息。主要关注:方法参数和方法签名。
返回通知的returning属性可以将目标方法的返回值定义一个名字,然后在返回通知的形参上声明一个同名的Object类型的参数,来访问方法的返回结果。
<aop:after-returning method=”afterReturnLog” pointcut-ref=”userDaoPointccut” returning=”result” /> 环绕通知 环绕通知必须要有返回值(Object类型)
环绕通知必须要有形参(ProceedingJoinPoint pjp)
在环绕通知中,通过pjp.proceed()方法显示调用目标对象的切点并将结果返回出去。
使用注解配置aop
引入约束 beans context aop 扫描包 开启注解式的aop <aop:aspectj-autoproxy proxy-target-class="true"></aop:aspectj-autoproxy>
在业务类上加上注解(@Component)
在属性上加@Autowired注解
在切面类上加注解 (@Component @Aspect)
在通知上加上相应的注解 @Before(value="")
@AfterReturning(returning="目标切点返回值的名字") 在通知方法参数只能为Object
@AfterThrowing(throwing="异常的名字") 在通知方法参数可以为Object也可为Exception
重用切入点表达式: 在切面中定义一个空的方法,在方法上加@Pointcut注解,在value属性中指定切入点表达式 @Pointcut(value=“execution(* com.cdsxt.dao.*.*(..))”) Public void pointcutExpression(){} @Before(value="pointcutExpression()")
在面对多个切面时可以在类上加@Order(1)数字越小越优先执行
AOP两种代理的区别:
AOP支持2种代理,jdk的动态代理和CGLIB实现机制。
jdk基于接口实现:jdk动态代理对实现了接口的类进行代理。
CGLIB基于继承:CGLIB代理可以对类代理,主要对指定的类生成一个子类,因为是继承,所以目标类最好不要使用final声明。
通常情况下,鼓励使用jdk代理,因为业务一般都会抽象出一个接口,而且不用引入新的东西。如果是遗留的系统,以前没有实现接口,那么只能使用CGLIB。
-
在Spring AOP切面中启用新事务
2019-07-31 19:16:01sping的声明式事务就是靠AOP来实现的,一般事务都在业务层中启用,那如果要在AOP的逻辑中启用一个新的事务要怎么做呢?比如下面的例子: //定义一个切点,这里指com.lidehang.remote包下所有的类的方法...在工作中有一个在切面中需要记录一下操作日志的需求,而且要求这些操作日志要存入数据库,并且无论业务层有什么异常,日志照常记录,那就不能沿用业务层的事务,而是需要新启一个事务了。
sping的声明式事务就是靠AOP来实现的,一般事务都在业务层中启用,那如果要在AOP的逻辑中启用一个新的事务要怎么做呢?比如下面的例子://定义一个切点,这里指com.lidehang.remote包下所有的类的方法 @Pointcut("execution(public * com.lidehang.remote..*.*(..))") public void remote(){} //切点指定的方法执行完返回后调用 @AfterReturning(returning = "ret", pointcut = "remote()") public void doAfterReturning(JoinPoint joinPoint,Object ret) throws Throwable { //一些切面逻辑,包含了数据库操作,为了即便业务层的原事务回滚也不会影响切面中的数据库操作,需要启用新的事务 ... }
经过我的测试,通过在doAfterReturning方法上加上注解@Transactional,并指定传播行为是REQUIRES_NEW依然不行。因为@Transactional也是声明式事务,本身就是AOP实现的,在AOP的代码中使用不起作用。所以就只能使用spring的编程式事务了,需要引入TransactionTemplate。如下:
@Autowired private TransactionTemplate transactionTemplate; @AfterReturning(returning = "ret", pointcut = "remote()") public void doAfterReturning(JoinPoint joinPoint,Object ret) throws Throwable { //声明式事务在切面中不起作用,需使用编程式事务 //设置传播行为:总是新启一个事务,如果存在原事务,就挂起原事务 transactionTemplate.setPropagationBehavior(TransactionDefinition.PROPAGATION_REQUIRES_NEW); transactionTemplate.execute(new TransactionCallback<T>() { @Override public T doInTransaction(TransactionStatus arg0) { //一些切面逻辑,包含了数据库操作 ... } }); }
通过以上的步骤,切面里的逻辑会在新事务中执行,执行完就会提交,和业务层中的原事务无关,即便执行完切面逻辑后继续执行业务代码的过程中出现异常,业务层中的数据库操作因为有原事务而回滚,但切面中的数据库操作不会回滚,因为这是个新的事务!
-
细说Spring——AOP详解(AOP概览)
2018-05-30 18:29:25一、对AOP的初印象 首先先给出一段比较专业的术语(来自百度): 在软件业,AOP为Aspect Oriented Programming的缩写,意为:面向切面编程,通过预编译方 式和运行期动态代理实现程序功能的统一维护的一种技术。...一、对AOP的初印象
首先先给出一段比较专业的术语(来自百度):
在软件业,AOP为Aspect Oriented Programming的缩写,意为:面向切面编程,通过预编译方 式和运行期动态代理实现程序功能的统一维护的一种技术。AOP是OOP的延续,是软件开发中的一个 热点,也是Spring框架中的一个重要内容,是函数式编程的一种衍生范型。利用AOP可以对业务逻辑 的各个部分进行隔离,从而使得业务逻辑各部分之间的耦合度降低,提高程序的可重用性,同时提高 了开发的效率。
然后我们举一个比较容易理解的例子(来自:Spring 之 AOP):
要理解切面编程,就需要先理解什么是切面。用刀把一个西瓜分成两瓣,切开的切口就是切面;炒菜,锅与炉子共同来完成炒菜,锅与炉子就是切面。web层级设计中,web层->网关层->服务层->数据层,每一层之间也是一个切面。编程中,对象与对象之间,方法与方法之间,模块与模块之间都是一个个切面。
我们一般做活动的时候,一般对每一个接口都会做活动的有效性校验(是否开始、是否结束等等)、以及这个接口是不是需要用户登录。
按照正常的逻辑,我们可以这么做。
这有个问题就是,有多少接口,就要多少次代码copy。对于一个“懒人”,这是不可容忍的。好,提出一个公共方法,每个接口都来调用这个接口。这里有点切面的味道了。
同样有个问题,我虽然不用每次都copy代码了,但是,每个接口总得要调用这个方法吧。于是就有了切面的概念,我将方法注入到接口调用的某个地方(切点)。
这样接口只需要关心具体的业务,而不需要关注其他非该接口关注的逻辑或处理。
红框处,就是面向切面编程。二、AOP中的相关概念
看过了上面的例子,我想大家脑中对AOP已经有了一个大致的雏形,但是又对上面提到的切面之类的术语有一些模糊的地方,接下来就来讲解一下AOP中的相关概念,了解了AOP中的概念,才能真正的掌握AOP的精髓。
这里还是先给出一个比较专业的概念定义:Aspect
(切面): Aspect 声明类似于 Java 中的类声明,在 Aspect 中会包含着一些 Pointcut 以及相应的 Advice。Joint point
(连接点):表示在程序中明确定义的点,典型的包括方法调用,对类成员的访问以及异常处理程序块的执行等等,它自身还可以嵌套其它 joint point。Pointcut
(切点):表示一组 joint point,这些 joint point 或是通过逻辑关系组合起来,或是通过通配、正则表达式等方式集中起来,它定义了相应的 Advice 将要发生的地方。Advice
(增强):Advice 定义了在Pointcut
里面定义的程序点具体要做的操作,它通过 before、after 和 around 来区别是在每个 joint point 之前、之后还是代替执行的代码。Target
(目标对象):织入Advice
的目标对象.。Weaving
(织入):将Aspect
和其他对象连接起来, 并创建Advice
d object 的过程
然后举一个容易理解的例子:
看完了上面的理论部分知识, 我相信还是会有不少朋友感觉到 AOP 的概念还是很模糊, 对 AOP 中的各种概念理解的还不是很透彻. 其实这很正常, 因为 AOP 中的概念是在是太多了, 我当时也是花了老大劲才梳理清楚的.
下面我以一个简单的例子来比喻一下 AOP 中Aspect
,Joint point
,Pointcut
与Advice
之间的关系.
让我们来假设一下, 从前有一个叫爪哇的小县城, 在一个月黑风高的晚上, 这个县城中发生了命案. 作案的凶手十分狡猾, 现场没有留下什么有价值的线索. 不过万幸的是, 刚从隔壁回来的老王恰好在这时候无意中发现了凶手行凶的过程, 但是由于天色已晚, 加上凶手蒙着面, 老王并没有看清凶手的面目, 只知道凶手是个男性, 身高约七尺五寸. 爪哇县的县令根据老王的描述, 对守门的士兵下命令说: 凡是发现有身高七尺五寸的男性, 都要抓过来审问. 士兵当然不敢违背县令的命令, 只好把进出城的所有符合条件的人都抓了起来.来让我们看一下上面的一个小故事和 AOP 到底有什么对应关系.
首先我们知道, 在 Spring AOP 中Joint point
指代的是所有方法的执行点, 而 point cut 是一个描述信息, 它修饰的是Joint point
, 通过 point cut, 我们就可以确定哪些Joint point
可以被织入Advice
. 对应到我们在上面举的例子, 我们可以做一个简单的类比,Joint point
就相当于 爪哇的小县城里的百姓,pointcut
就相当于 老王所做的指控, 即凶手是个男性, 身高约七尺五寸, 而Advice
则是施加在符合老王所描述的嫌疑人的动作: 抓过来审问.
为什么可以这样类比呢?Joint point
: 爪哇的小县城里的百姓: 因为根据定义,Joint point
是所有可能被织入Advice
的候选的点, 在 Spring AOP中, 则可以认为所有方法执行点都是Joint point
. 而在我们上面的例子中, 命案发生在小县城中, 按理说在此县城中的所有人都有可能是嫌疑人.Pointcut
:男性, 身高约七尺五寸: 我们知道, 所有的方法(joint point) 都可以织入Advice
, 但是我们并不希望在所有方法上都织入Advice
, 而Pointcut
的作用就是提供一组规则来匹配joinpoint, 给满足规则的 joinpoint 添加Advice
. 同理, 对于县令来说, 他再昏庸, 也知道不能把县城中的所有百姓都抓起来审问, 而是根据凶手是个男性, 身高约七尺五寸, 把符合条件的人抓起来. 在这里 凶手是个男性, 身高约七尺五寸 就是一个修饰谓语, 它限定了凶手的范围, 满足此修饰规则的百姓都是嫌疑人, 都需要抓起来审问.Advice
:抓过来审问,Advice
是一个动作, 即一段 Java 代码, 这段 Java 代码是作用于 point cut 所限定的那些Joint point
上的. 同理, 对比到我们的例子中, 抓过来审问 这个动作就是对作用于那些满足 男性, 身高约七尺五寸 的爪哇的小县城里的百姓.Aspect
::Aspect
是 point cut 与Advice
的组合, 因此在这里我们就可以类比: “根据老王的线索, 凡是发现有身高七尺五寸的男性, 都要抓过来审问” 这一整个动作可以被认为是一个Aspect
.
最后是一个描述这些概念之间关系的图:
三、其他的一些内容
AOP
中的Joinpoint
可以有多种类型:构造方法调用,字段的设置和获取,方法的调用,方法的执行,异常的处理执行,类的初始化。也就是说在AOP
的概念中我们可以在上面的这些Joinpoint
上织入我们自定义的Advice
,但是在Spring
中却没有实现上面所有的joinpoint
,确切的说,Spring
只支持方法执行类型的Joinpoint
。Advice 的类型
before advice
, 在 join point 前被执行的 advice. 虽然 before advice 是在 join point 前被执行, 但是它并不能够阻止 join point 的执行, 除非发生了异常(即我们在 before advice 代码中, 不能人为地决定是否继续执行 join point 中的代码)after return advice
, 在一个 join point 正常返回后执行的 adviceafter throwing advice
, 当一个 join point 抛出异常后执行的 adviceafter(final) advice
, 无论一个 join point 是正常退出还是发生了异常, 都会被执行的 advice.around advice
, 在 join point 前和 joint point 退出后都执行的 advice. 这个是最常用的 advice.introduction
,introduction可以为原有的对象增加新的属性和方法。
在
Spring
中,通过动态代理和动态字节码技术实现了AOP
,这些内容,我们将在以后进行讲解。 -
【SpringBoot-3】切面AOP实现权限校验:实例演示与注解全解
2019-10-26 16:14:51何为AOP,AOP的注解详解,AOP的使用详例,以上内容尽在本文SpringBoot中的AOP处理
一键三连运势涨,offer飞来落满筐!喜欢本文的朋友,不要吝啬你们的赞。1 理解AOP
1.1 什么是AOP
AOP(Aspect Oriented Programming),面向切面思想,是Spring的三大核心思想之一(两外两个:IOC-控制反转、DI-依赖注入)。
那么AOP为何那么重要呢?在我们的程序中,经常存在一些系统性的需求,比如权限校验、日志记录、统计等,这些代码会散落穿插在各个业务逻辑中,非常冗余且不利于维护。例如下面这个示意图:
有多少业务操作,就要写多少重复的校验和日志记录代码,这显然是无法接受的。当然,用面向对象的思想,我们可以把这些重复的代码抽离出来,写成公共方法,就是下面这样:
这样,代码冗余和可维护性的问题得到了解决,但每个业务方法中依然要依次手动调用这些公共方法,也是略显繁琐。有没有更好的方式呢?有的,那就是AOP,AOP将权限校验、日志记录等非业务代码完全提取出来,与业务代码分离,并寻找节点切入业务代码中:1.2 AOP体系与概念
简单地去理解,其实AOP要做三类事:
- 在哪里切入,也就是权限校验等非业务操作在哪些业务代码中执行。
- 在什么时候切入,是业务代码执行前还是执行后。
- 切入后做什么事,比如做权限校验、日志记录等。
因此,AOP的体系可以梳理为下图:
一些概念详解:Pointcut
:切点,决定处理如权限校验、日志记录等在何处切入业务代码中(即织入切面)。切点分为execution
方式和annotation
方式。前者可以用路径表达式指定哪些类织入切面,后者可以指定被哪些注解修饰的代码织入切面。Advice
:处理,包括处理时机和处理内容。处理内容就是要做什么事,比如校验权限和记录日志。处理时机就是在什么时机执行处理内容,分为前置处理(即业务代码执行前)、后置处理(业务代码执行后)等。Aspect
:切面,即Pointcut
和Advice
。Joint point
:连接点,是程序执行的一个点。例如,一个方法的执行或者一个异常的处理。在 Spring AOP 中,一个连接点总是代表一个方法执行。Weaving
:织入,就是通过动态代理,在目标对象方法中执行处理内容的过程。
网络上有张图,我觉得非常传神,贴在这里供大家观详:
2 AOP实例
实践出真知,接下来我们就撸代码来实现一下AOP。完成项目已上传至:GitHub
使用 AOP,首先需要引入 AOP 的依赖。
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency>
2.1 第一个实例
接下来,我们先看一个极简的例子:所有的
get
请求被调用前在控制台输出一句"get请求的advice触发了"。具体实现如下:
- 创建一个AOP切面类,只要在类上加个
@Aspect
注解即可。@Aspect
注解用来描述一个切面类,定义切面类的时候需要打上这个注解。@Component
注解将该类交给 Spring 来管理。在这个类里实现advice:
package com.mu.demo.advice; import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.annotation.Before; import org.aspectj.lang.annotation.Pointcut; import org.springframework.stereotype.Component; @Aspect @Component public class LogAdvice { // 定义一个切点:所有被GetMapping注解修饰的方法会织入advice @Pointcut("@annotation(org.springframework.web.bind.annotation.GetMapping)") private void logAdvicePointcut() {} // Before表示logAdvice将在目标方法执行前执行 @Before("logAdvicePointcut()") public void logAdvice(){ // 这里只是一个示例,你可以写任何处理逻辑 System.out.println("get请求的advice触发了"); } }
- 创建一个接口类,内部创建一个get请求:
package com.mu.demo.controller; import com.alibaba.fastjson.JSON; import com.alibaba.fastjson.JSONObject; import org.springframework.web.bind.annotation.*; @RestController @RequestMapping(value = "/aop") public class AopController { @GetMapping(value = "/getTest") public JSONObject aopTest() { return JSON.parseObject("{\"message\":\"SUCCESS\",\"code\":200}"); } @PostMapping(value = "/postTest") public JSONObject aopTest2(@RequestParam("id") String id) { return JSON.parseObject("{\"message\":\"SUCCESS\",\"code\":200}"); } }
项目启动后,请求
http://localhost:8085/aop/getTest
接口:
请求http://localhost:8085/aop/postTest
接口,控制台无输出,证明切点确实是只针对被GetMapping
修饰的方法。2.2 第二个实例
下面我们将问题复杂化一些,该例的场景是:
- 自定义一个注解
PermissionsAnnotation
- 创建一个切面类,切点设置为拦截所有标注
PermissionsAnnotation
的方法,截取到接口的参数,进行简单的权限校验 - 将
PermissionsAnnotation
标注在测试接口类的测试接口test
上
具体的实现步骤:
- 使用
@Target、@Retention、@Documented
自定义一个注解(关于这三个注解详情请见:元注解详解):
@Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface PermissionAnnotation{ }
- 创建第一个AOP切面类,,只要在类上加个
@Aspect
注解即可。@Aspect
注解用来描述一个切面类,定义切面类的时候需要打上这个注解。@Component
注解将该类交给 Spring 来管理。在这个类里实现第一步权限校验逻辑:
package com.example.demo; import com.alibaba.fastjson.JSON; import com.alibaba.fastjson.JSONObject; import org.aspectj.lang.ProceedingJoinPoint; import org.aspectj.lang.annotation.Around; import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.annotation.Pointcut; import org.springframework.core.annotation.Order; import org.springframework.stereotype.Component; @Aspect @Component @Order(1) public class PermissionFirstAdvice { // 定义一个切面,括号内写入第1步中自定义注解的路径 @Pointcut("@annotation(com.mu.demo.annotation.PermissionAnnotation)") private void permissionCheck() { } @Around("permissionCheck()") public Object permissionCheckFirst(ProceedingJoinPoint joinPoint) throws Throwable { System.out.println("===================第一个切面===================:" + System.currentTimeMillis()); //获取请求参数,详见接口类 Object[] objects = joinPoint.getArgs(); Long id = ((JSONObject) objects[0]).getLong("id"); String name = ((JSONObject) objects[0]).getString("name"); System.out.println("id1->>>>>>>>>>>>>>>>>>>>>>" + id); System.out.println("name1->>>>>>>>>>>>>>>>>>>>>>" + name); // id小于0则抛出非法id的异常 if (id < 0) { return JSON.parseObject("{\"message\":\"illegal id\",\"code\":403}"); } return joinPoint.proceed(); } }
- 创建接口类,并在目标方法上标注自定义注解
PermissionsAnnotation
:
package com.example.demo; import com.alibaba.fastjson.JSON; import com.alibaba.fastjson.JSONObject; import org.springframework.web.bind.annotation.*; @RestController @RequestMapping(value = "/permission") public class TestController { @RequestMapping(value = "/check", method = RequestMethod.POST) // 添加这个注解 @PermissionsAnnotation() public JSONObject getGroupList(@RequestBody JSONObject request) { return JSON.parseObject("{\"message\":\"SUCCESS\",\"code\":200}"); } }
在这里,我们先进行一个测试。首先,填好请求地址和header:
其次,构造正常的参数:
可以拿到正常的响应结果:
然后,构造一个异常参数,再次请求:
响应结果显示,切面类进行了判断,并返回相应结果:
有人会问,如果我一个接口想设置多个切面类进行校验怎么办?这些切面的执行顺序如何管理?很简单,一个自定义的
AOP
注解可以对应多个切面类,这些切面类执行顺序由@Order
注解管理,该注解后的数字越小,所在切面类越先执行。下面在实例中进行演示:
创建第二个AOP切面类,在这个类里实现第二步权限校验:
package com.example.demo; import com.alibaba.fastjson.JSON; import com.alibaba.fastjson.JSONObject; import org.aspectj.lang.ProceedingJoinPoint; import org.aspectj.lang.annotation.Around; import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.annotation.Pointcut; import org.springframework.core.annotation.Order; import org.springframework.stereotype.Component; @Aspect @Component @Order(0) public class PermissionSecondAdvice { @Pointcut("@annotation(com.mu.demo.annotation.PermissionAnnotation)") private void permissionCheck() { } @Around("permissionCheck()") public Object permissionCheckSecond(ProceedingJoinPoint joinPoint) throws Throwable { System.out.println("===================第二个切面===================:" + System.currentTimeMillis()); //获取请求参数,详见接口类 Object[] objects = joinPoint.getArgs(); Long id = ((JSONObject) objects[0]).getLong("id"); String name = ((JSONObject) objects[0]).getString("name"); System.out.println("id->>>>>>>>>>>>>>>>>>>>>>" + id); System.out.println("name->>>>>>>>>>>>>>>>>>>>>>" + name); // name不是管理员则抛出异常 if (!name.equals("admin")) { return JSON.parseObject("{\"message\":\"not admin\",\"code\":403}"); } return joinPoint.proceed(); } }
重启项目,继续测试,构造两个参数都异常的情况:
响应结果,表面第二个切面类执行顺序更靠前:
3 AOP相关注解
上面的案例中,用到了诸多注解,下面针对这些注解进行详解。
3.1 @Pointcut
@Pointcut
注解,用来定义一个切点,即上文中所关注的某件事情的入口,切入点定义了事件触发时机。@Aspect @Component public class LogAspectHandler { /** * 定义一个切面,拦截 com.itcodai.course09.controller 包和子包下的所有方法 */ @Pointcut("execution(* com.mutest.controller..*.*(..))") public void pointCut() {} }
@Pointcut 注解指定一个切点,定义需要拦截的东西,这里介绍两个常用的表达式:一个是使用
execution()
,另一个是使用annotation()
。execution表达式:
以
execution(* * com.mutest.controller..*.*(..)))
表达式为例:- 第一个 * 号的位置:表示返回值类型,* 表示所有类型。
- 包名:表示需要拦截的包名,后面的两个句点表示当前包和当前包的所有子包,在本例中指 com.mutest.controller包、子包下所有类的方法。
- 第二个 * 号的位置:表示类名,* 表示所有类。
- *(..):这个星号表示方法名,* 表示所有的方法,后面括弧里面表示方法的参数,两个句点表示任何参数。
annotation() 表达式:
annotation()
方式是针对某个注解来定义切点,比如我们对具有 @PostMapping 注解的方法做切面,可以如下定义切面:@Pointcut("@annotation(org.springframework.web.bind.annotation.PostMapping)") public void annotationPointcut() {}
然后使用该切面的话,就会切入注解是
@PostMapping
的所有方法。这种方式很适合处理@GetMapping、@PostMapping、@DeleteMapping
不同注解有各种特定处理逻辑的场景。还有就是如上面案例所示,针对自定义注解来定义切面。
@Pointcut("@annotation(com.example.demo.PermissionsAnnotation)") private void permissionCheck() {}
3.2 @Around
@Around
注解用于修饰Around
增强处理,Around
增强处理非常强大,表现在:@Around
可以自由选择增强动作与目标方法的执行顺序,也就是说可以在增强动作前后,甚至过程中执行目标方法。这个特性的实现在于,调用ProceedingJoinPoint
参数的procedd()
方法才会执行目标方法。@Around
可以改变执行目标方法的参数值,也可以改变执行目标方法之后的返回值。
Around
增强处理有以下特点:- 当定义一个
Around
增强处理方法时,该方法的第一个形参必须是ProceedingJoinPoint
类型(至少一个形参)。在增强处理方法体内,调用ProceedingJoinPoint
的proceed
方法才会执行目标方法:这就是@Around
增强处理可以完全控制目标方法执行时机、如何执行的关键;如果程序没有调用ProceedingJoinPoint
的proceed
方法,则目标方法不会执行。 - 调用
ProceedingJoinPoint
的proceed
方法时,还可以传入一个Object[ ]
对象,该数组中的值将被传入目标方法作为实参——这就是Around
增强处理方法可以改变目标方法参数值的关键。这就是如果传入的Object[ ]
数组长度与目标方法所需要的参数个数不相等,或者Object[ ]
数组元素与目标方法所需参数的类型不匹配,程序就会出现异常。
@Around
功能虽然强大,但通常需要在线程安全的环境下使用。因此,如果使用普通的Before
、AfterReturning
就能解决的问题,就没有必要使用Around
了。如果需要目标方法执行之前和之后共享某种状态数据,则应该考虑使用Around
。尤其是需要使用增强处理阻止目标的执行,或需要改变目标方法的返回值时,则只能使用Around
增强处理了。下面,在前面例子上做一些改造,来观察
@Around
的特点。自定义注解类不变。首先,定义接口类:
package com.example.demo; import com.alibaba.fastjson.JSON; import com.alibaba.fastjson.JSONObject; import org.springframework.web.bind.annotation.*; @RestController @RequestMapping(value = "/permission") public class TestController { @RequestMapping(value = "/check", method = RequestMethod.POST) @PermissionsAnnotation() public JSONObject getGroupList(@RequestBody JSONObject request) { return JSON.parseObject("{\"message\":\"SUCCESS\",\"code\":200,\"data\":" + request + "}"); } }
唯一切面类(前面案例有两个切面类,这里只需保留一个即可):
package com.example.demo; import com.alibaba.fastjson.JSONObject; import org.aspectj.lang.ProceedingJoinPoint; import org.aspectj.lang.annotation.Around; import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.annotation.Pointcut; import org.springframework.core.annotation.Order; import org.springframework.stereotype.Component; @Aspect @Component @Order(1) public class PermissionAdvice { @Pointcut("@annotation(com.example.demo.PermissionsAnnotation)") private void permissionCheck() { } @Around("permissionCheck()") public Object permissionCheck(ProceedingJoinPoint joinPoint) throws Throwable { System.out.println("===================开始增强处理==================="); //获取请求参数,详见接口类 Object[] objects = joinPoint.getArgs(); Long id = ((JSONObject) objects[0]).getLong("id"); String name = ((JSONObject) objects[0]).getString("name"); System.out.println("id1->>>>>>>>>>>>>>>>>>>>>>" + id); System.out.println("name1->>>>>>>>>>>>>>>>>>>>>>" + name); // 修改入参 JSONObject object = new JSONObject(); object.put("id", 8); object.put("name", "lisi"); objects[0] = object; // 将修改后的参数传入 return joinPoint.proceed(objects); } }
同样使用JMeter调用接口,传入参数:
{"id":-5,"name":"admin"}
,响应结果表明:@Around
截取到了接口的入参,并使接口返回了切面类中的结果。
3.3 @Before
@Before
注解指定的方法在切面切入目标方法之前执行,可以做一些Log
处理,也可以做一些信息的统计,比如获取用户的请求URL
以及用户的IP
地址等等,这个在做个人站点的时候都能用得到,都是常用的方法。例如下面代码:@Aspect @Component @Slf4j public class LogAspectHandler { /** * 在上面定义的切面方法之前执行该方法 * @param joinPoint jointPoint */ @Before("pointCut()") public void doBefore(JoinPoint joinPoint) { log.info("====doBefore方法进入了===="); // 获取签名 Signature signature = joinPoint.getSignature(); // 获取切入的包名 String declaringTypeName = signature.getDeclaringTypeName(); // 获取即将执行的方法名 String funcName = signature.getName(); log.info("即将执行方法为: {},属于{}包", funcName, declaringTypeName); // 也可以用来记录一些信息,比如获取请求的 URL 和 IP ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes(); HttpServletRequest request = attributes.getRequest(); // 获取请求 URL String url = request.getRequestURL().toString(); // 获取请求 IP String ip = request.getRemoteAddr(); log.info("用户请求的url为:{},ip地址为:{}", url, ip); } }
JointPoint
对象很有用,可以用它来获取一个签名,利用签名可以获取请求的包名、方法名,包括参数(通过joinPoint.getArgs()
获取)等。3.4 @After
@After
注解和@Before
注解相对应,指定的方法在切面切入目标方法之后执行,也可以做一些完成某方法之后的 Log 处理。@Aspect @Component @Slf4j public class LogAspectHandler { /** * 定义一个切面,拦截 com.mutest.controller 包下的所有方法 */ @Pointcut("execution(* com.mutest.controller..*.*(..))") public void pointCut() {} /** * 在上面定义的切面方法之后执行该方法 * @param joinPoint jointPoint */ @After("pointCut()") public void doAfter(JoinPoint joinPoint) { log.info("==== doAfter 方法进入了===="); Signature signature = joinPoint.getSignature(); String method = signature.getName(); log.info("方法{}已经执行完", method); } }
到这里,我们来写个 Controller 测试一下执行结果,新建一个 AopController 如下:
@RestController @RequestMapping("/aop") public class AopController { @GetMapping("/{name}") public String testAop(@PathVariable String name) { return "Hello " + name; } }
启动项目,在浏览器中输入:localhost:8080/aop/csdn,观察一下控制台的输出信息:
====doBefore 方法进入了==== 即将执行方法为: testAop,属于com.itcodai.mutest.AopController包 用户请求的 url 为:http://localhost:8080/aop/name,ip地址为:0:0:0:0:0:0:0:1 ==== doAfter 方法进入了==== 方法 testAop 已经执行完
从打印出来的
Log
中可以看出程序执行的逻辑与顺序,可以很直观的掌握@Before
和@After
两个注解的实际作用。3.5 @AfterReturning
@AfterReturning
注解和@After
有些类似,区别在于@AfterReturning
注解可以用来捕获切入方法执行完之后的返回值,对返回值进行业务逻辑上的增强处理,例如:@Aspect @Component @Slf4j public class LogAspectHandler { /** * 在上面定义的切面方法返回后执行该方法,可以捕获返回对象或者对返回对象进行增强 * @param joinPoint joinPoint * @param result result */ @AfterReturning(pointcut = "pointCut()", returning = "result") public void doAfterReturning(JoinPoint joinPoint, Object result) { Signature signature = joinPoint.getSignature(); String classMethod = signature.getName(); log.info("方法{}执行完毕,返回参数为:{}", classMethod, result); // 实际项目中可以根据业务做具体的返回值增强 log.info("对返回参数进行业务上的增强:{}", result + "增强版"); } }
需要注意的是,在
@AfterReturning
注解 中,属性returning
的值必须要和参数保持一致,否则会检测不到。该方法中的第二个入参就是被切方法的返回值,在doAfterReturning
方法中可以对返回值进行增强,可以根据业务需要做相应的封装。我们重启一下服务,再测试一下:方法 testAop 执行完毕,返回参数为:Hello CSDN 对返回参数进行业务上的增强:Hello CSDN 增强版
3.6 @AfterThrowing
当被切方法执行过程中抛出异常时,会进入
@AfterThrowing
注解的方法中执行,在该方法中可以做一些异常的处理逻辑。要注意的是throwing
属性的值必须要和参数一致,否则会报错。该方法中的第二个入参即为抛出的异常。@Aspect @Component @Slf4j public class LogAspectHandler { /** * 在上面定义的切面方法执行抛异常时,执行该方法 * @param joinPoint jointPoint * @param ex ex */ @AfterThrowing(pointcut = "pointCut()", throwing = "ex") public void afterThrowing(JoinPoint joinPoint, Throwable ex) { Signature signature = joinPoint.getSignature(); String method = signature.getName(); // 处理异常的逻辑 log.info("执行方法{}出错,异常为:{}", method, ex); } }
完整的项目已上传至Gtihub:https://github.com/ThinkMugz/aopDemo,觉得有帮助的顺手点个赞给个star,听说这么做的人2021年都升职加薪了!
以上就是AOP的全部内容。通过几个例子就可以感受到,AOP的便捷之处。欢迎大家指出文中不足之处,喜欢的朋友来个一键三连,听说这么做的人offer拿到手软( •̀ ω •́ )y
-
Spring中AOP开发步骤
2017-01-11 20:38:36AOP:不是由Spring定义.AOP联盟的组织定义. Spring中的通知:(增强代码) 前置通知 org.springframework.aop.MethodBeforeAdvice * 在目标方法执行前实施增强 后置通知 org.springframework.aop.... -
Spring中的AOP以及切入点表达式和各种通知
2019-05-31 17:57:50上篇讲了动态代理:Java中动态代理的两种方式JDK动态代理和cglib动态代理以及区别 我们用上篇的做法去实现目标方法的增强,实现代码的解耦,是...那就是Spring的AOP,这才是咱们最终想引出来的重点! 有了Sprin... -
SpringAOP切点表达式
2020-12-25 21:18:58SpringAOP切点表达式 切点表达式(aop最难部分) execution(常用) 描述力度:描述具体到方法、参数、类型 举个栗子: @Pointcut("execution(* com.llds.seek.SeekAspect.*.*(..))") public void s(){ } ... -
SpringAOP的注解形式
2019-06-01 14:23:08上一篇讲了配置文件形式的SpringAOP:Spring中的AOP以及切入点表达式和各种通知 本篇继续看一下注解形式怎么去理解和应用AOP 前几篇已经讲了不少AOP相关的知识,本篇不再赘述,直接用代码写一下注解形式的AOP 举... -
关于 Spring AOP (AspectJ) 你该知晓的一切
2017-02-21 08:00:47【版权申明】未经博主同意,谢绝转载!(请尊重原创,博主保留追究权) ... 出自【zejian的博客】 关联文章: ...关于 Spring AOP (AspectJ) 你该知晓的一切本篇是年后第一篇博文,由于博主用了不少 -
AOP增强
2019-12-28 04:03:01AOP联盟为通知Advice定义了org.aopalliance.aop.Interface.Advice Spring按照通知Advice在目标类方法的连接点位置,可以分为5类 1、前置通知org.springframework.aop.MethodBeforeAdvice 在目标方法执行前实施... -
Spring AOP详细介绍
2019-04-14 21:32:57什么是AOP AOP(Aspect-OrientedProgramming,面向切面编程),可以说是OOP(Object-Oriented Programing,面向对象编程)的补充和完善。OOP引入封装、继承和多态性等概念来建立一种对象层次结构,用以模拟公共... -
16-Spring 基于注解的AOP编程、AOP总结
2020-11-04 09:26:55上一篇:15-Spring AOP的底层实现原理JDKProxy&CGLIB https://blog.csdn.net/fsjwin/article/details/109481104 前面我们介绍的aop编程完全可以满足项目的需要,但是有没有更为简便的方式呢? 当然有了,就是... -
Spring AOP
2018-11-08 19:33:28Spring AOP 主要内容: AOP是什么? 为什么需要AOP? 什么场景适用AOP? AOP的几个核心概念 Spring AOP源码使如何实现的? 如何使用 Spring AOP? 1. AOP是什么? AOP (Aspect-oriented ... -
SpringAOP是啥,怎么用?
2020-12-26 13:46:44SpringAOP是啥,怎么用? 一、面试问题:什么是SpringAOP? SpringAOP的全称是(Aspect Oriented Programming)中文翻译过来是面向切面编程,个人理解:主要意思是我们的传统架构至上而下,后期想要从中间切入写... -
Spring AOP面向切面编程:理解篇(一看就明白)
2018-09-28 18:15:33一直想着怎么去通俗的讲解AOP,看了一篇文章受到了启发(https://blog.csdn.net/qukaiwei/article/details/50367761),下面我加入自己的理解,咱们来说说AOP! 一、到底什么是AOP(面向切面编程)? 无论在学习... -
SSM第三讲 SpringAOP开发
2020-08-17 20:52:34SpringAOP开发 AOP概述 AOP原理 基于xml配置aop 基于注解配置aop 日志 一. AOP概述 1. 什么是AOP AOP(Aspect Oriented Programming),即面向切面编程。通过预编译方式和运行期动态代理实现程序功能的统一维护... -
Spring AOP使用示例
2019-06-13 21:46:38AOP:【面向切面编程】 指在程序运行期间动态的将某段代码切入到指定方法指定位置进行运行的编程方式。 1、导入aop模块:Spring AOP:(spring-aspects) 2、定义一个业务逻辑类(MathCalculator);在业务逻辑... -
【SpringBoot】SpingBoot整合AOP
2018-09-07 00:47:33说起spring,我们知道其最核心的两个功能就是AOP(面向切面)和IOC(控制反转),这边文章来总结一下SpringBoot如何整合使用AOP。 一、示例应用场景:对所有的web请求做切面来记录日志。 1、pom中引入SpringBoot的... -
AOP概述
2019-02-20 15:20:28●AOP(Aspect-Oriented Programming,面向切面编程):是一种新的方法论,是对传统 OOP(Object-Oriented Programming,面向对象编程)的补充。 ●AOP编程操作的主要对象是切面(aspect),而切面模块化横切关注点。 ●... -
SpringBoot使用AOP
2018-09-09 20:02:49本文介绍SpringBoot中使用Spring AOP。 简介 AOP简介 AOP可能对于广大开发者耳熟能详,它是Aspect Oriented Programming的缩写,翻译成中文就是:面向切面编程。这个可能是面试中经常提到的问题,同时它也... -
springAOP底层源码解析
2019-08-09 13:43:19本课程是一门短小、精悍、专门介绍springAop应用和原理... 整个课程将由浅入深,介绍spring5源码的构建、spring5AOP在开发当中如何应用、springAop的术语理解、springAop和aspectj的优缺点,springaop的源码设计原理。 -
Spring AOP 实现原理
2013-09-24 15:23:43什么是AOP AOP(Aspect-OrientedProgramming,面向方面编程),可以说是OOP(Object-Oriented Programing,面向对象编程)的补充和完善。OOP引入封装、继承和多态性等概念来建立一种对象层次结构,用以模拟公共行为... -
spring AOP中 aop:advisor 与 aop:aspect 的区别
2019-04-21 19:02:58在开发过程中,不少有Spring Aop的使用, 在面向切面编程时,我们会使用< aop:aspect>; 在进行事务管理时,我们会使用< aop:advisor>。 那么,对于< aop:aspect>与< aop:advisor>的区别,... -
Spring Aop(一)——Aop简介
2017-09-26 22:56:071 Aop简介AOP的全称是Aspect Oriented Programming,翻译成中文是面向切面编程。它的主要思想是在程序正常执行的某一个点切进去加入特定的逻辑。AOP框架中对AOP支持最完整的是Aspectj,Spring Aop是基于Aspectj实现... -
Spring-AOP
2019-12-28 03:16:44什么是AOP aop指的是面向切面编程,aop采取横向抽取机制取代了传统的纵向继承重复性代码 aop使用纯java语言实现,不需要专门的编译过程和类加载器 aop的术语(术语解释直接套用某位大神的文章) aop术语原网址 ...
-
Kafka手动提交offset到自定义存储介质代码实现
-
零基础极简以太坊智能合约开发环境搭建并开发部署
-
【布道者】Linux极速入门
-
python模块快速下载.txt
-
C++中const变量的修改与赋值
-
yolov5 v4.0 gpu上训练出来的模型文件
-
MySQL Router 实现高可用、负载均衡、读写分离
-
自动化测试Python3+Selenium3+Unittest
-
LeihLokalVerwaltung:轻松管理产品,租赁和客户-源码
-
Python Tkinter之初体验
-
C++代码规范和Doxygen根据注释自动生成手册
-
TCP的拥塞控制
-
数学实验第二次作业.docx
-
在家工作-源码
-
C/C++反汇编解密
-
安卓开发者模式!一个三非渣本的Android校招秋招之路,高级面试题+解析
-
java笔记(基础篇)
-
JMETER 性能测试基础课程
-
Qt使用线程更新界面
-
简约黑板擦特效表白网源码