Java探针-javaagent由浅入深（二）

这篇文章主要介绍如何通过maven工具构建javaagent，实质原理相同，只是借助maven工具更符合工作中的应用场景，所以简单介绍下，同时将着重介绍一种在运行时引入javaagent的方法。

一、利用maven工具构建javaagent

1、创建maven项目

2、按照前文中的方法创建Agent类，并正确编写permain(String,Instrumentation)方法

3、编写maven项目的pom文件，引入maven-jar-plugin并正确配置打包参数

pom文件：

​

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>edu.haye</groupId>
    <artifactId>myagent</artifactId>
    <version>1.0-SNAPSHOT</version>

    <build>
        <plugins>
            <plugin>
<!--                引入maven-jar-plugin-->
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>2.6</version>
                <configuration>
                    <archive>
                        <manifestEntries>
<!--                            在这里的内容会写入之前提到的Manifest清单文件-->
                            <premain-class>edu.haye.agents.MyAgent</premain-class>
                        </manifestEntries>
                    </archive>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>8</source>
                    <target>8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

[点击并拖拽以移动]
​

 

4、使用 mvn clean package命令进行打包，最后会在target目录下生成满足javaagent要求的jar包。

二、运行时引入javaagent

运行时引入javaagent主要依赖于VirtualMachine对象，该对象可以引入两种不同形式的javaagent，这里我们先介绍一种声明为Agent-Class的javaagent，因为其形式与PremainClass类似。（如果你的项目中没有VirtualMachine类，则需要先引入JDK安装目录下的lib/tools.jar）

1、编写Agent-Class类，提供满足要求的回调方法

package edu.haye.agents;

import java.lang.instrument.Instrumentation;
import java.util.Arrays;

/**
 * @author haye
 * @date 10/11/19
 * @description:
 */
public class MyAgent {
    public static void  agentmain(String agentOps,Instrumentation inst){
        System.out.println("--------------agent->agentmain(String Instrumentation) is run------------");
    }
}

可以看到Agent-Class与Premain-Class的入口方法仅仅是名称不同，参数类型是完全一致的。

2、编写Manifest清单文件

与Permain-Class类似，我们也需要将Agent-Class属性写入到Manifest文件中，以此指明javaagent类，这里我们依然借助maven工具，编写pom文件：

            <plugin>
<!--                引入maven-jar-plugin-->
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>2.6</version>
                <configuration>
                    <archive>
                        <manifestEntries>
<!--                            在这里的内容会写入之前提到的Manifest清单文件-->
                            <agent-class>edu.haye.agents.MyAgent</agent-class>
                        </manifestEntries>
                    </archive>
                </configuration>
            </plugin>
            <plugin>

将之前的标签<premain-class>改为<agent-class>即可（我的类名是MyAgent）。

3、使用VirtualMachine.attach(String)静态方法获取VirtualMachine的实例对象

attach（String）方法中的参数为目标虚拟机的进程号，可根据实际需求获取，演示代码中使用如下方法进行获取：

        String pid=ManagementFactory.getRuntimeMXBean().getName().split("@")[0];

4、调用VirtualMachine实例的loadAgent（String）方法进行运行时引入

参数为javaagent的jar包路径，完整调用代码如下：

package edu.haye;

import com.sun.tools.attach.AgentInitializationException;
import com.sun.tools.attach.AgentLoadException;
import com.sun.tools.attach.AttachNotSupportedException;
import com.sun.tools.attach.VirtualMachine;

import java.io.File;
import java.io.IOException;
import java.lang.management.ManagementFactory;

/**
 * @author haye
 * @date 10/11/19
 * @description:
 */
public class Main {
    public static void main(String[] args) throws IOException, AttachNotSupportedException, AgentLoadException, AgentInitializationException {
        System.out.println("main method is run");
        String pid=ManagementFactory.getRuntimeMXBean().getName().split("@")[0];//获取当前虚拟机的pid
        VirtualMachine vm = VirtualMachine.attach(pid);//首先判断Jar文件是否存在
        if(new File("/home/haye/Dev/Code/java/myagent/target/myagent-1.0-SNAPSHOT.jar").exists()){
            vm.loadAgent("/home/haye/Dev/Code/java/myagent/target/myagent-1.0-SNAPSHOT.jar");
        }
    }
}

运行结果：

main method is run
--------------agent->agentmain(String Instrumentation) is run------------

Process finished with exit code 0

*注意事项

1、Manifest文件中需要包含Agent-Class属性，而不是之前的Permain-Class;

2、Permain-Class指定的类中要包含agentmain(String,Instrumentation)方法，而不是之前的premain(String,Instrumentation);

3、同一个类文件中可以同时包含agentmain(String,Instrumentation)和premain(String,Instrumentation)，如果Manifest中对两种加载方式都有配置，那么两者是可以共存的。

 

以上内容如有不当还请不吝赐教，下一篇将重点说明Instrumentation的用法。