關(guān)于Java字節(jié)碼編程javassist的詳細(xì)介紹

猿友 2021-07-22 10:08:43 瀏覽數(shù) (8523)

反饋

本篇文章將和大家分享一下關(guān)于Java字節(jié)碼編程中一個(gè)非常之好用的技術(shù)javassist，下面將詳細(xì)為大家介紹一下javassist技術(shù)，以及具體實(shí)例代碼講解。

一、Javassist入門(mén)

（一）Javassist是什么

Javassist是可以動(dòng)態(tài)編輯Java字節(jié)碼的類(lèi)庫(kù)。它可以在Java程序運(yùn)行時(shí)定義一個(gè)新的類(lèi)，并加載到JVM中；還可以在JVM加載時(shí)修改一個(gè)類(lèi)文件。Javassist使用戶不必關(guān)心字節(jié)碼相關(guān)的規(guī)范也是可以編輯類(lèi)文件的。

（二）Javassist核心API

在Javassist中每個(gè)需要編輯的class都對(duì)應(yīng)一個(gè)CtCLass實(shí)例，CtClass的含義是編譯時(shí)的類(lèi)（compile time class），這些類(lèi)會(huì)存儲(chǔ)在Class Pool中（Class poll是一個(gè)存儲(chǔ)CtClass對(duì)象的容器）。
CtClass中的CtField和CtMethod分別對(duì)應(yīng)Java中的字段和方法。通過(guò)CtClass對(duì)象即可對(duì)類(lèi)新增字段和修改方法等操作了。

（三）簡(jiǎn)單示例

為了減少演示的復(fù)雜度，示例以及之后的操作，都在Maven項(xiàng)目下進(jìn)行，因?yàn)槲覀兛梢灾苯右胍蕾?lài)就可以達(dá)到我們導(dǎo)包的目的，很方便，不用再去下載jar包，然后自己手動(dòng)導(dǎo)入了。

1、創(chuàng)建一個(gè)maven項(xiàng)目

如果你使用的是IDEA，可以像我一樣；如果是其他工具，可以自行百度，或者按照自己的經(jīng)驗(yàn)來(lái)創(chuàng)建即可。

2、創(chuàng)建一個(gè)測(cè)試類(lèi)，代碼如下：

package com.ssdmbbl.javassist;

import javassist.*;

import java.io.IOException;
/**
 * @author zhenghui
 * @description: Javassist使用演示測(cè)試
 * @date 2021/4/6 6:38 下午
 */
public class JavassistTest {
    public static void main(String[] args) throws CannotCompileException, IOException {
        ClassPool cp = ClassPool.getDefault();
        CtClass ctClass = cp.makeClass("com.ssdmbbl.javassist.Hello");
        ctClass.writeFile("./");
    }
}

當(dāng)運(yùn)行這個(gè)代碼的時(shí)候，可以看到已經(jīng)在項(xiàng)目的根目錄下創(chuàng)建了一個(gè)“com.ssdmbbl.javassist”包，在這個(gè)包下創(chuàng)建了“Hello.java”的java文件。

內(nèi)容如下：

package com.ssdmbbl.javassist;

public class Hello {
    public Hello() {
    }
}

二、Javassist操作字節(jié)碼示例

回想一下，咱們?nèi)绻麑?duì)一個(gè)Java正常操作的話，大概存在哪些操作呢？

1、咱們會(huì)對(duì)一個(gè)類(lèi)添加字段；
2、咱們會(huì)對(duì)一個(gè)類(lèi)添加方法；

好像沒(méi)其他的了吧。其余的就是在方法里寫(xiě)代碼了唄。

（一）新增一個(gè)方法

咱們繼續(xù)套用上面簡(jiǎn)單示例的代碼，在此基礎(chǔ)之上進(jìn)行新增一個(gè)方法。

新增方法的名字為"hello1"，傳遞兩個(gè)參數(shù)分別為int和double類(lèi)型，并且沒(méi)有返回值。

package com.ssdmbbl.javassist;

import javassist.*;

import java.io.IOException;
import java.net.URL;

/**
 * @author zhenghui
 * @description: Javassist使用演示測(cè)試
 * @date 2021/4/6 6:38 下午
 */
