Javassist 字節(jié)碼插樁

Javassist基礎(chǔ)

Javassist 使您可以檢查、編輯以及創(chuàng)建Java 二進制類糠排。Javassist 使用javassist.ClassPool 類跟蹤和控制所操作的類颂砸。這個類的工作方式是與JVM的 ClassLoader非常相似笼恰，但是有一個重要的區(qū)別是它不是將裝載的仑最、要執(zhí)行的類作為應(yīng)用程序的一部分連接辽话，ClassPool使所裝載的類可以通過 Javassist API 作為數(shù)據(jù)使用肄鸽。可以使用默認的 ClassPool油啤，獲取方式：ClassPool.default()典徘，它是從JVM搜索路徑中裝載的，也可以定義一個搜索您自己路徑列表的 ClassPool益咬，甚至可以直接從 字節(jié)數(shù)組 或流中裝載二進制類逮诲，以及從頭開始創(chuàng)建新類。

裝載到 ClassPool 的類由 javassist.CtClass 實例表示幽告。與標準的Java java.lang.Class類一樣梅鹦，CtClass提供了檢查類數(shù)據(jù)的方法，它還定義了在類中添加新字段冗锁、方法和構(gòu)造函數(shù)齐唆、以及改變類、父類和接口的方法蒿讥。但是 Javassist 沒有提供刪除一個類的字段蝶念、方法或者構(gòu)造函數(shù)的方法抛腕。

字段芋绸、方法和構(gòu)造函數(shù)分別由 javassist.CtField、javassist.CtMethod 和 javassist.CtConstructor 的實例表示担敌。這些類定義了修改由它們所表示的對象的所有的方法的方法摔敛，包括方法或者構(gòu)造函數(shù)中實際字節(jié)碼內(nèi)容。

所有字節(jié)碼的源代碼全封，Javassist 讓你可以完全替換一個方法或構(gòu)造函數(shù)的字節(jié)碼正文马昙，或者在正文的開始或者結(jié)束位置選擇性的添加字節(jié)碼。Javassist 方法將您提供的源代碼高效地編譯為Java字節(jié)碼刹悴，然后將它插入到目標方法或者構(gòu)造方法的正文中行楞。

Javassist 接受的源代碼與 Java 語言的并不完全一致，不過主要區(qū)別只是增加了一些特殊的標識符土匀，用于表示方法或者構(gòu)造函數(shù)參數(shù)子房、方法返回值 和其他在插入的代碼中可能用到的內(nèi)容。

對于在傳遞給 Javassist 的源代碼中可以做的事情有一些限制。第一項限制是使用的格式证杭，它必須是 單條語句或者塊田度。在大多數(shù)情況下這算不上是限制。下面是一個使用特殊Javassist標識符中表示前兩個參數(shù)的例子：

System.out.println("arg1: " + $1);
System.out.println("arg1: " + $2);

對于源代碼的一項更實質(zhì)性的限制是：不能引用在所添加的聲明或者塊外聲明的局部變量解愤。這意味著镇饺，在方法開始和結(jié)尾處都添加了代碼，那么一般不能將在開始處添加的代碼中的信息傳遞給結(jié)尾處添加的代碼送讲。

實踐：測量執(zhí)行一個方法所花費的時間

這在源代碼中可以很容易的完成奸笤，只要在方法開始時記錄當前時間、之后在方法結(jié)束時再次檢查當前時間并計算兩個值的差哼鬓。如果沒有源代碼揭保，那么這種計時信息就要困難的多。

我們定一個類 StrBuilder

package com.test.monitorMethodInvokeTime;
public class StrBuilder {

    public String buildString(int length){
        String result = "";
        for (int i = 0; i < length; i++){
            result += (char) (i%26 + 'a');
        }
        return result;
    }

}

接下來魄宏，監(jiān)測 buildString 方法的執(zhí)行所花費時間秸侣。

思路一：

//使用默認的ClassPoll，默認從JVM加載class路徑加載宠互，本項目使用IntelliJ味榛，編譯以后的文件在 out/production/路徑下
CtClass clas = ClassPool.getDefault().get("com.test.monitorMethodInvokeTime.StrBuilder");
CtMethod ctMethod = clas.getDeclaredMethod("buildString");

/**
  構(gòu)造body
*/
StringBuilder builder = new StringBuilder();
builder.append("{");
builder.append("long start = System.currentTimeMillis(); \n");
builder.append("String result = \"\"; \n");
builder.append(" for (int i = 0; i < $1; i++){  \n");
builder.append("  result += (char) (i%26 + 'a'); \n");
builder.append(" } \n");
builder.append("long end = System.currentTimeMillis();\n");
builder.append("System.out.println(\"耗時：\" + (end - start) + \"ms\");\n");
builder.append(" return result; \n");
builder.append("}");

ctMethod.setBody(builder.toString());

//寫回文件。我是用的 IntelliJ IDEA
clas.writeFile("/Users/jxf/workspace/Java/project/JavassistManual/out/production/JavassistManual/");

經(jīng)過這一段代碼之后予跌，我們來看一下生成的 class字節(jié)碼文件：

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//
package com.test.monitorMethodInvokeTime;

public class StrBuilder {
    public StrBuilder() {
    }

