javassist编程指南==ClassPool 类池

迷南。 2021-12-04 03:03 696阅读 0赞

# ClassPool 类池 #

一个`ClassPool`对象是包含`CtClass`对象的容器。一旦一个`CtClass`对象被创建后，就会被记录到一个`ClassPool`中。这是因为编译器在编译源码时会引用代表`CtClass`的类，可能会访问`CtClass`对象。

比如，假设一个新的方法`getter()`被添加到一个代表`Point`类的`CtClass`对象中。之后，程序尝试编译`Point`中包含调用`getter()`方法的源代码，并且使用编译后的代码作为方法的方法体，将其添加到另一个类`Line`中。如果代表`Point`的`CtClass`对象丢失了，编译器则不能编译`Line`中调用`getter()`的方法。注意：原来定义的类是不包含`getter()`方法的。因此，为了正确编译这样的方法调用，`ClassPool`必须包含程序执行时所有的`CtClass`实例。

## 避免内存不足 ##

如果对象存在惊人大量的`CtClass`，`ClassPool`的这种规范则可能会引起极大的内存消耗（这其实很少会发生，因为javassist会以各种方式降低内存开销：冻结calss等方式）。为了避免这种问题，你需要从`ClassPool`中明确移除不必要的`CtClass`对象。

可以调用`CtClass`的`detach()`方法，然后会将该对象从`ClassPool`中移除：

ClassPool classPool = ClassPool.getDefault();
    CtClass cc = classPool.get("org.byron4j.cookbook.javaagent.Javassist2ClassPool");
    
    // 调用该方法后，会将CtClass对象从ClassPool中移除
    cc.detach();

调用`CtClass.detach()`方法后，你不应该再继续调用这个ctClass对象的其他方法了。可是，你可以调用`ClassPool.get()`方法会重新读取class文件构造一个表示相同的类的ctClass对象。

另一方案是,偶尔使用一个新的classPool代替旧的classPool。如果旧的classPool被gc了，包含在其中的ctClass也会被gc掉。

ClassPool cp = new ClassPool(true)

## 级联ClassPool ##

***如果程序运行在一个web应用中***,是有必要创建`ClassPool`的多实例的。每一个类加载器应该只创建一个ClassPool对象。此时程序不应该使用`getDefault()`方法而是使用ClassPool的构造方法。

多个ClassPool对象可以像`java.lang.ClassLoader`一样级联：

// 级联ClassPool
    ClassPool parent = ClassPool.getDefault();
    ClassPool child = new ClassPool(parent);
    child.insertClassPath("./classes");

如果调用了`child.get()`方法，child首先委托父ClassPool，如果父ClassPool加载class文件失败，然后child再尝试从`./classes/`目录下查找类文件。

如果`child.childFirstLookup`设置为true，则child尝试在委托给父classPool之前去加载class文件：

// child classpool在委托之前加载类文件
    ClassPool parent2 = ClassPool.getDefault();
    ClassPool child2 = new ClassPool(parent2);
    child2.appendSystemPath();         // 和默认同样的class查找路径
    child2.childFirstLookup = true;    // 改变child的行为

## 更改类名以定义新类 ##

一个新的class可以被定义为一个已存在的类的副本。

// 首先获取表示Point类的一个CtClass对象
    // 然后调用setName修改类名
    ClassPool pool3 = ClassPool.getDefault();
    CtClass cc3 = pool3.get("org.byron4j.cookbook.javaagent.Point");
    cc3.setName("Pair");

这个程序首先包含类Point的ctClass对象，然后调用`setName()`方法为CtClass对象设置新的名称。在这个调用之后，所有由该CtClass对象定义的所有类名展示均由Point变更为Pair，类定义的其他部分则不会变更。

注意： `CtClass.setName()`方法改变了ClassPool中记录的对象。从实现的角度来看，一个ClassPool对象是CtClass对象的哈希表形式。`setName`会改变CtClass对象在哈希表中关联的key，key值从原来的类名变更为新的设置后的类名。  
因此，如果后面再调用`get("Point")`方法的话，不会再返回变量cc3引用的CtClass对象了，ClassPool对象会再次读取class文件Point.class并且为Point类构造一个新的CtClass对象，这是因为ClassPool对象中关联Point的key不存在了：

ClassPool pool = ClassPool.getDefault();
    CtClass ctClass = pool.get("org.byron4j.cookbook.javaagent.Point");
    CtClass ctClass1 = pool.get("org.byron4j.cookbook.javaagent.Point");
    ctClass.setName("Pair");
    CtClass ctClass2 = pool.get("Pair");
    CtClass ctClass3 = pool.get("org.byron4j.cookbook.javaagent.Point");
    System.out.println(ctClass == ctClass2);  // true;
    System.out.println(ctClass3 == ctClass2); // false;

> `ClassPool`对象用于维护类和CtClass的一对一映射关系。javassist不允许两个不一样的CtClass表示同一个class，除非是两个独立的ClassPool创建的。

为了创建一个默认ClassPool实例(Clas.getDefault()返回的)的一个副本，可以使用以下代码片段：

ClassPool cp = new ClassPool(true);

这样一来，你拥有了两个ClassPool对象，可以从每一个ClassPool提供不同的CtClass对象表示同一个类。

