ByteBuddy（八）—Around Advice

除了OnMethodEnter和OnMethodExit Advice之外，ByteBuddy还支持Around Advice。
Around Advice通过方法委托将Advice代码添加到函数方法的开始和结束。

image.png

本章使用两个Advice代码：

PerfObjectReturnInterceptor.java
PerfVoidReturnInterceptor.java

这是功能代码

public class DataProducer{

    public void create(){
        logger.info("create data");
    }

    public String createData(){
        String uniqueId = UUID.randomUUID().toString();
        return new String(
                  Base64.getEncoder().encode(uniqueId.getBytes()), 
                  Charset.forName("UTF-8"));
    }

}

create方法在屏幕上打印状态字符串"create data"。
createData方法返回base64编码的UUID。

这是InterceptorPlugin.java方法的实现（3个方法不在解释，不懂看之前的内容）

public class InterceptorPlugin implements Plugin {
    @Override
    public DynamicType.Builder apply(DynamicType.Builder builder,
                                        TypeDescription typeDescription,
                                        ClassFileLocator classFileLocator) {
        // 
    }
    @Override
    public void close() throws IOException {
        //
    }
    @Override
    public boolean matches(TypeDescription typeDefinitions) {
        //
    }
}

这是apply方法的实现

public DynamicType.Builder apply(Builder builder, 
                            TypeDescription typeDescription,
                            ClassFileLocator classFileLocator){
    return builder
          .method(ElementMatchers.named("create"))
               .intercept(MethodDelegation
                    .to(PerfVoidReturnInterceptor.class))
          .method(ElementMatchers.named("createData"))
              .intercept(MethodDelegation
                    .to(PerfObjectReturnInterceptor.class));
}

Around Advice create方法

在apply方法中，调用builder.method的方法。
method方法使用ElementMatchers.named Advice匹配逻辑。
named方法使用"create"作为其参数值：

builder.method(ElementMatchers.named("create"))

因此，DataProducer.java的create方法被选择用于instrumentation。
之后，调用builder的intercept方法。
intercept方法的参数指定MethodDelegation.to(PerfVoidReturnInterceptor.class)

这些方法与onMethodEnter和onMethodExit Advice完全不同。
首先，builder调用intercept方法来执行检测，但不调用visit方法。
然后，检测使用MethodDelegation，而不是Advice.to方法。
匹配逻辑是通过method方法实现的，但不是Advice方法链中的on方法。

PerfVoidReturnInterceptor.java

public class PerfVoidReturnInterceptor{

    public static Logger logger = Logger.getLogger(PerfVoidReturnInterceptor.class.getName());

    public static void aroundVoid(@SuperCall Runnable targetCode, @Origin Method method){
        long startTime = System.currentTimeMillis();
        logger.info("Method start");
        targetCode.run();
        logger.info("Methodend:" + method.getName() + "executiontime:" + (System.currentTimeMillis() - startTime));
    }
}

以下是实施的Around Advice的要求：

• Advice方法是一种静态方法。
• Advice方法返回void。
• Advice方法有一个java.lang.Runnable参数，并用@SuperCall注解进行注解。

在本例中，aroundVoid方法是Advice方法。
ByteBuddy将基于aroundVoid方法的内容生成插入指令的代码。
由于MethodDelegation和@SuperCall注解，ByteBuddy创建了一个代理类来实现插入指令的代码。

这个代码的目的是测试业务代码的运行性能。

targetCode参数表示DataProducer.java的函数代码的create方法。
插入指令的代码将执行以下指令：

1.将方法开始时间存储到startTime变量
2.记录指示方法执行开始的消息
3.执行功能代码，在屏幕上打印状态"create data"。
4.记录一条消息，指示方法执行结束，以及方法执行时间（毫秒）。

启动maven build并执行Main1.java
这是插入指令的代码在屏幕上产生的结果：

11月 10, 2022 2:52:01 下午 com.wpixel.bytebuddy.chapter1.PerfVoidReturnInterceptor aroundVoid
信息: Method start
11月 10, 2022 2:52:01 下午 com.wpixel.bytebuddy.chapter1.DataProducer create$original$nNDKo4Mw
信息: create data
11月 10, 2022 2:52:01 下午 com.wpixel.bytebuddy.chapter1.PerfVoidReturnInterceptor aroundVoid
信息: Method end: create execution time: 140

方法委托不同于访问方法的字节码。
为了更好地理解这一差异，让我们看看生成的字节码的Java源代：

public class DataProducer {
    public static Logger logger = Logger.getLogger(DataProducer.class.getName());

    public DataProducer() {
    }

    public void create() {
        PerfVoidReturnInterceptor.aroundVoid(new DataProducer$auxiliary$oGTr3aHb(this), cachedValue$4Pj3oKix$k5ssu03);
    }

    public String createData() {
        return (String)PerfObjectReturnInterceptor.aroundReturn(new DataProducer$auxiliary$wfWjMGB6(this), cachedValue$DokzLtVw$daoi2o0);
    }
}

class DataProducer$auxiliary$oGTr3aHb implements Runnable, Callable {
    private DataProducer argument0;

    public Object call() throws Exception {
        this.argument0.create$original$nNDKo4Mw$accessor$4Pj3oKix();
        return null;
    }

    public void run() {
        this.argument0.create$original$nNDKo4Mw$accessor$4Pj3oKix();
    }

    DataProducer$auxiliary$oGTr3aHb(DataProducer var1) {
        this.argument0 = var1;
    }
}

在生成的字节码中，ByteBuddy创建一个名为create$original的新私有方法，并将原始create方法的方法内容复制到该方法。

然后，ByteBuddy修改创建方法。
ByteBuddy声明了一个名为auxiliary的内部类。

这个内部类是代理类。
代理类包含对函数代码的引用：DataProducer.java代理类使用参数来存储该引用，该引用通过代理类的构造函数传递。
代理类实现了两个Java接口：Java.lang.Runnable和Java.util.concurrent.Callable。

他们的派生方法调用并运行通过argument0实例变量调用create$original方法。
然后，ByteBuddy在Advice方法的末尾使用PerfVoidReturnInterceptor.java调用aroundVoid方法，该方法调用targetCode.run方法。
其中run方法是java.lang.Runnable的实现。
可在auxiliary.oGTr3aHb中运行。

尽管PerfVoidReturnInterceptor.java只为SuperCall参数指定了Runnable，但是ByteBuddy在其生成的字节码中隐式地实现了Runnaable和Callable接口。然而，如果函数方法返回void，则@SuperCall注解参数应在Advice代码中使用java.lang.Runnable。

关于createData方法的Advice

类似地，要拦截DataProducer.java的createData方法，这是InterceptorPlugin的代码段。

 .method(ElementMatchers.named("createData"))
                .intercept(MethodDelegation
                        .to(PerfObjectReturnInterceptor.class));

createData方法是返回java.lang.String对象的方法。PerfObjectReturnInterceptor.java是createData方法的Advice代码：

public class PerfObjectReturnInterceptor{
    public static Logger logger = Logger.getLogger(PerfObjectReturnInterceptor.class.getName());

    @RuntimeType 
    public static Object aroundReturn(
                    @SuperCall Callable