Java高级特性之Instrumentation

编程

不要说精通Java、Spring,能掌握70%就很不错了,其他的高级特性。。。

 

我们平常开发java程序时,总想开发一个代理程序监视记录类的运行情况,比如性能监控或运维人员很需要,比如调用业务方法时记录日志、计时等,除了AOP实现之外,还有一种实现,那就是基于java高级特性Instrumentation功能,

比如很多开源或商业公司也是基于此玩法,用开源的技术赚钱是我们一生的梦想!!!!!!!!!

Instrumentation简介

  • 利用java.lang.instrument(容器类) 做动态 Instrumentation(执行容器) 是 Java SE 5 的新特性。
  • 使用 Instrumentation,开发者可以构建一个独立于应用程序的代理程序(Agent),用来监测和协助运行在 JVM 上的程序,甚至能够替换和修改某些类的定义。
  • 这个功能为虚拟机监控提供了支撑。

利用 Java 代码,即 java.lang.instrument 做动态 Instrumentation 是 Java SE 5 的新特性,它把 Java 的 instrument 功能从本地代码中解放出来,使之可以用 Java 代码的方式解决问题。使用 Instrumentation,开发者可以构建一个独立于应用程序的代理程序(Agent),用来监测和协助运行在 JVM 上的程序,甚至能够替换和修改某些类的定义。有了这样的功能,开发者就可以实现更为灵活的运行时虚拟机监控和 Java 类操作了,这样的特性实际上提供了一种虚拟机级别支持的 AOP 实现方式,使得开发者无需对 JDK 做任何升级和改动,就可以实现某些 AOP 的功能了。

在 Java SE 6 里面,instrumentation 包被赋予了更强大的功能:启动后的 instrument、本地代码(native code)instrument,以及动态改变 classpath 等等。这些改变,意味着 Java 具有了更强的动态控制、解释能力,它使得 Java 语言变得更加灵活多变。

在 Java SE6 里面,最大的改变使运行时的 Instrumentation 成为可能。在 Java SE 5 中,Instrument 要求在运行前利用命令行参数或者系统参数来设置代理类,在实际的运行之中,虚拟机在初始化之时(在绝大多数的 Java 类库被载入之前),instrumentation 的设置已经启动,并在虚拟机中设置了回调函数,检测特定类的加载情况,并完成实际工作。但是在实际的很多的情况下,我们没有办法在虚拟机启动之时就为其设定代理,这样实际上限制了 instrument 的应用。而 Java SE 6 的新特性改变了这种情况,通过 Java Tool API 中的 attach 方式,我们可以很方便地在运行过程中动态地设置加载代理类,以达到 instrumentation 的目的。

另外,对 native 的 Instrumentation 也是 Java SE 6 的一个崭新的功能,这使以前无法完成的功能 —— 对 native 接口的 instrumentation 可以在 Java SE 6 中,通过一个或者一系列的 prefix 添加而得以完成。

最后,Java SE 6 里的 Instrumentation 也增加了动态添加 class path 的功能。所有这些新的功能,都使得 instrument 包的功能更加丰富,从而使 Java 语言本身更加强大。

Instrumentation 的基本功能和用法

“java.lang.instrument”包的具体实现,依赖于 JVMTI。JVMTI(Java Virtual Machine Tool Interface)是一套由 Java 虚拟机提供的,为 JVM 相关的工具提供的本地编程接口集合。JVMTI 是从 Java SE 5 开始引入,整合和取代了以前使用的 Java Virtual Machine Profiler Interface (JVMPI) 和 the Java Virtual Machine Debug Interface (JVMDI),而在 Java SE 6 中,JVMPI 和 JVMDI 已经消失了。JVMTI 提供了一套”代理”程序机制,可以支持第三方工具程序以代理的方式连接和访问 JVM,并利用 JVMTI 提供的丰富的编程接口,完成很多跟 JVM 相关的功能。事实上,java.lang.instrument 包的实现,也就是基于这种机制的:在 Instrumentation 的实现当中,存在一个 JVMTI 的代理程序,通过调用 JVMTI 当中 Java 类相关的函数来完成 Java 类的动态操作。除开 Instrumentation 功能外,JVMTI 还在虚拟机内存管理,线程控制,方法和变量操作等等方面提供了大量有价值的函数。

Instrumentation 的最大作用,就是类定义动态改变和操作。在 Java SE 5 及其后续版本当中,开发者可以在一个普通 Java 程序(带有 main 函数的 Java 类)运行时,通过 – javaagent参数指定一个特定的 jar 文件(包含 Instrumentation 代理)来启动 Instrumentation 的代理程序。

还记得吗,虽然我们噼里啪啦的写java代码,可到了JVM就只认识字节码

