SpringBoot 热插拔AOP，动态的实现AOP【简单易懂，有大用】

2024-05-26 02:28
文章标签 java 简单 动态 实现 springboot spring 易懂 aop 热插拔 有大用

本文主要是介绍SpringBoot 热插拔AOP，动态的实现AOP【简单易懂，有大用】，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

B站学习地址


文章目录

  • 一、理论
  • 二、核心代码
    • 2-1、自定义操作类型枚举
    • 2-2、自定义 Advisor
    • 2-3、动态添加/删除advisor 工具类
    • 2-4、提供测试的 Controller
  • 三、测试
    • 3-1、自定义注解
    • 3-2、自定义拦截器
    • 3-3、测试
  • 四、源码获取


前段时间在学习sentinel和dubbo的时候，很好奇它们对应的控制台为何可以实现代码无侵入 动态的添加/删除功能

看过 @Async、@Transactionnal相关源码的朋友应该知道，这是基于动态代理去实现了，既然如此那我们是否可以实现动态的去添加/删除动态代理呢

答案是 YES，下面就来实现一个动态的添加/删除动态代理的功能，它的源码很简单，但这会打开你的新世界


动态代理后你想干嘛都行，干什么不是这里的重点，重点是控制它干和不干，所以为了简单的我就在返回值上做了点文章


先来看效果图

SpringBoot 热插拔AOP，动态的实现AOP


一、理论


在开始写代码之前，先来了解几个基本的理论知识 （重要‼️）

keyvalue
advice动态代理之后要干什么，其实就是这个 advice的定义，本质上就是 Interceptor（实际上也是，因为Interceptor 继承了 advice）
pointcut不可能对所有的方法都强加上 advice（可以但没必要），所以 pointcut 就是定义拦截的规则（可以对使用了某个注解进行拦截，也可以用表达式去匹配）
advisor简单理解为 它就是包含了advice 和 pointcut 的类
advised代理后生成的代理对象，它维护了一个 List advisors，从而实现功能叠加

原理就是先把bean转换成 advised，然后添加/删除 advisor，就实现了动态的动态代理 （最重要的一句话）


也可以添加/删除 advice，但这就对bean的所有方法都代理了，在大多数情况下这不是我们想要了，比如 @Async 是想添加在哪个方法上，哪个方法就异步，而不是全部的方法都异步


advisor，advice 这俩玩意不熟悉的时候，很容易看错，我开始就是，排查半天

advised.addAdvisor();
advised.addAdvice();

二、核心代码


2-1、自定义操作类型枚举

public enum OperateEventEnum {ADD("add"),DELETE("delete");private String value;OperateEventEnum(String value) {this.value = value;}public String getValue() {return value;}
}

2-2、自定义 Advisor

