【Agent】尝试第一个 Agent

1  前言

JavaAgent是在JDK5之后提供的新特性，也可以叫java代理。开发者通过这种机制(Instrumentation)可以在加载class文件之前修改方法的字节码(此时字节码尚未加入JVM)，动态更改类方法实现AOP，提供监控服务如；方法调用时长、可用率、内存等。

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

本节初步怎么让java代码执行时可以进入我们的agent方法。

2  Java agent

2.1  Java agent 是什么

Java agent是java命令的一个参数，参数 javaagent 可以用于指定一个 jar 包。这个 jar 包的 MANIFEST.MF 文件必须指定 Premain-Class 项。

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

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

2.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.3  Java agent 尝试

使用 maven 创建一个简单工程：

pom.xml  里边的 agent 类换成你自己的，他里边的插件会自动给你生成 MANIFEST.MF

<properties>
    <!-- Build args -->
    <argline>-Xms512m -Xmx512m</argline>
    <project.build.sourceEncoding>utf-8</project.build.sourceEncoding>
<maven.test.skip>true</maven.test.skip>
</properties>
<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>com.kuku.MyAgent</Premain-Class>
                        <Agent-Class>com.kuku.MyAgent</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>

MyAgent.java

package com.kuku;

import java.lang.instrument.Instrumentation;

/**
 * @author: kuku
 * @description
 */
public class MyAgent {

    /**
     * JVM 首先尝试在代理类上调用以下方法
     * @param agentArgs
     * @param inst
     */
    public static void premain(String agentArgs, Instrumentation inst) {
        System.out.println("premain方法1" + agentArgs);
    }

    /**
     * 如果代理类没有实现上面的方法，那么 JVM 将尝试调用该方法
     * @param agentArgs
     */
    public static void premain(String agentArgs) {
        System.out.println("premain方法2" + agentArgs);
    }

}

我们打包：

然后找个简单的 java 程序，加上 agent 配置：

-javaagent:D:\JetBrains\yanjiu\kuku-agent\target\kuku-agent-1.0-SNAPSHOT.jar=1111

效果如下：

3  小结

一个最简单的 agent 的完成了，可以尝试下，下节我们看看一些高级功能的实现，有理解不对的地方欢迎指正哈。