你不知道的Java探针?

基于JavaAgent和Java字节码注入技术的java探针工具技术原理

img

我们利用javaAgent和ASM字节码技术开发java探针工具,实现原理如下:

jdk1.5以后引入了javaAgent技术,javaAgent是运行方法之前的拦截器。我们利用javaAgent和ASM字节码技术,在JVM加载class二进制文件的时候,利用ASM动态的修改加载的class文件,在监控的方法前后添加计时器功能,用于计算监控方法耗时,同时将方法耗时及内部调用情况放入处理器,处理器利用栈先进后出的特点对方法调用先后顺序做处理,当一个请求处理结束后,将耗时方法轨迹和入参map输出到文件中,然后根据map中相应参数或耗时方法轨迹中的关键代码区分出我们要抓取的耗时业务。最后将相应耗时轨迹文件取下来,转化为xml格式并进行解析,通过浏览器将代码分层结构展示出来,方便耗时分析,如图0-1所示。

img

Java探针工具功能点:

1、支持方法执行耗时范围抓取设置,根据耗时范围抓取系统运行时出现在设置耗时范围的代码运行轨迹。

2、支持抓取特定的代码配置,方便对配置的特定方法进行抓取,过滤出关系的代码执行耗时情况。

3、支持APP层入口方法过滤,配置入口运行前的方法进行监控,相当于监控特有的方法耗时,进行方法专题分析。

4、支持入口方法参数输出功能,方便跟踪耗时高的时候对应的入参数。

5、提供WEB页面展示接口耗时展示、代码调用关系图展示、方法耗时百分比展示、可疑方法凸显功能。

一个简单的JavaAgent demo实例

JavaAgent 是JDK 1.5 以后引入的,也可以叫做Java代理。

JavaAgent 是运行在 main方法之前的拦截器,它内定的方法名叫 premain ,也就是说先执行 premain 方法然后再执行 main 方法。

那么如何实现一个 JavaAgent 呢?很简单,只需要增加 premain 方法即可,后续可以在此基础上实现注入拦截,AOP等。

package com.xifj.agent.demo;
import java.lang.instrument.Instrumentation;
 
/**
 * Created by uc on 2018/4/18.
 */
public class agentDemo {
    /**
     * 该方法在main方法之前运行,与main方法运行在同一个JVM中
     *
     * @param agentArgs
     * @param inst
     * @author xifeijian
     * @create  2018年4月18日
     */
    public static void premain(String agentArgs, Instrumentation inst) {
        System.out.println("=========premain方法执行1========");
        System.out.println(agentArgs);
    }
 
    /**
     * 如果不存在 premain(String agentArgs, Instrumentation inst)
     * 则会执行 premain(String agentArgs)
     *
     * @param agentArgs
     * @author xifeijian
     * @create  2018年4月18日
     */
    public static void premain(String agentArgs) {
        System.out.println("=========premain方法执行2========");
        System.out.println(agentArgs);
    }
}

在这个 premain 函数中,开发者可以进行对类的各种操作。
1、agentArgs 是 premain 函数得到的程序参数,随同 “– javaagent”一起传入。与 main 函数不同的是,这个参数是一个字符串而不是一个字符串数组,如果程序参数有多个,程序将自行解析这个字符串。

2、Inst 是一个 java.lang.instrument.Instrumentation 的实例,由 JVM 自动传入。java.lang.instrument.Instrumentation 是 instrument 包中定义的一个接口,也是这个包的核心部分,集中了其中几乎所有的功能方法,例如类定义的转换和操作等等。

写完这个类后,我们还需要做一步配置工作,在 src 目录下生成 META-INF/MANIFEST.MF 文件。
img

img

然后编辑META-INF/MANIFEST.MF,内容按如下定义:

要特别注意,最后一行是空行,还有就是Premain-Class冒号后面有个空格,例如:

Manifest-Version: 1.0
Premain-Class: com.xifj.agent.demo.agentDemo

img

然后我们打包代码为 javaagent.jar(Build-Artifact)

img

接着我们在创建一个带有main方法的主程序工程,截图如下:

img

程代码已完成,运行前配置VM参数:

-javaagent:D:\workspace\javaagent\out\artifacts\javaagent_jar\javaagent.jar=Hello -javaagent:D:\workspace\javaagent\out\artifacts\javaagent_jar\javaagent.jar=World
img

运行agentTest程序,得到以下结果:

img

