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可以幫助我們更好地實現一些功能，比如：日誌系統、代碼位置追蹤、性能監控等。