AopContext.currentProxy() 获取代理对象

2024-02-01 20:44

本文主要是介绍AopContext.currentProxy() 获取代理对象,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

引言

Spring AOP中,切面Aspect是一个强大的概念,允许我们将横切关注点模块化,提高代码的可维护性。然而,在同一个类中,当非切面方法A调用切面方法B时,有时我们会面临切面失效的问题。本文将介绍一种解决方案,即使用AopContext.currentProxy()方法,以确保在这种场景下切面能够正常生效。

背景

在某些情况下,我们可能会在同一个类中定义既包含切面方法,又包含非切面方法的业务逻辑。当非切面方法直接调用切面方法时,切面有可能失效,导致切面中定义的通知未被触发。这时,我们需要一种方法来确保切面能够在同一类的内部正确工作。

起源

闲着无聊看到RuoYi-Cloud-Plus项目里面封装的一个SpringUtils,也就是封装的一个spring工具类,它继承了Hutool的SpringUtil工具类,其中里面有一个getAopProxy获取aop代理对象的方法引起了我的注意。

    /*** 获取aop代理对象** @param invoker* @return*/@SuppressWarnings("unchecked")public static <T> T getAopProxy(T invoker) {return (T) AopContext.currentProxy();}

该方法所引用到的地方例如:
全限定路径:com.ruoyi.resource.service.impl.SysOssServiceImpl#download
这是一个文件上传的服务
在这里插入图片描述
从图中我们可以看到download方法里面调用了当前类的一个getById方法,但是仔细看,getById方法上面标注了一个注解 @Cacheable,这个注解主要就是用来做缓存数据的,而这个注解在Spring中主要是通过Aop实现的,因此在会被Spring创建一个代理对象

那么问题来了,为什么要这样写呢?而不是直接去调用getById方法


解决方案:AopContext.currentProxy()

为什么切面会失效?

在同一个类中,非切面方法直接调用切面方法时,Spring AOP 默认情况下可能无法正确拦截调用,从而导致切面失效。这是因为 Spring AOP 是基于代理模式实现的,直接在同一类中调用切面方法可能绕过了代理。

AopContext.currentProxy() 的作用

为了解决这个问题,我们可以使用 AopContext.currentProxy() 方法获取当前代理对象。该方法允许我们在同一类的非切面方法中获取代理对象,从而确保切面可以正常生效

示例代码

