AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

java instrument机制分析与实践

2022-11-27 1588
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 1. 原理介绍java instrument是一种字节码增强技术，在jdk1.5开始已引入，其核心功能实现依赖java.lang.instrument.Instrumentation接口，通过实现该接口，我们可以对已加载和未加载的类进行修改。java instrumentation最常用的一种使用方式是通过jvm的启动参数：-javaagent来启动，例如：java -javaagent:myag

1. 原理介绍

java instrument是一种字节码增强技术，在jdk1.5开始已引入，其核心功能实现依赖java.lang.instrument.Instrumentation接口，通过实现该接口，我们可以对已加载和未加载的类进行修改。

java instrumentation最常用的一种使用方式是通过jvm的启动参数：-javaagent来启动，例如：java -javaagent:myagent.jar MyMain。为了能让jvm识别到agent的入口类，需要在MANIFEST.MF文件中指定Premain-Class等配置，例如：（最后需要留一个空行，否则会报错）

通过-javaagent来启动，实际上是一种静态的代理，其处理流程如下：

在我们实现的Agent类中，有一个premain方法，顾名思义，他会在java启动入口方法main之前被调用，在premain中我们可以进行类的字节码增强，例如通过实现ClassFileTransformer接口，可以将指定规则的类的字节码进行替换，最终jvm的类加载器会去加载已经被agent修改后的类字节码。

这种静态的agent只能在jar包启动时进行代理，存在比较大的局限性，jdk1.6开始引入了动态的Attach Agent方式，可以在jvm启动之后的任意时刻通过Attach API远程加载Agent的jar，比如阿里开源的arthas工具就是基于Attach API实现的。

JVM Attach API的实现主要是基于UNIX域套接字的，与TCP，UDP不同，UNIX域套接字主要应用于同一个主机上的进程间通信，虽然理论上使用localhost也可以在同一个主机上实现进程间通信，但是UNIX域套接字更可靠，效率也更高。（因为它不用进行协议处理，不需要计算序列号，也不用发送确认报文，只需读写数据即可，因为在同一个主机上进程之间实际上就是处于一个高度可信可靠的通信环境）详见：Unix域套接字简介。

Attach API的执行过程如下：

2. 静态agent使用示例

首先新建一个InstrumentTest类，如下：

package com.xycode.techlecture.instrument;

/**
* 测试javaagent的入口类
* @author: xycode
* @email: lianguang.xy@alibaba-inc.com
* @date: 2022/8/17
*/
public class InstrumentTest {
    public void foo(){
        System.out.println("execute foo");
        bar();
    }

    public void bar(){
        System.out.println("execute bar");
    }

    public static void main(String[] args) {
        new InstrumentTest().foo();
    }

}

期望在InstrumentTest类实例方法执行前后添加log，我们可以写出如下代码：

package com.xycode.agent;

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

import jdk.internal.org.objectweb.asm.ClassReader;
import jdk.internal.org.objectweb.asm.ClassVisitor;
import jdk.internal.org.objectweb.asm.ClassWriter;
import jdk.internal.org.objectweb.asm.MethodVisitor;
import jdk.internal.org.objectweb.asm.Opcodes;
import jdk.internal.org.objectweb.asm.commons.AdviceAdapter;

/**
 * java agent入口类
 *
 * @author: xycode
 * @email: lianguang.xy@alibaba-inc.com
 * @date: 2022/8/17
 */
public class AgentMain {

    public static class MyClassFileTransformer implements ClassFileTransformer {

