JVM-Sandbox笔记 -- 增强的时机

目标

了解Instrumentation的字节码修改机制
了解Sandbox如何使用Instrumentation技术

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.何时向插桩中添加字节码转换器

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

Sandbox Wiki中说道:

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

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

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

3.如何修改字节码

修改字节码有难度，其实我们关注的是操控什么类、什么方法、方法中的什么逻辑。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() {

拆解watch方法的实现：

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

4. 字节码修改的执行

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

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

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

5.被细节侵蚀的大局观

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

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

增强的注意事项：

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