日志切面类
package com.hsqyz.aop.test.proxy.aspect;import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.springframework.stereotype.Component;@Component
@Aspect//表明当前类是一个切面类
public class LogUtil {/*** 用于配置当前方法是一个前置通知*/@Before("execution(* com.hsqyz.aop.test.proxy.service.impl.*.saveUser(..))")public void printLog() {System.out.println("执行打印日志的功能");}}
用户实体类
package com.hsqyz.aop.test.proxy.entity;import lombok.Data;import java.io.Serializable;
import java.util.Date;@Data
public class User implements Serializable {private String id;private String username;private String password;private String email;private Date birthday;private String gender;private String mobile;private String nickname;
}
用户业务接口
package com.hsqyz.aop.test.proxy.service;import com.hsqyz.aop.test.proxy.entity.User;import java.util.List;public interface UserService {/*** 模拟保存用户** @param user*/void saveUser(User user);/*** 批量保存用户** @param users*/void saveAllUser(List<User> users);}
用户业务实现类
package com.hsqyz.aop.test.proxy.service.impl;import com.hsqyz.aop.test.proxy.service.UserService;
import com.hsqyz.aop.test.proxy.entity.User;
import org.springframework.aop.framework.AopContext;
import org.springframework.stereotype.Service;import java.util.List;@Service("userService")
public class UserServiceImpl implements UserService {/*** 此方法被AOP切面增强过* @param user 用户对象*/@Overridepublic void saveUser(User user) {System.out.println("执行了保存用户" + user);}/*** 保存所有用户* 对用户列表中的每个用户,通过动态代理调用 UserService 的 saveUser 方法进行保存。** @param users 用户列表,包含需要保存的用户对象*/@Overridepublic void saveAllUser(List<User> users) {for (User user : users) {UserService proxyUserServiceImpl = (UserService) AopContext.currentProxy();proxyUserServiceImpl.saveUser(user);}}}
AOP切面配置类
package com.hsqyz.aop.test.proxy;import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.EnableAspectJAutoProxy;@Configuration
@ComponentScan("com.hsqyz.aop.test.proxy")
@EnableAspectJAutoProxy(exposeProxy = true)//开启spring注解aop配置的支持
public class SpringConfiguration {}
测试类
package com.hsqyz.aop.test.proxy;import com.hsqyz.aop.test.proxy.entity.User;
import com.hsqyz.aop.test.proxy.service.UserService;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;import java.util.ArrayList;
import java.util.List;public class SpringEnableAspecctJAutoProxyTest {public static void main(String[] args) {//1.创建容器AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SpringConfiguration.class);//2.获取对象UserService userService = ac.getBean("userService", UserService.class);//3.执行方法User user = new User();user.setId("1");user.setUsername("test");List<User> users = new ArrayList<>();users.add(user);// 调用userService.saveAllUser(users);}}

总览

运行效果

这里展示2种不同调用运行效果

通过this直接调用

通过this直接调用当前对象的方法。

运行效果:没有走切面逻辑!

通过代理调用

通过AopContext获取代理对象 UserService proxyUserServiceImpl = (UserService) AopContext.currentProxy();

运行效果:走了切面逻辑!

总结

Spring AOP 中,切面的生效取决于方法的调用关系:

  • 在不同类中,非切面方法A调用切面方法B,切面生效。
  • 在不同类中,切面方法A调用非切面方法B,切面生效
  • 在同一个类中,切面方法A调用非切面方法B,切面具有传播性,切面生效
  • 在同一个类中,非切面方法A调用同一类中的另一个切面方法C时,切面失效

其实这个问题和有些场景比如:加上@Transactional注解事物却失效,都是一个道理, @Transactional也是基于AOP实现的,那么既然基于AOP肯定就会被Spring创建代理对象,事务失效失效有很多种,其一种场景就和本文说的是一样的,直接在当前类去调用一个事物方法,也就会导致事物失效。

参考资料

AopContext.currentProxy();为什么能获取到代理对象
SpringBoot 中 AOP 的内部调用失效

这篇关于AopContext.currentProxy() 获取代理对象的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/668417

相关文章

Spring Boot中获取IOC容器的多种方式

《SpringBoot中获取IOC容器的多种方式》本文主要介绍了SpringBoot中获取IOC容器的多种方式,包括直接注入、实现ApplicationContextAware接口、通过Spring... 目录1. 直接注入ApplicationContext2. 实现ApplicationContextA

python获取指定名字的程序的文件路径的两种方法

《python获取指定名字的程序的文件路径的两种方法》本文主要介绍了python获取指定名字的程序的文件路径的两种方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要... 最近在做项目,需要用到给定一个程序名字就可以自动获取到这个程序在Windows系统下的绝对路径,以下

SpringBoot 获取请求参数的常用注解及用法

《SpringBoot获取请求参数的常用注解及用法》SpringBoot通过@RequestParam、@PathVariable等注解支持从HTTP请求中获取参数,涵盖查询、路径、请求体、头、C... 目录SpringBoot 提供了多种注解来方便地从 HTTP 请求中获取参数以下是主要的注解及其用法:1

使用Java读取本地文件并转换为MultipartFile对象的方法

《使用Java读取本地文件并转换为MultipartFile对象的方法》在许多JavaWeb应用中,我们经常会遇到将本地文件上传至服务器或其他系统的需求,在这种场景下,MultipartFile对象非... 目录1. 基本需求2. 自定义 MultipartFile 类3. 实现代码4. 代码解析5. 自定

javaSE类和对象进阶用法举例详解

《javaSE类和对象进阶用法举例详解》JavaSE的面向对象编程是软件开发中的基石,它通过类和对象的概念,实现了代码的模块化、可复用性和灵活性,:本文主要介绍javaSE类和对象进阶用法的相关资... 目录前言一、封装1.访问限定符2.包2.1包的概念2.2导入包2.3自定义包2.4常见的包二、stati

Python获取浏览器Cookies的四种方式小结

《Python获取浏览器Cookies的四种方式小结》在进行Web应用程序测试和开发时,获取浏览器Cookies是一项重要任务,本文我们介绍四种用Python获取浏览器Cookies的方式,具有一定的... 目录什么是 Cookie?1.使用Selenium库获取浏览器Cookies2.使用浏览器开发者工具

Java获取当前时间String类型和Date类型方式

《Java获取当前时间String类型和Date类型方式》:本文主要介绍Java获取当前时间String类型和Date类型方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,... 目录Java获取当前时间String和Date类型String类型和Date类型输出结果总结Java获取

C#监听txt文档获取新数据方式

《C#监听txt文档获取新数据方式》文章介绍通过监听txt文件获取最新数据,并实现开机自启动、禁用窗口关闭按钮、阻止Ctrl+C中断及防止程序退出等功能,代码整合于主函数中,供参考学习... 目录前言一、监听txt文档增加数据二、其他功能1. 设置开机自启动2. 禁止控制台窗口关闭按钮3. 阻止Ctrl +

一文详解如何使用Java获取PDF页面信息

《一文详解如何使用Java获取PDF页面信息》了解PDF页面属性是我们在处理文档、内容提取、打印设置或页面重组等任务时不可或缺的一环,下面我们就来看看如何使用Java语言获取这些信息吧... 目录引言一、安装和引入PDF处理库引入依赖二、获取 PDF 页数三、获取页面尺寸(宽高)四、获取页面旋转角度五、判断

Python使用OpenCV实现获取视频时长的小工具

《Python使用OpenCV实现获取视频时长的小工具》在处理视频数据时,获取视频的时长是一项常见且基础的需求,本文将详细介绍如何使用Python和OpenCV获取视频时长,并对每一行代码进行深入解析... 目录一、代码实现二、代码解析1. 导入 OpenCV 库2. 定义获取视频时长的函数3. 打开视频文