【alibaba/jvm-sandbox#04】通过EventWatchBuilder修改字节码Applehope

太过爱你忘了你带给我的痛 2023-10-03 22:49 13阅读 0赞

### 一、alibaba/jvm-sandbox 概述 ###

alibaba/jvm-sandbox 是 JVM 沙箱容器，一种 JVM 的非侵入式运行期 AOP 解决方案。沙箱容器提供

1.  动态增强类你所指定的类，获取你想要的参数和行信息甚至改变方法执行
2.  动态可插拔容器框架

在其能力至上构建的上层应用有：

*  [chaosblade-io][]/**[chaosblade][]**
    
     *  其[chaosblade-io][]/**[chaosblade-exec-jvm][]** 是一个基于 jvm-sandbox 的 chaosblade 执行器，用于通过增强类在 Java 应用程序上进行混沌实验。
 *  [alibaba][]/**[jvm-sandbox-repeater][]**
    
     *  基于 JVM-Sandbox 的录制/回放通用解决方案

在[《【alibaba/jvm-sandbox\#02】通过无侵入 AOP 实现行为注入和流控》][alibaba_jvm-sandbox_02_ AOP] 介绍了 JVM-SANDBOX 属于基于 Instrumentation 的动态编织类的 AOP 框架，**通过精心构造了字节码增强逻辑，使得沙箱的模块能在不违反 JDK 约束情况下实现对目标应用方法的`无侵入`运行时 AOP 拦截**。实现行为注入和流控。

本篇的目标是梳理 Sandbox 如何使用 Instrumentation 技术修改字节码

### 二、ClassFileTransformer ###

#### 2.1 回顾 java agent 的 Instrumentation 修改字节码的机制 ####

java agent 提供了`Instrumentation`，通过`Instrumentation#addTransformer` 我们添加自定义的`ClassFileTransformer`，在其方法`transform`中修改类的字节码。

`Instrumentation`： 中文叫插桩 `ClassFileTransformer` ：我把它叫做字节码转换器

*  启动挂载 ： JDK1.5 提供了启动挂载的机制，JVM 首次加载一个类信息时，在使用之前，调用`ClassFileTransformer#transform`修改字节;JVM 使用修改后的字节码创建对象、调用方法。 结论：所有的类在加载时就经历了增强处理的逻辑； 即待增强的类，在应用启动后就被增强了。
 *  动态挂载 ： JDK1.6 提供启动后（运行时）挂载的机制 a. 动态挂载之后，类加载时都会执行`ClassFileTransformer#transform`，我们在此方法中增强目标类。 b. 动态挂载前 已经加载的类，都未经历增强的处理。可通过调用`java.lang.instrument.Instrumentation#retransformClasses`方法，让已加载的类重新加载，重新加载时也会执行`java.lang.instrument.ClassFileTransformer#transform`，我们在此方法中增强目标类。

JVM-Sandbox 支持启动时挂载和运行时挂载两种方式。

#### 2.2 何时向插桩中添加字节码转换器 ####

什么时候创建`ClassFileTransformer`，什么时候调用`Instrumentation#addTransformer` ？

Sandbox Wiki 中说道:

> 模块被沙箱正确加载，沙箱将会允许模块进行命令相应、代码插桩等动作 模块激活后才能受到沙箱事件。

即在模块**加载完毕后**，我们就可以进行代码插桩，代码插桩 其内部就是创建`ClassFileTransformer`，执行`Instrumentation#addTransformer`。 给我们提供了两种途径：

1.  在模块的 onLoad 事件中
2.  模块中接收 http 指令响应逻辑中

### 三、如何修改字节码 ###

#### 3.1 使用者关注什么 ####

修改字节码有一定的技术难度，其实从使用者的角度来看，我们关注的是操控什么类、什么方法、方法中的什么逻辑。JVM-Sandbox 针对这些需求对代码插桩进行了封装；把底层复杂的字节码操控隐藏起来，让我们以使用者的思维模式来操作：

*  你关注什么类，什么方法
 *  方法执行时你想干什么？

这非常符合事件监听模式，Sandbox 就是按照事件监听模式来实现以上需求的，体现在其核心接口`com.alibaba.jvm.sandbox.api.resource.ModuleEventWatcher` 中`watch`方法上，解释其部分参数：

1.  `Filter`：指定目标类和方法 可以使用 通配符匹配 和 正则匹配
2.  `EventListener`：将方法执行逻辑回调 我们在 listener 的回调方法中自定义逻辑

为了进一步方便用户提供了`EventWatchBuilder`，使用起来更清晰简单

new EventWatchBuilder(moduleEventWatcher)
            .onClass("com.taobao.demo.Clock")
            .onBehavior("report")
            .onBehavior("sleepSecond")
            .onWatching()
            .withCall()
            .onWatch(new AdviceListener() {
    复制代码

#### 3.2 拆解 watch 方法的实现 ####

1.  用 Matcher 来封装 目标类和方法的识别 的逻辑
2.  创建`SandboxClassFileTransformer`（Sandbox 自定义的类转换器，在其内部实现字节码的修改）
3.  类转换器注册到 JVM 上
4.  查找需要渲染的类集合，告诉 JVM 把这些类进行重新加载；对应动态装在的模式
5.  如果模块是激活的，那么监听器才生效，即才有方法执行的回调。

#### 3.3 字节码修改的执行 ####

JVM 在加载类的时候 会被逐个调用`Instrumentation`中的`ClassFileTransformer#transform`方法，Sandbox 在这里的逻辑主要只有这些

1.  排除不需要不增强的类
2.  判断是否是用户指定的并且可以增强的类，不满足条件的不处理
3.  修改字节码，执行方法级的增强（666）。

字节码的的一个细节： **每次`watch`，在所匹配的类方法中都有其对应的增强代码**

#### 3.4 被细节侵蚀的大局观 ####

考虑`watch`方法执行一次的后果：

*  新建一个`SandboxClassFileTransformer`
 *  插桩中就会多添加一个`ClassFileTransformer`
 *  匹配的类就会被重新定义一次
 *  `ClassFileTransformer#transform`多执行一次，类会被多增强一次

#### 3.5 增强的注意事项 ####

1.  考虑是否有必要在同一个方法中存在多个增强。
2.  当增强不需要的时候，考虑是否删除增强，调用 `watcher#onUnWatched`

### 四、最后说一句 ###

我是石页兄，如果这篇文章对您有帮助，或者有所启发的话，欢迎关注笔者的微信公众号【 架构染色 】进行交流和学习。您的支持是我坚持写作最大的动力。

原文链接：https://juejin.cn/post/7182830306250981437  
来源：稀土掘金

[chaosblade-io]: https://link.juejin.cn?target=https%3A%2F%2Fgithub.com%2Fchaosblade-io
[chaosblade]: https://link.juejin.cn?target=https%3A%2F%2Fgithub.com%2Fchaosblade-io%2Fchaosblade
[chaosblade-exec-jvm]: https://link.juejin.cn?target=https%3A%2F%2Fgithub.com%2Fchaosblade-io%2Fchaosblade-exec-jvm
[alibaba]: https://link.juejin.cn?target=https%3A%2F%2Fgithub.com%2Falibaba
[jvm-sandbox-repeater]: https://link.juejin.cn?target=https%3A%2F%2Fgithub.com%2Falibaba%2Fjvm-sandbox-repeater
[alibaba_jvm-sandbox_02_ AOP]: https://juejin.cn/post/7182790460640624696