Javaagent使用指南

最新推荐文章于 2024-10-12 16:27:03 发布
最新推荐文章于 2024-10-12 16:27:03 发布
阅读量930 收藏 1
点赞数
分类专栏： java 文章标签： java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/YouYouKeLe/article/details/118359095
版权

Javaagent，一开始我对它的概念也比较陌生，后来在别人口中听到 字节码插桩，bTrace，Arthas后面才逐渐了解到Java还提供了这么个工具。
​

javaagent 是什么？

javaagent是java命令的一个参数。参数 javaagent 可以用于指定一个 jar 包，并且对该 java 包有2个要求：

  1. 这个 jar 包的 MANIFEST.MF 文件必须指定 Premain-Class 项。
  2. Premain-Class 指定的那个类必须实现 premain() 方法。

premain 方法，从字面上理解，就是运行在 main 函数之前的的类。当Java 虚拟机启动时，在执行 main 函数之前，JVM 会先运行 -javaagent 所指定 jar 包内 Premain-Class 这个类的 premain 方法 。

在命令行输入 java 可以看到相应的参数，其中有 和 java agent相关的：

-agentlib:<libname>[=<选项>] 加载本机代理库 <libname>, 例如 -agentlib:hprof
	另请参阅 -agentlib:jdwp=help 和 -agentlib:hprof=help
-agentpath:<pathname>[=<选项>]
	按完整路径名加载本机代理库
-javaagent:<jarpath>[=<选项>]
	加载 Java 编程语言代理, 请参阅 java.lang.instrument

在上面-javaagent参数中提到了参阅java.lang.instrument，这是在rt.jar 中定义的一个包，该路径下有两个重要的类：
​
在这里插入图片描述

该包提供了一些工具帮助开发人员在 Java 程序运行时，动态修改系统中的 Class 类型。其中，使用该软件包的一个关键组件就是 Javaagent。从名字上看，似乎是个 Java 代理之类的，而实际上，他的功能更像是一个Class 类型的转换器，他可以在运行时接受重新外部请求，对Class类型进行修改。
​

从本质上讲，Java Agent 是一个遵循一组严格约定的常规 Java 类。 上面说到 javaagent命令要求指定的类中必须要有premain()方法，并且对premain方法的签名也有要求，签名必须满足以下两种格式：

public static void premain(String agentArgs, Instrumentation inst)
    
public static void premain(String agentArgs)

JVM 会优先加载 带 Instrumentation 签名的方法，加载成功忽略第二种，如果第一种没有，则加载第二种方法。这个逻辑在 sun.instrument.InstrumentationImpl 类中：

在这里插入图片描述

如何使用javaagent？

JVM启动时加载Instrument

​

使用场景
  • 集成链路追踪解决方案，通过javaagent探针集成，如 pingpoint，skywalking，ARMS

使用 javaagent 需要几个步骤：

  1. 定义一个 MANIFEST.MF 文件，必须包含 Premain-Class 选项，通常也会加入Can-Redefine-Classes 和 Can-Retransform-Classes 选项。
  2. 创建一个Premain-Class 指定的类，类中包含 premain 方法，方法逻辑由用户自己确定。
  3. 将 premain 的类和 MANIFEST.MF 文件打成 jar 包。
  4. 使用参数 -javaagent: jar包路径 启动要代理的方法。

在执行以上步骤后，JVM 会先执行 premain 方法，大部分类加载都会通过该方法，**注意：是大部分，不是所有。当然，遗漏的主要是系统类，因为很多系统类先于 agent 执行，而用户类的加载肯定是会被拦截的。**也就是说，这个方法是在 main 方法启动前拦截大部分类的加载活动，既然可以拦截类的加载，那么就可以去做重写类这样的操作，结合第三方的字节码编译工具，比如ASM，javassist，cglib等等来改写实现类。

通过上面的步骤我们用代码实现来实现。实现 javaagent 你需要搭建两个工程，
一个工程是用来承载 javaagent类，单独的打成jar包；
一个工程是javaagent需要去代理的类。即javaagent会在这个工程中的main方法启动之前去做一些事情。

首先来实现javaagent工程。

目录如下：

.
├── pom.xml
├── src
│   └── main
│       ├── java
│       │   └── com
│       │       └── company

第一步是需要创建一个类，包含premain 方法：

package com.company.agent;

import java.lang.instrument.ClassFileTransformer;
import java.lang.instrument.IllegalClassFormatException;
import java.lang.instrument.Instrumentation;
import java.security.ProtectionDomain;

public class PreMainTraceAgent {

    public static void premain(String agentArgs, Instrumentation inst) {
        System.out.println("agentArgs : " + agentArgs);
        inst.addTransformer(new DefineTransformer(), true);
    }

    static class DefineTransformer implements ClassFileTransformer {

        @Override
        public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer) throws IllegalClassFormatException {
            System.out.println("premain load Class:" + className);
            return classfileBuffer;
        }
    }
}

上面就是我实现的一个类，实现了带Instrumentation参数的premain()方法。调用addTransformer()方法对启动时所有的类进行拦截。

