目录
1、什么是Java Agent2、实现Java Agent2.1 类转换2.2 使用Java代理进行实际操作假设您有一个在生产环境中运行的应用程序。每隔一段时间,它就会进入中断状态,错误很难重现,您需要从应用程序中获得更多信息。
那么你想知道解决方案吗?
您可以做的是动态地将一些代码集附加到应用程序中,并仔细地重写它,以便代码转储您可以记录的其他信息,或者您可以将应用程序阶段转储到文本文件中。Java
为我们提供了使用Java Agent
实现这一点的工具。
你有没有想过我们的Java代码是如何在IDE
中进行热交换的?这是因为特工。关于Java Agent
的另一个有趣的事实是,应用程序探查器在后端使用相同的技术来收集内存使用情况、内存泄漏和方法执行时间的信息。
1、什么是Java Agent
Java Agent是一种特殊类型的类,通过使用Java Instrumentation API,它可以拦截JVM上运行的应用程序,修改它们的字节码。Java Agent非常强大,也非常危险。
在开始之前,我将解释Java Agent如何使用简单的HelloWorld示例拦截类。
public class Hello { public static void main(String[] args){ System.out.println("hello world"); } }
如下图所示:
类加载器负责将类从二进制加载到内存中。运行编译后的HelloWorld应用程序(HelloWorld.class
)时,可以将Agent视为在运行时拦截类加载器行为的一种方式。您可能会想,java字节代码是如何被重新构造的,以便Agent可以在正确的位置添加相关代码的。有趣的是,对于Java程序来说,字节码的结构非常接近原始Java程序源代码。因此,虽然我们不为Java程序本身添加工具,但我们使用了它的一个非常接近的表示形式。需要注意的是,有一些非Java语言可以编译成Java字节码(如Scala、Clojure和Kotlin),这意味着程序字节码的结构和形状可能会非常不同。
2、实现Java Agent
JavaAgent基于来自Java平台的facility,它的入口点是Java.lang instrument
包,它提供了允许Agent为JVM上运行的程序提供工具的服务。该包非常简单且自包含,因为它包含两个异常类、一个数据类、类定义和两个接口。在这两种方法中,如果我们想编写Java Agent,我们只需要实现classFileTransformer
接口。
定义代理有两种方法。
第一个是静态代理,这意味着我们构建Agent代理,将其打包为jar文件,当我们启动Java应用程序时,我们传入一个名为java agent的特殊JVM参数。然后我们给它代理jar在磁盘上的位置,然后JVM发挥它的魔力。
$ java -javaagent:<path of agent jar file> -jar <path of the packaged jar file you want to intecept>
我们需要添加一个特殊的清单条目,称为pre-main类,当然,这是一个完全限定的名称类定义。
Premain-Class : org.example.JavaAgent
这个类看起来像这样
public class JavaAgent { /** * As soon as the JVM initializes, This method will be called. * * @param agentArgs The list of agent arguments * @param instrumentation The instrumentation object * @throws InstantiationException */ public static void premain(String agentArgs, Instrumentation instrumentation) throws InstantiationException { InterceptingClassTransformer interceptingClassTransformer = new InterceptingClassTransformer(); interceptingClassTransformer.init(); instrumentation.addTransformer(interceptingClassTransformer); } }
premain
方法接受两个参数:
agentArgs
—字符串参数,用户选择作为参数传递给Java Agent调用的任何参数。
instrumentation
来自java.lang instrument
包,我们可以添加一个新的ClassFileTransformer
对象,它包含Agent的实际逻辑。
第二个选项称为动态代理。
我们可以做的不是检测启动应用程序的方式,而是编写一小段代码,接收并连接到现有JVM,并告诉它加载某个代理。
VirtualMachine vm = VirtualMachine.attach(vmPid); vm.load(agentFilePath); vm.detach();
此参数agentFilePath与静态代理方法中的参数完全相同。它必须是agent jar的文件名,因此没有输入流也没有字节。这种方法有两个警告。第一个是,这是生活在com.sun空间下的私有API,它通常适用于热点实现。第二个问题是,使用Java9进行排序时,您不能再使用此代码连接到它正在运行的JVM。
2.1 类转换
这是我们需要为agent实现的接口,以便转换类。
public interface ClassFileTransformer { byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer) throws IllegalClassFormatException; }
这有点多,但我将解释方法签名中的必要参数。第一个重要的是类名。此参数的主要目的是帮助查找并区分要拦截的正确类和其他类。显然,您可能不想截取应用程序中的每个类,最简单的方法是使用条件语句进行检查。
然后是类加载器,它主要用于基本应用程序没有平坦类空间的环境中,您可能不需要查看它,但一旦遇到更复杂或模块化的平台,您就需要查看类加载器。classfileBuffer
是检测前类的当前定义。要截取它,您需要使用库读取这个字节数组并截取代码,然后必须再次转换回字节码才能返回。
有几个字节码生成库。您需要进行研究,并根据它是高级API还是低级API、社区大小和许可证自行决定。我放在下面的演示是Javassist,因为我认为它在高级和低级API之间有一个很好的平衡,并且是一个三重许可证,所以几乎任何人都可以使用它。这
就是ClassFileTransformer
实现的主体。
@Override public byte[] transform(ClassLoader loader, ..) throws .. { byte[] byteCode = classfileBuffer; // If you wanted to intercept all the classs then you can remove this conditional check. if (className.equals("Example")) { try { ClassPool classPool = scopedClassPoolFactory.create(loader, rootPool, ScopedClassPoolRepositoryImpl.getInstance()); CtClass ctClass = classPool.makeClass(new ByteArrayInputStream(classfileBuffer)); CtMethod[] methods = ctClass.getDeclaredMethods(); for (CtMethod method : methods) { if (method.equals("main")) { method.insertAfter("System.out.println(\"Logging using Agent\");"); } } byteCode = ctClass.toBytecode(); ctClass.detach(); } catch (Throwable ex) { log.log(Level.SEVERE, "Error in transforming the class: " + className, ex); } } return byteCode; } ctClass.detach(); } catch (Throwable ex) { log.log(Level.SEVERE, "Error in transforming the class: " + className, ex); } } return byteCode; }
在这里,从类池中,我们可以直接绕过classfileBuffer
获取类,因为我想使用main
方法。我们循环遍历类定义中的所有方法,得到我们想要的类。我们根本不需要使用字节码。我们可以简单地向它传递一些合法的Java代码,然后Javassist将编译它,生成新的字节码,并给出定义。
有三种方法可以向方法中插入一些Java代码。insertAfter(..)
在正文末尾插入字节码。它在正文的末尾插入字节码。insertAt(..)
在正文的指定行插入字节码,insertBefore(..)
在正文的开头插入字节码。
2.2 使用Java代理进行实际操作
从指定的链接下载示例应用程序和Java Agent。
使用进入路径并执行命令mvn clean install
来构建这两个repo
现在,您将获得目标中的jar文件。复制示例应用程序中.jar文件的路径,并复制Java Agent中-dependencies.jar
文件的路径。
首先,使用命令$java-jar<path of the packaged jar>
仅与示例应用程序一起运行应用程序,并观察输出。Hi I am main。将在控制台中打印。
然后,使用命令$ java -javaagent:<path of agent jar file> -jar <path of the packaged jar
并观察输出。将在控制台中另外打印使用代理的日志记录。这确保
file you want to intercept>java agent
被拦截并添加到main
方法的主体中。
总之,如果要实现Java Agent,请执行以下操作:
1. 您需要创建两个Java类。一个是premain
方法(JavaAgent),另一个是扩展ClassFileTransformer的类(CustomTransformer
)
2. 在premain
方法的主体内,需要添加扩展ClassFileTransformer
的类的对象
3. 然后,您需要在CustomTransformer中的重写方法transform中添加逻辑。
4. 在转换方法内转换字节码时,可能需要根据用途使用字节码生成库。
5. 您需要在清单中指定premain
类并构建jar。
6. 使用javaagent
标记将代理加载到要拦截的应用程序中。