import org.aopalliance.aop.Advice;
import org.aopalliance.intercept.MethodInterceptor;
import org.springframework.aop.Pointcut;
import org.springframework.aop.aspectj.AspectJExpressionPointcut;
import org.springframework.aop.support.AbstractPointcutAdvisor;
import org.springframework.aop.support.ComposablePointcut;
import org.springframework.aop.support.annotation.AnnotationMatchingPointcut;import java.lang.annotation.Annotation;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.Set;public class XdxAdvisor extends AbstractPointcutAdvisor {private final Advice advice;private final Pointcut pointcut;// 基于注解的 pointcutpublic XdxAdvisor(Class<? extends Annotation>  annotationClass, MethodInterceptor interceptor) {this.advice = interceptor;this.pointcut = buildPointcut(annotationClass);}// 基于表达式的 pointcutpublic XdxAdvisor(String expression, MethodInterceptor interceptor) {this.advice = interceptor;this.pointcut = buildPointcut(expression);}/*** 直接复制的 @Async 构建 pointcut的代码* @param annotationType* @return*/private Pointcut buildPointcut(Class<? extends Annotation> annotationType) {Set<Class<? extends Annotation>> annotationTypes = new LinkedHashSet(2);annotationTypes.add(annotationType);ComposablePointcut result = null;AnnotationMatchingPointcut mpc;for(Iterator var3 = annotationTypes.iterator(); var3.hasNext(); result = result.union(mpc)) {Class<? extends Annotation> asyncAnnotationType = (Class)var3.next();Pointcut cpc = new AnnotationMatchingPointcut(asyncAnnotationType, true);mpc = new AnnotationMatchingPointcut((Class)null, asyncAnnotationType, true);if (result == null) {result = new ComposablePointcut(cpc);} else {result.union(cpc);}}return (Pointcut) (result != null ? result : Pointcut.TRUE);}private Pointcut buildPointcut(String expression) {AspectJExpressionPointcut tmpPointcut = new AspectJExpressionPointcut();tmpPointcut.setExpression(expression);return  tmpPointcut;}@Overridepublic Pointcut getPointcut() {return pointcut;}@Overridepublic Advice getAdvice() {return advice;}//    private Pointcut buildPointcut(Class<? extends Annotation> annotationTypes) {
//
//        AnnotationClassFilter classFilter = new AnnotationClassFilter(annotationTypes, true);
//        return new ComposablePointcut(classFilter);
//    }}

2-3、动态添加/删除advisor 工具类

import org.springframework.aop.Advisor;
import org.springframework.aop.framework.Advised;
import org.springframework.aop.framework.ProxyFactory;
import org.springframework.aop.framework.ProxyProcessorSupport;
import org.springframework.aop.support.AopUtils;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.BeanFactoryAware;
import org.springframework.beans.factory.support.DefaultListableBeanFactory;
import org.springframework.context.annotation.Configuration;@Configuration
public class DynamicProxy extends ProxyProcessorSupport implements BeanFactoryAware {private DefaultListableBeanFactory beanFactory;public void operateAdvisor(XdxAdvisor advisor, OperateEventEnum operateEventEnum) {// 循环每一个beanfor (String beanDefinitionName : beanFactory.getBeanDefinitionNames()) {Object bean = beanFactory.getBean(beanDefinitionName);// 判断当前bean是否匹配if (!isEligible(bean, advisor)) {continue;}// 判断当前bean是不是已经是代理对象了，是就直接进行 Advisor 操作if (bean instanceof Advised) {Advised advised = (Advised) bean;if(operateEventEnum == OperateEventEnum.DELETE) {advised.removeAdvisor(advisor);}else if(operateEventEnum == OperateEventEnum.ADD){advised.addAdvisor(advisor);}continue;}// 生成 Advisor 的代理对象ProxyFactory proxyFactory = new ProxyFactory();proxyFactory.addAdvisor(advisor);proxyFactory.setTarget(bean);ClassLoader classLoader = this.getProxyClassLoader();Object proxy = proxyFactory.getProxy(classLoader);// 销毁之前的bean，把新的bean注入到容器beanFactory.destroySingleton(beanDefinitionName);beanFactory.registerSingleton(beanDefinitionName, proxy);}}@Overridepublic void setBeanFactory(BeanFactory beanFactory) throws BeansException {this.beanFactory = (DefaultListableBeanFactory) beanFactory;}/*** 复制的 @Async 的匹配逻辑*/private boolean isEligible(Object bean, Advisor advisor) {return AopUtils.canApply(advisor, bean.getClass());}
}

  1. 添加的时候其实可以指定位置的，如果有需要的话，本身存储的就是List有序的
  2. @Async每次添加的时候 pos = 0 ，因为异步要先开启呀
void addAdvisor(int pos, Advisor advisor) throws AopConfigException;void addAdvice(int pos, Advice advice) throws AopConfigException;

2-4、提供测试的 Controller

import cn.hutool.core.text.CharSequenceUtil;
import com.xdx97.cli.dynamic.DynamicProxy;
import com.xdx97.cli.dynamic.OperateEventEnum;
import com.xdx97.cli.dynamic.XdxAdvisor;
import com.xdx97.cli.dynamic.annotation.XdxAnnotation;
import org.aopalliance.intercept.MethodInterceptor;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.annotation.Resource;
import java.lang.annotation.Annotation;
import java.util.HashMap;
import java.util.Map;@RestController
@RequestMapping("/advisor")
public class AdvisorController {@Resourceprivate DynamicProxy dynamicProxy;private static Map<String, XdxAdvisor> xdxAdvisorMap = new HashMap<>();@GetMapping(value = "/add")public String add(String interceptorClass, String expression, String annotationClass) throws Exception {if(CharSequenceUtil.isAllBlank(expression, annotationClass) || CharSequenceUtil.isBlank(interceptorClass)) {return "the parameter is abnormal";}if (xdxAdvisorMap.containsKey(interceptorClass + annotationClass) || xdxAdvisorMap.containsKey(interceptorClass + expression)) {return "advisor already exists";}MethodInterceptor methodInterceptor =  (MethodInterceptor) Class.forName(interceptorClass).getDeclaredConstructor().newInstance();XdxAdvisor xdxAdvisor;// 以注解为主，有注解就用注解if (CharSequenceUtil.isNotBlank(annotationClass)) {Class<? extends Annotation> aClass = (Class<? extends Annotation>) Class.forName(annotationClass);xdxAdvisor = new XdxAdvisor(aClass, methodInterceptor);xdxAdvisorMap.put(interceptorClass + annotationClass, xdxAdvisor);} else {xdxAdvisor = new XdxAdvisor(expression, methodInterceptor);xdxAdvisorMap.put(interceptorClass + expression, xdxAdvisor);}dynamicProxy.operateAdvisor(xdxAdvisor, OperateEventEnum.ADD);return "advisor add success" ;}@GetMapping(value = "/delete")public String delete(String interceptorClass, String expression, String annotationClass) {if(CharSequenceUtil.isAllBlank(expression, annotationClass) || CharSequenceUtil.isBlank(interceptorClass)) {throw new IllegalArgumentException("参数异常");}if (!xdxAdvisorMap.containsKey(interceptorClass + annotationClass) && !xdxAdvisorMap.containsKey(interceptorClass + expression)) {return "advisor not exists";}// 以注解为主，有注解就用注解StringBuilder advisorKey = new StringBuilder(interceptorClass);if (CharSequenceUtil.isNotBlank(annotationClass)) {advisorKey.append(annotationClass);} else {advisorKey.append(expression);}XdxAdvisor xdxAdvisor = xdxAdvisorMap.get(advisorKey.toString());dynamicProxy.operateAdvisor(xdxAdvisor, OperateEventEnum.DELETE);xdxAdvisorMap.remove(advisorKey.toString());return "advisor delete success";}/*** 用来测试效果的fun* @return*/@GetMapping(value = "/fun")@XdxAnnotationpublic String fun() {return "my fun";}
}

三、测试


上面的代码就已经完成了动态的动态代理，是不是很简单？或许你现在还有点懵，别担心下面的测试，会让你脉动回来

要实现两种动态代理

  1. 基于表达式，（不会写表达式？没关系，AI助你）
  2. 基于注解的

3-1、自定义注解

细心的朋友可能已经发现了在AdvisorController.fun() 方法上面已经携带了这个注解

import java.lang.annotation.*;@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface XdxAnnotation {
}

这个注解也可以用在类上面哦，这样会把所有方法都拦截


3-2、自定义拦截器


拦截到之后总得干点什么，这里我在返回值上做文章，因为这样测试的时候效果最显著了

import org.aopalliance.intercept.MethodInterceptor;
import org.aopalliance.intercept.MethodInvocation;public class OneInterceptor implements MethodInterceptor {@Overridepublic Object invoke(MethodInvocation invocation) throws Throwable {Object result = invocation.proceed();return result + " 增强One";}
}public class TwoInterceptor implements MethodInterceptor {@Overridepublic Object invoke(MethodInvocation invocation) throws Throwable {Object result = invocation.proceed();return result + " 增强Two";}
}

定义2个拦截器，是为了一个给注解拦截用，一个给表达式拦截用，方便观察


3-3、测试


查看代理结果

curl --location --request GET 'http://127.0.0.1:9897/advisor/fun'

添加注解的代理

curl --location --request GET 'http://127.0.0.1:9897/advisor/add?interceptorClass=com.xdx97.cli.dynamic.inteceptor.OneInterceptor&annotationClass=com.xdx97.cli.dynamic.annotation.XdxAnnotation'

添加表达式代理

curl --location --request GET 'http://127.0.0.1:9897/advisor/add?interceptorClass=com.xdx97.cli.dynamic.inteceptor.TwoInterceptor&expression=execution(* com.xdx97.cli.AdvisorController.fun(..))'

删除注解代理

curl --location --request GET 'http://127.0.0.1:9897/advisor/delete?interceptorClass=com.xdx97.cli.dynamic.inteceptor.OneInterceptor&annotationClass=com.xdx97.cli.dynamic.annotation.XdxAnnotation'

删除表达式代理

curl --location --request GET 'http://127.0.0.1:9897/advisor/delete?interceptorClass=com.xdx97.cli.dynamic.inteceptor.TwoInterceptor&expression=execution(* com.xdx97.cli.AdvisorController.fun(..))'

四、源码获取


  1. 关注公众号：小道仙97
  2. 回复：dynamicProxy

这篇关于SpringBoot 热插拔AOP，动态的实现AOP【简单易懂，有大用】的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1003299。

相关文章

Flutter实现文字镂空效果的详细步骤

Flutter实现文字镂空效果的详细步骤

《Flutter实现文字镂空效果的详细步骤》：本文主要介绍如何使用Flutter实现文字镂空效果,包括创建基础应用结构、实现自定义绘制器、构建UI界面以及实现颜色选择按钮等步骤,并详细解析了混合模... 目录引言实现原理开始实现步骤1：创建基础应用结构步骤2：创建主屏幕步骤3：实现自定义绘制器步骤4：构建U
阅读更多...
SpringBoot中四种AOP实战应用场景及代码实现

SpringBoot中四种AOP实战应用场景及代码实现

《SpringBoot中四种AOP实战应用场景及代码实现》面向切面编程(AOP)是Spring框架的核心功能之一,它通过预编译和运行期动态代理实现程序功能的统一维护,在SpringBoot应用中,AO... 目录引言场景一：日志记录与性能监控业务需求实现方案使用示例扩展：MDC实现请求跟踪场景二：权限控制与
阅读更多...
Android实现定时任务的几种方式汇总(附源码)

Android实现定时任务的几种方式汇总(附源码)

《Android实现定时任务的几种方式汇总(附源码)》在Android应用中,定时任务（ScheduledTask）的需求几乎无处不在：从定时刷新数据、定时备份、定时推送通知,到夜间静默下载、循环执行... 目录一、项目介绍1. 背景与意义二、相关基础知识与系统约束三、方案一：Handler.postDel
阅读更多...
慢sql提前分析预警和动态sql替换-Mybatis-SQL

慢sql提前分析预警和动态sql替换-Mybatis-SQL

《慢sql提前分析预警和动态sql替换-Mybatis-SQL》为防止慢SQL问题而开发的MyBatis组件,该组件能够在开发、测试阶段自动分析SQL语句,并在出现慢SQL问题时通过Ducc配置实现动... 目录背景解决思路开源方案调研设计方案详细设计使用方法1、引入依赖jar包2、配置组件XML3、核心配
阅读更多...
Java NoClassDefFoundError运行时错误分析解决

Java NoClassDefFoundError运行时错误分析解决

《JavaNoClassDefFoundError运行时错误分析解决》在Java开发中,NoClassDefFoundError是一种常见的运行时错误,它通常表明Java虚拟机在尝试加载一个类时未能... 目录前言一、问题分析二、报错原因三、解决思路检查类路径配置检查依赖库检查类文件调试类加载器问题四、常见
阅读更多...
Java注解之超越Javadoc的元数据利器详解

Java注解之超越Javadoc的元数据利器详解

《Java注解之超越Javadoc的元数据利器详解》本文将深入探讨Java注解的定义、类型、内置注解、自定义注解、保留策略、实际应用场景及最佳实践,无论是初学者还是资深开发者,都能通过本文了解如何利用... 目录什么是注解？注解的类型内置注编程解自定义注解注解的保留策略实际用例最佳实践总结在 Java 编程
阅读更多...
使用Python实现IP地址和端口状态检测与监控

使用Python实现IP地址和端口状态检测与监控

《使用Python实现IP地址和端口状态检测与监控》在网络运维和服务器管理中,IP地址和端口的可用性监控是保障业务连续性的基础需求,本文将带你用Python从零打造一个高可用IP监控系统,感兴趣的小伙... 目录概述：为什么需要IP监控系统使用步骤说明1. 环境准备2. 系统部署3. 核心功能配置系统效果展
阅读更多...
Java 实用工具类Spring 的 AnnotationUtils详解

Java 实用工具类Spring 的 AnnotationUtils详解

《Java实用工具类Spring的AnnotationUtils详解》Spring框架提供了一个强大的注解工具类org.springframework.core.annotation.Annot... 目录前言一、AnnotationUtils 的常用方法二、常见应用场景三、与 JDK 原生注解 API 的
阅读更多...
Java controller接口出入参时间序列化转换操作方法(两种)

Java controller接口出入参时间序列化转换操作方法(两种)

《Javacontroller接口出入参时间序列化转换操作方法(两种)》：本文主要介绍Javacontroller接口出入参时间序列化转换操作方法,本文给大家列举两种简单方法,感兴趣的朋友一起看... 目录方式一、使用注解方式二、统一配置场景：在controller编写的接口，在前后端交互过程中一般都会涉及
阅读更多...
Java中的StringBuilder之如何高效构建字符串

Java中的StringBuilder之如何高效构建字符串

《Java中的StringBuilder之如何高效构建字符串》本文将深入浅出地介绍StringBuilder的使用方法、性能优势以及相关字符串处理技术,结合代码示例帮助读者更好地理解和应用,希望对大家... 目录关键点什么是 StringBuilder？为什么需要 StringBuilder？如何使用 St
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2