通过使用Byte Buddy便捷创建Java Agent

本文将为大家介绍如何通过使用Byte Buddy创建Java Agent，达到对Java应用程序的增强和监控的目的。

第一步：新建项目并导入依赖

首先，我们需要在Eclipse或者IntelliJ IDEA中创建一个Maven项目，并导入Byte Buddy的依赖：

<dependency>
  <groupId>net.bytebuddy</groupId>
  <artifactId>byte-buddy</artifactId>
  <version>1.11.14</version>
</dependency>

<dependency>
  <groupId>net.bytebuddy</groupId>
  <artifactId>byte-buddy-agent</artifactId>
  <version>1.11.14</version>
</dependency>

第二步：编写Java Agent

在项目中编写一个Java类，命名为MyAgent，并让其实现java.lang.instrument.ClassFileTransformer接口。在transform方法中，可以使用Byte Buddy对类进行操作，并返回修改后的字节码。

import java.lang.instrument.ClassFileTransformer;
import java.lang.instrument.Instrumentation;
import java.security.ProtectionDomain;
import net.bytebuddy.ByteBuddy;
import net.bytebuddy.agent.builder.AgentBuilder;
import net.bytebuddy.asm.Advice;
import net.bytebuddy.description.type.TypeDescription;
import net.bytebuddy.dynamic.DynamicType;
import net.bytebuddy.matcher.ElementMatchers;

public class MyAgent {
    public static void premain(String args, Instrumentation instrumentation) {
        new AgentBuilder.Default()
                .type(ElementMatchers.any())
                .transform(new ClassFileTransformer() {
                    public byte[] transform(ClassLoader loader,
                            String className,
                            Class<?> classBeingRedefined,
                            ProtectionDomain protectionDomain,
                            byte[] classfileBuffer) {

                        DynamicType.Builder<?> builder = new ByteBuddy().redefine(Class.forName(className));

                        builder.visit(
                            Advice.to(MyMethodAdvice.class)
                                .on(ElementMatchers.isAnnotatedWith(MyAnnotation.class)));

                        DynamicType.Unloaded<?> unloaded = builder.make();
                        byte[] byteCode = unloaded.getBytes();

                        return byteCode;
                    }
                }).installOn(instrumentation);
    }
}

在上面的代码中，我们通过Byte Buddy对类进行了重定义，并添加了一个方法级别的拦截器。

在此之前，我们需要定义一个注解类MyAnnotation和一个拦截器类MyMethodAdvice：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MyAnnotation {
}

public class MyMethodAdvice {
    @Advice.OnMethodEnter
    public static void enter() {
        System.out.println("调用方法前");
    }

    @Advice.OnMethodExit
    public static void exit() {
        System.out.println("调用方法后");
    }
}

第三步：打包并运行Java Agent

在项目根目录下，运行如下命令：

mvn clean package

打包完成后，在启动Java应用程序时，添加如下参数来加载Java Agent：

-javaagent:/path/to/your/agent jar

其中，/path/to/your/agent jar是你的Java Agent JAR包所在的绝对路径。

示例一：监控Spring Boot应用程序

在Spring Boot应用程序中添加如下注解：

@MyAnnotation
@GetMapping("/")
public String hello() {
    return "Hello World!";
}

然后启动Spring Boot应用程序，访问http://localhost:8080/，你将会看到如下输出：

调用方法前
调用方法后

这说明你的拦截器已经生效。

示例二：动态为类添加方法

在一个普通的Java类中添加如下方法：

@MyAnnotation
public void myMethod() {
    System.out.println("调用了自定义方法");
}

然后编写如下测试代码：

public class MyClass {
    public static void main(String[] args) {
        MyClass instance = new MyClass();
        instance.myMethod();
    }
}

随后运行测试代码，你将会看到如下输出：

调用方法前
调用了自定义方法
调用方法后

这说明你成功地为这个类添加了一个方法，并在生产环境中使用Java Agent进行了增强。

参考文献：

• Byte Buddy官方文档：http://bytebuddy.net/#/
• 使用JavaAgent动态修改类文件：https://www.cnblogs.com/blg555/p/9785287.html