Java Instrumentation从概念到基本用法详解

 更新时间:2025年09月25日 11:51:40   作者:燎原人生  
Java Instrumentation是java.lang.instrument包提供的 API,允许开发者在类被JVM 加载时对其进行修改,或者在运行时重新定义类的字节码,本文给大家介绍Java Instrumentation从概念到基本用法详解,感兴趣的朋友一起看看吧

一、什么是 Java Instrumentation

Java Instrumentation 是 java.lang.instrument 包提供的 API,允许开发者在类被 JVM 加载时对其进行修改,或者在运行时重新定义类的字节码。

主要用途

  • 性能监控与分析(如:JProfiler、YourKit)
  • 代码覆盖率工具(如:JaCoCo、Cobertura)
  • 动态代理、AOP
  • 安全检查、沙箱实现
  • 热代码替换(HotSwap)

二、核心概念

1. Java Agent

Instrumentation 的入口是 Java Agent,它是一种特殊的 jar 包,启动 JVM 时通过 -javaagent 参数加载。

Agent Jar 需要在 MANIFEST.MF 里指定入口类:

Premain-Class: com.example.MyAgent

2. Premain & Agentmain

  • public static void premain(String agentArgs, Instrumentation inst)
    • JVM 启动时执行(静态加载)
  • public static void agentmain(String agentArgs, Instrumentation inst)
    • JVM 运行中动态 attach(动态加载)

3. Instrumentation 接口

这是核心接口,提供了如下能力:

  • 添加 ClassFileTransformer
  • 获取已加载的类
  • 重定义类(redefineClasses)
  • 检查是否支持 Retransform(isRetransformClassesSupported)

三、基本用法

1. 编写 Agent

public class MyAgent {
    public static void premain(String agentArgs, Instrumentation inst) {
        System.out.println("Agent loaded!");
        inst.addTransformer(new MyTransformer());
    }
}

2. 实现 ClassFileTransformer

public class MyTransformer implements ClassFileTransformer {
    @Override
    public byte[] transform(
        ClassLoader loader, String className, Class<?> classBeingRedefined,
        ProtectionDomain protectionDomain, byte[] classfileBuffer
    ) {
        // 可以用 ASM/Javassist 修改字节码
        if (className.equals("com/example/TargetClass")) {
            // 返回修改后的字节码
        }
        return null; // 返回 null 表示不修改
    }
}

3. 启动 JVM 时加载

java -javaagent:myagent.jar -jar myapp.jar

四、进阶应用

1. 动态 Attach

JDK 提供了 com.sun.tools.attach.VirtualMachine 实现动态 attach agent 到运行中的 JVM。

VirtualMachine vm = VirtualMachine.attach("pid");
vm.loadAgent("myagent.jar");

2. 字节码修改

常用工具有 ASM、Javassist、ByteBuddy。例如用 ASM 修改方法字节码,实现方法增强、插桩。

3. 热代码替换

通过 Instrumentation.redefineClasses 可以在不重启 JVM 的情况下替换已加载类的实现(有一定限制)。

五、典型案例

1. 性能监控

在所有方法入口和出口插入计时代码,统计每个方法的耗时。

2. 代码覆盖率

在每个分支、方法插入标记,记录哪些代码被执行过。

3. 安全防护

在敏感 API 调用前插入权限检查逻辑。

六、注意事项

  • 并非所有类都能被重新定义(如 JVM 内部类、已被 native 方法锁定的类)。
  • 字节码修改需谨慎,容易引发兼容性和稳定性问题。
  • 动态 attach 需要目标 JVM 开启 attach 功能(通常为同一用户)。

七、实战案例

编写一个Java Instrumentation接口性能监控示例

1. 创建 Java Agent

PerformanceMonitorAgent.java

import java.lang.instrument.Instrumentation;
public class PerformanceMonitorAgent {
    public static void premain(String agentArgs, Instrumentation inst) {
        System.out.println("PerformanceMonitorAgent loaded.");
        inst.addTransformer(new PerformanceTransformer());
    }
}

2. 编写 Transformer

PerformanceTransformer.java

