开发工具
- 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 文件中添加打包插件
org.apache.maven.plugins
maven-shade-plugin
2.4.3
package
shade
top.zhyee.helloagent.StartUp
添加好之后,运行 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