Java Agent（一）Instrumention及启动时加载agent

本文主要是介绍Java Agent（一）Instrumention及启动时加载agent，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

引入

如何对一个方法进行类似于切面的修改呢？首先我们想到的是AOP面向切面编程，及其原理：代理技术。

Java中实现AOP的方式，可以大致分为静态AOP和动态AOP。
静态AOP：
在编译期就把切面逻辑加入到目标类中，在编译期直接改变了字节码，例如程序员的硬编码、AspectJ（非Spring AspectJ）。
动态AOP：
在运行期间实现的代理模式，方式有生成目标类的代理类、生成目标类的子类、修改目标类的字节码。
Spring中的AOP就属于动态AOP，它在实现上有两种方式：

JDK动态代理：通过反射实现，限制在于被代理的类必须实现一个接口。
GCLib动态代理：Code Generation Library，通过动态生成字节码作为目标类的子类，限制是被代理的类不能是final的。

上述两种方式，都是类被加载到JVM之后，把修改的字节码作为切面织入生成的子类/代理类中；
有另外一种方式，是在类被JVM加载之前，直接重写目标类的字节码，即Instrumentation。

简介

Instrumentation是Java5提供的新特性。使用Instrumentation，开发者可以构建一个代理，用来监测运行在JVM上的程序。

java.lang.instrument是基于JVMTI(JVM Tool Interface)的由JVM提供的本地接口集合，它使得开发者可以构建一个代理Java-Agent，用以协助运行在JVM上的程序；
其作用包括：

可以在加载 class 文件之前做拦截，对字节码做修改
可以在运行期对已加载类的字节码做变更
获取所有已经加载过的类、获取所有已经初始化过的类等

instrument两个核心API：ClassFileTransformer（类加载前的预处理类）和Instrumentation（增强器）

byte[] transform(ClassLoader loader,String className,Class<?> classBeingRedefined,ProtectionDomain protectionDomain, byte[] classfileBuffer)throws IllegalClassFormatException
//如果transform方法返回null, 表示我们不对类进行处理直接返回。否则，会用我们返回的byte[]来代替原来的类

在类字节码载入JVM前，JVM会调用ClassFileTransformer.transform方法，从而实现对类定义进行操作修改，实现AOP功能。相对于JDK 动态代理、CGLIB等AOP实现技术，不会生成新类，也不需要原类有接口。

    Instrumentation inst;ClassFileTransformer classFileTransformer;inst.addTransformer(classFileTransformer);
//ClassFileTransformer必须添加进Instrumentation才能生效

Instrument工作过程：

Agent可以在启动时加载，也可以在运行时动态被加载；在启动时通过配置-javaagent参数指定Agent jar的位置，传入jar包及args；而在运行时通过发送"load"命令给JVM，来加载agent。
调用MAINFEST.MF文件中Premain-Class或者Agent-Class指定的方法；
对于还没有被加载的类，在类加载时会调用我们自定义的ClassFileTransformer中的transform方法，实现字节码的替换；
对于已经被加载过的类，通过redefineClasses（重定义：直接返回新的byte）或者retransformClasses（重转换：读取原有字节码，并进行处理）方法重新触发我们自定义的ClassFileTransformer的转换。

Demo

一个小例子，以JVM启动时加载Agent的方式实现：

首先是创建一个Demo工程，用于作为测试类。

package com.example.javaagent.demo.controller;@RestController
@RequestMapping(value = "/demo")
public class Demo {@RequestMapping(value = "/test", method = RequestMethod.GET)public String test() {return "I am the test origin method!";}
}

创建另一个工程作为Java-agent，目的是打包为jar，以供Demo工程引用。

public class Agent {public static void premain(String args, Instrumentation ins) {System.out.printf("Pre-Main called , args : " + args);ins.addTransformer(new Transformer());}
}

public class Transformer implements ClassFileTransformer {@Overridepublic byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer) {if ("com/example/javaagent/demo/controller/Demo".equals(className)) {System.out.println("Find Demo.Class ! ");}return null;}
}

MANIFEST-MF:

Manifest-Version: 1.0
Premain-Class: com.demo.agent.Agent
Can-Redefine-Classes: true

运行
我们可以通过指定-javaagent=来指定agent的jar包位置。
运行Demo前配置参数VM options，agentJarPath为本地agent jar包位置，args为要传入的参数。

-javaagent:agentJarPath=args

运行结果：

Pre-Main called , args : testArg.   ____          _            __ _ _/\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \\\/  ___)| |_)| | | | | || (_| |  ) ) ) )'  |____| .__|_| |_|_| |_\__, | / / / /=========|_|==============|___/=/_/_/_/:: Spring Boot ::        (v2.2.6.RELEASE)2020-04-01 21:16:33.970  INFO 90174 --- [           main] c.e.javaagent.demo.DemoApplication       : ... ...
Find Demo.Class ! 
... ...

可见，Java-agent工程中的Pre-Main方法被调用，且Transformer类的transform方法被调用。

接下来是实现字节码的替换：

创建与Demo类的类名、方法名等全部一致的一个类，修改方法中的逻辑内容，然后对其编译得到class文件。其实此目的仅是为了得到class文件，也可直接对原class文件进行修改。

package com.example.javaagent.demo.controller;
@RestController
@RequestMapping(value = "/demo")
public class Demo {@RequestMapping(value = "/test", method = RequestMethod.GET)public String test() {return "I am the test transformed method!";}
}

修改Transformer类，新增的内容意义为：对名为com.example.javaagent.demo.controller.Demo的类进行字节码替换，其他类的字节码不变。其中的fileName为上一步我们得到的class文件路径。

public class Transformer implements ClassFileTransformer {@Overridepublic byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer) {if ("com/example/javaagent/demo/controller/Demo".equals(className)) {System.out.println("Find Demo.Class ! ");return getBytesFromFile("... .../Demo.class");}return null;}public static byte[] getBytesFromFile(String fileName) {File file = new File(fileName);Long filelength = file.length();byte[] filecontent = new byte[filelength.intValue()];try {FileInputStream in = new FileInputStream(file);in.read(filecontent);in.close();} catch (FileNotFoundException e) {e.printStackTrace();} catch (IOException e) {e.printStackTrace();}return filecontent;}
}