0


调用内部方法,SpringBoot AOP注解失效问题排查与解决

开发时,遇到这样一个问题。项目使用springboot框架,项目中的task基于quartz实现,其中有个BaseTask代码实现quartz的Job接口,关键代码如下:

importorg.quartz.Job;importorg.quartz.JobExecutionContext;importorg.quartz.JobExecutionException;publicabstractclassBaseTaskimplementsJob{@Overridepublicvoidexecute(JobExecutionContext context){// do something before...doTask(taskDto);// do something after...}publicabstractvoiddoTask(TaskDTO taskDto);}

项目中的所有task会继承这个BaseTask,并重写doTask方法,如下:

publicclassMyTaskextendsBaseTask{@OverridepublicvoiddoTask(TaskDTO taskDto){// 在这里实现你的具体任务逻辑System.out.println("执行MyTask的doTask方法");}}

这时候因为做的业务会涉及很多类似的数据同步,有很多task,且都需要做如下操作:
1.实现并发锁控制
2.读取上次同步时间进行增量同步操作
3.插入taskRecord记录等
这些代码会极大的冗余和重复,故此想使用AOP的思想,使用注解的方式,将这些操作抽象整合,于是开干:
1.引入springboot的aop依赖

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-aop</artifactId></dependency>

2.写注解:

@Target(ElementType.METHOD)@Retention(RetentionPolicy.RUNTIME)public@interfaceTaskRecord{}

3.使用@Aspect写切面

importorg.aspectj.lang.JoinPoint;importorg.aspectj.lang.annotation.Aspect;importorg.aspectj.lang.annotation.Before;importorg.aspectj.lang.annotation.Pointcut;importorg.springframework.stereotype.Component;@Aspect@ComponentpublicclassTaskAspect{@Pointcut("execution(* com.example.task.*.doTask(..)) && @annotation(TaskRecord)")publicvoidpointcut(){}@Before("pointcut()")publicvoidbefore(JoinPoint joinPoint){Object[] args = joinPoint.getArgs();// 获取方法的参数System.out.println("方法参数: "+ args[0]);}}

4.在MyTask类的方法里加上注解

publicclassMyTaskextendsBaseTask{@Override@TaskRecordpublicvoiddoTask(TaskDTO taskDto){// 在这里实现你的具体任务逻辑System.out.println("执行MyTask的doTask方法");}}

一番操作下来行云流水,心里默想:老子cv代码天下第一,肯定没问题。打断点debug调试,发现问题出现,他娘的根本进不了@Before方法里啊

// 此处李云龙表情包

于是排查问题,百度chatgpt问了n²+1天,在试过如下方法如:
1.将MyTask,BaseTask加上@Component将bean加载到spring容器内
2.启动类增加@EnableAspectJAutoProxy注解(实际SpringBoot默认自动配置AOP的)
3.联想是否跟CGLIB或JDK动态代理有关
一系列操作,发现屡战屡败,于是搁置了数天,今天又心血来潮试了下,换了个思路去思考,查询AOP失效的几个场景,总结如下:
1.内部方法调用:AOP通常不会拦截同一个类内部的方法调用。如果一个被代理的方法调用了另一个被代理的方法,那么只有外部调用的方法会触发AOP。

2.AOP配置问题:AOP切入点配置不正确,切入点表达式可能没有正确应用到目标bean。

3.直接实例化对象:如直接使用new关键字创建了一个对象实例,AOP将无法拦截此对象的方法调用。需要通过Spring容器获取对象,让Spring负责bean的实例化,才能让AOP生效。

嗯?好像有点思路了,很符合1的情况,于是在某个controller写了个请求并加上注解,发现可以进入,但是如果写一个内部方法,在内部方法上加注解,请求的方法再去调用则会失效,如下:
这样是ok的

@RequestMapping("/test")@ResponseBody@TaskRecordpublicStringtest(@RequestBodyTestRequest request){test1(request);return"执行成功!";}

这样是not ok的

@RequestMapping("/test")@ResponseBodypublicStringtest(@RequestBodyTestRequest request){test1(request);return"执行成功!";}@TaskRecordpublicvoidtest1(TestRequest request){System.out.println(request.toString());}

所以思路就是在执行内部的doTask方法时,不能直接调用,需要通过代理类去调用才能让AOP切面生效,改造如下:
1.新增接口

publicinterfaceJobCommonService{voiddoTaskNew(TaskDTO taskDTO)throwsException;}

2.BaseTask改造,不直接调用doTask

importorg.quartz.Job;importorg.quartz.JobExecutionContext;importorg.quartz.JobExecutionException;publicabstractclassBaseTaskimplementsJob{@Overridepublicvoidexecute(JobExecutionContext context){// do something before...// 这是自建的一个spring容器工具类,可以获取容器里的beanJobCommonService jobService =SpringContextUtil.getBean(JobCommonService.class);
        jobService.doTaskNew(taskDTO);// do something after...}publicabstractvoiddoTask(TaskDTO taskDto);}

3.具体task改造,实现JobCommon接口重写doTaskNew方法

@ComponentpublicclassMyTaskextendsBaseTaskimplementsJobCommonService{@OverridepublicvoiddoTask(TaskDTO taskDto){return;}@Override@TaskRecordpublicvoiddoTaskNew(TaskDTO taskDTO){// do something...return;}}

至此打完收工,成功进入@Before方法,下面关掉所有查询的窗口,可以愉快的进行其他操作啦!
进一步,这就能拓展另一个知识点,SpringBoot中@Transactional注解失效的场景,触类旁通,所以如果真的搞懂了SpringAOP,这些都不是问题,后面得专门写个AOP的文章来记录下吧

总结:基础知识不过关,排查问题走弯路,多学多问多积累,加油吧!

如果您对技术有兴趣,愿意友好交流,可以加v进技术群一起沟通,v:zzs1067632338,备注csdn即可

标签: spring boot java 后端

本文转载自: https://blog.csdn.net/zzs1067632338/article/details/134059220
版权归原作者 园区阿祖 所有, 如有侵权,请联系我们删除。

“调用内部方法,SpringBoot AOP注解失效问题排查与解决”的评论:

还没有评论