ClassWorking技术

ClassWorking技术

IBM所提出的，动态地监测、修改运行时JVM中的Java字节码文件，从而在充分挖掘应用程序的动态性时，又不会像使用反射那样大大降低系统的性能，Class Working使得静态编码的代码性能与反射的灵活性得以结合。

在ClassWorking中，Java Class文件只不过是一种数据结构而已，通过编写程序或者使用相关的开源项目来对Class文件修改。

ClassWorking，虽然IBM给出的定义中看，更加偏向于对Java类字节码进行修改这个方面，但是由于修改字节码文件一般都是进行运行时的修改，（如果是静态修改的话，那我就直接修改源码然后编译运行就好了）修改往往涉及着Java Instrumentation的相关原理，因此我将Java Instrumentation也纳入ClassWorking的范畴之内。在本节中，给出ClassWorking的大致介绍，由于主要的精力在Starfish和Nutch中，因此也仅仅是一个大致的介绍。

1.1. Java Instrumentation

Java Instrumentation是JDK5.0以来诞生的新技术，JDK5.0中，Java Instrumentation更倾向于作为一种新技术而进行出现，而在JDK6.0中，Java Instrumentation才真正的成熟和实用起来。

java Instrumentation是指可以用独立于应用程序之外的代理（agent）程序来监测和协助运行在JVM上的应用程序。这种监测和协助包括但不限于获取JVM运行时状态，替换和修改类定义等。

使用 Instrumentation，开发者可以构建一个独立于应用程序的代理程序（Agent），用来监测和协助运行在 JVM 上的程序，甚至能够替换和修改某些类的定义。有了这样的功能，开发者就可以实现更为灵活的运行时虚拟机监控和 Java 类操作了，这样的特性实际上提供了一种虚拟机级别支持的 AOP 实现方式，使得开发者无需对 JDK 做任何升级和改动，就可以实现某些 AOP 的功能了。

在 Java SE 6 里面，instrumentation 包被赋予了更强大的功能：启动后的 instrument、本地代码（native code）instrument，以及动态改变 classpath 等等。

1.1.1. 接口和类的介绍

Java Instrumentation的主要内容都包含在包java.lang.instrument之中。总共只有两个接口和一个类

接口ClassFileTransfomer，主要用于类的转换，规定了用户应该是实现的转换函数byte[] transform()。转换完的类是二进制数据，从byte[]数组看出。

1.1.2. Java Instrumentation实例

给出一个使用到Java Instrumentation的例子，来更加真切地体会一下Java的动态性，在这个例子中，我们将在运行时修改类TransClass的字节码，修改的方法是将它替换成另外一个类的字节码，从而动态改变JVM中已经加载好的类：

l 准备工作

首先编写一个要被Instrumentation的类，这个类非常的简单：

public class TransClass {

public int getNumber() {

return 1;

    }

}

这个类拥有一个getNumber()函数，然后调用返回一个固定值1。接下来写一个main函数来进行测试：

public class TestMainInJar {

    public static void main(String[] args) {

        System.out.println(new TransClass().getNumber());

    }

}

Main函数将TransClass类的信息打印了出来，函数的运行结果肯定显示的是1。然后再编写一个类，这个类和TransClass基本相同，唯一不同的地方就是函数的返回值：

public class TransClass2 {

public int getNumber() {

return 2;

    }

} 

返回值变成了2，因此把类名也修改成了TransClass2。

l 代码编写，实现Instrument包中的相应接口

为了能够进行动态替换，需要按照Instrumentation中的API进行代码的编写工作。要实现接口ClassFileTransformer，以及其中的函数byte[] transform()函数：

class Transformer implements ClassFileTransformer {

    public static final String classNumberReturns2 = "TransClass2.class";

    public static byte[] getBytesFromFile(String fileName) {

        try {

            // precondition

            File file = new File(fileName);

            InputStream is = new FileInputStream(file);

            long length = file.length();

            byte[] bytes = new byte[(int) length];


            // Read in the bytes

            int offset = 0;

            int numRead = 0;

            while (offset <bytes.length

                    && (numRead = is.read(bytes, offset, bytes.length - offset)) >= 0) {

                offset += numRead;

            }


            if (offset < bytes.length) {

                throw new IOException("Could not completely read file "

                        + file.getName());

            }

            is.close();

            return bytes;

        } catch (Exception e) {

            System.out.println("error occurs in _ClassTransformer!"

                    + e.getClass().getName());

            return null;

        }

    }


    public byte[] transform(ClassLoader l, String className, Class<?> c,

            ProtectionDomain pd, byte[] b) throws IllegalClassFormatException {

        if (!className.equals("TransClass")) {

            return null;

        }

        return getBytesFromFile(classNumberReturns2);

    }

}

现在对我们示例代码中的关键部分进行解析：Transformer实现了接口ClassFileTransformer及接口函数byte[] transform()。函数transform()传入参数包括该类的类加载器，类名，原字节码字节流等，返回被转换后的字节码字节流。也就是这个函数完成了类的转换。在此类中，我们的transform()判断被传入的类名，如果类名为“TransClass”则执行相应类的修改操作。

而函数getBytesFromFile()完成了实际的类的修改工作：读入TransClass2类的class文件的字节流，然后再替换掉TransClass类的class文件。从而体现了Java的动态性。