public class JavassistTest2 {


    public static void main(String[] args) throws CannotCompileException, IOException {
		
        //找到本文件的路徑，與之保存在一起
        URL resource = JavassistTest2.class.getClassLoader().getResource("");
        String file = resource.getFile();
        System.out.println("文件存儲(chǔ)路徑："+file);

        ClassPool cp = ClassPool.getDefault();
        CtClass ctClass = cp.makeClass("com.ssdmbbl.javassist.Hello");

        //創(chuàng)建一個(gè)類(lèi)名為"hello"，傳遞參數(shù)的順序?yàn)?int,double)，沒(méi)有返回值的類(lèi)
        /*
        CtMethod（...）源代碼：
        public CtMethod(CtClass returnType,//這個(gè)方法的返回值類(lèi)型，
                        String mname, //（method name）方法的名字是什么
                        CtClass[] parameters, //方法傳入的參數(shù)類(lèi)型是什么
                        CtClass declaring //添加到哪個(gè)類(lèi)中
                        ) {....}
         */
        CtMethod ctMethod = new CtMethod(CtClass.voidType, "hello", new CtClass[]{CtClass.intType, CtClass.doubleType}, ctClass);
		//設(shè)置hello方法的權(quán)限為public
        ctMethod.setModifiers(Modifier.PUBLIC);
        
        //向ctClass中添加這個(gè)方法
        ctClass.addMethod(ctMethod);
        
        //寫(xiě)入本地
        ctClass.writeFile(file);
    }
}

執(zhí)行后，就可以查看生成的代碼了：

可以看到，我們并沒(méi)有指定參數(shù)的名字，也會(huì)給生成var1、var2依次類(lèi)推的名字。

var1和var2其實(shí)class變量表中存放的名字。

package com.ssdmbbl.javassist;

public class Hello {
    public void hello1(int var1, double var2) {
    }

    public Hello() {
    }
}

可以設(shè)置的返回值類(lèi)型：

public static CtClass booleanType;
public static CtClass charType;
public static CtClass byteType;
public static CtClass shortType;
public static CtClass intType;
public static CtClass longType;
public static CtClass floatType;
public static CtClass doubleType;
public static CtClass voidType;

（二）新增一個(gè)變量

URL resource = JavassistTest2.class.getClassLoader().getResource("");
String file = resource.getFile();
System.out.println("文件存儲(chǔ)路徑："+file);

ClassPool cp = ClassPool.getDefault();
CtClass ctClass = cp.makeClass("com.ssdmbbl.javassist.Hello");

//添加一個(gè)hello1的方法
CtMethod ctMethod = new CtMethod(CtClass.voidType, "hello1", new CtClass[]{CtClass.intType, CtClass.doubleType}, ctClass);
ctMethod.setModifiers(Modifier.PUBLIC);
ctClass.addMethod(ctMethod);

//添加一個(gè)int類(lèi)型的，名字為value的變量
CtField ctField = new CtField(CtClass.intType,"value",ctClass);
ctField.setModifiers(Modifier.PRIVATE);
ctClass.addField(ctField);


ctClass.writeFile(file);

那么執(zhí)行后的內(nèi)容就是如下了：

package com.ssdmbbl.javassist;

public class Hello {
    private int value;

    public void hello1(int var1, double var2) {
    }

    public Hello() {
    }
}

（三）給變量新增get和set方法

代碼修改如下：

   public static void main(String[] args) throws CannotCompileException, IOException {

        URL resource = JavassistTest2.class.getClassLoader().getResource("");
        String file = resource.getFile();
        System.out.println("文件存儲(chǔ)路徑："+file);

        ClassPool cp = ClassPool.getDefault();
        CtClass ctClass = cp.makeClass("com.ssdmbbl.javassist.Hello");

        //添加一個(gè)hello1的方法
        CtMethod ctMethod = new CtMethod(CtClass.voidType, "hello1", new CtClass[]{CtClass.intType, CtClass.doubleType}, ctClass);
        ctMethod.setModifiers(Modifier.PUBLIC);
        ctClass.addMethod(ctMethod);

        //添加一個(gè)int類(lèi)型的，名字為value的變量
        CtField ctField = new CtField(CtClass.intType,"value",ctClass);
        ctField.setModifiers(Modifier.PRIVATE);
        ctClass.addField(ctField);

        //為value變量添加set方法
        CtMethod setValue = new CtMethod(CtClass.voidType, "setValue", new CtClass[]{CtClass.intType}, ctClass);
        setValue.setModifiers(Modifier.PUBLIC);
        ctClass.addMethod(setValue);

        //為value變量添加get方法
        CtMethod getValue = new CtMethod(CtClass.intType, "getValue", new CtClass[]{}, ctClass);
        getValue.setModifiers(Modifier.PUBLIC);
        ctClass.addMethod(getValue);


        ctClass.writeFile(file);
    }

