agent对应的java类 java agent技术

帮你学会使用Java agent

• 什么是Java agent
• Java agent的作用
• Java agent怎么用
• 谁使用了Java agent
• 代码示例(打印某个方法的执行时间)

• 创建agent项目

• 1.POM结构
• 2. 创建JavaAgent类，并添加premain方法
• 3.创建自己的Transformer，实现transform方法
• 4.通过maven打包

• 创建agent-demo项目

• 1.pom.xml
• 2.创建TimeTest类
• 3.创建主类Demo
• 4.在VM options添加启动参数，执行main方法

• 执行效果

什么是Java agent

JavaAgent 是JDK 1.5 以后引入的，也可以叫做Java代理。是一种可以动态修改 Java 字节码的技术。Java 类编译之后形成字节码被 JVM 执行，在 JVM 在执行这些字节码之前获取这些字节码信息，并且通过字节码转换器对这些字节码进行修改，来完成一些额外的功能。

Java agent的作用

• 在JVM加载字节码文件之前进行拦截，并且可以修改字节码
• 可以在运行期间修改已经加载过的字节码
• avaagent结合javassist功能更强大：可以创建类、方法、变量等。
  这实际上提供了一种虚拟机级别的 AOP 实现方式。通过以上方法就能实现对一些框架或是技术的采集点进行字节码修改，完成这些功能：对应用进行监控，对执行指定方法或是接口时额外添加操作（打印日志、打印方法执行时间、采集方法的入参和结果等）。

Java agent怎么用

启动java程序时添加“-javaagent”参数,跟上需要植入到代码里的jar包，做到代码无侵入的情况下增强代码、或者监控代码运行的能力。
注意：是大部分，不是所有。
如:

java -jar -javaagent:agent.jar -jar yourCode.jar

Java agent在加载你的字节码文件之前会先执行 premain 方法，大部分类加载都会通过该方法，遗漏的主要是系统类，很多系统类是优先于agent执行的，所有的用户类都会被agent拦截。

谁使用了Java agent

使用Skywalking的时候，并没有修改程序中任何一行 Java 代码，这里便使用到了Java Agent 技术。

我们平时用过的很多工具都是基于java Agent来实现的，例如：

• 热部署工具JRebel
• springboot的热部署插件
• 各种线上诊断工具（btrace, greys）
• 阿里开源的arthas等等

代码示例(打印某个方法的执行时间)

创建agent项目

项目结构

1.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">
    <parent>
        <artifactId>jvm-study</artifactId>
        <groupId>org.example</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>java-agent</artifactId>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>


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

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.5.1</version>
                <!-- 指定maven编译的jdk版本。若不指定,maven3默认用jdk 1.5 maven2默认用jdk1.3 -->
                <configuration>
                    <source>8</source>
                    <target>8</target>
                </configuration>
            </plugin>

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>3.2.0</version>
                <configuration>
                    <archive>
                        <!--自动添加META-INF/MANIFEST.MF -->
                        <manifest>
                            <addClasspath>true</addClasspath>
                        </manifest>
                        <manifestEntries>
                            <Menifest-Version>1.0</Menifest-Version>
                            <Premain-Class>com.hs.study.JavaAgent</Premain-Class>
                            <Can-Redefine-Classes>true</Can-Redefine-Classes>
                            <Can-Retransform-Classes>true</Can-Retransform-Classes>
                        </manifestEntries>
                    </archive>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

2. 创建JavaAgent类，并添加premain方法

package com.hs.study;

import java.lang.instrument.Instrumentation;

public class JavaAgent {

    /***
     * 在pom.xml中配置<Premain-Class>
     * 该方法就会在main方法之前运行
     * @param arg
     * @param instrumentation
     */
    public static void premain(String arg, Instrumentation instrumentation) {
        System.out.println("agent的premain(String arg, Instrumentation instrumentation)方法");
        instrumentation.addTransformer(new MyTransformer());
    }

}

注意：如果该类中没有premain(String arg, Instrumentation instrumentation)方法，jvm则会执行premain(String arg）方法

3.创建自己的Transformer，实现transform方法

package com.hs.study;

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

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

public class MyTransformer implements ClassFileTransformer {

    @Override
    public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer) {
        String realClassName = className.replaceAll("/", ".");

        if (realClassName.contains("com.hs.study")) {
            CtClass ctClass;
            try {
                ClassPool classPool = ClassPool.getDefault();
                ctClass = classPool.get(realClassName);
                CtMethod[] declaredMethods = ctClass.getDeclaredMethods();
                for (CtMethod declaredMethod : declaredMethods) {
                    declaredMethod.addLocalVariable("time", CtClass.longType);


                    declaredMethod.insertBefore("System.out.println(\"---------Before----------\");");
                    declaredMethod.insertBefore("time = System.currentTimeMillis();");

                    declaredMethod.insertAfter("System.out.println(\"---------after----------\");");
                    declaredMethod.insertAfter("System.out.println(System.currentTimeMillis() - time);");
                }

                return ctClass.toBytecode();
            } catch (Throwable e) {
                System.out.println(e.getMessage());
                e.printStackTrace();
            }
        }
        return classfileBuffer;
    }
}

4.通过maven打包

创建agent-demo项目

项目结构

1.pom.xml

<?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">
    <parent>
        <artifactId>jvm-study</artifactId>
        <groupId>org.example</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>agent-demo</artifactId>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

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

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.5.1</version>
                <!-- 指定maven编译的jdk版本。若不指定,maven3默认用jdk 1.5 maven2默认用jdk1.3 -->
                <configuration>
                    <source>8</source>
                    <target>8</target>
                </configuration>
            </plugin>

            <plugin>
                <artifactId>maven-assembly-plugin</artifactId>
                <configuration>
                    <archive>
                        <manifest>
                            <mainClass>com.hs.study.Demo</mainClass>
                        </manifest>
                    </archive>
                    <descriptorRefs>
                        <descriptorRef>jar-with-dependencies</descriptorRef>
                    </descriptorRefs>
                    <appendAssemblyId>false</appendAssemblyId>

                </configuration>

                <executions>
                    <execution>
                        <id>make-assembly</id>
                        <phase>package</phase>
                        <goals>
                            <goal>assembly</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

2.创建TimeTest类

package com.hs.study;

public class TimeTest {

    public void test() {
        System.out.println("开始执行TimeTest.test");
        System.out.println("sleep开始");
        try {
            Thread.sleep(1000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        System.out.println("sleep结束");
    }

    public void testAndTest() {
        System.out.println("开始执行TimeTest.testAndTest");
        System.out.println("sleep开始");
        try {
            Thread.sleep(1000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        System.out.println("sleep结束");
    }
}

3.创建主类Demo

package com.hs.study;

public class Demo {

    public static void main(String[] args) throws InterruptedException {
        System.out.println("主类main方法");
        TimeTest timeTest = new TimeTest();
        timeTest.test();
        timeTest.testAndTest();
    }
}

4.在VM options添加启动参数，执行main方法

-javaagent:D:\study-workspace\jvm-study\java-agent\target\java-agent-1.0-SNAPSHOT.jar

执行效果