也可以将agentTest打成jar包通过java命令行执行,我们通过 -javaagent 参数来指定我们的Java代理包,值得一说的是 -javaagent 这个参数的个数是不限的,如果指定了多个,则会按指定的先后执行,执行完各个 agent 后,才会执行主程序的 main 方法。命令如下:

java -javaagent:D:\workspace\javaagent\out\artifacts\javaagent_jar\javaagent.jar=hello1 -javaagent:D:\workspace\javaagent\out\artifacts\javaagent_jar\javaagent.jar=hello2 -jar D:\workspace\myTest\out\artifacts\myTest_jar\myTest.jar

执行结果和上图是完全一致的。

特别提醒:如果你把 -javaagent 放在 -jar 后面,则不会生效。也就是说,放在主程序后面的 agent 是无效的。

常见问题

一、什么是java agent?

Java agent是在JDK1.5引入的,是一种可以动态修改Java字节码的技术。java类编译之后形成字节码被JVM执行,JVM在执行这些字节码之前获取这些字节码信息,并且对这些字节码进行修改,来完成一些额外的功能,这种就是java agent技术。

二、java agent可以实现什么样的功能?

1.java agent能够在加载java字节码之前进行拦截并对字节码进行修改

2.在jvm运行期间修改已经加载的字节码

通过以上两种就可以实现在一些框架或是技术的采集点进行字节码修改,可以对应用进行监控,或是对执行指定方法或是接口时额外添加操作(打印日志、打印方法执行时间、采集方法的入参和结果等)

三、java agent的实现原理?

了解java agent的实现原理就必须先了解java的类加载机制(还不了解的自行了解),这个是了解java agent的前提。

其次需要了解的是JVMTI以及JVMTIAgent,下面分别介绍下

3.1、JVMTI

JVMTI是JVM Tool Interface的缩写,是JVM暴露出来给用户扩展使用的接口集合,JVMTI是基于事件驱动的,JVM每执行一定的逻辑就会调用一些事件的回调接口,这些接口可以给用户自行扩展来实现自己的逻辑

3.2、JVMTIAgent

JVMTIAgent是一个动态库,利用JVMTI暴露出来的接口实现用户自行的逻辑(eclipse、idea等工具等代码调试就是通过这个实现的)

JVMTIAgent主要有三个方法,

Agent_OnLoad方法,如果agent在启动时加载,就执行这个方法

Agent_OnAttach方法,如果agent不是在启动的时候加载的,是我们先attach到目标线程上,然后对对应的目标进程发送load命令来加载agent,在加载过程中调用Agent_OnAttach函数

Agent_OnUnload方法,在agent做卸载掉时候调用

3.3、instrument agent

instrument agent实现了Agent_OnLoad方法和Agent_OnAttach方法,也就是即能在启动的时候加载agent,也可以在运行期来加动态加载agent,运行期动态加载agent依赖JVM的attach机制实现,通过发送load命令来加载agent

3.4、JVM Attach机制

jvm attach机制上JVM提供的一种JVM进程间通信的功能,能让一个进程传命令给另一个进程,并进行一些内部的操作,比如进行线程dump,那么就需要执行jstack进行,然后把pid等参数传递给需要dump的线程来执行,这就是一种java attach。

3.5、Class Transform的实现

第一次类加载的时候要求被transform的场景,在加载类文件的时候发出ClassFileLoad事件,交给instrument agent来调用java agent里注册的ClassFileTransformer实现字节码的修改

3.6、Class Redefind的实现

类重新定义,主要用在已经被加载的类上

四、实现字节码增强的技术框架有哪些?

原理了解清楚了就需要实现,java agent实现字节码增强到过程大概是:

1.修改字节码、2.加载新到字节码、3.替换旧的字节码

第二步可以通过自定义ClassLoader来加载修改的字节码,第三步可以通过JVM加载或运行字节码时进行替换,那么第一步修改字节码该如何进行呢,至少大部分人时不会修改的,那么就需要使用工具来修改,

目前实现修改字节码的工具主要有ASM、Javassist和byte buddy,下一篇将着重介绍这三种字节码生成框架及用法

参考文章:
https://www.cnblogs.com/jackion5/p/10679728.html
https://www.cnblogs.com/aspirant/p/8796974.html
https://blog.csdn.net/xifeijian/article/details/79991913

发布了108 篇原创文章 · 获赞 14 · 访问量 4万+

猜你喜欢

转载自blog.csdn.net/belongtocode/article/details/103976167