java探针技术I——如何写一个 java agent

开发工具

  • Intellij Idea 2019
  • maven 3

开始吧

java 探针不依赖于任何框架,所以首先我们创建一个 maven 项目即可。

创建启动类

新增一个 SartUp 的启动类

public class StartUp {
    public static void premain(String agentArgs, Instrumentation inst) {
        System.out.println("hello, i'am agent!");
    }
}

premain 方法为固定写法,它有两个方法签名可以选择,JVM 首先会去寻找这个方法来启动探针,它传入了探针的参数,以及 Instrumentation 对象,该对象可以提供对字节码的修改。

public static void premain(String agentArgs, Instrumentation inst);

如果没有找到上面的方法,则会寻找

public static void premain(String agentArgs);

这里我们选择了第一个方法,后续会有用的啦~

添加 MANIFEST.MF 文件

在 resources 目录下新建文件夹 META-INF ,在此文件夹中新增 MANIFEST.MF 文件。这是 JVM 启动时所必须的参数,如果不存在,将终止运行。

Premain-Class: io.daocloud.mircoservice.StartUp #指明包含 premain 方法的类

打包 agent

agent 是一个 jar 包,所以我们要将它打包,供其他项目使用。

在 pom.xml 文件中添加打包插件

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-shade-plugin</artifactId>
            <version>2.4.3</version>
            <executions>
                <execution>
                    <phase>package</phase>
                    <goals>
                        <goal>shade</goal>
                    </goals>
                    <configuration>
                        <transformers>
                            <transformer
                                    implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                                <manifestEntries>
                                  <!--指明包含 premain 方法的类名,否则打包出来的文件会找不到 MANIFEST.MF -->
                                    <Premain-Class>top.zhyee.helloagent.StartUp</Premain-Class>
                                </manifestEntries>
                            </transformer>
                        </transformers>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

添加好之后,运行 mvn package 打包即可,jar 文件默认存放在 target 目录下。

测试

接下来再新建一个 springboot 项目进行测试吧~

直接用 spring 脚手架新建一个 springboot 的 web 服务就可以了。注意,如果想要在 idea 中对探针进行 Debug 的话,探针应该与使用探针的项目放在同一目录下。

在项目的 VM Options 中添加 -javaagent:jarpath[=options],如

-javaagent:/Users/zhyee/projects/hello-agent/target/hello-agent-1.0-SNAPSHOT.jar

等号后面为参数,可选。可以填写多个 agent ,按执行顺序排列就好,需要注意的是,agent 要写在应用程序的 jar 之前。

运行可以得到如下日志

hello, i'am agent!

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::        (v2.1.6.RELEASE)

2019-07-11 15:28:17.715  INFO 36295 --- [           main] t.z.h.HelloAgentTestDemoApplication      : Starting HelloAgentTestDemoApplication on zhiyideMacBook-Pro-2.local with PID 36295 (/Users/zhiyiyan/projects/gitprojects/hello-agent-test-demo/target/classes started by zhiyiyan in /Users/zhiyiyan/projects/gitprojects/hello-agent)

agent 就成功运行啦~

补充

这里所写的 agent 只是一种启动方式,将会在 JVM 初始化时启动,启动完成后再执行应用程序本身的 main 方法。agent 也可以在 JVM 启动之后再执行,这里不做说明。

参考文档

java.lang.instrument (Java Platform SE 7 ) - Oracle Help Center

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,084评论 6 503
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,623评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,450评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,322评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,370评论 6 390
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,274评论 1 300
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,126评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,980评论 0 275
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,414评论 1 313
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,599评论 3 334
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,773评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,470评论 5 344
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,080评论 3 327
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,713评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,852评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,865评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,689评论 2 354

推荐阅读更多精彩内容