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。

相关文章

分布式锁在Spring Boot应用中的实现过程

分布式锁在Spring Boot应用中的实现过程

《分布式锁在SpringBoot应用中的实现过程》文章介绍在SpringBoot中通过自定义Lock注解、LockAspect切面和RedisLockUtils工具类实现分布式锁,确保多实例并发操作... 目录Lock注解LockASPect切面RedisLockUtils工具类总结在现代微服务架构中，分布
阅读更多...
Java使用Thumbnailator库实现图片处理与压缩功能

Java使用Thumbnailator库实现图片处理与压缩功能

《Java使用Thumbnailator库实现图片处理与压缩功能》Thumbnailator是高性能Java图像处理库,支持缩放、旋转、水印添加、裁剪及格式转换,提供易用API和性能优化,适合Web应... 目录1. 图片处理库Thumbnailator介绍2. 基本和指定大小图片缩放功能2.1 图片缩放的
阅读更多...
Spring Boot集成/输出/日志级别控制/持久化开发实践

Spring Boot集成/输出/日志级别控制/持久化开发实践

《SpringBoot集成/输出/日志级别控制/持久化开发实践》SpringBoot默认集成Logback,支持灵活日志级别配置（INFO/DEBUG等）,输出包含时间戳、级别、类名等信息,并可通过... 目录一、日志概述1.1、Spring Boot日志简介1.2、日志框架与默认配置1.3、日志的核心作用
阅读更多...
Python使用Tenacity一行代码实现自动重试详解

Python使用Tenacity一行代码实现自动重试详解

《Python使用Tenacity一行代码实现自动重试详解》tenacity是一个专为Python设计的通用重试库,它的核心理念就是用简单、清晰的方式,为任何可能失败的操作添加重试能力,下面我们就来看... 目录一切始于一个简单的 API 调用Tenacity 入门：一行代码实现优雅重试精细控制：让重试按我
阅读更多...
破茧 JDBC:MyBatis 在 Spring Boot 中的轻量实践指南

破茧 JDBC:MyBatis 在 Spring Boot 中的轻量实践指南

《破茧JDBC:MyBatis在SpringBoot中的轻量实践指南》MyBatis是持久层框架,简化JDBC开发,通过接口+XML/注解实现数据访问,动态代理生成实现类,支持增删改查及参数... 目录一、什么是 MyBATis二、 MyBatis 入门2.1、创建项目2.2、配置数据库连接字符串2.3、入
阅读更多...
Springboot项目启动失败提示找不到dao类的解决

Springboot项目启动失败提示找不到dao类的解决

《Springboot项目启动失败提示找不到dao类的解决》SpringBoot启动失败,因ProductServiceImpl未正确注入ProductDao,原因：Dao未注册为Bean,解决：在启... 目录错误描述原因解决方法总结***************************APPLICA编
阅读更多...
深度解析Spring Security 中的 SecurityFilterChain核心功能

深度解析Spring Security 中的 SecurityFilterChain核心功能

《深度解析SpringSecurity中的SecurityFilterChain核心功能》SecurityFilterChain通过组件化配置、类型安全路径匹配、多链协同三大特性,重构了Spri... 目录Spring Security 中的SecurityFilterChain深度解析一、Security
阅读更多...
Redis客户端连接机制的实现方案

Redis客户端连接机制的实现方案

《Redis客户端连接机制的实现方案》本文主要介绍了Redis客户端连接机制的实现方案,包括事件驱动模型、非阻塞I/O处理、连接池应用及配置优化,具有一定的参考价值,感兴趣的可以了解一下... 目录1. Redis连接模型概述2. 连接建立过程详解2.1 连php接初始化流程2.2 关键配置参数3. 最大连
阅读更多...
SpringBoot多环境配置数据读取方式

SpringBoot多环境配置数据读取方式

《SpringBoot多环境配置数据读取方式》SpringBoot通过环境隔离机制,支持properties/yaml/yml多格式配置,结合@Value、Environment和@Configura... 目录一、多环境配置的核心思路二、3种配置文件格式详解2.1 properties格式（传统格式）1.
阅读更多...
Apache Ignite 与 Spring Boot 集成详细指南

Apache Ignite 与 Spring Boot 集成详细指南

《ApacheIgnite与SpringBoot集成详细指南》ApacheIgnite官方指南详解如何通过SpringBootStarter扩展实现自动配置,支持厚/轻客户端模式,简化Ign... 目录 一、背景：为什么需要这个集成？ 二、两种集成方式（对应两种客户端模型） 三、方式一：自动配置 Thick
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2