JavaAgent简介

我会带着你远行 2024-03-17 11:25 69阅读 0赞

JavaAgent是一种Java技术，它允许在Java应用程序运行时修改字节码。它可以被用来监视和调试应用程序，也可以用于性能优化、安全检查等方面。JavaAgent通常作为一个独立的JAR文件加载到Java虚拟机中，并通过Java命令行参数指定。一旦JavaAgent被加载，它就可以在应用程序运行时动态地修改字节码，比如添加日志、性能监控、安全检查等功能。

Java Agent是一种特殊的Java程序，它可以在Java应用程序启动时，通过JVM的Instrumentation API来修改和监控Java字节码。其中，Java Agent需要实现一个特定的方法premain，该方法会在Java应用程序启动时被调用。premain方法在main方法之前调用。

*transform方法是ClassFileTransformer接口的一个方法，它用于在Java应用程序启动或运行时，对指定的Java类进行转换。具体来说，transform方法会在以下情况下被调用：*

*1. Java应用程序启动时：当Java应用程序启动时，Java虚拟机会扫描所有的Java Agent，并调用每个Java Agent的premain方法。在premain方法中，Java Agent可以使用Instrumentation API注册一个ClassFileTransformer对象，用于对Java类进行转换。当Java虚拟机加载Java类时，它会调用注册的ClassFileTransformer对象的transform方法，对Java类进行转换。*

*2. Java应用程序运行时：在Java应用程序运行时，Java Agent也可以通过agentmain方法动态地加载一个Java Agent，并注册一个ClassFileTransformer对象。当Java虚拟机加载Java类时，它会调用注册的ClassFileTransformer对象的transform方法，对Java类进行转换。*

*在transform方法中，你可以使用Javassist等字节码操作库，对Java类进行各种形式的转换，例如增加、删除、修改类的字段和方法，添加、删除、修改类的注解等。由于transform方法是在Java类加载期间被调用的，因此它可以对Java类进行较为底层的操作，例如替换类的字节码，实现AOP等功能。*

*需要注意的是，transform方法必须返回一个字节数组，表示转换后的Java类文件内容。如果你不想对某个Java类进行转换，可以直接返回null或原始的classfileBuffer。同时，为了避免在transform方法中出现异常导致Java应用程序崩溃，你应该尽可能地编写健壮和可靠的代码，并使用try-catch语句来捕获异常。*

举一个使用JavaAgent和Javassist结合的例子，来实现在方法入口和出口处添加日志语句。

首先，我们需要编写一个JavaAgent程序，它将会被加载到JVM中。这个程序需要实现Java Agent API，并提供一个premain方法。在这个方法中，我们可以通过Instrumentation API来获取应用程序中所有类的字节码，并对其进行修改。

具体来说，我们可以在关键方法的入口处和出口处添加日志语句。这里我使用Javassist库来操作字节码，代码如下

public class LoggingAgent {
    
        public static void premain(String args, Instrumentation instrumentation) throws Exception {
    
            System.out.println("Hello JavaAgent Premain: " + args);
            LoggingTransformer loggingTransformer = new LoggingTransformer();
            instrumentation.addTransformer(loggingTransformer);
        }
    
    }
    
    
    public class LoggingTransformer implements ClassFileTransformer {
        @Override
        public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer) throws IllegalClassFormatException {
            try {
                String targetClassName = "com.agent.MyAgent";
                if (className.equals(targetClassName.replace(".","/"))) {
                    InputStream inputStream = loader.getResourceAsStream(targetClassName.replace(".","/") + ".class");
                    ClassPool classPool = ClassPool.getDefault();
                    CtClass ctClass = classPool.makeClass(inputStream);
                    for (CtMethod ctMethod : ctClass.getDeclaredMethods()) {
                        // 用来判断一个方法是否为抽象方法,如果结果为0，则说明该方法不是抽象方法
                        if ((ctMethod.getModifiers() & Modifier.ABSTRACT) == 0) {
                            String methodName = ctMethod.getName();
                            ctMethod.insertBefore("System.out.println(\"Entering " + methodName + "\");");
                            ctMethod.insertAfter("System.out.println(\"Exiting " + methodName + "\");", true);
                        }
                    }
                    ctClass.detach();
                    return ctClass.toBytecode();
                }
                return classfileBuffer;
            } catch (Exception e) {
                e.printStackTrace();
                return null;
            }
        }
    }

应用程序代码：

public class MyAgent {
    
        public void myMethod() {
            System.out.println("MyMethod  start ..........");
        }
    
        public static void main(String[] args) {
            System.out.println("main start!");
            MyAgent myAgent = new MyAgent();
            myAgent.myMethod();
        }
    }

这个应用程序中，我们只是简单地调用了MyAgent中的myMethod方法。当JavaAgent被加载时，它将会自动修改MyAgent中的字节码，在myMethod方法的入口处和出口处添加日志语句。

运行程序时需要添加JVM参数：

-javaagent:D:a\target\java_se-1.0-SNAPSHOT.jar=123