        @Override
        public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined,
            ProtectionDomain protectionDomain, byte[] classfileBuffer) {
            //只处理com.xycode.techlecture.instrument.InstrumentTest
            if (!"com/xycode/techlecture/instrument/InstrumentTest".equals(className)) {
                return classfileBuffer;
            }
            try {
                //asm字节码操作
                ClassReader classReader = new ClassReader(classfileBuffer);
                ClassWriter classWriter = new ClassWriter(classReader, ClassWriter.COMPUTE_FRAMES);
                ClassVisitor classVisitor = new ClassVisitor(Opcodes.ASM5, classWriter) {
                    @Override
                    public MethodVisitor visitMethod(int access, String name, String descriptor, String signature,
                        String[] exceptions) {
                        MethodVisitor methodVisitor = super.visitMethod(access, name, descriptor, signature,
                            exceptions);
                        if (name.equals("<init>")) {
                            return methodVisitor;
                        }
                        return new AdviceAdapter(Opcodes.ASM5, methodVisitor, access, name, descriptor) {
                            @Override
                            protected void onMethodEnter() {
                                //getstatic #2               //Field java/lang/System.out:Ljava/io/PrintStream;
                                this.mv.visitFieldInsn(Opcodes.GETSTATIC, "java/lang/System", "out", "Ljava/io/PrintStream;");
                                //ldc #3                     //String ">> enter " + name
                                this.mv.visitLdcInsn(">> enter " + name);
                                //invokevirtual  #4          //Method java/io/PrintStream.println:(Ljava/lang/String;)V
                                this.mv.visitMethodInsn(INVOKEVIRTUAL, "java/io/PrintStream", "println",
                                    "(Ljava/lang/String;)V", false);
                                super.onMethodEnter();
                            }

                            @Override
                            protected void onMethodExit(int opcode) {
                                super.onMethodExit(opcode);
                                this.mv.visitFieldInsn(Opcodes.GETSTATIC, "java/lang/System", "out", "Ljava/io/PrintStream;");
                                this.mv.visitLdcInsn(">> exit " + name);
                                this.mv.visitMethodInsn(Opcodes.INVOKEVIRTUAL, "java/io/PrintStream", "println",
                                    "(Ljava/lang/String;)V", false);

                            }
                        };
                    }
                };

                classReader.accept(classVisitor, ClassReader.SKIP_DEBUG | ClassReader.SKIP_FRAMES);
                return classWriter.toByteArray();
            } catch (Exception exception) {
                exception.printStackTrace();
            }
            return classfileBuffer;
        }
    }

    //notice: javaagent jar入口方法为premain
    public static void premain(String agentArgs, Instrumentation instrumentation) {
        System.out.println("premain");
        //注册类文件转换器
        instrumentation.addTransformer(new MyClassFileTransformer(), true);
    }
}

接着将AgentMain编译成jar，我们还需要配置MANIFEST.MF，目录结构与内容如下：

pom文件：(需要指定编译参数以及MANIFEST.MF文件路径)

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <groupId>com.xycode</groupId>
    <artifactId>testJavaAgent</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <modelVersion>4.0.0</modelVersion>


    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <build>
        <plugins>
            <plugin>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>UTF-8</encoding>
                    <compilerArguments>
                        <!-- 将jdk的依赖jar打入项目中，这样项目中使用的jdk的依赖就可以正常使用 -->
                        <bootclasspath>${java.home}/lib/rt.jar</bootclasspath>
                    </compilerArguments>
                </configuration>
            </plugin>

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>3.2.0</version>
                <configuration>
                    <archive>
                        <!-- 指定MANIFEST.MF文件路径-->
                        <manifestFile>src/main/resources/META-INF/MANIFEST.MF</manifestFile>
                    </archive>
                </configuration>
            </plugin>
        </plugins>
    </build>


</project>

使用mvn编译出jar包：testJavaAgent-0.0.1-SNAPSHOT.jar，然后我们可以通过命令行运行，如下：

java -javaagent:${your_path}/testJavaAgent-0.0.1-SNAPSHOT.jar com.xycode.techlecture.instrument.InstrumentTest

也可以选择在IDEA中运行，只需在运行InstrumentTest时指定vm参数即可，如下：（在IEDA中可以使用idea的debug能力, 只需在java agent类中添加断点即可）

运行效果：

3. 动态agent使用示例

先创建一个AttachMainTest类，如下：

package com.xycode.techlecture.instrument.attach;

import java.util.concurrent.TimeUnit;

/**
 * @author: xycode
 * @email: lianguang.xy@alibaba-inc.com
 * @date: 2022/8/26
 */
public class AttachMainTest {

    public static void main(String[] args) throws InterruptedException {
        while (true) {
            System.out.println(foo());
            TimeUnit.SECONDS.sleep(2);
        }
    }

    public static int foo() {
        return 100;
    }
}

我们这里希望在jvm运行中动态修改foo方法的返回值，代码如下：

package com.xycode.agent;

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

