我是石页兄,朋友不因远而疏,高山不隔友谊情;偶遇美羊羊,我们互相鼓励欢迎关注微信公众号「架构染色」交流和学习
一、alibaba/jvm-sandbox 概述
alibaba/jvm-sandbox 是 JVM 沙箱容器,一种 JVM 的非侵入式运行期 AOP 解决方案。沙箱容器提供
- 动态增强类你所指定的类,获取你想要的参数和行信息甚至改变方法执行
- 动态可插拔容器框架
在其能力至上构建的上层应用有:
-
- 其chaosblade-io/chaosblade-exec-jvm 是一个基于 jvm-sandbox 的 chaosblade 执行器,用于通过增强类在 Java 应用程序上进行混沌实验。
-
- 基于 JVM-Sandbox 的录制/回放通用解决方案
在《【alibaba/jvm-sandbox#02】通过无侵入 AOP 实现行为注入和流控》 介绍了 JVM-SANDBOX 属于基于 Instrumentation 的动态编织类的 AOP 框架,通过精心构造了字节码增强逻辑,使得沙箱的模块能在不违反 JDK 约束情况下实现对目标应用方法的无侵入
运行时 AOP 拦截。实现行为注入和流控。
本篇的目标是
- 理解事件的种类,调用顺序
- 理解事件链路 事件与通知的转换 以及方法链和通知栈的关系。
- 理解流程跳转的控制-通过自定义异常来实现流程的跳转。
- 理解流程跳转后,通知的有效性。
二、事件处理器
1)概述
代码中的 new 一个 Listener,sandbox 内部就创建并注册一个与之对应的事件处理器。
Spy 的静态方法中将方法事件交给了事件处理器经过一些内部处理,最终回调 listener 的方法。
2)注册事件处理器
注册过程在com.alibaba.jvm.sandbox.core.enhance.weaver.EventListenerHandlers#active
中。
先说明listenerId
是什么:listener
对象 放入对象池后,得到 listenerId
,程序中不需要操作listener
实例,但是上下文中又需要用到listener
的引用的地方都用listenerId
;
public void active(final int listenerId,
final EventListener listener,
final Event.Type[] eventTypes) {
//对于一个listener对象,创建一个事件处理器并与之关联
//mappingOfEventProcessor 容器中通过listenerId与EventProcessor 建立关联。
//sandbox源码中注入的方法参数里 有 listenerid,mappingOfEventProcessor通过listenerId能找到事件处理器
mappingOfEventProcessor.put(listenerId, new EventProcessor(listenerId, listener, eventTypes));
logger.info("activated listener[id={};target={};] event={}",
listenerId,
listener,
join(eventTypes, ",")
);
}
3)获取事件处理器
mappingOfEventProcessor.get(listenerId);
4) 事件处理器的功能
- 提供方法对应的事件对象
- 维护事件对应的方法之间的调用关系
- 跳转控制
三、处理单元
处理单元来负责事件处理器的 2 个功能:
- 提供方法对应的事件对象
- 维护事件对应的方法之间的调用关系是由
3.1 什么是处理单元
一个监听的方法链路在一个线程中对应着一个处理单元com.alibaba.jvm.sandbox.core.enhance.weaver.EventProcessor.Process
。 方法肯定是在多个线程中执行,事件处理器通过 ThreadLocal的方法每个线程创建了一个处理单元Process
的实例,这样处理单元之间就是线程隔离的,其内部创建的对象就是线程安全的。
两个基本的功能:
- 提供方法对应的事件对象
EventProcessor.Process
的SingleEventFactory
事件工厂负责创建各种事件对象,比如 makeBeforeEvent 就创建一个 before 事件对象;每个事件都是一个单例,下一个事件到来时,其内部通过 unsafe 方法来给对象的属性变更值,避免了每次创建新对象,减少新生代 GC 的工作量。 .weaver.EventProcessor.Process
的stack
负责维护方法之间的调用关系,跟 JVM 的操作类似(JVM 通过栈结构来组织方法的调用关系,调用方法时方法栈帧压栈,方法执行结束后就方法栈帧出栈);栈的深度取决于监听的方法链路的深度。
在处理链路的时候有两个 id 很关键,processId
和invokeId
,每个方法的before
事件即方法的入口处对应一个invokeId
,对于方法链路来说,最外层的方法是的 invokeId 就标识了整个调用链路,即整个执行过程,存储为processId
,内部方法的processId
就是最外层方法的InvokeId
。
xxxEvent 对象是线程复用的,这样在用户使用时就有很多约束,所以处理单元所提供的方法事件,仅在 sandbox 内部使用,在用户视角的监听器里回调方法中就被封装成了Advice
通知对象com.alibaba.jvm.sandbox.api.listener.ext.Advice
。
方法之间的调用栈关系,转换为com.alibaba.jvm.sandbox.api.listener.ext.AdviceAdapterListener.OpStack
同时也在 Advice 上体现,通过 top 属性来指向栈底 Advice,通过 parent 属性指向上一个 Advice(朝栈底方向)。Advice 更重要的是提供了打标marks
和挂载数据attatchment
的功能;这样在通知栈中就增加了交互通信的手段。类似于传话的功能。
Advice 压栈和出栈如下:
四、事件的处理
4.1 report 方法的三个事件
- BEFORE
在
BEFORE
事件中,sandbox 内部通过makeBeforeEvent
创建beforeEvent
对象,根据这个Event
创建了Advice
后压栈;后续RETURN
/THROWS
中使用;所以一个方法内只在入口处创建一个advice
对象。 - RETURN
sandbox 内部通过
makeReturnEvent
创建returnEvent
对象。通过invokeId
,从栈顶拿到Advice
对象,将事件包裹的函数返回值 放置到advice
中。 - THROWS
sandbox 内部通过
makeThrowsEvent
创建throwsEvent
对象。通过invokeId
,从栈顶拿到Advice
对象,将事件包裹的函数返回值 放置到advice
中。
4.2 report 方法中的 call 事件
CALL_BEFORE
xxxAdvice对象在一次方法的调用内部只有一个,在`before`事件中创建。其他的所有事件中复用此通知对象。
call_before
事件中也是通过invokeId
,从栈顶拿到Advice
对象,复用此advice
中;call
事件中创建了CallTarget
对象,记录了被call
方法的一些信息;
作为attach
附加到 xxxAdvice 上。wrapAdvice.attach(target = new CallTarget( cbEvent.lineNumber,//代码行号 toJavaClassName(cbEvent.owner),//调用者的类名 cbEvent.name,//被调方法名 cbEvent.desc//被调方法的参数 ));
之后调用adviceListener.beforeCall
CALL_RETURN
也是通过`invokeId`,从栈顶拿到`Advice`对象,复用此`Advice`中; ``` CallTarget target = wrapAdvice.attachment(); ``` 从`target`中拿到方法名和调用者类名信息;之后调用`adviceListener.afterCallReturning`和
adviceListener.afterCall
CALL_THROWS
也是通过`invokeId`,从栈顶拿到`Advice`对象,复用此`advice`中; ``` CallTarget target = wrapAdvice.attachment(); ``` 从`target`中拿到方法名和调用者类名信息;之后调用`adviceListener.afterCallThrowing`和
adviceListener.afterCall
4.3 report 方法中的 LINE 事件
也是通过invokeId
,从栈顶拿到Advice
对象,复用此advice
中;之后调用adviceListener.beforeLine
4.4 函数的嵌套调用,即多层调用的情况
- 子函数的
invokeId
在自增变化 advice
的parent
和top
能查找到整个通知栈的advice
- 再通过
advice
上的attachment
可以在上下游之间传递信息。不用再额外的设计和引入其他的载体容器。
五、最后说一句
我是石页兄,如果这篇文章对您有帮助,或者有所启发的话,欢迎关注笔者的微信公众号【 架构染色 】进行交流和学习。您的支持是我坚持写作最大的动力。