一文带你了解Java Agent

Java Agent这个技术,对于大多数同学来说都比较陌生,但是多多少少又接触过,实际上,我们平时用的很多工具,都是基于Java Agent实现的,例如常见的热部署JRebel,各种线上诊断工具(btrace, greys),还有阿里最近开源的arthas。

其实Java Agent一点都不神秘,也是一个Jar包,只是启动方式和普通Jar包有所不同,对于普通的Jar包,通过指定类的main函数进行启动,但是Java Agent并不能单独启动,必须依附在一个 Java 应用程序运行,有点像寄生虫的感觉。

如何动手写一个Java Agent

因为Java Agent的特殊性,需要一些特殊的配置,在META-INF目录下创建MANIFEST文件.

一文带你了解Java Agent

并在MANIFEST文件中指定Agent的启动类

一文带你了解Java Agent

这里需要解释下为什么要指定 Agent-ClassPremain-Class ,在加载Java Agent之后,会找到 Agent-Class 或者 Premain-Class 指定的类,并运行对应的 agentmain 或者 premain 方法。

/**
 * 以vm参数的方式载入,在Java程序的main方法执行之前执行
 */
public static void premain(String agentArgs, Instrumentation inst);

/**
 * 以Attach的方式载入,在Java程序启动后执行
 */
public static void agentmain(String agentArgs, Instrumentation inst);

如果不想手动创建MANIFEST文件,也可以通过Maven配置,在打包的时候自动生成,具体配置可以参数下面。

plugin>
    <artifactId>maven-assembly-plugin</artifactId>
    <configuration>
        <archive>
            <manifestEntries>
                <Premain-Class>com.dianping.rhino.agent.AgentBoot</Premain-Class>
                <Agent-Class>com.dianping.rhino.agent.AgentBoot</Agent-Class>
                <Can-Redefine-Classes>true</Can-Redefine-Classes>
                <Can-Retransform-Classes>true</Can-Retransform-Classes>
            </manifestEntries>
        </archive>
    </configuration>
</plugin>

所以,我们需要在 agentmain 或者 premain 方法中实现具体的Agent逻辑,这里是你大显身手的地方,读取JVM的各种数据,修改类的字节码,只要你能想到的,一般都可以实现。

如何加载 Java Agent

前面说了,一个Java Agent既可以在程序运行前加载,也可以在程序运行后加载,两者有什么区别呢?

程序运行前加载

通过JVM参数 -javaagent:**.jar 启动,程序启动的时候,会优先加载Java Agent,并执行其 premain 方法,这个时候,其实大部分的类都还没有被加载,这个时候可以实现对新加载的类进行字节码修改,但是如果 premain 方法执行失败或抛出异常,那么JVM会被中止,这是很致命的问题。

程序运行后加载

程序启动之后,通过某种特定的手段加载Java Agent,这个特定的手段就是 VirtualMachineattach api ,这个api其实是JVM进程之间的的沟通桥梁,底层通过socket进行通信,JVM A可以发送一些指令给JVM B,B收到指令之后,可以执行对应的逻辑,比如在命令行中经常使用的jstack、jcmd、jps等,很多都是基于这种机制实现的。

因为是进程间通信,所以使用 attach api 的也是一个独立的Java进程,下面是一个简单的实现。

// 15186表示目标进程的PID
VirtualMachine vm = VirtualMachine.attach("15186");  
try {
   // 指定Java Agent的jar包路径
    vm.loadAgent(".../agent.jar");    
} finally {
    vm.detach();
}

首先,我们得知道目标进程的PID,这个可以通过jps指令方便得到,也可以通过 VirtualMachine 的list方法拿到本机所有Java进程的PID。通过 attach 连接上目标PID之后,可以获得表示目标进程的vm对象,执行 loadAgent 方法,对应的Java Agent会被加载,然后会找到指定的入口类,并执行agentmain方法,如果执行出现普通异常(除了oom和其它致命异常),目标JVM并不会受到影响。

通过这种方式,可以实现动态的加载Java Agent,而不需要修改JVM启动参数。

Java Agent 后续内容

  • attach api 的实现原理
  • agentmainpremain 方法中的Instrumentation参数是什么?
  • 如何自定义类加载器,避免污染目前进程
  • 如何实现字节码的修改
  • 如何实现字节码的多次修改
  • 如何恢复被修改过的字节码
  • 如何卸载Java Agent的类
  • 卸载自定义类加载器遇到的一些坑
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,271评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,275评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,151评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,550评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,553评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,559评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,924评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,580评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,826评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,578评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,661评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,363评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,940评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,926评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,156评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,872评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,391评论 2 342

推荐阅读更多精彩内容