基于Java Agent的premain方式实现方法耗时监控问题

Java Agent是依附于java应用程序并能对其字节码做相关更改的一项技术，它也是一个Jar包，但并不能独立运行，有点像寄生虫的感觉。当今的许多开源工具尤其是监控和诊断工具，很多都是基于Java Agent来实现的，如最近阿里刚开源的Arthas。一个Java Agent既可以在程序运行前加载(premain方式), 又可以在程序运行后加载(attach方式)。本文通过实现一个对Java方法耗时监控的Agent来让大家了解一下Java Agent的premain方式具体应用。

首先给出测试类，如下所示，该类的代码很简单，最终要达到的目的就是在不修改这段代码的情况下，能够知道运行这段程序时每个方法的具体耗时，也就是实现一个Java方法耗时监控的Agent。

MyAgentTest.java

public class MyAgentTest {
    public static void main(String[] args) throws InterruptedException {
        MyAgentTest mat = new MyAgentTest();
        mat.test();
        Thread.sleep((long)(Math.random() * 10));//随机暂停0-10ms
    }

    public void test() throws InterruptedException {
        System.out.println("I'm TestAgent");
        Thread.sleep((long)(Math.random() * 100));//随机暂停0-100ms
    }
}

接下来就是要创建一个名为myagent的工程，项目结构如下:

myagent
├── pom.xml
├── src
│   └── main
│       ├── java
│       │   └── test
│       │       ├── MyAgent.java
│       │       └── MyTransformer.java
│       └── resources
│           └── META-INF
│               └── MANIFEST.MF

从上面可以看到，项目中主要文件只有两个java类和一个MANIFEST.MF，所以Java Agent其实也并没有那么神秘。

先看看pom.xml这个文件，因为字节码的相关操作要依赖于javassist这个包，所以要添加相关依赖。在默认情况下，用maven进行打包时会覆盖掉我们自己的MANIFEST.MF，以及不会引进依赖的jar包，所以在build中要引进maven-assembly-plugin插件并添加相关配置。

pom.xml

<?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.hebh.me</groupId>
  <artifactId>demo-myagent</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>jar</packaging>

  <name>demo-myagent Maven Webapp</name>
  <url>http://www.example.com</url>

  <dependencies>
    <dependency>
      <groupId>javassist</groupId>
      <artifactId>javassist</artifactId>
      <version>3.12.1.GA</version>
    </dependency>
  </dependencies>

  <build>
    <finalName>myagent</finalName>
    <plugins>
      <plugin>
        <artifactId>maven-assembly-plugin</artifactId>
        <configuration>
          <archive>
            <!--避免MANIFEST.MF被覆盖-->
            <manifestFile>src/main/resources/META-INF/MANIFEST.MF</manifestFile>
          </archive>
          <descriptorRefs>
            <!--打包时加入依赖-->
            <descriptorRef>jar-with-dependencies</descriptorRef>
          </descriptorRefs>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

接下来就是最重要MyAgent类，而premain(String args, Instrumentation inst)这个方法是关键，也是Agent的入口, 在方法里我们直接打印"Hi, I'm agent!"文本并添加一个自己实现的字节码转换器。

MyAgent.java

package test;

import java.lang.instrument.Instrumentation;
public class MyAgent {
    public static void premain(String args, Instrumentation inst){
        System.out.println("Hi, I'm agent!");
        inst.addTransformer(new MyTransformer());
    }
}

然后看看这个字节码转换器的具体实现，首先是要实现ClassFileTransformer接口，然后实现接口中的transform方法，jdk中源码对该接口的说明如下

An agent provides an implementation of this interface in order to transform class files. The transformation occurs before the class is defined by the JVM

翻译过来也就是我们可以通过实现该接口来在虚拟机加载类之前对字节码进行相关更改。