然后在 resources 目录下新建目录：META-INF，在该目录下新建文件：MANIFREST.MF：

Manifest-Version: 1.0
Can-Redefine-Classes: true
Can-Retransform-Classes: true
Premain-Class: com.company.agent.PreMainTraceAgent

注意到第5行有空行。
说一下MANIFREST.MF文件的作用，这里如果你不去手动指定的话，直接 打包，默认会在打包的文件中生成一个MANIFREST.MF文件：

Manifest-Version: 1.0
Implementation-Title: test-agent
Implementation-Version: 0.0.1-SNAPSHOT
Built-By: yangyue
Implementation-Vendor-Id: com.rickiyang.learn
Spring-Boot-Version: 2.0.9.RELEASE
Main-Class: org.springframework.boot.loader.JarLauncher
Start-Class: com.rickiyang.learn.LearnApplication
Spring-Boot-Classes: BOOT-INF/classes/
Spring-Boot-Lib: BOOT-INF/lib/
Created-By: Apache Maven 3.5.2
Build-Jdk: 1.8.0_151
Implementation-URL: https://projects.spring.io/spring-boot/#/spring-bo
 ot-starter-parent/test-agent

这是默认的文件，包含当前的一些版本信息，当前工程的启动类，它还有别的参数允许你做更多的事情，可以用上的有：

Premain-Class ：包含 premain 方法的类（类的全路径名）
Agent-Class ：包含 agentmain 方法的类（类的全路径名）
Boot-Class-Path ：设置引导类加载器搜索的路径列表。查找类的特定于平台的机制失败后，引导类加载器会搜索这些路径。按列出的顺序搜索路径。列表中的路径由一个或多个空格分开。路径使用分层 URI 的路径组件语法。如果该路径以斜杠字符（“/”）开头，则为绝对路径，否则为相对路径。相对路径根据代理 JAR 文件的绝对路径解析。忽略格式不正确的路径和不存在的路径。如果代理是在 VM 启动之后某一时刻启动的，则忽略不表示 JAR 文件的路径。（可选）
Can-Redefine-Classes ：true表示能重定义此代理所需的类，默认值为 false（可选）
Can-Retransform-Classes ：true 表示能重转换此代理所需的类，默认值为 false （可选）
Can-Set-Native-Method-Prefix： true表示能设置此代理所需的本机方法前缀，默认值为 false（可选）

即在该文件中主要定义了程序运行相关的配置信息，程序运行前会先检测该文件中的配置项。
一个java程序中-javaagent参数的个数是没有限制的，所以可以添加任意多个javaagent。所有的java agent会按照你定义的顺序执行，例如：

java -javaagent:agent1.jar -javaagent:agent2.jar -jar MyProgram.jar

程序执行的顺序将会是：

MyAgent1.premain -> MyAgent2.premain -> MyProgram.main

另外的再说一种不去手动写MANIFREST.MF文件的方式，使用maven插件：

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>3.1.0</version>
                <configuration>
                    <archive>
                        <!--自动添加META-INF/MANIFEST.MF -->
                        <manifest>
                            <addClasspath>true</addClasspath>
                        </manifest>
                        <manifestEntries>
                            <Premain-Class>com.company.agent.PreMainTraceAgent</Premain-Class>
                            <Agent-Class>com.company.agent.PreMainTraceAgent</Agent-Class>
                            <Can-Redefine-Classes>true</Can-Redefine-Classes>
                            <Can-Retransform-Classes>true</Can-Retransform-Classes>
                        </manifestEntries>
                    </archive>
                </configuration>
            </plugin>            
        </plugins>
    </build>
​

用这种插件的方式也可以自动生成该文件。

agent代码就写完了，下面再重新开一个工程，你只需要写一个带 main 方法的类即可：

package com.company.agent;

public class TestPreMain {

