Java Agent热部署

Java Agent是一个依附在目标JVM进程上的一个jar包。一旦JVM跑起来后，通过Java Agent则像一个探针一样插到JVM内部，探到想要的信息，并且可以注入东西进去。即监听与热修改。在修改某个类后，通过Java Agent的instrument机制，将之前的字节码替换为新代码所对应的字节码。

Java Agent的实现和使用

Java Agent最终以jar包形式存在。方法有两种agentmain和premain，主要包含两个部分，一部分是实现代码，一部分是配置文件。配置文件放在META-INF目录下，包括以下配置项：

Manifest-Version: 1.0   //版本
Created-By: sorry   //Creator
Agent-Class: agent.MyCustomAgent    //agentmain方法所在类
Can-Redefine-Classes: true  //是否可实现类的重定义
Can-Retransform-Classes: true   //是否可实现字节码替换
Premain-Class: agent.MyCustomAgent  //premain方法所在类

在方法中插入代码主要用到字节码修改技术，字节码修改技术主要有javassist、ASM,以及ASM的高级封装可扩展性cglib，这里使用javassist。可以引入maven包。

<dependency>
    <groupId>javassist</groupId>
    <artifactId>javassist</artifactId>
    <version>3.11.0.GA</version>
</dependency>

Java Agent有两种启动方式，一种直接以JVM启动参数-javaagent:xxx.jar的形式随JVM一起启动，这种情况下，会调用premain方法，并且是主进程的main方法之外执行。另一种则是以loadAgent方法动态attach到目标JVM上，这种情况下，会执行agentmain方法。
代码实现如下：

package agent;
import java.lang.instrument.Instrumentation;
public class MyCustomAgent {
    /**
     * jvm 参数形式启动，运行此方法
     * @param agentArgs
     * @param inst
     */
    public static void premain(String agentArgs, Instrumentation inst){
        System.out.println("premain");
        customLogic(inst);
    }
    /**
     * 动态 attach 方式启动，运行此方法
     * @param agentArgs
     * @param inst
     */
    public static void agentmain(String agentArgs, Instrumentation inst){
        System.out.println("agentmain");
        customLogic(inst);
    }
    /**
     * 打印所有已加载的类名称
     * 修改字节码
     * @param inst
     */
    private static void customLogic(Instrumentation inst){
        inst.addTransformer(new MyTransformer(), true);
        Class[] classes = inst.getAllLoadedClasses();
        for(Class cls :classes){
            System.out.println(cls.getName());
        }
    }
}

参数有agentArgs和inst，其中agentArgs是启动Java Agent时进来的参数，比如-javaagent:xxx.jar agentArgs。Instrumentation Java开放出来的专门用于字节码修改和程序监控的实现。我们要实现的修改字节码就是基于它实现。其中inst.getAllLoadedClassed()一个方法就实现了获取所有已加载类的功能。
inst.addTransformer方法则是实现字节码修改的关键，后面的参数就是实现字节码修改的实现类，代码如下：

package agent;
import javassist.ClassPool;
import javassist.CtClass;
import javassist.CtMethod;
import java.io.ByteArrayInputStream;
import java.lang.instrument.ClassFileTransformer;
import java.lang.instrument.IllegalClassFormatException;
import java.security.ProtectionDomain;
public class MyTransformer implements ClassFileTransformer {
    @Override
    public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer) throws IllegalClassFormatException {
        System.out.println("正在加载类："+ className);
        if (!"attach/Person".equals(className)){
            return classfileBuffer;
        }
        CtClass cl = null;
        try {
            ClassPool classPool = ClassPool.getDefault();
            cl = classPool.makeClass(new ByteArrayInputStream(classfileBuffer));
            CtMethod ctMethod = cl.getDeclaredMethod("test");
            System.out.println("获取方法名称："+ ctMethod.getName());
            ctMethod.insertBefore("System.out.println(\" 动态插入的打印语句 \");");
            ctMethod.insertAfter("System.out.println($_);");
            byte[] transformed = cl.toBytecode();
            return transformed;
        }catch (Exception e){
            e.printStackTrace();
        }
        return classfileBuffer;
    }
}

以上的逻辑是当碰到加载类是attach.Person时，在其中的test方法开始时插入一条打印语句，打印内容是“动态插入的打印语句”，在test方法结尾处，打印返回值，其中$_就是返回值，这是javassist里特定的标识符。在pom.xml中加入以下配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-assembly-plugin</artifactId>
            <configuration>
                <archive>
                    <manifestFile>src/main/resources/META-INF/MANIFEST.MF</manifestFile>
                </archive>
                <descriptorRefs>
                    <descriptorRef>jar-with-dependencies</descriptorRef>
                </descriptorRefs>
            </configuration>
        </plugin>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <configuration>
                <source>6</source>
                <target>6</target>
            </configuration>
        </plugin>
    </plugins>
</build>

用maven的maven-assembly-pubgin插件，注意manifestFile指定MANIFEST.MF所在路径，然后指定jar-with-dependencies，将依赖包打进去。
运行打包命令：

mvn assembly:assembly

写一个简单的测试项目，用来作为目标JVM，稍后以两种方式将Java Agent挂到这个测试项目上。

package attach;
import java.util.Scanner;
public class RunJvm {
    public static void main(String[] args){
        System.out.println("按数字键1调用测试方法");
        while(true){
            Scanner reader = new Scanner(System.in);
            int number = reader.nextInt();
            if(number==1){
                Person person = new Person();
                person.test();
            }
        }
    }
}

一个简单的main方法，用while方式保证线程不退出，且当输入数字1后调用person.test()方法。

package attach;
public class Person {
    public String test(){
        System.out.println("执行测试方法");
        return "I'm ok";
    }
}

以命令行的方式运行(premain)

java -javaagent:reAgent.jar -jar reAttach.jar

以动态attach的方式运行
测试之前要先运行reAttach.jar,在利用jps -l查找此进程id。
动态attach需要代码实现，实现代码如下：

import com.sun.tools.attach.VirtualMachine;
public class AttachAgent {
    public static void main(String[] args) throws Exception{
        VirtualMachine vm = VirtualMachine.attach("8196");
        vm.loadAgent("F:\\reAgent.jar");
        //vm.loadAgent("E:\\reAgent\\target\\sorry-1.0-SNAPSHOT-jar-with-dependencies.jar");
    }
}

运行上面的main方法，并在测试程序中输入”1”也会得到结果。
结果：
Java Agent - 图1