import jdk.internal.org.objectweb.asm.ClassReader;
import jdk.internal.org.objectweb.asm.ClassVisitor;
import jdk.internal.org.objectweb.asm.ClassWriter;
import jdk.internal.org.objectweb.asm.MethodVisitor;
import jdk.internal.org.objectweb.asm.Opcodes;
import jdk.internal.org.objectweb.asm.commons.AdviceAdapter;

/**
 * attachAgent
 *
 * @author: xycode
 * @email: lianguang.xy@alibaba-inc.com
 * @date: 2022/8/29
 */
public class AttachAgentMain {

    public static class MyClassFileTransformer implements ClassFileTransformer {

        @Override
        public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined,
            ProtectionDomain protectionDomain, byte[] classfileBuffer) throws IllegalClassFormatException {
            //指定处理com.xycode.techlecture.instrument.attach.AttachMainTest
            if (!"com/xycode/techlecture/instrument/attach/AttachMainTest".equals(className)) {
                return classfileBuffer;
            }

            //ASM字节码操作
            ClassReader classReader = new ClassReader(classfileBuffer);
            ClassWriter classWriter = new ClassWriter(classReader, ClassWriter.COMPUTE_FRAMES);

            ClassVisitor classVisitor = new ClassVisitor(Opcodes.ASM5, classWriter) {
                @Override
                public MethodVisitor visitMethod(int access, String name, String desc, String signature,
                    String[] exceptions) {
                    MethodVisitor methodVisitor = super.visitMethod(access, name, desc, signature, exceptions);
                    //转换foo方法, 修改其返回值
                    if ("foo".equals(name)) {
                        return new AdviceAdapter(Opcodes.ASM5, methodVisitor, access, name, desc) {
                            @Override
                            protected void onMethodEnter() {
                                //在方法开始处插入return 50;
                                this.mv.visitIntInsn(Opcodes.BIPUSH, 50); //bipush 50
                                this.mv.visitInsn(Opcodes.IRETURN); //ireturn
                            }
                        };
                    }
                    return methodVisitor;
                }
            };

            classReader.accept(classVisitor, ClassReader.SKIP_FRAMES | ClassReader.SKIP_DEBUG);

            return classWriter.toByteArray();
        }
    }

    //notice: attach agent jar入口方法为agentmain
    public static void agentmain(String agentArgs, Instrumentation instrumentation) throws UnmodifiableClassException {
        System.out.println("agentMain");
        //注册类文件转换器
        instrumentation.addTransformer(new MyClassFileTransformer(),true);


        for (Class loadedClass : instrumentation.getAllLoadedClasses()) {
            //因为动态更改jvm中的指定类, 因此这里需要重新加载
            //notice: 注意这里的类名, 格式与asm中的类名不一样
            // 分别是com.xycode.techlecture.instrument.attach.AttachMainTest 与 com/xycode/techlecture/instrument/attach/AttachMainTest
            if (loadedClass.getName().equals("com.xycode.techlecture.instrument.attach.AttachMainTest")) {
                System.out.println("reloading " + loadedClass.getName());
                instrumentation.retransformClasses(loadedClass);
                break;
            }
        }
    }

}

目录结构与MANIFEST.MF如下：

pom文件如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.xycode</groupId>
    <artifactId>testAttachAgent</artifactId>
    <version>0.0.1-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <build>
        <plugins>
            <plugin>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.8.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>UTF-8</encoding>
                    <compilerArguments>
                        <!-- 将jdk的依赖jar打入项目中，这样项目中使用的jdk的依赖就可以正常使用 -->
                        <bootclasspath>${java.home}/lib/rt.jar</bootclasspath>
                    </compilerArguments>
                </configuration>
            </plugin>

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>3.2.0</version>
                <configuration>
                    <archive>
                        <!-- 指定MANIFEST.MF文件路径-->
                        <manifestFile>src/main/resources/META-INF/MANIFEST.MF</manifestFile>
                    </archive>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

然后编译出testAttachAgent-0.0.1-SNAPSHOT.jar，并运行AttachMainTest类，并找到其pid，如下

pid为19854，新建AttachClient类，并指定attach的pid，如下：

package com.xycode.techlecture.instrument.attach;

import java.io.IOException;

import com.sun.tools.attach.AttachNotSupportedException;
import com.sun.tools.attach.VirtualMachine;