    public static void main(String[] args) {
        System.out.println("main start");
        try {
            Thread.sleep(3000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        System.out.println("main end");
    }

}

然后运行该类即可：

 #将该类编译成class文件
 > javac TestMain.java
 
 #指定agent程序并运行该类
 > java -javaagent:/Users/youyoukele/sian/code/java-agent/target/java-agent-1.0-SNAPSHOT.jar TestMain

输出结果如下：​

/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/bin/java -javaagent:/Users/youyoukele/sian/code/java-agent/target/java-agent-1.0-SNAPSHOT.jar "-javaagent:/Applications/IntelliJ IDEA.app/Contents/lib/idea_rt.jar=64311:/Applications/IntelliJ IDEA.app/Contents/bin" -Dfile.encoding=UTF-8 -classpath /Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/charsets.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/deploy.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/ext/cldrdata.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/ext/dnsns.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/ext/jaccess.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/ext/jfxrt.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/ext/localedata.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/ext/nashorn.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/ext/sunec.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/ext/sunjce_provider.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/ext/sunpkcs11.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/ext/zipfs.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/javaws.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/jce.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/jfr.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/jfxswt.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/jsse.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/management-agent.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/plugin.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/resources.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/rt.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/lib/ant-javafx.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/lib/dt.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/lib/javafx-mx.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/lib/jconsole.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/lib/packager.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/lib/sa-jdi.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/lib/tools.jar:/Users/youyoukele/sian/code/nasa/nasa-common/target/classes:/Users/youyoukele/.m2/repository/com/google/guava/guava/18.0/guava-18.0.jar:/Users/youyoukele/.m2/repository/com/google/code/gson/gson/2.8.6/gson-2.8.6.jar:/Users/youyoukele/.m2/repository/org/springframework/boot/spring-boot-starter/2.2.5.RELEASE/spring-boot-starter-2.2.5.RELEASE.jar:/Users/youyoukele/.m2/repository/org/springframework/boot/spring-boot/2.2.5.RELEASE/spring-boot-2.2.5.RELEASE.jar:/Users/youyoukele/.m2/repository/org/springframework/boot/spring-boot-autoconfigure/2.2.5.RELEASE/spring-boot-autoconfigure-2.2.5.RELEASE.jar:/Users/youyoukele/.m2/repository/org/springframework/boot/spring-boot-starter-logging/2.2.5.RELEASE/spring-boot-starter-logging-2.2.5.RELEASE.jar:/Users/youyoukele/.m2/repository/ch/qos/logback/logback-classic/1.2.3/logback-classic-1.2.3.jar:/Users/youyoukele/.m2/repository/ch/qos/logback/logback-core/1.2.3/logback-core-1.2.3.jar:/Users/youyoukele/.m2/repository/org/slf4j/slf4j-api/1.7.30/slf4j-api-1.7.30.jar:/Users/youyoukele/.m2/repository/org/apache/logging/log4j/log4j-to-slf4j/2.12.1/log4j-to-slf4j-2.12.1.jar:/Users/youyoukele/.m2/repository/org/apache/logging/log4j/log4j-api/2.12.1/log4j-api-2.12.1.jar:/Users/youyoukele/.m2/repository/org/slf4j/jul-to-slf4j/1.7.30/jul-to-slf4j-1.7.30.jar:/Users/youyoukele/.m2/repository/jakarta/annotation/jakarta.annotation-api/1.3.5/jakarta.annotation-api-1.3.5.jar:/Users/youyoukele/.m2/repository/org/springframework/spring-core/5.2.4.RELEASE/spring-core-5.2.4.RELEASE.jar:/Users/youyoukele/.m2/repository/org/springframework/spring-jcl/5.2.4.RELEASE/spring-jcl-5.2.4.RELEASE.jar:/Users/youyoukele/.m2/repository/org/yaml/snakeyaml/1.25/snakeyaml-1.25.jar:/Users/youyoukele/.m2/repository/org/springframework/spring-beans/5.2.4.RELEASE/spring-beans-5.2.4.RELEASE.jar:/Users/youyoukele/.m2/repository/org/springframework/spring-context/5.2.4.RELEASE/spring-context-5.2.4.RELEASE.jar:/Users/youyoukele/.m2/repository/org/springframework/spring-expression/5.2.4.RELEASE/spring-expression-5.2.4.RELEASE.jar:/Users/youyoukele/.m2/repository/org/springframework/boot/spring-boot-starter-aop/2.2.5.RELEASE/spring-boot-starter-aop-2.2.5.RELEASE.jar:/Users/youyoukele/.m2/repository/org/springframework/spring-aop/5.2.4.RELEASE/spring-aop-5.2.4.RELEASE.jar:/Users/youyoukele/.m2/repository/org/aspectj/aspectjweaver/1.9.5/aspectjweaver-1.9.5.jar:/Users/youyoukele/.m2/repository/org/projectlombok/lombok/1.18.12/lombok-1.18.12.jar:/Users/youyoukele/.m2/repository/cn/hutool/hutool-all/5.2.4/hutool-all-5.2.4.jar:/Users/youyoukele/.m2/repository/org/apache/poi/poi-ooxml/4.1.2/poi-ooxml-4.1.2.jar:/Users/youyoukele/.m2/repository/org/apache/poi/poi/4.1.2/poi-4.1.2.jar:/Users/youyoukele/.m2/repository/org/apache/commons/commons-collections4/4.4/commons-collections4-4.4.jar:/Users/youyoukele/.m2/repository/org/apache/commons/commons-math3/3.6.1/commons-math3-3.6.1.jar:/Users/youyoukele/.m2/repository/com/zaxxer/SparseBitSet/1.2/SparseBitSet-1.2.jar:/Users/youyoukele/.m2/repository/org/apache/poi/poi-ooxml-schemas/4.1.2/poi-ooxml-schemas-4.1.2.jar:/Users/youyoukele/.m2/repository/org/apache/xmlbeans/xmlbeans/3.1.0/xmlbeans-3.1.0.jar:/Users/youyoukele/.m2/repository/org/apache/commons/commons-compress/1.19/commons-compress-1.19.jar:/Users/youyoukele/.m2/repository/com/github/virtuald/curvesapi/1.06/curvesapi-1.06.jar:/Users/youyoukele/.m2/repository/com/auth0/java-jwt/3.9.0/java-jwt-3.9.0.jar:/Users/youyoukele/.m2/repository/commons-codec/commons-codec/1.13/commons-codec-1.13.jar:/Users/youyoukele/.m2/repository/commons-lang/commons-lang/2.6/commons-lang-2.6.jar:/Users/youyoukele/.m2/repository/org/hibernate/validator/hibernate-validator/6.0.18.Final/hibernate-validator-6.0.18.Final.jar:/Users/youyoukele/.m2/repository/javax/validation/validation-api/2.0.1.Final/validation-api-2.0.1.Final.jar:/Users/youyoukele/.m2/repository/org/jboss/logging/jboss-logging/3.4.1.Final/jboss-logging-3.4.1.Final.jar:/Users/youyoukele/.m2/repository/com/fasterxml/classmate/1.5.1/classmate-1.5.1.jar:/Users/youyoukele/.m2/repository/com/fasterxml/jackson/core/jackson-databind/2.10.2/jackson-databind-2.10.2.jar:/Users/youyoukele/.m2/repository/com/fasterxml/jackson/core/jackson-core/2.10.2/jackson-core-2.10.2.jar:/Users/youyoukele/.m2/repository/com/fasterxml/jackson/core/jackson-annotations/2.10.2/jackson-annotations-2.10.2.jar:/Users/youyoukele/.m2/repository/com/github/pagehelper/pagehelper-spring-boot-starter/1.2.13/pagehelper-spring-boot-starter-1.2.13.jar:/Users/youyoukele/.m2/repository/org/mybatis/spring/boot/mybatis-spring-boot-starter/2.1.2/mybatis-spring-boot-starter-2.1.2.jar:/Users/youyoukele/.m2/repository/org/springframework/boot/spring-boot-starter-jdbc/2.2.5.RELEASE/spring-boot-starter-jdbc-2.2.5.RELEASE.jar:/Users/youyoukele/.m2/repository/com/zaxxer/HikariCP/3.4.2/HikariCP-3.4.2.jar:/Users/youyoukele/.m2/repository/org/springframework/spring-jdbc/5.2.4.RELEASE/spring-jdbc-5.2.4.RELEASE.jar:/Users/youyoukele/.m2/repository/org/springframework/spring-tx/5.2.4.RELEASE/spring-tx-5.2.4.RELEASE.jar:/Users/youyoukele/.m2/repository/org/mybatis/spring/boot/mybatis-spring-boot-autoconfigure/2.1.2/mybatis-spring-boot-autoconfigure-2.1.2.jar:/Users/youyoukele/.m2/repository/org/mybatis/mybatis/3.5.4/mybatis-3.5.4.jar:/Users/youyoukele/.m2/repository/org/mybatis/mybatis-spring/2.0.4/mybatis-spring-2.0.4.jar:/Users/youyoukele/.m2/repository/com/github/pagehelper/pagehelper-spring-boot-autoconfigure/1.2.13/pagehelper-spring-boot-autoconfigure-1.2.13.jar:/Users/youyoukele/.m2/repository/com/github/pagehelper/pagehelper/5.1.11/pagehelper-5.1.11.jar:/Users/youyoukele/.m2/repository/com/github/jsqlparser/jsqlparser/2.0/jsqlparser-2.0.jar:/Users/youyoukele/.m2/repository/ma/glasnost/orika/orika-core/1.5.2/orika-core-1.5.2.jar:/Users/youyoukele/.m2/repository/org/javassist/javassist/3.19.0-GA/javassist-3.19.0-GA.jar:/Users/youyoukele/.m2/repository/com/thoughtworks/paranamer/paranamer/2.8/paranamer-2.8.jar:/Users/youyoukele/.m2/repository/com/googlecode/concurrentlinkedhashmap/concurrentlinkedhashmap-lru/1.4.2/concurrentlinkedhashmap-lru-1.4.2.jar:/Users/youyoukele/.m2/repository/com/carrotsearch/java-sizeof/0.0.4/java-sizeof-0.0.4.jar:/Users/youyoukele/.m2/repository/org/codehaus/janino/janino/3.1.0/janino-3.1.0.jar:/Users/youyoukele/.m2/repository/org/codehaus/janino/commons-compiler/3.1.0/commons-compiler-3.1.0.jar com.company.sian.common.utils.JwtUtils
agentArgs : null
premain load Class:java/util/concurrent/ConcurrentHashMap$ForwardingNode
premain load Class:sun/nio/cs/ThreadLocalCoders
premain load Class:sun/nio/cs/ThreadLocalCoders$1
premain load Class:sun/nio/cs/ThreadLocalCoders$Cache
premain load Class:sun/nio/cs/ThreadLocalCoders$2
...
...
...    
premain load Class:sun/util/resources/CurrencyNames
premain load Class:sun/util/resources/zh/CurrencyNames_zh_CN
main start
premain load Class:sun/misc/VMSupport
premain load Class:java/io/ByteArrayOutputStream
premain load Class:java/util/Hashtable$KeySet
...
...
...    
premain load Class:sun/util/resources/TimeZoneNamesBundle
premain load Class:sun/util/resources/en/TimeZoneNames_en
premain load Class:java/util/LinkedHashMap$LinkedKeySet
main end
premain load Class:java/lang/Shutdown
premain load Class:java/lang/Shutdown$Lock

Process finished with exit code 0

上面的输出结果我们能够发现：

  1. 执行main方法之前会加载所有的类，包括系统类和自定义类；
  2. 在ClassFileTransformer中会去拦截系统类和自己实现的类对象；
  3. 如果你有对某些类对象进行改写，那么在拦截的时候抓住该类使用字节码编译工具即可实现。

JVM运行时加载Instrument

​

使用场景
  • 诊断工具，如 Arthas

​

上面介绍的Instrumentation是在 JDK 1.5中提供的，开发者只能在main加载之前添加手脚，在 Java SE 6 的 Instrumentation 当中，提供了一个新的代理操作方法：agentmain，可以在 main 函数开始运行之后再运行。
​

跟premain函数一样， 开发者可以编写一个含有agentmain函数的 Java 类：

// 采用attach机制，被代理的目标程序VM有可能很早之前已经启动，当然其所有类已经被加载完成，这个时候需要借助Instrumentation#retransformClasses(Class<?>... classes)让对应的类可以重新转换，从而激活重新转换的类执行ClassFileTransformer列表中的回调
public static void agentmain (String agentArgs, Instrumentation inst)

public static void agentmain (String agentArgs)

同样，agentmain 方法中带Instrumentation参数的方法也比不带优先级更高。开发者必须在 manifest 文件里面设置“Agent-Class”来指定包含 agentmain 函数的类。

在Java6 以后实现启动后加载的新实现是Attach api。Attach API 很简单，只有2个主要的类，都在com.sun.tools.attach 包里面：

在这里插入图片描述

  1. VirtualMachine 字面意义表示一个Java 虚拟机，也就是程序需要监控的目标虚拟机，提供了获取系统信息(比如获取内存dump、线程dump，类信息统计(比如已加载的类以及实例个数等)， loadAgent，Attach 和 Detach （Attach 动作的相反行为，从 JVM 上面解除一个代理）等方法，可以实现的功能可以说非常之强大 。该类允许我们通过给attach方法传入一个jvm的pid(进程id)，远程连接到jvm上 。代理类注入操作只是它众多功能中的一个，通过loadAgent方法向jvm注册一个代理程序agent，在该agent的代理程序中会得到一个Instrumentation实例，该实例可以 在class加载前改变class的字节码，也可以在class加载后重新加载。在调用Instrumentation实例的方法时，这些方法会使用ClassFileTransformer接口中提供的方法进行处理。

  2. VirtualMachineDescriptor 则是一个描述虚拟机的容器类，配合 VirtualMachine 类完成各种功能。

​

Attach实现动态注入原理

在这里插入图片描述

通过VirtualMachine类的attach(pid)方法，便可以attach到一个运行中的java进程上，之后便可以通过loadAgent(agentJarPath)来将agent的jar包注入到对应的进程，然后对应的进程会调用agentmain方法。

既然是两个进程之间通信那肯定的建立起连接，VirtualMachine.attach动作类似TCP创建连接的三次握手，目的就是搭建attach通信的连接。而后面执行的操作，例如vm.loadAgent，其实就是向这个socket写入数据流，接收方target VM会针对不同的传入数据来做不同的处理。

我们来测试一下agentmain的使用：

工程结构和上面premain的测试一样，编写 AgentMain ，然后使用maven插件打包生成MANIFEST.MF。

package com.company.agent;

import java.lang.instrument.ClassFileTransformer;
import java.lang.instrument.IllegalClassFormatException;
import java.lang.instrument.Instrumentation;
import java.security.ProtectionDomain;

public class AgentMain {

    public static void agentmain(String agentArgs, Instrumentation inst) {
        System.out.println("agentmain agentArgs : " + agentArgs);
        inst.addTransformer(new DefineTransformer(), true);
    }

    static class DefineTransformer implements ClassFileTransformer {

        @Override
        public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer) throws IllegalClassFormatException {
            System.out.println("agentmain load Class:" + className);
            return classfileBuffer;
        }
    }
}


    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>3.1.0</version>
                <configuration>
                    <archive>
                        <!--自动添加META-INF/MANIFEST.MF -->
                        <manifest>
                            <addClasspath>true</addClasspath>
                        </manifest>
                        <manifestEntries>
                            <Premain-Class>com.company.agent.PreMain</Premain-Class>
                            <Agent-Class>com.company.agent.AgentMain</Agent-Class>
                            <Can-Redefine-Classes>true</Can-Redefine-Classes>
                            <Can-Retransform-Classes>true</Can-Retransform-Classes>
                        </manifestEntries>
                    </archive>
                </configuration>
            </plugin>            
        </plugins>
    </build>

将agent打包之后，就是编写测试main方法。上面我们画的图中的步骤是：从一个attach JVM去探测目标JVM，如果目标JVM存在则向它发送agent.jar。我测试写的简单了些，找到当前JVM并加载agent.jar。
​

package com.company.agent;

import com.sun.tools.attach.*;

import java.io.IOException;
import java.util.List;
import java.util.Objects;

public class TestAgentMain {

    private static final String AGENT_PATH = "/Users/youyoukele/sian/code/java-agent/target/java-agent-1.0-SNAPSHOT.jar";

    public static void main(String[] args) throws IOException, AttachNotSupportedException, AgentLoadException, AgentInitializationException, InterruptedException {
        // 获取当前系统中所有运行中的 虚拟机
        System.out.println("running JVM start ");
        List<VirtualMachineDescriptor> list = VirtualMachine.list();

        VirtualMachineDescriptor virtualMachineDescriptor = list.stream()
                .filter(vmd -> vmd.displayName().endsWith(TestAgentMain.class.getName()))
                .findFirst()
                .orElse(null);

        if(Objects.nonNull(virtualMachineDescriptor)){
            System.out.println(String.format(" >>>> running vm name <<<<  %s %s", virtualMachineDescriptor.id(), virtualMachineDescriptor.displayName()));

            VirtualMachine virtualMachine = VirtualMachine.attach(virtualMachineDescriptor.id());
            System.out.println(" >>>> vm attach <<<< ");

            virtualMachine.loadAgent(AGENT_PATH);
            System.out.println(" >>>> load agent <<<< ");

            Thread.sleep(5000);
            virtualMachine.detach();
            System.out.println(" >>>> vm detach <<<< ");
        }

    }


}

list()方法会去寻找当前系统中所有运行着的JVM进程，你可以打印vmd.displayName()看到当前系统都有哪些JVM进程在运行。因为main函数执行起来的时候进程名为当前类名，所以通过这种方式可以去找到当前的进程id。

运行main方法的输出为：

/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/bin/java "-javaagent:/Applications/IntelliJ IDEA.app/Contents/lib/idea_rt.jar=65396:/Applications/IntelliJ IDEA.app/Contents/bin" -Dfile.encoding=UTF-8 -classpath /Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/charsets.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/deploy.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/ext/cldrdata.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/ext/dnsns.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/ext/jaccess.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/ext/jfxrt.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/ext/localedata.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/ext/nashorn.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/ext/sunec.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/ext/sunjce_provider.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/ext/sunpkcs11.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/ext/zipfs.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/javaws.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/jce.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/jfr.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/jfxswt.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/jsse.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/management-agent.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/plugin.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/resources.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/jre/lib/rt.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/lib/ant-javafx.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/lib/dt.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/lib/javafx-mx.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/lib/jconsole.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/lib/packager.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/lib/sa-jdi.jar:/Library/Java/JavaVirtualMachines/jdk1.8.0_251.jdk/Contents/Home/lib/tools.jar:/Users/youyoukele/sian/code/java-agent/target/classes com.company.agent.TestAgentMain
running JVM start 
 >>>> running vm name <<<<  13938 com.company.agent.TestAgentMain
 >>>> vm attach <<<< 
 >>>> load agent <<<< 
agentmain agentArgs : null
agentmain load Class:java/io/ByteArrayOutputStream
agentmain load Class:java/util/Hashtable$KeySet
agentmain load Class:sun/nio/cs/ISO_8859_1$Encoder
agentmain load Class:sun/nio/cs/Surrogate$Parser
agentmain load Class:sun/nio/cs/Surrogate
agentmain load Class:java/util/Date
agentmain load Class:sun/util/calendar/CalendarSystem
agentmain load Class:sun/util/calendar/Gregorian
agentmain load Class:sun/util/calendar/BaseCalendar
agentmain load Class:sun/util/calendar/AbstractCalendar
agentmain load Class:java/util/TimeZone
agentmain load Class:sun/util/calendar/ZoneInfo
agentmain load Class:sun/util/calendar/ZoneInfoFile
agentmain load Class:sun/util/calendar/ZoneInfoFile$1
agentmain load Class:sun/util/calendar/ZoneInfoFile$ZoneOffsetTransitionRule
agentmain load Class:sun/util/calendar/ZoneInfoFile$Checksum
agentmain load Class:java/util/zip/CRC32
agentmain load Class:java/util/zip/Checksum
agentmain load Class:java/util/TimeZone$1
agentmain load Class:sun/util/calendar/Gregorian$Date
agentmain load Class:sun/util/calendar/BaseCalendar$Date
agentmain load Class:sun/util/calendar/CalendarDate
agentmain load Class:sun/util/calendar/CalendarUtils
agentmain load Class:sun/util/locale/provider/TimeZoneNameUtility
agentmain load Class:sun/util/locale/provider/TimeZoneNameProviderImpl
agentmain load Class:sun/util/locale/provider/TimeZoneNameUtility$TimeZoneNameGetter
agentmain load Class:sun/util/resources/TimeZoneNames
agentmain load Class:sun/util/resources/TimeZoneNamesBundle
agentmain load Class:sun/util/resources/en/TimeZoneNames_en
agentmain load Class:java/util/LinkedHashMap$LinkedKeySet
 >>>> vm detach <<<< 
agentmain load Class:java/lang/Shutdown
agentmain load Class:java/lang/Shutdown$Lock

Process finished with exit code 0

instrument原理

​

instrument的底层实现依赖于JVMTI(JVM Tool Interface)，它是JVM暴露出来的一些供用户扩展的接口集合，JVMTI是基于事件驱动的，JVM每执行到一定的逻辑就会调用一些事件的回调接口（如果有的话），这些接口可以供开发者去扩展自己的逻辑。JVMTIAgent是一个利用JVMTI暴露出来的接口提供了代理启动时加载(agent on load)、代理通过attach形式加载(agent on attach)和代理卸载(agent on unload)功能的动态库。而instrument agent可以理解为一类JVMTIAgent动态库，别名是JPLISAgent(Java Programming Language Instrumentation Services Agent)，也就是专门为java语言编写的插桩服务提供支持的代理。
​

启动时加载instrument agent过程
  1. 创建并初始化 JPLISAgent；
  2. 监听 VMInit 事件，在 JVM 初始化完成之后做下面的事情：
    1. 创建 InstrumentationImpl 对象 ；
    2. 监听 ClassFileLoadHook 事件 ；
    3. 调用 InstrumentationImpl 的loadClassAndCallPremain方法，在这个方法里会去调用 javaagent 中 MANIFEST.MF 里指定的Premain-Class 类的 premain 方法 ；
  3. 解析 javaagent 中 MANIFEST.MF 文件的参数，并根据这些参数来设置 JPLISAgent 里的一些内容。
运行时加载instrument agent过程

通过 JVM 的attach机制来请求目标 JVM 加载对应的agent，过程大致如下：

  1. 创建并初始化JPLISAgent；
  2. 解析 javaagent 里 MANIFEST.MF 里的参数；
  3. 创建 InstrumentationImpl 对象；
  4. 监听 ClassFileLoadHook 事件；
  5. 调用 InstrumentationImpl 的loadClassAndCallAgentmain方法，在这个方法里会去调用javaagent里 MANIFEST.MF 里指定的Agent-Class类的agentmain方法。
Instrumentation的局限性

​

大多数情况下，我们使用Instrumentation都是使用其字节码插桩的功能，或者笼统说就是类重定义(Class Redefine)的功能，但是有以下的局限性：

  1. premain和agentmain两种方式修改字节码的时机都是类文件加载之后，也就是说必须要带有Class类型的参数，不能通过字节码文件和自定义的类名重新定义一个本来不存在的类。

  2. 类的字节码修改称为类转换(Class Transform)，类转换其实最终都回归到类重定义Instrumentation#redefineClasses()方法，此方法有以下限制：

    1. 新类和老类的父类必须相同；
    2. 新类和老类实现的接口数也要相同，并且是相同的接口；
    3. 新类和老类访问符必须一致。 新类和老类字段数和字段名要一致；
    4. 新类和老类新增或删除的方法必须是private static/final修饰的；
    5. 可以修改方法体。

除了上面的方式，如果想要重新定义一个类，可以考虑基于类加载器隔离的方式：创建一个新的自定义类加载器去通过新的字节码去定义一个全新的类，不过也存在只能通过反射调用该全新类的局限性。

javaagent使用指南
糖小喵
06-05 424
字节码插桩？bTrace？Arthas？ 在加载类的时候，对字节码进行修改 Javaagent介绍 Javaagent是java命令的一个参数。参数 javaagent 可以用于指定一个 jar 包，并且对该 java 包有2个要求： 这个 jar 包的 MANIFEST.MF 文件必须指定 Premain-Class 项。 Premain-Class 指定的那个类必须实现 premain() 方法。 使用 javaagent 需要几个步骤 定义一个 MANIFEST.MF 文件，必须包含 P.
javaagent入门指南
qq_42885587的博客
06-23 1705
第一次见到javaagent时，是偶然了解到Spring的AOP中使用了一个Instrumentation技术，对自己来说是一个新的知识点，所以很好奇，因此查阅相关文档和资料进行学习，在此记录，如有不妥之处，请指正。 运行环境： 操作系统：Windows10 jdk版本：openjdk version 11.0.7 概述 javaagent顾名思义就是一个java代理，我们知道任何一项java应用的启动都需要有一个入口函数，加载从入口函数开始一直扩散到整个应用。类在jvm中的加载顺序是：加载——&g
java agent使用全解析
08-18
主要介绍了javaagent的相关资料，文中示例代码非常详细，供大家参考和学习，感兴趣的朋友可以了解下
javaagent使用
zhangyifang_009的博客
04-19 1156
是在JDK1.5以后引入的，它能够在不影响正常编译的情况下修改字节码，相当于是在main方法执行之前的拦截器，也叫premain，也就是会先执行premain方法然后再执行main方法。JDK 1.6后引入了agentmain模式，同样提供了一个agentmain方法，可以在main方法执行之后运行。方法将我们的jar包注入到对应的进程当中，然后被注入的进程就好调用jar包里的。可以看到，我们的agentmain方法的代理已经生效，其中。包含agentmain方法的类（类的全路径名）
Java Agent 技术解析
最新发布
leonhongliang806的博客
10-12 734
java agent技术解析
java agent使用
星星我啊，已经很努力在学习了， 有人一起学习吗？Ziansec-1
03-02 535
本质是一个jar包中的类，有两种实现，第一种是通过permain()函数实现。这种javaagent会在宿主程序的main函数的启动前启动自己premain函数，这时候会得到一个Instrumentation对象，我们可以通过Instrumentation对象对还未加载的class进行拦截与修改。还有一种实现方式是利用agentmain()函数。
Java agent使用大全
07-15
Java agent使用大全-编辑再发
Java Agent的使用与实现
weixin_53840353的博客
06-07 865
Java Agent是一种特殊的Java程序，它可以在Java虚拟机（JVM）启动时或运行时加载，并对正在运行的应用程序进行探测和修改。性能监控：收集JVM和应用程序的运行时数据。字节码操作：在运行时修改类的字节码。安全性管理：在应用程序执行前进行安全性检查。Java Agent是一种强大的工具，允许开发者在运行时对Java应用程序进行动态修改。本篇博客介绍了Java Agent的基本概念、实现方法和实际应用场景，并提供了详细的代码示例。
javaagent使用指南-rickiyang1
08-03
在本文中，我们将深入探讨 Javaagent 的使用以及其核心概念。 首先，Javaagent 是通过 `java` 命令的 `-javaagent` 参数来指定的，这个参数需要指向一个包含特定配置的 JAR 包。JAR 包内的 `MANIFEST.MF` 文件是...
深入探索Java Agent：机制解析与使用指南
08-28
本文将详细介绍Java Agent的工作原理、API使用以及实际应用场景。 Java Agent为Java应用程序提供了一种在运行时操作类的能力，这使得它在许多高级应用场景中非常有用。通过本文的详细介绍，你应该能够理解Java Agent...
java JAVA_OPTS javaagent
04-23
例如，使用`-javaagent:path/to/agent.jar=parameters`格式，其中`path/to/agent.jar`是代理类库的路径，`parameters`是传递给代理的参数。 在给定的压缩包文件中，`testagent.jar`很可能就是一个Java代理的实现，...
JavaAgent例子-agentmain方式
12-02
JavaAgent技术的Demo，agentmain方式 采用Javaassist技术实现字节码修改，VirtualMachine技术实现运行时代码织入
Java：javaagent
难得糊涂
08-01 1428
不同于于我们之前使用-Djava.library.path 指定其它的非Java类包用于实现JNIjavaagent本身就是命令的一个选项，用于Java类在加载前，做一些不可告人的事情cuiyaonan2000@163.com，这里所说的不可告人的事情其实就是：字节码插桩字节码插桩 听起来似乎很高大上的样子，实际上就是在Java应用启动加载类前通过某种机制在执行的字节码实现嵌入代码片段或者修改字节码的操作。...
JavaAgent的使用总结
Harry的博客
04-15 3616
Java Agent出现在JDK1.5版本以后，它允许程序员利用agent技术构建一个独立于应用程序的代理程序，用途也非常广泛，可以协助监测、运行、甚至替换其他JVM上的程序，先从下面这张图直观的看一下它都被应用在哪些场景： ...
javaagent的简单使用
随便写写
05-30 356
1. 概述 每个程序都是从main方法开始执行，指定javaagent后，则可以在main方法前执行agent的premain方法。 下面说下结合javassist修改指定类的字节码信息，实现方法延时的统计功能。 2. 使用示例 2.1 编写方法统计代码 public class Test001 implements ClassFileTransformer { @Override public byte[] transform(ClassLoader loader, String className
Java Agent介绍及其使用
ClarkCC的博客
05-20 9730
一、简介 Java Agent技术，也被称为Java代理、Java探针，它允许程序员利⽤其构建⼀个独⽴于应⽤程序的代理程序。 Java Agent 本质上就是一个 jar 包，对于普通的Jar包，通过指定类的 main 函数进行启动，但是 Java Agent 并不能单独启动，必须依附在一个 Java 应用程序运行。使用Java Agent可以实现在Java程序运行的过程中对其进行修改。 Java Agent的jar包主要包含两个部分：实现代码与配置文件...
JavaAgent简介和使用
白鸽
10-08 1858
Java字节码是众多字节码增强技术的知识基础。Java语言写出的源代码首先需要编译成class文件，即字节码文件，然后被JVM加载并运行，每个 class文件 具有如下固定的数据格式u4 magic;// 魔数，固定为0xCAFEBABE u2 minor_version;// 次版本 u2 major_version;// 主版本，常见版本：52对应1.8，51对应1.7，其他依次类推 u2 constant_pool_count;
帮你学会使用Java agent(Java 探针)
qq_39956994的博客
11-10 2254
JavaAgent 是JDK 1.5 以后引入的，也可以叫做Java代理。是一种可以动态修改 Java 字节码的技术。Java 类编译之后形成字节码被 JVM 执行，在 JVM 在执行这些字节码之前获取这些字节码信息，并且通过字节码转换器对这些字节码进行修改，来完成一些额外的功能。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值