ClassPool pool10 = ClassPool.getDefault();
    CtClass ctClass10 = pool10.get("org.byron4j.cookbook.javaagent.Point");
    ClassPool pool20 = new ClassPool(true);
    CtClass ctClass20 = pool20.get("org.byron4j.cookbook.javaagent.Point");
    System.out.println(pool10 == pool20);   // false 不同的ClassPool中表示同一个类的CtClass对象

## 通过重命名一个冻结的CtClass来创建一个新的CtClass对象 ##

一旦一个CtClass对象已经被writeFile()或者toBytecode()方法转到class文件，Javassist拒绝进一步修改该CtClass对象。因此，如果代表Point类的CtClass对象冻结后不能通过setName()修改它的名称。

ClassPool pool30 = ClassPool.getDefault();
    CtClass ctClass30 = pool30.get("org.byron4j.cookbook.javaagent.Point");
    ctClass30.writeFile();// 被冻结
    ctClass30.setName("Pair");// 错误

为了打破这个约束，可以使用ClassPool的`getAndRename()`方法：

ClassPool pool30 = ClassPool.getDefault();
    CtClass ctClass30 = pool30.get("org.byron4j.cookbook.javaagent.Point");
    ctClass30.writeFile();// 被冻结
    //ctClass30.setName("Pair");// 冻结后不能使用--错误
    pool30.getAndRename("org.byron4j.cookbook.javaagent.Point", "Pair");

因为如果getAndRename方法被调用了，ClassPool首先读取Point.class文件来创建一个新的CtClass对象，会在记录到ClassPool的哈希表之前将Point变更为Pair。  
getAndRename方法的源码：

public CtClass getAndRename(String orgName, String newName)
            throws NotFoundException
    { 
        // 获取一个新的CtClass对象
        CtClass clazz = get0(orgName, false);
        if (clazz == null)
            throw new NotFoundException(orgName);
    
        if (clazz instanceof CtClassType)
            ((CtClassType)clazz).setClassPool(this);
    
        // 设置新的名称
        clazz.setName(newName);         // indirectly calls
                                        // classNameChanged() in this class
        return clazz;
    }

发表评论取消回复

表情：

评论列表（有 0 条评论，696人围观）

还没有评论，来说两句吧...

相关阅读

相关 Javassist-官方文档中文翻译-第二章-ClassPool详解

是把官方的文档给翻译了，顺便学习，一共10章，可以到下面地址查看，里面可能有翻译不准的地方，欢迎指正 https://github.com/Industriou...

青旅半醒/ 2024年04月19日 10:29/ 0 赞/ 190 阅读

相关 JAVAssist(Javassist 教程)

搜狗问问-搜狗旗下最大互动问答社区 ![JAVAssist][] 搜狗问问-搜狗旗下最大互动问答社区 [JAVAssist]: https://img1.bai

我就是我/ 2023年09月25日 08:37/ 0 赞/ 84 阅读

相关 Java动态编程之javassist

概述　　Javassist是一款字节码编辑工具，可以直接编辑和生成Java生成的字节码，以达到对.class文件进行动态修改的效果。熟练使用这套工具，可以让Java编程

我不是女神ヾ/ 2022年05月21日 01:20/ 0 赞/ 299 阅读

相关 Javassist动态创建类

近日研究mybatis 然后发现他的默认代理框架是Javassist,日本人搞的. 创建代理对象也是直接写了一个ClassFile,然后通过classLoder 加载进来.

快来打我*/ 2022年04月15日 04:16/ 0 赞/ 353 阅读

相关 javassist编程指南(一)

javassist编程指南（主译） javassist是什么？ Javassist(Java 编程辅助)使得Java字节码操作更简单。 Javassis

客官°小女子只卖身不卖艺/ 2022年02月28日 12:16/ 0 赞/ 346 阅读

相关 javassist编程指南==Class loader 类加载

Class loader 类加载如果必须修改的类是预先知道的，最简单的修改类的方式可能是以下这些： 1.通过调用`ClassPool.get()`获取一个`Ct

迈不过友情╰/ 2021年12月04日 03:06/ 0 赞/ 925 阅读

相关 javassist编程指南==ClassPool 类池

ClassPool 类池一个`ClassPool`对象是包含`CtClass`对象的容器。一旦一个`CtClass`对象被创建后，就会被记录到一个`ClassPool`

迷南。/ 2021年12月04日 03:03/ 0 赞/ 697 阅读

相关 javassist编程指南==读、写字节码

读、写字节码 Javassist是一个处理字节码的类库。Java字节码存储在一个叫做\.class的二进制文件中。每个class文件包含一个java类或者接口。 `ja

野性酷女/ 2021年12月04日 02:59/ 0 赞/ 372 阅读

相关 javassist编程指南（概览）

javassist编程指南（主译） [JAVA高级架构师技术栈][JAVA] javassist是什么？ Javassist(Java 编程辅助)使得

向右看齐/ 2021年12月04日 02:59/ 0 赞/ 449 阅读

相关 Java动态编程之javassist

概述　　Javassist是一款字节码编辑工具，可以直接编辑和生成Java生成的字节码，以达到对.class文件进行动态修改的效果。熟练使用这套工具，可以让Java编程

灰太狼/ 2021年09月15日 12:20/ 0 赞/ 461 阅读