執(zhí)行效果：

package com.ssdmbbl.javassist;

public class Hello {
    private int value;

    public void hello1(int var1, double var2) {
    }

    public void setValue(int var1) {
    }

    public int getValue() {
    }

    public Hello() {
    }
}

（四）給方法內(nèi)部添加代碼

你是不是很好奇，set和get方法內(nèi)部并沒(méi)有代碼，當(dāng)程序運(yùn)行的時(shí)候，肯定會(huì)出錯(cuò)的。
下面就來(lái)看一下。

我們預(yù)想的結(jié)果：

    private int value;

    public void setValue(int var1) {
        this.value = var1
    }

    public int getValue() {
        return this.value;
    }

修改如下：

//為value變量添加set方法
CtMethod setValue = new CtMethod(CtClass.voidType, "setValue", new CtClass[]{CtClass.intType}, ctClass);
setValue.setModifiers(Modifier.PUBLIC);
//設(shè)置方法體
setValue.setBody("this.value = var1;");

ctClass.addMethod(setValue);

//為value變量添加get方法
CtMethod getValue = new CtMethod(CtClass.intType, "getValue", new CtClass[]{}, ctClass);
getValue.setModifiers(Modifier.PUBLIC);
//設(shè)置方法體
getValue.setBody("return this.value;");
ctClass.addMethod(getValue);

很倒霉，說(shuō)找不到這個(gè)var1這個(gè)變量

報(bào)錯(cuò)的堆棧信息如下：

Exception in thread "main" javassist.CannotCompileException: [source error] no such field: var1
at javassist.CtBehavior.setBody(CtBehavior.java:474)
at javassist.CtBehavior.setBody(CtBehavior.java:440)
at com.ssdmbbl.javassist.JavassistTest2.main(JavassistTest2.java:41)
Caused by: compile error: no such field: var1

這個(gè)原因我們前面其實(shí)提到了，因?yàn)樵诰幾g的時(shí)候，會(huì)把變量名抹掉，傳遞的參數(shù)會(huì)依次在局部變量表中的順序。

如果傳遞：

public void test(int a,int b,int c){
    ...
}

那么a,b,c就對(duì)應(yīng)本地變量表中的1,2,3的位置。

 —— ——
｜a｜1｜
｜b｜2｜
｜c(diǎn)｜3｜
 —— ——

那么我們獲取變量時(shí)就不能使用原始的名字了，在Javassist中訪問(wèn)方法中的參數(shù)使用的是$1, 2 , 2, 2,…，而不是直接使用原始的名字。

我們修改如下：

//為value變量添加set方法
CtMethod setValue = new CtMethod(CtClass.voidType, "setValue", new CtClass[]{CtClass.intType}, ctClass);
setValue.setModifiers(Modifier.PUBLIC);
//設(shè)置方法體
setValue.setBody("this.value = $1;");

ctClass.addMethod(setValue);

//為value變量添加get方法
CtMethod getValue = new CtMethod(CtClass.intType, "getValue", new CtClass[]{}, ctClass);
getValue.setModifiers(Modifier.PUBLIC);
//設(shè)置方法體
getValue.setBody("return this.value;");
ctClass.addMethod(getValue);

結(jié)果成功了：

public class Hello {
    private int value;

    public void hello1(int var1, double var2) {
    }

    public void setValue(int var1) {
        this.value = var1;
    }

    public int getValue() {
        return this.value;
    }

