Skywalking（11）： java agent原理

1 java agent原理

上文中我们知道，要使用Skywalking去监控服务，需要在其 VM 参数中添加 “-javaagent:/usr/local/skywalking/apache-skywalking-apm-bin/agent/skywalking-agent.jar"。这里就使用到了java agent技术。

1.1 Java agent 是什么？

Java agent是java命令的一个参数。参数 javaagent 可以用于指定一个 jar 包。

1. 这个 jar 包的 MANIFEST.MF 文件必须指定 Premain-Class 项。

2. Premain-Class 指定的那个类必须实现 premain() 方法。

当Java 虚拟机启动时，在执行 main 函数之前，JVM 会先运行 -javaagent 所指定 jar 包内 Premain-Class 这个类的 premain 方法。

1.2 如何使用java agent？

使用 java agent 需要几个步骤：

1. 定义一个 MANIFEST.MF 文件，必须包含 Premain-Class 选项，通常也会加入Can-Redefine-Classes 和 Can-Retransform-Classes 选项。

2. 创建一个Premain-Class 指定的类，类中包含 premain 方法，方法逻辑由用户自己确定。

3. 将 premain 的类和 MANIFEST.MF 文件打成 jar 包。

4. 使用参数 -javaagent: jar包路径启动要代理的方法。

2 搭建java agent工程

使用maven创建java_agent_demo工程：

在java文件夹下新建PreMainAgent类：

import net.bytebuddy.agent.builder.AgentBuilder;
import net.bytebuddy.description.method.MethodDescription;
import net.bytebuddy.description.type.TypeDescription;
import net.bytebuddy.dynamic.DynamicType;
import net.bytebuddy.implementation.MethodDelegation;
import net.bytebuddy.matcher.ElementMatchers;
import net.bytebuddy.utility.JavaModule;import java.lang.instrument.Instrumentation;public class PreMainAgent {/*** 在这个 premain 函数中，开发者可以进行对类的各种操作。* 1、agentArgs 是 premain 函数得到的程序参数，随同 “– javaagent”一起传入。与 main 函数不同的是，* 这个参数是一个字符串而不是一个字符串数组，如果程序参数有多个，程序将自行解析这个字符串。* 2、Inst 是一个 java.lang.instrument.Instrumentation 的实例，由 JVM 自动传入。** java.lang.instrument.Instrumentation 是 instrument 包中定义的一个接口，也是这个包的核心部分，* 集中了其中几乎所有的功能方法，例如类定义的转换和操作等等。* @param agentArgs* @param inst*/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*/public static void premain(String agentArgs) {System.out.println("=========premain方法执行2========");System.out.println(agentArgs);}}

注意：

1、类中提供两个静态方法，方法名均为premain，不能拼错。

2、如果不存在 premain(String agentArgs, Instrumentation inst)，则会执行 premain(String agentArgs)

在pom文件中添加打包插件：

<build><plugins><plugin><artifactId>maven-assembly-plugin</artifactId><configuration><appendAssemblyId>false</appendAssemblyId><descriptorRefs><descriptorRef>jar-with-dependencies</descriptorRef></descriptorRefs><archive><!--自动添加META-INF/MANIFEST.MF --><manifest><addClasspath>true</addClasspath></manifest><manifestEntries><Premain-Class>PreMainAgent</Premain-Class><Agent-Class>PreMainAgent</Agent-Class><Can-Redefine-Classes>true</Can-Redefine-Classes><Can-Retransform-Classes>true</Can-Retransform-Classes></manifestEntries></archive></configuration><executions><execution><id>make-assembly</id><phase>package</phase><goals><goal>single</goal></goals></execution></executions></plugin></plugins></build>

该插件会在自动生成META-INF/MANIFEST.MF文件时，帮我们添加agent相关的配置信息。

使用maven的package命令进行打包：

打包成功之后，复制打包出来的jar包地址。

3 搭建主工程

使用maven创建java_agent_user工程：

Main类代码：

package com.agent;public class Main {public static void main(String[] args) {System.out.println("Hello World");}
}

先运行一次，然后点击编辑MAIN启动类：

在VM options中添加代码：

代码为：

-javaagent:路径\java-agent-demo-1.0-SNAPSHOT.jar=test

启动时加载javaagent，指向上一节中编译出来的java agent工程jar包地址，同时在最后追加参数

HELLOAGENT。

运行MAIN方法，查看结果:

可以看到java agent的代码优先于MAIN函数的方法运行，证明java agent运行正常。