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命令,效果如下:

image-20190105205332639

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

image-20190105205205594

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

目标达成,完。。。

原文:https://www.jianshu.com/p/f28dfbb2faa2

基于Java Agent的premain方式实现方法耗时监控(转),为了找到结论执行:premain在jvm启动的时候执行,所有方法前,会执行MyAgent的premain方法的更多相关文章

  1. 基于java.util.logging实现轻量级日志记录库(增加根据当前类class初始化,修复线程池模型(javaEE)下的堆栈轨迹顺序与当前调用方法不一致问题)

    前言: 本章介绍自己写的基于java.util.logging的轻量级日志记录库(baseLog). 该版本的日志记录库犹如其名,baseLog,是个实现日志记录基本功能的小库,适合小型项目使用,方便 ...

  2. 基于Spring aop写的一个简单的耗时监控

    前言:毕业后应该有一两年没有好好的更新博客了,回头看看自己这一年,似乎少了太多的沉淀了.让自己做一个爱分享的人,好的知识点拿出来和大家一起分享,一起学习. 背景: 在做项目的时候,大家肯定都遇到对一些 ...

  3. Java 调式、热部署、JVM 背后的支持者 Java Agent

    我们平时写 Java Agent 的机会确实不多,也可以说几乎用不着.但其实我们一直在用它,而且接触的机会非常多.下面这些技术都使用了 Java Agent 技术,看一下你就知道为什么了. -各个 J ...

  4. java agent技术原理及简单实现

    注:本文定义-在函数执行前后增加对应的逻辑的操作统称为MOCK 1.引子 在某天与QA同学进行沟通时,发现QA同学有针对某个方法调用时,有让该方法停止一段时间的需求,我对这部分的功能实现非常好奇,因此 ...

  5. [转] Java Agent使用详解

    以下文章来源于古时的风筝 ,作者古时的风筝 我们平时写 Java Agent 的机会确实不多,也可以说几乎用不着.但其实我们一直在用它,而且接触的机会非常多.下面这些技术都使用了 Java Agent ...

  6. Java 安全之Java Agent

    Java 安全之Java Agent 0x00 前言 在前面发现很多技术都会去采用Java Agent该技术去做实现,比分说RASP和内存马(其中一种方式).包括IDEA的这些破解都是基于Java A ...

  7. 🏆【Java技术专区】「探针Agent专题」Java Agent探针的技术介绍(1)

    前提概要 Java调式.热部署.JVM背后的支持者Java Agent: 各个 Java IDE 的调试功能,例如 eclipse.IntelliJ : 热部署功能,例如 JRebel.XRebel. ...

  8. 利用Java Agent进行代码植入

    利用Java Agent进行代码植入 Java Agent 又叫做 Java 探针,是在 JDK1.5 引入的一种可以动态修改 Java 字节码的技术.可以把javaagent理解成一种代码注入的方式 ...

  9. Spring Security基于Java配置

    Maven依赖 <dependencies> <!-- ... other dependency elements ... --> <dependency> < ...

随机推荐

  1. MySQL安装教程并使用springboot2和Mybatis测试

    目录 MySQL是什么 MySQL安装 开始使用一下MySQL 用spring boot2+Mybatis试试MySQL 创建数据库和表 拉通spring boot2+mybatis MySQL是什么 ...

  2. 微信小程序(二)--逻辑层与界面层

    一.逻辑层与界面层分离 小程序开发框架将我们需要完成的编码,划分成了两种类型的编码:逻辑编码(由JavaScript完成,业务数据供给界面事件处理),界面编码(页面结构WXML,页面样式WXSS,展示 ...

  3. [Bzoj2243][SDOI2011]染色(线段树&&树剖||LCT)

    题目链接:https://www.lydsy.com/JudgeOnline/problem.php?id=2243 线段树+树链剖分,在线段树需要每次用lt和rt两个数组记录当前区间的左右边界的颜色 ...

  4. 动态规划——稀疏表求解RMQ问题

    RMQ (Range Minimum/Maximum Query)问题,即区间最值查询问题,是求解序列中的某一段的最值的问题.如果只需要询问一次,那遍历枚举(复杂度O(n))就是最方便且高效的方法,但 ...

  5. python学习第十三天元组创建和操作方法

    有人问,有了列表,为什么还要有元组呢,到底元组是什么,元组是不可变的有序的列表,一旦创建不能改变,那些地方用到元组呢,小编知道可以应用到数据库连接. 1,元组的创建 n1 = () 元组用的是小括号 ...

  6. ArrayList与List<T>的区别

    ArrayList alist = new ArrayList(); //ArrayList(object value),所以ArrayList可以存储任何类型,如果存储值类型的话会进行装箱操作,在操 ...

  7. ERROR in Template execution failed: ReferenceError: htmlwebpackPlugin is not defined

    ejs文件配置如下: <!DOCTYPE html> <html lang="zh-CN"> <head> <title>webpa ...

  8. facenet 人脸识别(一)

    前言 已完成TensorFlow Object Detection API环境搭建,具体搭建过程请参照: 安装运行谷歌开源的TensorFlow Object Detection API视频物体识别系 ...

  9. 解决图片插入word文档后清晰度降低的问题

    解决图片插入word文档后清晰度降低的问题 在默认情况下,word程序会自动压缩插入word文档中的图片以减小整个word文档的.当我们需要插入word文档中的图片保持原始清晰度时,可以通过设置wor ...

  10. windows下搭建Mongo主(Master)/从(slave)数据库同步

    需要启动两个mongoDb文档数据库,一个是主模式启动,另一个是属于从模式启动. 1. 创建主从服务器 主服务器:192.168.1.131:27017 备服务器:192.168.1.131:2701 ...