trace java_使用java动态字节码技术简单实现arthas的trace功能。

参考资料

ASM 系列详细教程

编译时，找不到asm依赖

用过[Arthas]的都知道，Arthas是alibaba开源的一个非常强大的Java诊断工具。

不管是线上还是线下，我们都可以用Arthas分析程序的线程状态、查看jvm的实时运行状态、打印方法的出入参和返回类型、收集方法中每个代码块耗时，

甚至可以监控类、方法的调用次数、成功次数、失败次数、平均响应时长、失败率等。

前几天学习java动态字节码技术时，突然想起这款java诊断工具的trace功能：打印方法中每个节点的调用耗时。简简单单的，正好拿来做动态字节码入门学习的demo。

程序结构

src ├── agent-package.bat ├── java │ ├── asm │ │ ├── MANIFEST.MF │ │ ├── TimerAgent.java │ │ ├── TimerAttach.java │ │ ├── TimerMethodVisitor.java │ │ ├── TimerTrace.java │ │ └── TimerTransformer.java │ └── demo │ ├── MANIFEST.MF │ ├── Operator.java │ └── Test.java ├── run-agent.bat ├── target-package.bat └── tools.jar

编写目标程序

代码

package com.gravel.demo.test.asm;/** * @Auther: syh * @Date: 2020/10/12 * @Description: */public class Test { public static boolean runnable = true; public static void main(String[] args) throws Exception { while (runnable) { test(); } } // 目标：分析这个方法中每个节点的耗时 public static void test() throws Exception { Operator.handler(); long time_wait = (long) ((Math.random() * 1000) + 2000); Operator.callback(); Operator.pause(time_wait); }}

Operator.java

/** * @Auther: syh * @Date: 2020/10/28 * @Description: 辅助类，同样可用于分析耗时 */public class Operator { public static void handler() throws Exception { long time_wait = (long) ((Math.random() * 10) + 20); sleep(time_wait); } public static void callback() throws Exception { long time_wait = (long) ((Math.random() * 10) + 20); sleep(time_wait); } public static void pause(long time_wait) throws Exception { sleep(time_wait); } public static void stop() throws Exception { Test.runnable = false; System.out.println("business stopped."); } private static void sleep(long time_wait) throws Exception { Thread.sleep(time_wait); }}

MANIFEST.MF

编写MANIFEST.MF文件，指定main-class。注意：冒号后面加空格，结尾加两行空白行。

Manifest-Version: 1.0Archiver-Version: Plexus ArchiverBuilt-By: syhCreated-By: Apache MavenBuild-Jdk: 1.8.0_202Main-Class: com.gravel.demo.test.asm.Target

打包

偷懒写了bat批命令，生成target.jar

@echo off & setlocalattrib -s -h -r -a /s /d demord /s /q demord /q target.jarjavac -encoding utf-8 -d . ./java/demo/*.javajar cvfm target.jar ./java/demo/MANIFEST.MF demord /s /q demopausejava -jar target.jar

java agent探针

instrument 是 JVM 提供的一个可以修改已加载类文件的类库。而要实现代码的修改，我们需要实现一个 instrument agent。

jdk1.5时，agent有个内定方法premain。是在类加载前修改。所以无法做到修改正在运行的类。

jdk1.6后，agent新增了agentmain方法。agentmain是在虚拟机启动以后加载的。所以可以做拦截、热部署等。

讲JAVA探针技术，实际上我自己也是半吊子。所以这里用的是边分析别人例子边摸索的思路来实现我的简单的trace功能。

例子使用的是ASM字节码生成框架

MANIFEST.MF

首先一个可用的jar，关键之一是MAINFEST.MF文件是吧。

Manifest-Version: 1.0Archiver-Version: Plexus ArchiverCreated-By: Apache MavenBuilt-By: syhBuild-Jdk: 1.8.0_202Agent-Class: asm.TimerAgentCan-Retransform-Classes: trueCan-Redefine-Classes: trueClass-Path: ./tools.jarMain-Class: asm.TimerAttach

我们从MANIFEST.MF中提取几个关键的属性

属性

说明

Agent-Class

agentmain入口类

Premain-Class

premain入口类，与agent-class至少指定一个。

Can-Retransform-Classes

对于已经加载的类重新进行转换处理，即会触发重新加载类定义。

Can-Redefine-Classes

对已经加载的类不做转换处理，而是直接把处理结果(bytecode)直接给JVM

Class-Path

asm动态字节码技术依赖tools.jar，如果没有可以从jdk的lib目录下拷贝。

Main-Class

这里并不是agent的关键属性，为了方便，我把加载虚拟机的程序和agent合并了。

代码

然后我们来看看两个入口类，首先分析一个可执行jar的入口类Main-Class。

public class TimerAttach { public static void main(String[] args) throws Exception { /** * 启动jar时，需要指定两个参数：1目标程序的pid。 2 要修改的类路径及方法，格式 package.class#methodName */ if (args.length < 2) { System.out.println("pid and class must be specify."); return; } if (!args[1].contains("#")) { System.out.println("methodName must be specify."); return; } VirtualMachine vm = VirtualMachine.attach(args[0]); // 这里为了方便我把 vm和agent整合在一个jar里面了， args[1]就是agentmain的入参。 vm.loadAgent("agent.jar", args[1]); }}

代码很简单，1：args入参校验；2：加载目标进程pid(args[0])；3：加载agent jar包(因为合并了，所以这个jar其实就是自己)。

其中vm.loadAgent(agent.jar, args[1])会调用agent-class中的agentmain方法，而args[1]就是agentmain的第一个入参。

public class TimerAgent { public static void agentmain(String agentArgs, Instrumentation inst) { String[] ownerAndMethod = agentArgs.split("#"); inst.addTransformer(new TimerTransformer(ownerAndMethod[1]), true); try { inst.retransformClasses(Class.forName(ownerAndMethod[0])); System.out.println("agent load done."); } catch (Exception e) { e.printStackTrace(); System.out.println("agent load failed!"); } }}

在 agentmain 方法里，我们调用retransformClassess方法载入目标类，调用addTransformer方法加载TimerTransformer类实现对目标类的重新定义。

类转换器

public class TimerTransformer implements ClassFileTransformer { private String methodName; public TimerTransformer(String methodName) { this.methodName = methodName; } @Override public byte[] transform(ClassLoader loader, String className, Class> classBeingRedefined, ProtectionDomain protectionDomain, byte[] classFileBuffer) { ClassReader reader = new ClassReader(classFileBuffer); ClassWriter classWriter = new ClassWriter(ClassWriter.COMPUTE_MAXS); ClassVisitor classVisitor = new TimerTrace(Opcodes.ASM5, classWriter, methodName); reader.accept(classVisitor, ClassReader.EXPAND_FRAMES); return classWriter.toByteArray(); }}

对被匹配到的类中的方法进行修改

public class TimerTrace extends ClassVisitor implements Opcodes { private String owner; private boolean isInterface; private String methodName; public TimerTrace(int i, ClassVisitor classVisitor, String methodName) { super(i, classVisitor); this.methodName = methodName; } @Override public void visit(int version, int access, String name, String signature, String superName, String[] interfaces) { super.visit(version, access, name, signature, superName, interfaces); owner = name; isInterface = (access & ACC_INTERFACE) != 0; } @Override public MethodVisitor visitMethod(int access, String name, String descriptor, String signature, String[] exceptions) { MethodVisitor mv = super.visitMethod(access, name, descriptor, signature, exceptions); // 匹配到指定methodName时，进行字节码修改 if (!isInterface && mv != null && name.equals(methodName)) { // System.out.println(" package.className:methodName()") mv.vis.........