/**
 * @author: xycode
 * @email: lianguang.xy@alibaba-inc.com
 * @date: 2022/8/29
 */
public class AttachClient {

    public static void main(String[] args) throws IOException, AttachNotSupportedException {
        //attach上指定pid的java进程
        VirtualMachine virtualMachine = VirtualMachine.attach("19854");

        try {
            virtualMachine.loadAgent("/Users/xycode/IdeaProjects/techlecture/techlecture/testAttachAgent/target/testAttachAgent-0.0.1-SNAPSHOT.jar");
        }catch (Exception e){
            virtualMachine.detach();
        }
    }
}

最终效果如下：（可以看出，类已被重新加载，并更改了foo的返回值）

文章标签：
云虚拟主机
服务网格
Java
测试技术
Unix
网络协议
Arthas
API
关键词：
Java分析
Java实践
Java机制
Java机制实践
Java机制分析
xycode
目录
相关文章
凉凉心.
|
19天前
|
Java Go 开发工具
【Java】（9）抽象类、接口、内部的运用与作用分析，枚举类型的使用
抽象类必须使用abstract修饰符来修饰，抽象方法也必须使用abstract修饰符来修饰，抽象方法不能有方法体。抽象类不能被实例化，无法使用new关键字来调用抽象类的构造器创建抽象类的实例。抽象类可以包含成员变量、方法（普通方法和抽象方法都可以）、构造器、初始化块、内部类（接 口、枚举）5种成分。抽象类的构造器不能用于创建实例，主要是用于被其子类调用。抽象类中不一定包含抽象方法，但是有抽象方法的类必定是抽象类abstract static不能同时修饰一个方法。
凉凉心.
159 1
凉凉心.
|
19天前
|
存储 Java Go
【Java】（3）8种基本数据类型的分析、数据类型转换规则、转义字符的列举
牢记类型转换规则在脑海中将编译和运行两个阶段分开，这是两个不同的阶段，不要弄混！
凉凉心.
131 2
小白学大数据
|
1月前
|
数据采集 存储 弹性计算
高并发Java爬虫的瓶颈分析与动态线程优化方案
高并发Java爬虫的瓶颈分析与动态线程优化方案
小白学大数据
169 1
poemyang
|
2月前
|
安全 Java 编译器
new出来的对象，不一定在堆上？聊聊Java虚拟机的优化技术：逃逸分析
逃逸分析是一种静态程序分析技术，用于判断对象的可见性与生命周期。它帮助即时编译器优化内存使用、降低同步开销。根据对象是否逃逸出方法或线程，分析结果分为未逃逸、方法逃逸和线程逃逸三种。基于分析结果，编译器可进行同步锁消除、标量替换和栈上分配等优化，从而提升程序性能。尽管逃逸分析计算复杂度较高，但其在热点代码中的应用为Java虚拟机带来了显著的优化效果。
poemyang
81 4
青云交（Java大数据AI云原生Python）
|
2月前
|
机器学习/深度学习 安全 Java
Java 大视界 -- Java 大数据在智能金融反洗钱监测与交易异常分析中的应用（224）
本文探讨 Java 大数据在智能金融反洗钱监测与交易异常分析中的应用，介绍其在数据处理、机器学习建模、实战案例及安全隐私等方面的技术方案与挑战，展现 Java 在金融风控中的强大能力。
青云交（Java大数据AI云原生Python）
113 0
昵称被隐藏
|
3月前
|
SQL 缓存 安全
深度理解 Java 内存模型：从并发基石到实践应用
本文深入解析 Java 内存模型（JMM），涵盖其在并发编程中的核心作用与实践应用。内容包括 JMM 解决的可见性、原子性和有序性问题，线程与内存的交互机制，volatile、synchronized 和 happens-before 等关键机制的使用，以及在单例模式、线程通信等场景中的实战案例。同时，还介绍了常见并发 Bug 的排查与解决方案，帮助开发者写出高效、线程安全的 Java 程序。
昵称被隐藏
196 0
青云交（Java大数据AI云原生Python）
|
3月前
|
存储 Java 大数据
Java 大视界 -- Java 大数据在智能家居能源消耗模式分析与节能策略制定中的应用（198）
简介：本文探讨Java大数据技术在智能家居能源消耗分析与节能策略中的应用。通过数据采集、存储与智能分析，构建能耗模型，挖掘用电模式，制定设备调度策略，实现节能目标。结合实际案例，展示Java大数据在智能家居节能中的关键作用。
青云交（Java大数据AI云原生Python）
127 0
青云交（Java大数据AI云原生Python）
|
3月前
|
存储 搜索推荐 算法
Java 大视界 -- Java 大数据在智慧文旅旅游线路规划与游客流量均衡调控中的应用实践（196）
本实践案例深入探讨了Java大数据技术在智慧文旅中的创新应用，聚焦旅游线路规划与游客流量调控难题。通过整合多源数据、构建用户画像、开发个性化推荐算法及流量预测模型，实现了旅游线路的精准推荐与流量的科学调控。在某旅游城市的落地实践中，游客满意度显著提升，景区流量分布更加均衡，充分展现了Java大数据技术在推动文旅产业智能化升级中的核心价值与广阔前景。
青云交（Java大数据AI云原生Python）
133 0
啦啦啦191
|
3月前
|
监控 Java API
现代 Java IO 高性能实践从原理到落地的高效实现路径与实战指南
本文深入解析现代Java高性能IO实践，涵盖异步非阻塞IO、操作系统优化、大文件处理、响应式网络编程与数据库访问，结合Netty、Reactor等技术落地高并发应用，助力构建高效可扩展的IO系统。
啦啦啦191
125 0
啦啦啦191
|
3月前
|
并行计算 Java API
Java List 集合结合 Java 17 新特性与现代开发实践的深度解析及实战指南 Java List 集合
本文深入解析Java 17中List集合的现代用法，结合函数式编程、Stream API、密封类、模式匹配等新特性，通过实操案例讲解数据处理、并行计算、响应式编程等场景下的高级应用，帮助开发者提升集合操作效率与代码质量。
啦啦啦191
168 1

