java中agent使用

java中agent使用

一、简介

java agent是独立于应用程序外的代理程序，可以在应用程序启动前或运行中，修改类字节码信息，改变类的行为。这里对应用程序启动前和运行中的agent使用分别介绍。

二、应用程序启动前的agent使用

应用程序启动前agent使用，是通过在应用程序启动时添加-javaagent参数(可多个-javaagent参数)实现的。

2.1 javaagent参数格式

javaagent参数使用格式如下：

java -javaagent:/xx/agent.jar[=参数]  -jar xx.jar

2.2 开发步骤

应用程序启动前agent开发，包含agent程序开发、MENIFEST.MF配置文件定义、maven中maven-jar-plugin插件修改、打jar包、主程序调用，具体开发步骤如下：

1. 定义agent程序，需包含方法名为premain的静态方法，同时实现ClassFileTransformer接口对特定类字节码修改(结合javassist工具)；

2. 定义MENIFEST.MF配置文件，位于resources/META-INF目录下，内容类似：

   Manifest-Version: 1.0.1
   Premain-Class: com.dragon.study.spring_boot_pre_agent.PreAgentMain
   Can-Redefine-Classes: true
   
   

   其中Premain-Class为前面定义的agent类，且配置文件最要空一行。

3. 修改mava的pom.xml中的插件配置，类似于：

   <plugin>
       <groupId>org.apache.maven.plugins</groupId>
       <artifactId>maven-jar-plugin</artifactId>
       <version>3.2.0</version>
       <configuration>
           <archive>
               <manifest>
                   <addClasspath>true</addClasspath>
               </manifest>
               <manifestEntries>
                   <Premain-Class>
                       com.dragon.study.spring_boot_pre_agent.PreAgentMain
                   </Premain-Class>
               </manifestEntries>
           </archive>
       </configuration>
   </plugin>
   

4. 将前面定义的agent程序打成jar包；

5. 在目标主程序上，添加-javaagent参数及前面的agent的jar包，再运行目标主程序，类似于：

   java -javaagent:/xx/agent.jar=agentArgs  -cp /xx.jar xx.Main
   

2.3 示例

这是以spring_boot_pre_agent项目创建agent的jar包，以spring_boot_main项目中的PreAgentTargetMain为目标类为例。

2.3.1 agent项目spring_boot_pre_agent

2.3.1.1 agent项目中的maven依赖

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.3.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.dragon.study</groupId>
    <artifactId>spring_boot_pre_agent</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>spring_boot_pre_agent</name>
    <description>Demo project for Spring Boot</description>
    <packaging>jar</packaging>

    <properties>
        <java.version>1.8</java.version>
    </properties>

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

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>3.2.0</version>
                <configuration>
                    <archive>
                        <manifest>
                            <addClasspath>true</addClasspath>
                        </manifest>
                        <manifestEntries>
                            <Premain-Class>
                                com.dragon.study.spring_boot_pre_agent.PreAgentMain
                            </Premain-Class>
                        </manifestEntries>
                    </archive>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

2.3.1.2 agent项目中的agent相关类

这里agent相关类包含自定义字节码编辑类ConfigTransformer.java和agent主类PreAgentMain.java,如下：
ConfigTransformer.java类如下：

package com.dragon.study.spring_boot_pre_agent;
import javassist.ClassPool;
import javassist.CtClass;
import javassist.CtMethod;
import java.lang.instrument.ClassFileTransformer;
import java.lang.instrument.IllegalClassFormatException;
import java.security.ProtectionDomain