java agent 要生效,premain 方法中必须注册 classfiletransformer;它通过 instrumentation.addtransformer 注册字节码转换器,实现在类加载前修改字节码,且需在 manifest.mf 中声明 premain-class 和 can-retransform-classes。

premain 方法里必须注册 ClassFileTransformer
Java Agent 要起作用,核心是让 JVM 在类加载前就拿到你的字节码改写逻辑。这一步靠 premain 实现,它会在应用 main 执行前被调用。你必须在这个方法里拿到 Instrumentation 实例,并调用 addTransformer 注册一个 ClassFileTransformer。
常见错误是漏掉 MANIFEST.MF 中的关键声明:
-
Premain-Class: com.example.MyAgent—— 缺失会导致 JVM 根本不调用你的premain -
Can-Retransform-Classes: true—— 如果你想对已加载的类(比如 Spring Bean)做增强,这个必须设为true,否则retransformClasses会直接抛UnsupportedOperationException - jar 包不能有依赖未打包进去 ——
ClassFileTransformer里如果用了 ASM,而 ASM 没打进 agent jar,transform方法一执行就NoClassDefFoundError
transform 方法里用 ASM 修改目标方法字节码
所有类加载都会经过 ClassFileTransformer.transform,你得在里面判断是否要处理当前类和方法。不要在 transform 里写复杂逻辑或打日志 —— 它在类加载关键路径上,慢了会拖垮整个启动过程。
用 ASM 插入耗时统计,典型做法是在方法入口压入 System.nanoTime(),出口处取差值并上报。注意几个关键点:
当用户要求为 Java 代码添加注释、修改注释、审查注释、整理注释格式,或要求按照代码注释规范处理 Java 文件时,使用本技能。本技能用于统一生成和维护 Java 类注释模板、按 Git 对比 release 判断版本号、补充每行代码上方中文块注释、调整注释空行规则,并保持 Java 文件 UTF-8 无 BOM 编码。典型触发场景包括:补充类注释、更新 @version、检查 @author 来源、整理行尾注释、把注释放到代码上一行、检查注释是否符合规范、构建前检查 Java 注释风格。
- 只对匹配的
className和methodName + descriptor处理,避免全量扫描 —— 比如想增强com.example.UserService.login,descriptor 是(Ljava/lang/String;)Z,字符串要严格匹配 - 用
ClassReader+ClassWriter+ 自定义MethodVisitor,在visitCode后插入计时开始,在visitInsn遇到IRETURN/LRETURN/ARETURN/RETURN前插入结束逻辑 - 别直接用
System.currentTimeMillis()—— 它精度低、有系统时钟跳变风险;System.nanoTime()更适合耗时测量 - 上报逻辑(比如发到内存队列或简单 log)必须是无锁、非阻塞的,否则可能引发死锁或 GC 停顿放大
retransformClasses 对已加载类生效的前提
很多场景下,你想增强的类(比如 Spring Controller)在 Agent 初始化前就已经被加载了。这时 transform 不会触发,必须手动调用 retransformClasses。
但这个操作不是无条件可用的:
- JVM 启动参数必须加
-XX:+UnlockDiagnosticVMOptions -XX:+RevertMasterThread(某些 JDK 版本需要),否则即使Can-Retransform-Classes: true,isRetransformClassesSupported()也返回false -
retransformClasses只能重定义已加载类,不能新增方法或字段;若原方法有活跃栈帧(比如正在执行中),那些栈帧继续跑旧字节码,新字节码只对后续调用生效 - 建议在
premain末尾先调inst.getAllLoadedClasses()过滤出目标类,再批量传给retransformClasses,避免漏掉
ASM9 的 Opcodes 版本与 JDK 兼容性
ASM 版本选错是运行时 VerifyError 或 ClassFormatError 的高频原因。现在主流用 ASM9,但它默认生成的是 JDK 17+ 兼容的字节码。如果你的业务应用跑在 JDK 8 上,必须显式指定目标版本:
- 创建
ClassWriter时传ClassWriter.COMPUTE_FRAMES不够,还要确保ClassReader读出来的 class 版本不高于目标 JDK 支持范围 - 更稳妥的做法:在
ClassVisitor.visit回调里检查version参数,比如if (version > Opcodes.V1_8) return super.visit(...),跳过高版本类防止崩溃 - 不要混用 ASM 和 Byte Buddy —— 同一个类被两个 transformer 处理,极易因指令顺序冲突导致验证失败
真正难的不是插几行计时代码,而是让这套逻辑在各种 JDK 版本、Spring 生命周期、类加载器隔离环境下都稳定触发且不出错。尤其是 retransformClasses 的时机和范围,稍不注意就会漏监控或反复触发。
Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南