    public String buildString(int var1) {
        long var2 = System.currentTimeMillis();
        String var4 = "";

        for(int var5 = 0; var5 < var1; ++var5) {
            var4 = String.valueOf(var4).concat(String.valueOf((char)(var5 % 26 + 97)));
        }

        long var6 = System.currentTimeMillis();
        System.out.println("耗時：" + (var6 - var2) + "ms");
        return var4;
    }
}

查看生成的class字節(jié)碼搏色，已經(jīng)實現(xiàn)的方法執(zhí)行時間的監(jiān)控。

思路二：

使用方法代理來處理：

CtClass clas = ClassPool.getDefault().get("com.test.monitorMethodInvokeTime.StrBuilder");
String method = "buildString"
CtMethod ctMethod = clas.getDeclaredMethod(method);

//我們把實際方法進行一個重命名：buildString$impl
String nName = method + "$impl";
mOld.setName(nName);

//從 buildString$impl 復(fù)制出一個新的方法券册，新的方法名字叫：buildString
CtMethod mNew = CtNewMethod.copy(mOld, method, clas, null);

/**
構(gòu)建新方法的方法體
*/
String returnType = mOld.getReturnType().getName();
StringBuffer body = new StringBuffer();
body.append("{");
body.append("long start = System.currentTimeMillis(); \n");
if (!"void".equals(returnType)){
    body.append(returnType + " result = ");
}
body.append(nName + "($$);\n");  //$$ 代表把此方法的所有參數(shù)频轿，統(tǒng)統(tǒng)傳入下一個方法中。

body.append("long end = System.currentTimeMillis();\n");
body.append("System.out.println(\"耗時：\" + (end - start) + \"ms\");\n");

if(!"void".equals(returnType)){
    body.append("return result;\n");
}
body.append("}");
mNew.setBody(body.toString());

//把生成的方法添加到classs
clas.addMethod(mNew);

//寫回文件烁焙。我是用的 IntelliJ IDEA
clas.writeFile("/Users/jxf/workspace/Java/project/JavassistManual/out/production/JavassistManual/");

我們來看一下航邢，生成的字節(jié)碼：

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

package com.test.monitorMethodInvokeTime;

public class StrBuilder {
    public StrBuilder() {
    }

    public String buildString$impl(int length) {
        String result = "";

        for(int i = 0; i < length; ++i) {
            result = result + (char)(i % 26 + 97);
        }

        return result;
    }

    public String buildString(int var1) {
        long var2 = System.currentTimeMillis();
        String var4 = this.buildString$impl(var1);
        long var5 = System.currentTimeMillis();
        System.out.println("耗時：" + (var5 - var2) + "ms");
        return var4;
    }
}

實踐：創(chuàng)建一個全新的Class

假如創(chuàng)建一個如下的類：

package com.test;
public class Person {
    private String name = "Jack";
    public void setName(String var1) {
        this.name = var1;
    }
    public String getName() {
        return this.name;
    }
    public Person() {
        System.out.println(" constructor ");
    }
    public Person(String var1) {
        this.name = var1;
    }
    public void printName() {
        System.out.println(this.name);
    }
}

看一下 Javassist 的代碼：

        ClassPool pool =  ClassPool.getDefault();

        //1、創(chuàng)建一個空類
        CtClass cc = pool.makeClass("com.test.Person");

        //2骄蝇、增加一個字段 private String name;
        CtField ctField = new CtField(pool.get("java.lang.String"), "name", cc);
        //訪問級別 private
        ctField.setModifiers(Modifier.PRIVATE);
        // Person 添加 name屬性膳殷，并設(shè)置初始值：Jack
        cc.addField(ctField, CtField.Initializer.constant("Jack"));

        //3、生成 getter九火、setter 方法
        cc.addMethod(CtNewMethod.setter("setName", ctField));
        cc.addMethod(CtNewMethod.getter("getName", ctField));

        //4赚窃、添加無參構(gòu)造函數(shù)
        CtConstructor cons = new CtConstructor(new CtClass[]{}, cc);
        cons.setBody("{System.out.println(\" constructor \");}");
        cc.addConstructor(cons);

        //5、添加有參構(gòu)造函數(shù)
        cons = new CtConstructor(new CtClass[]{pool.get("java.lang.String")}, cc);
        // $0 == this $1岔激、$2勒极、$3 代表參數(shù)
        cons.setBody("{$0.name = $1;}");
        cc.addConstructor(cons);

        //6、創(chuàng)建一個名為 printName 方法
        CtMethod ctMethod = new CtMethod(CtClass.voidType, "printName", new CtClass[]{}, cc);
        ctMethod.setModifiers(Modifier.PUBLIC);
        ctMethod.setBody("{ System.out.println(name);}");
        cc.addMethod(ctMethod);

        //將創(chuàng)建的 CtClass 輸出到 文件
        cc.writeFile("/Users/jxf/workspace/Java/project/JavassistManual/out/production/JavassistManual/");
        //也可直接在內(nèi)存中生成Class類虑鼎，直接使用
        Class cls = cc.toClass();

至此辱匿，對于Javassist的常用做了一個實驗冀惭，其中還有一些其它的用法，就需要在日常使用中慢慢實踐掀鹅。

感謝：
https://www.ibm.com/developerworks/cn/java/j-dyn0429/index.html?ca=drs-
https://www.cnblogs.com/rickiyang/p/11336268.html