对于该方法的说明文字比较多，在这里我们只需要知道该方法传入类的所有相关信息，然后返回一个修改后的类的字节码。要达到对方法耗时的监控最核心的代码在在这个方法里面，如下，首先过滤我们不关注的类，复制关注类的原方法并在执行之前获取时间戳，执行后再次获取时间戳，两者取差值即为方法耗时，为一直观显示我们直接添加相关打印代码。

MyTransformer.java

package test;

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

import javassist.ClassPool;
import javassist.CtClass;
import javassist.CtMethod;
import javassist.CtNewMethod;

/**
 * 检测方法的执行时间
 */
public class MyTransformer implements ClassFileTransformer {

    final static String prefix = "\nlong startTime = System.currentTimeMillis();\n";
    final static String postfix = "\nlong endTime = System.currentTimeMillis();\n";

    @Override
    public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined,
                            ProtectionDomain protectionDomain, byte[] classfileBuffer){
        //java自带的方法不进行处理
        if(className.startsWith("java") || className.startsWith("sun")){
            return null;
        }
        className = className.replace("/", ".");
        CtClass ctclass = null;
        try {
            ctclass = ClassPool.getDefault().get(className);// 使用全称,用于取得字节码类<使用javassist>
            for(CtMethod ctMethod : ctclass.getDeclaredMethods()){
                String methodName = ctMethod.getName();
                String newMethodName = methodName + "$old";// 新定义一个方法叫做比如sayHello$old
                ctMethod.setName(newMethodName);// 将原来的方法名字修改

                // 创建新的方法，复制原来的方法，名字为原来的名字
                CtMethod newMethod = CtNewMethod.copy(ctMethod, methodName, ctclass, null);

                // 构建新的方法体
                StringBuilder bodyStr = new StringBuilder();
                bodyStr.append("{");
                bodyStr.append("System.out.println(\"==============Enter Method: " + className + "." + methodName + " ==============\");");
                bodyStr.append(prefix);
                bodyStr.append(newMethodName + "($$);\n");// 调用原有代码，类似于method();($$)表示所有的参数
                bodyStr.append(postfix);
                bodyStr.append("System.out.println(\"==============Exit Method: " + className + "." + methodName + " Cost:\" +(endTime - startTime) +\"ms " + "===\");");
                bodyStr.append("}");

                newMethod.setBody(bodyStr.toString());// 替换新方法
                ctclass.addMethod(newMethod);// 增加新方法
            }
            return ctclass.toBytecode();
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }
}

最后也是非常重要并且容易出错的地方就是在resources文件夹下面创建META-INF文件夹，然后定义MANIFEST.MF文件，通过Premain-Class属性来指定Agent的入口，需要注意的是冒号后面必须要有一个空格，并且最后要空出一行。

MANIFEST.MF

Manifest-Version: 1.0
Created-By: 0.0.1 (Demo Inc.)
Premain-Class: test.MyAgent

到此为止我们就已经完成了myagent工程的所有代码，为了使用它就必须将其打包为jar文件，用如下命令:

mvn assembly:assembly

执行mvn命令后就可以在项目的target目录下看到生成的myagent-jar-with-dependencies.jar文件。

然后编译在最开始用来测试的类:

javac MyAgentTest.java

编译后就生成了.class文件，为了方便，我们把.class文件放到和myagent-jar-with-dependencies.jar同一个目录。

如果不使用我们的agent直接执行java命令，效果如下:

如果在javaagent参数中加上agent，效果如下:

首先在执行所有方法前，会执行MyAgent的premain方法。并且可以直观看到，MyAgentTest在运行时首先是进入main方法，然后再是test方法，执行完test方法逻辑后退出test方法，最后退出main方法，不仅能看到每个方法的最终耗时也能看到方法执行的轨迹。

到此这篇关于基于Java Agent的premain方式实现方法耗时监控的文章就介绍到这了,更多相关Java Agent方法耗时监控内容请搜索猪先飞以前的文章或继续浏览下面的相关文章希望大家以后多多支持猪先飞！