第一个Java Agent程序，从简单开始入门

上一篇我们了解了Java Agent的基本原理，使用场景及发展趋势等。在本文中，我们将手把手地创建一个简单的Java Agent。

编写Agent类

首先，我们需要编写一个代理类（Agent类）。Agent类需要实现一个名为premain的静态方法。这个方法在目标程序的main方法执行之前被调用。我们还需要在这个方法中注册一个ClassFileTransformer实例。

import java.lang.instrument.ClassFileTransformer;import java.lang.instrument.Instrumentation;public class SimpleAgent {    public static void premain(String agentArgs, Instrumentation inst) {        System.out.println("Simple Agent started.");                // 注册一个ClassFileTransformer实例        ClassFileTransformer transformer = new SimpleClassFileTransformer();        inst.addTransformer(transformer);    }}

编写ClassFileTransformer

接下来，我们需要编写一个ClassFileTransformer实现，用于修改目标程序的字节码。在这个例子中，我们将使用ASM库来操纵字节码。

// 导入java.lang.instrument.ClassFileTransformer接口import java.lang.instrument.ClassFileTransformer;// 导入java.security.ProtectionDomain类import java.security.ProtectionDomain;// 定义一个名为SimpleClassFileTransformer的类，实现ClassFileTransformer接口public class SimpleClassFileTransformer implements ClassFileTransformer {    // 实现transform方法，该方法用于对类文件进行转换    @Override    public byte<> transform(ClassLoader loader, String className, Class<?> classBeingRedefined, ProtectionDomain protectionDomain, byte<> classfileBuffer) {        // 检查当前类名是否为“com/example/MyClass”，如果不是，则不对该类进行转换，直接返回原始字节码        if (!"com/example/MyClass".equals(className)) {            return classfileBuffer;        }        // 此处省略类转换相关代码        System.out.println("Transforming class: " + className);                        return classfileBuffer;    }}

编写manifest文件

为了打包我们的Java Agent，我们需要创建一个manifest文件，指定Agent-Class和Premain-Class属性。

Manifest-Version: 1.0Agent-Class: SimpleAgentPremain-Class: SimpleAgent

构建与部署Java Agent

将Agent类、ClassFileTransformer和manifest文件打包成一个jar文件。我使用的是Gradle构建项目，因此build.gradle文件如下：

plugins {    id 'java'}group 'com.example'version '1.0-SNAPSHOT'sourceCompatibility = 1.8targetCompatibility = 1.8repositories {    mavenCentral()}dependencies {    // 添加其他依赖，例如ASM库    implementation 'org.ow2.asm:asm:9.2'}// 配置JAR任务，包括Java Agent的MANIFEST.MF文件jar {    manifest {        attributes(                'Manifest-Version': '1.0',                'Premain-Class': 'com.example.MyJavaAgent'        )    }}

使用如下命令将其与目标应用程序一起运行

首先创建一个目标应用程序（推荐使用Spring boot项目），然后编写一个简单的测试类，如下：

import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RestController;@RestController@RequestMapping(value = "/javaagent")public class TestJavaAgentController {    @GetMapping(value = "/invoke_count")    public String getInvokeCount() {        MyClass clazz = new MyClass();        clazz.print();        return "success";    }}

创建MyClass类，在agent的jar中，我们只对com.example.MyClass类进行改写，因此类路径一定不能错。MyClass 类如下：

package com.example;public class MyClass {    public void print() {        System.out.println("MyClass print is invoked.");    }}

接下来启动Spring Boot项目，命令如下：

java -javaagent:/path/to/your-java-agent.jar -jar /path/to/your-target-program.jar

使用IntelliJ Idea启动，只需要添加VM options 参数：

启动成功后将输出以下日志，表明使用agent成功：

测试。

调用如下地址：

http://localhost:9999/javaagent/invoke_count

输出结果如下：

那么验证成功。恭喜完成第一个Java agent程序！！