热门文章

最新文章

  • 1
    构建基于Java的AI智能体：使用LangChain4j与Spring AI实现RAG应用
  • 2
    Java AI智能体实战：使用LangChain4j构建能使用工具的AI助手
  • 3
    使用LangChain4j构建Java AI智能体：让大模型学会使用工具
  • 4
    Java新特性：使用Stream API重构你的数据处理
  • 5
    告别字符串拼接：用Java文本块优雅处理多行字符串
  • 6
    JUC系列之《CompletableFuture：Java异步编程的终极武器》
  • 7
    告别空指针噩梦：Optional让Java代码更优雅
  • 8
    基于JavaWeb的销售管理系统设计系统
  • 9
    Java异常处理：程序世界的“交通规则
  • 10
    告别NullPointerException：拥抱Java Optional
  • 1
    2025 版 Java 零基础入门到精通实操指南
    824
  • 2
    java 入门学习视频_2025 最新 java 入门零基础学习视频教程
    177
  • 3
    顺丰同城抢单辅助脚本，顺丰骑士抢单辅助免封号，自动抢单神器【java版开源】
    551
  • 4
    现代化 java 分层开发实施策略与最佳实践指南
    174
  • 5
    我们详细地讲解一下 Java 异常及要如何处理
    97
  • 6
    MinIO Java SDK 7.1.4 升级到 8.5.17 需要注意什么
    370
  • 7
    微信不封号无限加人软件，微信一键自动加人软件，java实现批量化加人
    122
  • 8
    Java 与 C++ 区别深入剖析及应用实例详解
    414
  • 9
    Java 生态大模型应用开发全流程实战案例与技术路径终极对决
    681
  • 10
    Java 抽象类与接口在 Java17 + 开发中的现代应用实践解析
    103

    • 相关课程

    更多
  • Java面试疑难点解析 - 面试技巧及语言基础
  • Java面试疑难点解析 - Java Web开发
  • Java面试疑难点解析 - 系统架构及项目设计
  • Java编程入门
  • Java面向对象编程
  • Java高级编程

    • 相关电子书

    更多
  • Spring Cloud Alibaba - 重新定义 Java Cloud-Native
  • The Reactive Cloud Native Arch
  • JAVA开发手册1.5.0
    • 下一篇
    一文了解：阿里云对象存储OSS是什么？