Java Agent实例

2018-11-18 17:28:15

关于java agent,这里不做描述,相信网上已经有很多资料。
这篇文章主要记录两个个人实践的小栗子。

实现java agent有两种方式,premain和agentmain。

premain

premain通过java参数 javaagent 用于指定一个 jar 包,并且对该jar包有2个要求:

  • 这个 jar 包的MANIFEST.MF 文件必须指定 Premain-Class 项。
  • Premain-Class 指定的那个类必须实现 premain()方法。

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

1.首先,我们需要实现接口ClassFileTransformer,通过该接口我们可以修改类的字节码,从而修改类的行为。

为了方便修改字节码,我们使用了javassist

    <dependency>
      <groupId>org.javassist</groupId>
      <artifactId>javassist</artifactId>
      <version>3.22.0-GA</version>
    </dependency>

MyTransformer:

package com.binecy;

import javassist.ClassPool;
import javassist.CtClass;
import javassist.CtMethod;

import java.lang.instrument.ClassFileTransformer;
import java.lang.instrument.IllegalClassFormatException;
import java.security.ProtectionDomain;

public class MyTransformer implements ClassFileTransformer {
    private String targetClassName;
    private String targetMethodName;

    public MyTransformer(String targetClassName, String targetMethodName) {
        this.targetClassName = targetClassName;
        this.targetMethodName = targetMethodName;
    }

    public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined,
                            ProtectionDomain protectionDomain, byte[] classfileBuffer) throws IllegalClassFormatException {
        className = className.replace("/", ".");

        if (className.equals(targetClassName)) {
            try {
                // 得到类信息
                CtClass ctclass = ClassPool.getDefault().get(className);
                // 得到方法信息
                CtMethod ctmethod = ctclass.getDeclaredMethod(targetMethodName);
                // 修改方法实现
                ctmethod.insertAfter("System.out.println(\"hello Agent!\");");
                return ctclass.toBytecode();
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
        return null;
    }
}

2.编写Premain-Class类,绑定ClassFileTransformer。

package com.binecy;

import java.lang.instrument.Instrumentation;

public class MyPremain {
    public static void premain(String agentOps, Instrumentation inst) {
        String[] args = agentOps.split("&");
        // 绑定ClassFileTransformer
        inst.addTransformer(new MyTransformer(args[0], args[1]));
    }
}

javaagent使用时可以在jar路径后添加一个参数,agentOps正是该参数。

3.为了在jar中的MANIFEST.MF 文件指定 Premain-Class 项,pom中添加

  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <configuration>
          <source>1.8</source>
          <target>1.8</target>
          <encoding>utf-8</encoding>
        </configuration>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-shade-plugin</artifactId>
        <version>3.0.0</version>
        <executions>
          <execution>
            <phase>package</phase>
            <goals>
              <goal>shade</goal>
            </goals>
            <configuration>
              <transformers>
                <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                  <manifestEntries>
                    <Premain-Class>com.binecy.MyPremain</Premain-Class>
                  </manifestEntries>
                </transformer>
              </transformers>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>

4.打包

mvn clean package -Dmaven.test.skip=true

5.编写测试类

package com.binecy;

public class MyAgentTest {
    public static void main( String[] args ) throws InterruptedException {
        while (true) {
            hello();
            Thread.sleep(1000);
        }
    }

    public static void hello() {
        System.out.println("Hello World!");
    }
}

6.测试
java添加运行参数-javaagent:/home/binecy/code/myAgent/target/myAgent-1.0-SNAPSHOT.jar=com.binecy.MyAgentTest&hello

com.binecy.MyAgentTest&hello正是我们传递给Premain-Class类的参数。
com.binecy.MyAgentTest指定测试类
hello为测试方法

输出结果

Hello World!
hello Agent!
Hello World!
hello Agent!
...

Agentmain

Agentmain是JDK SE6的新特性,可以在java程序运行时,通过VirtualMachine 将jar包绑定到jvm进程中,动态地改变类的行为。
它对jar包也有2个要求:

  • 这个 jar 包的MANIFEST.MF 文件必须指定 Agent-Class 项。
  • Premain-Class 指定的那个类必须实现 agentmain()方法。

1.MyTransformer可以重复使用

2.编写Agent-Class

package com.binecy;

import java.lang.instrument.Instrumentation;
import java.lang.instrument.UnmodifiableClassException;

public class MyAgentmain {

    public static void agentmain(String agentOps, Instrumentation inst) throws UnmodifiableClassException {
        String[] args = agentOps.split("&");

        for(Class clazz : inst.getAllLoadedClasses()) {
            if(clazz.getName().equals(args[0])) {
                // 绑定ClassFileTransformer
                inst.addTransformer(new MyTransformer(args[0], args[1]), true);
                // 对已加载类重新转换处理
                inst.retransformClasses(clazz);
            }
        }
    }
}

调用retransformClasses,会对已加载类重新转换处理,需要在jar包的MANIFEST.MF 文件指定Can-Retransform-Classes项为true。

3.为了jar的MANIFEST.MF 文指定 Agent-Class ,Can-Retransform-Classes项, 将上面pom.xml中transformer修改为

                <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                  <manifestEntries>
                    <Agent-Class>com.binecy.MyAgentmain</Agent-Class>
                    <Can-Retransform-Classes>true</Can-Retransform-Classes>
                  </manifestEntries>
                </transformer>

4.重新打包

5.运行MyAgentTest,注意不要使用javaagent 参数了。
通过jps,获取该jvm进程的pid号7997
6.编写AgentmainAttach,将jar包绑定到jvm进程。

package com.binecy;

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.IOException;

public class AgentmainAttach {
    public static void main(String[] args) throws IOException, AttachNotSupportedException,
            AgentLoadException, AgentInitializationException {
        VirtualMachine vm = VirtualMachine.attach("7997");//7997是待绑定的jvm进程的pid号
        vm.loadAgent("target/myAgent-1.0-SNAPSHOT.jar", "com.binecy.MyAgentTest&hello");
    }
}

遇到错误java: 程序包com.sun.tools.attach不存在,pom.xml添加

    <dependency>
      <groupId>com.sun</groupId>
      <artifactId>tools</artifactId>
      <scope>system</scope>
      <systemPath>${JAVA_HOME}/lib/tools.jar</systemPath>
    </dependency>

7.运行AgentmainAttach,可以看到输出结果中多了
hello Agent!

ok,就这样。

扩展参考:
Java Agent的隔离实现以及卸载时一些坑