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

更新时间：2024年04月02日 10:58:06 作者：园区阿祖

这篇文章主要介绍了SpringBoot AOP注解失效问题排查与解决(调用内部方法),文中通过代码示例介绍的非常详细,对大家的学习或工作有一定的帮助,需要的朋友可以参考下

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

import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;

public abstract class BaseTask implements Job {

    @Override
    public void execute(JobExecutionContext context) {
    	// do something before...
        doTask(taskDto);
        // do something after...
    }
    
    public abstract void doTask(TaskDTO taskDto);
}

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

public class MyTask extends BaseTask {

    @Override
    public void doTask(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 @interface TaskRecord {

}

3.使用@Aspect写切面

import org.aspectj.lang.JoinPoint;
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 TaskAspect {

    @Pointcut("execution(* com.example.task.*.doTask(..)) && @annotation(TaskRecord)")
    public void pointcut() {}

    @Before("pointcut()")
    public void before(JoinPoint joinPoint) {
        Object[] args = joinPoint.getArgs(); // 获取方法的参数
        System.out.println("方法参数: " + args[0]);
    }
}

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

public class MyTask extends BaseTask {

    @Override
    @TaskRecord
    public void doTask(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
     @TaskRecord
    public String test(@RequestBody TestRequest request) {
        test1(request);
        return "执行成功!";
    }

这样是not ok的

 	@RequestMapping("/test")
    @ResponseBody
    public String test(@RequestBody TestRequest request) {
        test1(request);
        return "执行成功!";
    }
    
    @TaskRecord
    public void test1(TestRequest request) {
        System.out.println(request.toString());
    }

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

1.新增接口

public interface JobCommonService {

    void doTaskNew(TaskDTO taskDTO) throws Exception;
}

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

import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;

public abstract class BaseTask implements Job {

    @Override
    public void execute(JobExecutionContext context) {
    	// do something before...
    	// 这是自建的一个spring容器工具类，可以获取容器里的bean
    	JobCommonService jobService = SpringContextUtil.getBean(JobCommonService.class);
        jobService.doTaskNew(taskDTO);
        // do something after...
    }
    
    public abstract void doTask(TaskDTO taskDto);
}

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

@Component
public class MyTask extends BaseTask implements JobCommonService{

    @Override
    public void doTask(TaskDTO taskDto) {
    	return;
    }

	@Override
    @TaskRecord
    public void doTaskNew(TaskDTO taskDTO) {
        // do something...
        return;
    }
}

至此打完收工，成功进入@Before方法，下面关掉所有查询的窗口，可以愉快的进行其他操作啦！

到此这篇关于SpringBoot AOP注解失效问题排查与解决(调用内部方法)的文章就介绍到这了,更多相关SpringBoot AOP注解失效内容请搜索程序员之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持程序员之家！

您可能感兴趣的文章:

Spring?Boot实现MyBatis动态创建表的操作语句
这篇文章主要介绍了Spring?Boot实现MyBatis动态创建表,MyBatis提供了动态SQL,我们可以通过动态SQL,传入表名等信息然组装成建表和操作语句,本文通过案例讲解展示我们的设计思路,需要的朋友可以参考下
2024-01-01
Spring Boot启动过程全面解析（三）
这篇文章主要介绍了Spring Boot启动过程全面解析（三）的相关资料,需要的朋友可以参考下
2017-04-04
新手初学Java基础
这篇文章主要介绍了java基础之方法详解,文中有非常详细的代码示例,对正在学习java基础的小伙伴们有非常好的帮助,需要的朋友可以参考下
2021-07-07
Java中的代理模式详解及实例代码
这篇文章主要介绍了Java中的代理模式详解及实例代码的相关资料,这里附有实例代码，需要的朋友可以参考下
2017-02-02
IDEA运行SSM项目的超详细图解教程
SSM项目部署其实很简单,下面这篇文章主要给大家介绍了关于IDEA运行SSM项目的超详细图解教程,文中通过图文介绍的非常详细,需要的朋友可以参考下
2023-10-10
Java中输入输出方式的简单示例
Java语言的输入输出功能是十分强大而灵活的,美中不足的是看上去输入输出的代码并不是很简洁,因为你往往需要包装许多不同的对象,下面这篇文章主要给大家介绍了关于Java中输入输出方式的相关资料,需要的朋友可以参考下
2021-08-08
基于SpringBoot2.0版本与老版本的区别
这篇文章主要介绍了SpringBoot2.0版本与老版本的区别，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-10-10
java执行SQL语句实现查询的通用方法详解
这篇文章主要介绍了java执行SQL语句实现查询的通用方法详解，具有一定借鉴价值，需要的朋友可以参考下。
2017-12-12
浅谈Mybatis传参类型如何确定
最近有小伙伴在讨论#{}与${}的区别时，有提到#{}是用字符串进行替换，本文主要介绍了mapper接口中不同的参数类型，最终拼接sql中是如何进行替换的，感兴趣的可以了解一下
2021-10-10
java 字节流和字符流的区别详解
这篇文章主要介绍了java 字节流和字符流的区别详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2019-09-09