    public Hello() {
    }
}

再來(lái)一個(gè)：修改hello1方法體，使傳遞的兩個(gè)參數(shù)相加然后賦值給value；

//添加一個(gè)hello1的方法
CtMethod ctMethod = new CtMethod(CtClass.voidType, "hello1", new CtClass[]{CtClass.intType, CtClass.doubleType}, ctClass);
ctMethod.setModifiers(Modifier.PUBLIC);
ctMethod.setBody("this.value = $1 + $2;");
ctClass.addMethod(ctMethod);

執(zhí)行結(jié)果如下：

因?yàn)槲覀僾alue是int，$1是int，$2是double，所以做了強(qiáng)制轉(zhuǎn)型處理。

public void hello1(int var1, double var2) {
    this.value = (int)((double)var1 + var2);
}

（五）在方法體的前后分別插入代碼

測(cè)試代碼如下：

//添加一個(gè)hello1的方法
CtMethod ctMethod = new CtMethod(CtClass.voidType, "hello1", new CtClass[]{CtClass.intType, CtClass.doubleType}, ctClass);
ctMethod.setModifiers(Modifier.PUBLIC);
ctMethod.setBody("this.value = $1 + $2;");
ctMethod.insertBefore("System.out.println("我在前面插入了："+$1);");
ctMethod.insertAfter("System.out.println("我在最后插入了："+$1);");
ctClass.addMethod(ctMethod);

結(jié)果如下：

public void hello1(int var1, double var2) {
    System.out.println("我在前面插入了：" + var1);
    this.value = (int)((double)var1 + var2);
    Object var5 = null;
    System.out.println("我在最后插入了：" + var1);
}

三、Javassist中的一些特殊參數(shù)示例講解

在官方文檔中看到有幾個(gè)比較特殊的標(biāo)識(shí)符，還有幾個(gè)比較特殊的標(biāo)識(shí)符需要了解。

標(biāo)識(shí)符	作用
$0、$1、$2、 3 、 3、 3、…	this和方法參數(shù)（1-N是方法參數(shù)的順序）
$args	方法參數(shù)數(shù)組，類(lèi)型為Object[]
$$	所有方法參數(shù)，例如：m($$)相當(dāng)于m($1,$2,…)
$cflow(…)	control flow 變量
$r	返回結(jié)果的類(lèi)型，在強(qiáng)制轉(zhuǎn)換表達(dá)式中使用。
$w	包裝器類(lèi)型，在強(qiáng)制轉(zhuǎn)換表達(dá)式中使用。
$_	返回的結(jié)果值
$sig	類(lèi)型為java.lang.Class的參數(shù)類(lèi)型對(duì)象數(shù)組
$type	類(lèi)型為java.lang.Class的返回值類(lèi)型
$class	類(lèi)型為java.lang.Class的正在修改的類(lèi)

下面咱們來(lái)一起分別來(lái)看一下，分析一下，怎么用，有什么用吧。

只介紹幾個(gè)常見(jiàn)和常用到的吧。
有興趣的話，剩下的可以看官方文檔：http://www.javassist.org/tutorial/tutorial2.html

（一）$0,$1,$2,…

這個(gè)其實(shí)咱們已經(jīng)在上面用到過(guò)了，再來(lái)細(xì)說(shuō)一下吧。$0代表this，$1, 2 , 2, 2,…，依次對(duì)應(yīng)方法中參數(shù)的順序。
如果有：

public void test(int a,int b,int c){}

那么如果想引用a和b和c的話，需要這樣：

ctMethod.setBody("return $1 + $2 + $3;");

對(duì)了還有：靜態(tài)方法是沒(méi)有$0的，所以靜態(tài)方法下$0是不可用的。

（二）$args

$args變量表示所有參數(shù)的數(shù)組，它是一個(gè)Object類(lèi)型的數(shù)組（new Object[]{…}），如果參數(shù)中有原始類(lèi)型的參數(shù)，會(huì)被轉(zhuǎn)換成對(duì)應(yīng)的包裝類(lèi)型。比如原始數(shù)據(jù)類(lèi)型為int，則會(huì)被轉(zhuǎn)換成java.lang.Integer，然后存儲(chǔ)在args中。