在 Java SE 5 当中,开发者可以让 Instrumentation 代理在 main 函数运行前执行。简要说来就是如下几个步骤:

  1. 编写 premain 函数

    编写一个 Java 类,包含如下两个方法当中的任何一个

    publicstaticvoidpremain(String agentArgs, Instrumentation inst); 【1

    publicstaticvoidpremain(String agentArgs); 【2

    其中,[1] 的优先级比 [2] 高,将会被优先执行([1] 和 [2] 同时存在时,[2] 被忽略)。

    在这个 premain 函数中,开发者可以进行对类的各种操作。

    agentArgs 是 premain 函数得到的程序参数,随同 “– javaagent”一起传入。与 main 函数不同的是,这个参数是一个字符串而不是一个字符串数组,如果程序参数有多个,程序将自行解析这个字符串。

    Inst 是一个 java.lang.instrument.Instrumentation 的实例,由 JVM 自动传入。java.lang.instrument.Instrumentation 是 instrument 包中定义的一个接口,也是这个包的核心部分,集中了其中几乎所有的功能方法,例如类定义的转换和操作等等。

  2. jar 文件打包

    将这个 Java 类打包成一个 jar 文件,并在其中的 manifest 属性当中加入” Premain-Class”来指定步骤 1 当中编写的那个带有 premain 的 Java 类。(可能还需要指定其他属性以开启更多功能)

  3. 运行

    用如下方式运行带有 Instrumentation 的 Java 程序:

    java -javaagent:jar文件的位置 [= 传入 premain 的参数, ]

    对 Java class类文件的操作,可以理解为对一个 byte 数组的操作(将类文件的二进制字节流读入一个 byte 数组)。开发者可以在“ClassFileTransformer”的 transform 方法当中得到,操作并最终返回一个类的定义(一个 byte 数组)。

 

下面我就演示下怎么监视类及类中方法

1.  到官网下载 第三方库 Java bytecode http://www.javassist.org/

2.  eclipse新建纯java项目Agent

先把步骤1下载好的jar包倒入java工程项目(如何导入我就不说了),然后新建包com.dongguangming.Agent,分别建立三个java文件:  CustomClassFileTransformer.java、CustomAgent.java、AgentTest.java(可选),具体代码如下

/**

* @author dgm

* @describe "具体拦截哪些类哪些方法"

*/

publicclassCustomClassFileTransformerimplementsClassFileTransformer{

publicbyte[] transform(ClassLoader loader, String className,

Class classBeingRedefined, ProtectionDomain protectionDomain,

byte[] classfileBuffer) throws IllegalClassFormatException {

byte[] byteCode = classfileBuffer;

if (className.equals("com/dongguangming/Agent/AgentTest")) {

System.err.println("被拦截的类是:"+className);

ClassPool classPool = ClassPool.getDefault();

try {

CtClass ctClass = classPool.makeClass(new ByteArrayInputStream(

classfileBuffer));

CtMethod[] methods = ctClass.getDeclaredMethods();

//System.err.println(methods);

for (CtMethod method : methods) {

System.err.println(method.getName());

if (method.getName().equals("print")) {

System.out.println("被拦截的方法是 : "

+ className+"."+method.getName());

method.insertAt(1,

"System.out.println("注入代码,打日志,计时等");");

}

}

byteCode = ctClass.toBytecode();

ctClass.detach();

} catch (Throwable e) {

e.printStackTrace();

}

}

return byteCode;

}

}

/**

* @author dgm

* @describe "自定义代理"

*/

publicclassCustomAgent{

publicstaticvoidpremain(String agentArgs, Instrumentation instrumentation){

System.out.println("开始代理 Agent");

CustomClassFileTransformer transformer = new CustomClassFileTransformer();

instrumentation.addTransformer(transformer);

}

}

/**

*测试样本

*/

publicclassAgentTest{

publicstaticvoidmain(String[] args){

AgentTest sm = new AgentTest();

System.out.println("准备进入测试阶段");

sm.print();

}

publicvoidprint(){

System.out.println("真正的业务方法");

}

}

 然后新建元配置文件MANIFEST.MF,内容如下

Manifest-Version: 1.0

Premain-Class: com.dongguangming.Agent.CustomAgent

Class-Path: lib/javassist-3.27.0-GA.jar

 至此项目基本代码已完工,工程结构是这样的

 注意Agent.jar是用eclipse手工配置生成的,实际看个人情况,比如命令行或通过maven构建工具也可以。

3.  测试

进入生成Agent.jar目录,然后执行

java -javaagent:Agent.jar com.dongguangming.Agent.AgentTest

普通输出:. 

执行方法计时

实际生产中比如用的spring全家桶开发,那么传的就是启动类 SpringBoot*了。

这太强大了,对于监控、运维人员来说,可以做到不用改动业务代码,实现零入侵的实现打点、统计、性能监控等。

没有做不到,只有你想不到,世上本没有路,走的人多了,便成了路

 

总结: 天外有太空,人外有人!!!

java博大精深,其它模块你可以不用,但并不代表它不存在!!!

 

参考:

0.  Interface Instrumentation  https://docs.oracle.com/javase/8/docs/api/java/lang/instrument/Instrumentation.html 

1. Javabyte code: https://www.ibm.com/developerworks/ibm/library/it-haggar_bytecode

2. Developing a jvm agent for bytecode  instrumentation with  javassist-pt1 (要fq) http://rafaeloltra.com/developing-a-jvm-agent-for-bytecode-instrumentation-with-javassist-pt1/

3.  Easily Create Java Agents with Byte Buddy  https://www.infoq.com/articles/Easily-Create-Java-Agents-with-ByteBuddy/

4.  Building a dynamic instrumentation agent for Java 

https://blog.sqreen.com/building-a-dynamic-instrumentation-agent-for-java/

5.  鲁迅说过:世上本没有路,走的人多了便也成了路 https://baijiahao.baidu.com/s?id=1661756653899046770

以上是 Java高级特性之Instrumentation 的全部内容, 来源链接: utcz.com/z/516919.html

回到顶部