Java动态替换class：agentmain + attach + transformer

前段时间，用了阿里开发的arthas，对于它是如何动态介入java程序的很感兴趣，最近有时间，就自己研究了一下，写了个简单的项目试了试。

项目结构

如图所示，总共分为三个项目，分别是：

• 初时的启动项目，就是我们想要动态修改的目标项目MyClass；
• 将被attach到目标的agent项目；
• 负责将agent项目attach到目标项目的attach项目；

MyClass项目

只有一个类文件：Main.java

package org.example;

public class Main {
    public static void greet() {
        System.out.println("Hello!");
    }

    public static void main(String[] args) throws InterruptedException {
        while (true) {
            greet();
            Thread.sleep(1000 * 3);
        }
    }
}

因为要打包，需要在pom文件中添加plugin：

<build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>2.3.2</version>
                <configuration>
                    <archive>
                        <manifestFile>src/main/resources/MANIFEST.MF</manifestFile>
                    </archive>
                </configuration>
            </plugin>
        </plugins>
    </build>

MANIFEST.MF文件：

Main-Class: org.example.Main

然后使用Maven打包运行即可。
该项目每隔三秒输出一个"Hello!"。

Agent项目

AgentMain文件：

package org.agent;

import java.lang.instrument.Instrumentation;
import java.lang.instrument.UnmodifiableClassException;

public class AgentMain {
    public static void agentmain(String agentArgs, Instrumentation inst) throws UnmodifiableClassException,
            ClassNotFoundException {

        Transformer transformer = new Transformer(agentArgs);
        try {
            inst.addTransformer(transformer, true);
            inst.retransformClasses(Class.forName("org.example.Main"));
        } finally {
            new Thread(() -> {
                try {
                    Thread.sleep(10 * 1000);
                    inst.removeTransformer(transformer);
                    inst.retransformClasses(Class.forName("org.example.Main"));
                } catch (Exception e) {}
            }).start();
        }
    }
}

Transformer文件：

package org.agent;

import java.io.FileInputStream;
import java.lang.instrument.ClassFileTransformer;
import java.lang.instrument.IllegalClassFormatException;
import java.security.ProtectionDomain;

public class Transformer implements ClassFileTransformer {

    private String classPath;

    public Transformer(String classPath) {
        this.classPath = classPath;
    }

    @Override
    public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer) throws IllegalClassFormatException {
        className = className.replace("/", ".");
        if (className.equals("org.example.Main")) {
            System.out.println("retransform myclass:" + classPath);
            FileInputStream inputStream = null;
            try {
                inputStream = new FileInputStream(classPath);
                byte[] bytes = new byte[inputStream.available()];
                inputStream.read(bytes);
                return bytes;
            } catch (Exception e) {
                throw new RuntimeException(e);
            }
        }
        return classfileBuffer;
    }
}

因为要打包，需要在pom文件中添加plugin：

<build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>2.3.2</version>
                <configuration>
                    <archive>
                        <manifestFile>src/main/resources/MANIFEST.MF</manifestFile>
                    </archive>
                </configuration>
            </plugin>
        </plugins>
    </build>

MANIFEST.MF文件：

Agent-Class: org.agent.AgentMain
Can-Retransform-Classes: true

注意这里配置的是Agent-Class，用的是AgentMain，可以动态Attach；之前试过PrevMain，那个不是动态的，启动时需要指定。
该Agent主要是添加一个transformer，然后retransform目标class，过个十秒再删除掉之前的transformer，将替换的类恢复。

transformer根据Attach提供的参数，读取class文件，替换旧的目标class。
打包获得一个agent-1.0-SNAPSHOT.jar文件。

用于替换的Main文件：

package org.example;

public class Main {
    public static void greet() {
        System.out.println("Hi!");
    }

    public static void main(String[] args) throws InterruptedException {
        while (true) {
            greet();
            Thread.sleep(1000 * 3);
        }
    }
}

注意，包名和类名都要和源文件一致，不然会报错。这个文件其实不需要放在Agent项目里面，我只是为了方便，随便放在这里的，自己可以使用javac编译一下，得到Main.class。

Attach项目

Attach项目只有一个Main类，也不需要打包，直接运行就行。

package org.example;

import com.sun.tools.attach.*;

import java.io.IOException;
import java.util.List;

public class Main {

    //agent路径和新的class的路径，自己替换即可
    public static final String AGENT_PATH = "***/agent/target/agent-1.0-SNAPSHOT.jar";
    public static final String NEW_CLASS_PATH = "***/agent/src/main/java/org/example/Main.class";

    public static void main(String[] args) throws IOException, AttachNotSupportedException, AgentLoadException,
            AgentInitializationException, InterruptedException {

        // 获取正在运行的JVM的列表
        List<VirtualMachineDescriptor> list = VirtualMachine.list();
        
        for (VirtualMachineDescriptor descriptor : list) {
            // 根据进程名字获取进程ID, 并使用 loadAgent 注入进程
            if (descriptor.displayName().contains("MyClass")) {
                VirtualMachine virtualMachine = VirtualMachine.attach(descriptor.id());
                virtualMachine.loadAgent(AGENT_PATH, NEW_CLASS_PATH);
                virtualMachine.detach();
            }
        }
    }
}

运行结果

先启动MyClass的jar包，然后运行Attach项目的Main类，即可得到如下的结果：