Java字节码1-Agent简单上手

声明：原创文章，转载请注明出处。http://www.jianshu.com/p/3bbfa22ec7f5

Java字节码系列
Java字节码1-Agent简单上手
Java字节码2-instrument初体验
Java字节码3-使用ByteBuddy实现一个Java-Agent
Java字节码4-使用Java-Agent实现一个JVM监控工具
本系列代码可见：https://github.com/hawkingfoo/demo-agent

一、概述

Java Agent是从JDK1.5及以后引入的，其作用相当于你的main函数之前的一个拦截器，即在执行main函数前，先执行Agent中的代码。

Agent的代码与你的main方法在同一个JVM中运行，并被同一个类加载器所加载，被同一的安全策略 和上下文所管理。

二、简单上手写一个Agent

1、编写一个Java类，并包含如下两个方法中的任一个：

public static void premain(String agentArgs, Instrumentation inst);  //【1】
public static void premain(String agentArgs);  //【2】

其中，【1】和【2】同时存在时，【1】会优先被执行，而【2】则会被忽略。

具体使用如下代码：

import java.lang.instrument.Instrumentation;
public class MyAgent {
    public static void premain(String agentArgs, Instrumentation inst) {
        System.out.println("this is an agent.");
        System.out.println("args:" + agentArgs + "\n");
    }
}

2、jar打包

首先，需要在代码的resources目录下添加META-INF/MANIFEST.MF文件。其目的是指定Premain-Class的类。

Manifest-Version: 1.0
Premain-Class: agent.MyAgent
Can-Redefine-Classes: true

其次，在pom.xml中配置打包的相关配置。

    <packaging>jar</packaging>
    <build>
        <finalName>my-agent</finalName>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>2.3.2</version>
                <configuration>
                    <archive>
                        <index>true</index>
                        <manifestFile>
                            src/main/resources/META-INF/MANIFEST.MF
                        </manifestFile>
                        <manifest>
                            <addDefaultImplementationEntries/>
                        </manifest>
                    </archive>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.7</source>
                    <target>1.7</target>
                </configuration>
            </plugin>
    </plugins>
    </build>

最后，执行mvn clean package，就能生成一个my-agent.jar。

3、Agent运行

使用如下设置运行Agent。

-javaagent: 文件位置 [=参数]

备注：如果是运行多个agent，进行罗列即可。-javaagent: 文件位置 [=参数] -javaagent: 文件位置 [=参数]，其中的参数就是premain函数中的agentArgs。

三、Agent使用

首先，新建一个测试类。如下:

public class AgentTest {
    public static void main(String[] args) {
        System.out.println("this is main");
    }
}

命令行运行：java -javaagent: 文件位置 [=参数]
idea运行：如果是Idea中，按如下配置。

idea配置.png

运行结果如下：我这里重复加载了两次Agent，但是传入的参数不同。

this is an agent.
args:first

this is an agent.
args:second

this is main