最后编写一个premain函数(函数名是固定的)，完成Instrumentation的收尾工作。

public class Premain {

    public static void premain(String agentArgs， Instrumentation inst)

            throws ClassNotFoundException， UnmodifiableClas***ception {

        inst.addTransformer(new Transformer());

    }

}

l 打包与运行

将所有的东西打到一个Jar包里面，并修改MANIFEST.MF文件：

Manifest-Version: 1.0

Premain-Class: Premain

最后运行java命令，设置agent代理即可：

java –javaagent:TestInstrument1.jar  TestMainInJar

运行代码之后，控制台将输出2。

1.1.3. Java Instrumentation的其他方式

刚才给出的示例是在Java 5 中Instrumentation的方式，在Java 6中，这种特性被大大的加强了。用户进行Instrumentation的时候可以不用在程序运行的开始就指定agent的jar包，而是在程序运行的时候动态指定：

java attach.Test 33902

attach.Test即我们的Instrument类，用于动态监测和修改其他的类，而33902是我们Instrumentation的目标类的运行时的PID，这里就不再介绍细节了。

1.1.4. Java Instrumentation的缺陷

从上面的介绍和实例可以看出，Java Instrumentation在动态性来说实在是非常的强大，但是有一个比较大的缺陷就是对于修改Java字节码文件方面的弱点：由于我们对底层的Class文件不了解，因此修改起来就十分的困难，在刚才的实例中，我们对于TransClass的修改仅仅是通过替换方式。

1.2. 字节码修改

虽说单纯的JDK API中没有很好的字节码修改的接口函数等功能的提供，但是目前来说，已经存在很多的开源的字节码修改工具和项目了。包括BCEL、ASM、Javassist、CGLIB等开源工具。这些工具的具体的使用方法和细节都没有去了解，因为太过于复杂而且和项目的关系不是很大，因此这里给出一个简单的列表，大致展示每种开源的字节码框架的特点：

表2.1几种流行的字节码修改框架

框架名称
Class修改视角
性能

BCEL
字节码
很差

ASM
访问模式+字节码
最好

Javassist
源代码
稍差

CGLIB
封装了ASM
未知


上表可以看出，给出了几种不同的修改Class视角的方式，源代码层级的修改更加容易，用户就像修改源代码一样进行相应的修改即可。而字节码层面的修改方式则比较的晦涩难懂，用户需要对JVM的底层有一些了解才行。（例如apache的BCEL，在介绍使用BCEL之前，花费了大量的篇章讲述了JVM的底层的简化知识，就是为了使得用户便于使用）而其余的一些开源项目则是在字节码的层面上进行了相应的封装，就是为了便于使用。

1.3. BTrace

BTrace可以说是ClassWorking的一个非常好的开源的软件。它并不像其他字节码修改工具那样，只是单纯进行Class文件的修改，而是结合了Java Instrumentation，使得开发人员可以使用BTrace作为一个工具对代码进行相应的调试。

1.3.1. BTrace的功能结构

有一个BTrace的比较好的公式：

BTrace脚本解析引擎 + Objectweb ASM + JDK6 Instumentation

可以看出BTrace主要由三大部分组成。三大部分各司其职，从用户编程接口到字节码修改的修改再到Java Instrumentation动态监测和修改程序，形成一个完整的机体。

l BTrace脚本解析引擎

这一部分主要面向用户进行编程使用，将用户编写的BTrace进行解析，变成ASM使用的代码，有点像高级语言编译的意味。用户使用BTrace脚本进行编程就变得非常容易了，远远不像BCEL、ASM那样来得麻烦。

用户使用BTrace脚本利用到了Java注解编程的相关技术例如：

@BTrace

public class HelloWorld {

    @OnMethod(

        clazz="java.lang.Thread",

        method="start"

    )



    public static void func() {

        println("about to start a thread!");

    }

}

@OnMethod告诉Btrace解析引擎需要代理的类和方法。这个例子的作用是当java.lang.Thread类的任意一个对象调用 start 方法后，会调用 func 方法。

l ASM修改字节码文件

解析完脚本后，Btrace会使用ASM将脚本里标注的类java.lang.Thread的字节码重写，植入跟踪代码或新的逻辑。在上面那个例子中，Java.lang.Thread这个类的字节码被重写了。并在start方法体尾部植入了 func 方法的调用。ASM的使用，由于比较困难，就不再进行介绍了。

l Java Instrumentation动态性

ASM修改字节码的代码逻辑则被放到了Java Instrumentation中函数transform()中，来完成对特定类的字节码的修改。

这样在软件具体的运行时，可以这样：

Btrace 1234 HelloWorld.java

来对pid为1234的JVM进程进行Instrumentation，体现ClassWorking的完整的精髓。

1.3.2. BTrace的学习难度

可以看出BTrace确实是一个比较强大的工具，但是当前BTrace还是有一些问题的，主要的问题就是BTrace的相关资料实在是太少了。官方给出的资料也只是一些BTrace的示例程序，官网给出的BTrace的源码地址也下载不下来。互联网上搜索BTrace的教程之类的技术帖也讲述的比较浅显，因此目前对于BTrace的了解也非常浅显，希望以后可以努力加强这方面的工作。