import java.lang.instrument.ClassFileTransformer;
import java.security.ProtectionDomain;
public class PerformanceTransformer implements ClassFileTransformer {
    @Override
    public byte[] transform(
        ClassLoader loader,
        String className,
        Class<?> classBeingRedefined,
        ProtectionDomain protectionDomain,
        byte[] classfileBuffer) {
        // 只监控特定包下的类(比如com/example/)
        if (className != null && className.startsWith("com/example/")) {
            // 使用ASM或Javassist修改字节码,在方法前后插入耗时统计代码
            try {
                return MethodTimer.injectTimer(classfileBuffer);
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
        return classfileBuffer;
    }
}

3. 使用 Javassist 修改字节码

MethodTimer.java

import javassist.*;
public class MethodTimer {
    public static byte[] injectTimer(byte[] classfileBuffer) throws Exception {
        ClassPool pool = ClassPool.getDefault();
        CtClass ctClass = pool.makeClass(new java.io.ByteArrayInputStream(classfileBuffer));
        for (CtMethod method : ctClass.getDeclaredMethods()) {
            if (!method.isEmpty() && !method.getName().equals("<init>")) {
                method.addLocalVariable("_startTime", CtClass.longType);
                method.insertBefore("_startTime = System.nanoTime();");
                method.insertAfter(
                    "System.out.println(\"[Performance] Method " + method.getName() +
                    " executed in \" + (System.nanoTime() - _startTime) + \" ns.\");"
                );
            }
        }
        byte[] byteCode = ctClass.toBytecode();
        ctClass.detach();
        return byteCode;
    }
}

4. 目标类示例

com/example/Demo.java

package com.example;
public class Demo {
    public void test() {
        try { Thread.sleep(100); } catch (Exception e) {}
    }
    public static void main(String[] args) {
        new Demo().test();
    }
}

5. 编译 & 打包 Agent

javac -cp javassist.jar:. PerformanceMonitorAgent.java PerformanceTransformer.java MethodTimer.java
jar cmf MANIFEST.MF perfagent.jar PerformanceMonitorAgent.class PerformanceTransformer.class MethodTimer.class

MANIFEST.MF 内容:

Premain-Class: PerformanceMonitorAgent
Can-Redefine-Classes: true
Can-Retransform-Classes: true

6. 运行目标程序并加载 Agent

java -javaagent:perfagent.jar -cp javassist.jar:. com.example.Demo

7. 输出示例

PerformanceMonitorAgent loaded.
[Performance] Method test executed in 100123456 ns.

说明:

  • 这个例子用 Javassist 修改字节码,在每个方法前后插入耗时统计代码。
  • 你可以根据需要修改 PerformanceTransformer,选择需要监控的类和方法。
  • 实际生产环境建议将统计结果汇总、写入日志或上报到监控系统。

到此这篇关于Java Instrumentation详解的文章就介绍到这了,更多相关Java Instrumentation内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 最简单的spring boot打包docker镜像的实现

    最简单的spring boot打包docker镜像的实现

    这篇文章主要介绍了最简单的spring boot打包docker镜像的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-10-10
  • Java 基于Hutool实现DES加解密示例详解

    Java 基于Hutool实现DES加解密示例详解

    这篇文章主要介绍了Java基于Hutool实现DES加解密,本文通过示例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-08-08
  • spring cloud 之 客户端负载均衡Ribbon深入理解

    spring cloud 之 客户端负载均衡Ribbon深入理解

    下面小编就为大家带来一篇spring cloud 之 客户端负载均衡Ribbon深入理解。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-06-06
  • java中重写equals()方法的同时要重写hashcode()方法(详解)

    java中重写equals()方法的同时要重写hashcode()方法(详解)

    下面小编就为大家带来一篇java中重写equals()方法的同时要重写hashcode()方法(详解)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-05-05
  • SpringMVC框架REST架构体系原理分析

    SpringMVC框架REST架构体系原理分析

    REST:Representational State Transfer,资源表现层状态转换,是目前&#12112;较主流的&#12032;种互联网软件架构,它结构清晰、标准规范、易于理解、便于扩展
    2021-09-09
  • zookeeper实现分布式锁

    zookeeper实现分布式锁

    这篇文章主要为大家详细介绍了基于zookeeper实现分布式锁,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-05-05
  • Mybatis映射文件详解之mapper.xml文件

    Mybatis映射文件详解之mapper.xml文件

    本文详细介绍了Mybatis映射文件的结构、标签和使用方法,包括mapper元素、标签的主要属性如id、parameterType、resultType以及动态SQL和结果映射的使用,通过映射文件,可以将数据库表与Java对象映射,支持查询、插入、更新、删除等操作,提高了SQL语句的灵活性和可重用性
    2024-09-09
  • SpringBoot4中api版本控制的实现示例

    SpringBoot4中api版本控制的实现示例

    本文主要介绍了SpringBoot4中api版本控制,通过在请求注解中添加版本号,可以实现API的版本控制,从而避免对现有客户端造成兼容性问题
    2026-02-02
  • Spring batch批处理框架

    Spring batch批处理框架

    本文主要介绍了Spring batch批处理框架的相关知识。具有很好的参考价值,下面跟着小编一起来看下吧
    2017-04-04
  • Spring AI内置DeepSeek的详细步骤

    Spring AI内置DeepSeek的详细步骤

    Spring AI 最新快照版已经内置 DeepSeek 了,所以以后项目中对接 DeepSeek 就方便多了,但因为快照版会有很多 Bug,所以今天咱们就来看稳定版的 Spring AI 如何对接 DeepSeek 满血版,感兴趣的小伙伴跟着小编一起来看看吧
    2025-02-02

最新评论