例如我們測(cè)試代碼如下：

CtMethod ctMethod = new CtMethod(CtClass.voidType, "hello1", new CtClass[]{CtClass.intType, CtClass.doubleType}, ctClass);
ctMethod.setModifiers(Modifier.PUBLIC);
ctMethod.setBody("System.out.println($args);");

編譯后的結(jié)果如下：

public void hello1(int var1, double var2) {
    System.out.println(new Object[]{new Integer(var1), new Double(var2)});
}

（三）$$

變量是所有參數(shù) 的縮寫(xiě) ，參數(shù) 用逗號(hào) 分割，例如： m ( 是所有參數(shù)的縮寫(xiě)，參數(shù)用逗號(hào)分割，例如：m( 是所有參數(shù)的縮寫(xiě)，參數(shù)用逗號(hào)分割，例如：m()相當(dāng)于：m($1,$2,$3,…)。

如何使用呢？

我們經(jīng)常做一些代碼優(yōu)化，把較為復(fù)雜的方法內(nèi)部的邏輯，提煉出來(lái)，提煉到一個(gè)公共的方法里。

或者說(shuō)一個(gè)方法調(diào)用另一個(gè)方法，這兩個(gè)方法傳遞的參數(shù)是一樣的時(shí)候就用到了。

例如原java：

public Object m1(String name,String age){
	...省略10000行代碼邏輯
}

提煉后的：

提煉出來(lái)的代碼，我們也可以在其他地方使用（所謂的公共的代碼）。

public Object m1(String name,String age){
    ...省略20行代碼邏輯
    return m2(name,age);
}

private Object m2(String name,String age){
	...
}

那么我們就造一個(gè)這個(gè)場(chǎng)景來(lái)說(shuō)明一下用法吧。

簡(jiǎn)單點(diǎn)來(lái)說(shuō)，就是一個(gè)方法調(diào)用另一個(gè)方法，傳遞全參數(shù)時(shí)。

CtMethod hello2 = new CtMethod(CtClass.voidType, "hello2", new CtClass[]{CtClass.intType, CtClass.doubleType}, ctClass);
hello2.setModifiers(Modifier.PUBLIC);
hello2.setBody("this.value = $1 + $2;");
ctClass.addMethod(hello2);

//添加一個(gè)hello1的方法
CtMethod hello1 = new CtMethod(CtClass.voidType, "hello1", new CtClass[]{CtClass.intType, CtClass.doubleType}, ctClass);
hello1.setModifiers(Modifier.PUBLIC);
hello1.setBody("this.value = $1 + $2;");
hello1.insertAfter("hello2($$);");

可以看到我們hello1調(diào)用hello2時(shí)，需要傳遞全部參數(shù)。此時(shí)即可寫(xiě)成$$方法，當(dāng)然了也可以寫(xiě)成hello2($1,$2)。

編譯后的結(jié)果：

public void hello2(int var1, double var2) {
    this.value = (int)((double)var1 + var2);
}

public void hello1(int var1, double var2) {
    this.value = (int)((double)var1 + var2);
    Object var5 = null;
    this.hello2(var1, var2);
}

（四）$cflow(…)

$cflow 的全名為：control flow，這是一個(gè)只讀變量，返回指定方法遞歸調(diào)用的深度。

我們以計(jì)算n的斐波拉契數(shù)列為例，來(lái)演示一下如何使用。

我們正確的遞歸算法代碼如下：

public int f(int n){
	if(n <= 1){
    	return n;
    }
    return f(n-1) + f(n - 2)
 }

對(duì)于上面這段代碼，我們可以這樣寫(xiě)：

CtMethod f = new CtMethod(CtClass.intType,"f", new CtClass[]{CtClass.intType}, ctClass);
f.setBody("{if($1 <= 1){" +
          "     return $1;" +
          "}" +
          "return f($1 - 1) + f( $1 - 2);}");
f.setModifiers(Modifier.PUBLIC);

編譯后的：

public int f(int var1) {
    return var1 <= 1 ? var1 : this.f(var1 - 1) + this.f(var1 - 2);
}

那么我們只想在遞歸到前n次的時(shí)候打印log，我們?cè)撛趺醋瞿亍?/p>

例如，我們下面寫(xiě)的是"$cflow(f) == 1"時(shí)

CtMethod f = new CtMethod(CtClass.intType,"f", new CtClass[]{CtClass.intType}, ctClass);
f.setBody("{if($1 <= 1){" +
          "     return $1;" +
          "}" +
          "return f($1 - 1) + f( $1 - 2);}");
f.setModifiers(Modifier.PUBLIC);

//在代碼body的前面插入
f.useCflow("f");
f.insertBefore("if($cflow(f) == 1){" +
               "               System.out.println("我執(zhí)行了，此時(shí)的n是："+$1);" +
               "           }");

編譯后的代碼：

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

package com.ssdmbbl.javassist;

import javassist.runtime.Cflow;

public class Hello {
    public static Cflow _cflow$0 = new Cflow();

    public int f(int var1) {
        if (_cflow$0.value() == 1) {
            System.out.println("我執(zhí)行到來(lái)第2次，此時(shí)的n是：" + var1);
        }

        boolean var6 = false;

        int var10000;
        try {
            var6 = true;
            _cflow$0.enter();
            if (var1 <= 1) {
                var10000 = var1;
                var6 = false;
            } else {
                var10000 = this.f(var1 - 1) + this.f(var1 - 2);
                var6 = false;
            }
        } finally {
            if (var6) {
                boolean var3 = false;
                _cflow$0.exit();
            }
        }

        int var8 = var10000;
        _cflow$0.exit();
        return var8;
    }

    public Hello() {
    }
}

通過(guò)查看源碼，發(fā)先關(guān)鍵的一個(gè)地方是調(diào)用了Cflow對(duì)象的enter方法：

public static Cflow _cflow$0 = new Cflow();

...
    
    
_cflow$0.enter();

點(diǎn)進(jìn)enter()的內(nèi)部發(fā)現(xiàn)，調(diào)用了get().inc()方法：

public class Cflow extends ThreadLocal<Cflow.Depth> {
    protected static class Depth {
        private int depth;
        Depth() { depth = 0; }
        int value() { return depth; }
        void inc() { ++depth; }
        void dec() { --depth; }
    }

    @Override
    protected synchronized Depth initialValue() {
        return new Depth();
    }

    /**
     * Increments the counter.
     */
    public void enter() { get().inc(); }

    /**
     * Decrements the counter.
     */
    public void exit() { get().dec(); }

    /**
     * Returns the value of the counter.
     */
    public int value() { return get().value(); }
}

而inc()方法控制著一個(gè)全局變量的增加操作。

void inc() { ++depth; }

boolean var6 = false;相當(dāng)于是一個(gè)開(kāi)關(guān)，控制著是否開(kāi)始和結(jié)束。

當(dāng)參數(shù)var1<=1時(shí)，即結(jié)束

if (var1 <= 1) {
    var10000 = var1;
    var6 = false;
}

我們可以使用反射來(lái)驗(yàn)證一下，測(cè)試代碼如下：

package com.ssdmbbl.javassist;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;

/**
 * @author zhenghui
 * @description:
 * @date 2021/4/8 10:20 上午
 */
public class Test {

    public static void main(String[] args) throws ClassNotFoundException, NoSuchMethodException, IllegalAccessException, InstantiationException, InvocationTargetException {

        Class<?> aClass = Class.forName("com.ssdmbbl.javassist.Hello");

        //初始化這個(gè)類(lèi)
        Object obj = aClass.newInstance();

        //獲取所有的方法
        Method[] methods = aClass.getMethods();
        //遍歷所有的方法
        for (Method method : methods) {
            //當(dāng)方法為f的時(shí)候，進(jìn)行調(diào)用
            if(method.getName().equals("f")){
                //調(diào)用并傳遞參數(shù)為5，即f(5)
                method.invoke(obj,5);
            }
        }
    }
}

執(zhí)行的結(jié)果：

為什么是2次呢？原因上面也說(shuō)了：if(var1 <= 1){…}，所以是

我執(zhí)行了，此時(shí)的n是：4
我執(zhí)行了，此時(shí)的n是：3