JavaAgent入门指南

一、什么是JavaAgent

JavaAgent是Java虚拟机提供的一种机制，通过JavaAgent，可以在程序运行过程中动态地修改类的字节码，从而实现一些我们需要的功能。比如：可以在程序运行时利用JavaAgent动态的加载代理类，实现AOP面向切面编程。

JavaAgent有两种使用方式：以前启动代理程序，或者采用在程序运行时动态加入代理的方式。后者可以成为动态代理。

二、JavaAgent的使用场景

JavaAgent的使用场景举几个栗子，其中可能还有我们平常经常会使用到的：

1、日志系统

public class LogAgent {
    public static void premain(String args){
        System.out.println("LogAgent instrumentation");
        try{
            Class klass = Class.forName("example.MyClass");
            Method m = klass.getMethod("myMethod", String.class);
            m.addInterceptor(LogInterceptor.class);
        } catch(ClassNotFoundException e){}
          catch(NosSuchMethodException e){}
    }
}

这个日志系统就可以在程序启动时使用JavaAgent进行拦截并打印日志信息。

2、代码位置追踪

public class TraceAgent {
    public static void premain(String args){
        System.out.println("TraceAgent instrumentation");
        try{
            Class klass = Class.forName("example.MyClass");
            Method m = klass.getMethod("myMethod", String.class);
            m.addInterceptor(TraceInterceptor.class);
        } catch(ClassNotFoundException e){}
          catch(NosSuchMethodException e){}
    }
}

通过代码位置追踪可以获取到相关信息，方便进行分析处理。

3、性能监控

public class PerformanceAgent {
    public static void premain(String args){
        System.out.println("PerformanceAgent instrumentation");
        try{
            Class klass = Class.forName("example.MyClass");
            Method m = klass.getMethod("myMethod", String.class);
            m.addInterceptor(PerformanceInterceptor.class);
        } catch(ClassNotFoundException e){}
          catch(NosSuchMethodException e){}
    }
}

拦截某个方法的调用，获取执行时间，从而监控该方法的性能情况。

三、JavaAgent的实现方式

JavaAgent的实现方式主要有两种：

1、基于ASM工具实现字节码操作

class PerfMonXformer extends ClassVisitor {
    public PerfMonXformer(ClassVisitor cv) {
        super(Opcodes.ASM4, cv);
    }

    public MethodVisitor visitMethod(int access, String name, String desc, 
                            String signature, String[] exceptions) {
        MethodVisitor mv = cv.visitMethod(access, name, desc, signature, exceptions);
        //在原有的方法调用前后新增加方法，在JavaAgent中实现
        mv.visitCode();
        mv.visitMethodInsn(INVOKESTATIC, "PerfMon", "start", "()V");
        mv.visitCode();
        mv.visitMethodInsn(INVOKESTATIC, "PerfMon", "end", "()V");
        mv.visitCode();
        return mv;
    }
}

通过ASM工具实现字节码的操作，通过添加方法进行相关操作。

2、使用Javassist实现字节码操作

public static void changeMethod() throws Exception {
    CtClass ctClass = ClassPool.getDefault().getCtClass("example.MyClass");
    CtMethod ctMethod = ctClass.getDeclaredMethod("myMethod");
    ctMethod.insertAfter("{ System.out.println(\"after myMethod\"); }");
    ctMethod.insertBefore("{ System.out.println(\"before myMethod\"); }");
    ctClass.toClass();
}

使用Javassist工具实现字节码操作，同样在原有的方法调用前后添加相关操作。

四、JavaAgent的编写方式

JavaAgent的编写方式主要有两种：使用main方法和premain方法：

1、使用main方法

public static void main(String[] args){
    Instrumentation inst = new Instrumentation() {
        //覆写相关方法
    };
    premain(agentArgs, inst);
}

使用main方法时要手动添加包的加载。这种方法主要适用于主类已经启动。

2、使用premain方法

public static void premain(String agentArgs, Instrumentation inst){
    inst.addTransformer(new Transformer());
}

使用premain方法可以在JVM启动时自动添加agent，方便程序的运行。

五、JavaAgent的包装与部署

JavaAgent的包装和部署主要是以下三步：

1、将JavaAgent打包成Jar

在pom.xml中添加打包的插件：

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-jar-plugin</artifactId>
            <version>3.1.1</version>
            <configuration>
                <archive>
                    <manifest>
                        <mainClass>Main</mainClass>
                        <premain-Class>PreMain</premain-Class>
                        <agent-class>Agent</agent-class>
                    </manifest>
                </archive>
            </configuration>
        </plugin>
    </plugins>
</build>

然后使用该命令打包就可以了：mvn clean package。

2、在META-INF/MANIFEST.MF中添加Main-Class、Premain-Class以及Agent-Class

Manifest-Version: 1.0
Created-By: Maven Archiver 3.4.0
Built-By: UserName
Build-Jdk: 1.8.0_60
Main-Class: example.Main
Premain-Class: example.PreMain
Agent-Class: example.Agent

3、将JavaAgent添加到启动命令中

在启动程序时加入-javaagent参数，可以动态向程序注入JavaAgent，如下：

java -javaagent:path/to/javaagent.jar -jar app.jar

六、JavaAgent实现案例

下面是一个简单的JavaAgent实现案例：

public class MyAgent {
    public static void premain(String agentArgs, Instrumentation inst) throws Exception {
        inst.addTransformer(new MyTransformer());
    }

    static class MyTransformer implements ClassFileTransformer {
        public byte[] transform(ClassLoader loader, String className, Class classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer) throws IllegalClassFormatException {
            if(className.equals("example/MyClass")){
                ClassReader cr = new ClassReader(classfileBuffer);
                ClassWriter cw = new ClassWriter(ClassWriter.COMPUTE_FRAMES | ClassWriter.COMPUTE_MAXS);
                ClassVisitor cv = new MyClassAdapter(cw);
                cr.accept(cv, ClassReader.SKIP_DEBUG);
                return cw.toByteArray();
            }
            return classfileBuffer;
        }
    }

    static class MyClassAdapter extends ClassVisitor {
        public MyClassAdapter(ClassVisitor cv) {
            super(Opcodes.ASM4, cv);
        }

        public void visitMethodInsn(int opcode, String owner, String name, String desc) {
            if(owner.equals("example/MyClass") && name.equals("myMethod")){
                super.visitMethodInsn(opcode, owner, name, desc, true);
            } else{
                super.visitMethodInsn(opcode, owner, name, desc, false);
            }
        }
    }
}

总结

通过本文对于JavaAgent的介绍，我们了解到了JavaAgent的实现原理、使用场景、实现方式、编写方式以及部署等方面的内容。同时，也通过一个简单的JavaAgent实现案例加深了对于JavaAgent的理解。在实际应用开发中，JavaAgent可以帮助我们更好地实现一些功能，比如：日志系统、代码位置追踪、性能监控等。