Javassist用法详解

2023-07-05 17:46:03 69

概述

Java字节码以二进制的形式存储在.class文件中，每一个.class文件包含一个Java类或接口。Javaassist就是一个用来处理Java字节码的类库。它可以在一个已经编译好的类中添加新的方法，或者是修改已有的方法，并且不需要对字节码方面有深入的了解。同时也可以通过完全手动的方式生成一个新的类对象。

Maven依赖方式：


org.javassist
javassist
3.27.0-GA

Gradle依赖方式：

implementation'org.javassist:javassist:3.27.0-GA'

ClassPool

ClassPool是CtClass对象的容器，它按需读取类文件来构造CtClass对象，并且保存CtClass对象以便以后使用。

从实现的角度来看，ClassPool是一个存储CtClass的Hash表，类的名称作为Hash表的key。ClassPool的get()函数用于从Hash表中查找key对应的CtClass对象。如果没有找到，get()函数会创建并返回一个新的CtClass对象，这个新对象会保存在Hash表中。

需要注意的是ClassPool会在内存中维护所有被它创建过的CtClass，当CtClass数量过多时，会占用大量的内存，API中给出的解决方案是重新创建ClassPool或有意识的调用CtClass的detach()方法以释放内存。

ClassPool需要关注的方法：

getDefault：返回默认的ClassPool，一般通过该方法创建我们的ClassPool；
appendClassPath,insertClassPath：将一个ClassPath加到类搜索路径的末尾位置或插入到起始位置。通常通过该方法写入额外的类搜索路径，以解决多个类加载器环境中找不到类的尴尬；
toClass：将修改后的CtClass加载至当前线程的上下文类加载器中，CtClass的toClass方法是通过调用本方法实现。需要注意的是一旦调用该方法，则无法继续修改已经被加载的class；
makeClass：根据类名创建新的CtClass对象；
get，getCtClass：根据类路径名获取该类的CtClass对象，用于后续的编辑。

可以使用toBytecode()函数来获取修改过的字节码：

byte[]b=cc.toBytecode();

也可以通过toClass()函数直接将CtClass转换成Class对象:

Classclazz=cc.toClass();

toClass()会请求当前线程的ClassLoader加载CtClass所代表的类文件,它返回此类文件的java.lang.Class对象。

CtClass

CtClass类表示一个class文件，每个CtClass对象都必须从ClassPool中获取，CtClass需要关注的方法：

freeze：冻结一个类，使其不可修改；
isFrozen：判断一个类是否已被冻结；
defrost：解冻一个类，使其可以被修改；
prune：删除类不必要的属性，以减少内存占用。调用该方法后，许多方法无法将无法正常使用，慎用；
detach：将该class从ClassPool中删除；
writeFile：根据CtClass生成.class文件；
toClass：通过类加载器加载该CtClass；
addField，removeField：添加/移除一个CtField；
addMethod，removeMethod：添加/移除一个CtMethod；
addConstructor，removeConstructor：添加/移除一个CtConstructor。

如果一个CtClass对象通过writeFile(),toClass(),toBytecode()被转换成一个类文件，此CtClass对象会被冻结起来，不允许再修改，因为一个类只能被JVM加载一次。

但是，一个冷冻的CtClass也可以被解冻，例如：

CtClassscc=...;
cc.writeFile();
cc.defrost();
cc.setSuperclass(...);//因为类已经被解冻，所以这里可以调用成功

调用defrost()之后，此CtClass对象又可以被修改了。

如果ClassPool.doPruning被设置为true，Javassist在冻结CtClass时，会修剪CtClass的数据结构。为了减少内存的消耗，修剪操作会丢弃CtClass对象中不必要的属性。例如，Code_attribute结构会被丢弃。一个CtClass对象被修改之后，方法的字节码是不可访问的，但是方法名称、方法签名、注解信息可以被访问。修剪过的CtClass对象不能再次被解冻。ClassPool.doPruning的默认值为false。

stopPruning()可以用来驳回修剪操作。

CtClassscc=...;
cc.stopPruning(true);
cc.writeFile();//转换成一个class文件
//ccisnotpruned.

这个CtClass没有被修剪，所以在writeFile()之后，可以被解冻。

注意：调试的时候可能临时需要停止修剪和冻结，然后保存一个修改过的类文件到磁盘，debugWriteFile()方法正是为此准备的。它停止修剪，然后写类文件，然后解冻并再次打开修剪（如果开始时修养是打开的）。

CtMthod

CtMthod代表类中的某个方法，可以通过CtClass提供的API获取或者构造方法或者CtNewMethod.make()方法新建，通过CtMethod对象可以实现对方法的修改。

CtMethod中的一些重要方法：

insertBefore：在方法的起始位置插入代码；
insterAfter：在方法的所有return语句前插入代码以确保语句能够被执行，除非遇到exception；
insertAt：在指定的位置插入代码；
setBody：将方法的内容设置为要写入的代码，当方法被abstract修饰时，该修饰符被移除；
make：创建一个新的方法。

CtNewMethod是一个用来创建CtMethod实例的类，其一个make方法如下：

publicstaticCtMethodmake(intmodifiers,CtClassreturnType,
Stringmname,CtClass[]parameters,
CtClass[]exceptions,
Stringbody,CtClassdeclaring)
throwsCannotCompileException
{
try{
CtMethodcm
=newCtMethod(returnType,mname,parameters,declaring);
cm.setModifiers(modifiers);
cm.setExceptionTypes(exceptions);
cm.setBody(body);
returncm;
}
catch(NotFoundExceptione){
thrownewCannotCompileException(e);
}
}

也可以通过CtNewMethod.setter/getter方法为某个属性创建get/set方法：

CtClasscc=...;
CtFieldparam=...;
cc.addMethod(CtNewMethod.setter("setName",param));
cc.addMethod(CtNewMethod.getter("getName",param));

CtField

CtField代表类中的某个属性，可以直接通过其构造方法创建实例：

CtClasscc=pool.makeClass("com.hearing.demo.Person");
CtFieldparam=newCtField(pool.get("java.lang.String"),"name",cc);
param.setModifiers(Modifier.PRIVATE);
cc.addField(param,CtField.Initializer.constant("hearing"));

CtConstructor

CtConstructor代表类中的一个构造器，可以通过CtConstructor.make方法创建：

publicstaticCtConstructormake(CtClass[]parameters,
CtClass[]exceptions,
Stringbody,CtClassdeclaring)
throwsCannotCompileException
{
try{
CtConstructorcc=newCtConstructor(parameters,declaring);
cc.setExceptionTypes(exceptions);
cc.setBody(body);
returncc;
}
catch(NotFoundExceptione){
thrownewCannotCompileException(e);
}
}

也可以通过构造方法直接创建：

CtConstructorcons=newCtConstructor(newCtClass[]{pool.get("java.lang.String")},cc);
//$0=this/$1,$2,$3...代表方法参数
cons.setBody("{$0.name=$1;}");
cc.addConstructor(cons);

ClassPath

ClassPath是一个接口，代表类的搜索路径，含有具体的搜索实现。当通过其它途径无法获取要编辑的类时，可以尝试定制一个自己的ClassPath。API提供的实现中值得关注的有：

ByteArrayClassPath：将类以字节码的形式加入到该path中，ClassPool可以从该path中生成所需的CtClass。
ClassClassPath：通过某个class生成的path，通过该class的classloader来尝试加载指定的类文件。
LoaderClassPath：通过某个classloader生成path，并通过该classloader搜索加载指定的类文件。需要注意的是该类加载器以弱引用的方式存在于path中，当不存在强引用时，随时可能会被清理。

通过ClassPool.getDefault()获取的ClassPool使用JVM的类搜索路径。如果程序运行在JBoss或者Tomcat等Web服务器上，ClassPool可能无法找到用户的类，因为Web服务器使用多个类加载器作为系统类加载器。在这种情况下，ClassPool必须添加额外的类搜索路径。

下面的例子中，pool代表一个ClassPool对象：

pool.insertClassPath(newClassClassPath(this.getClass()));

上面的语句将this指向的类添加到pool的类加载路径中。你可以使用任意Class对象来代替this.getClass()，从而将Class对象添加到类加载路径中。

也可以注册一个目录作为类搜索路径。下面的例子将/usr/local/javalib添加到类搜索路径中：

ClassPoolpool=ClassPool.getDefault();
pool.insertClassPath("/usr/local/javalib");

类搜索路径不但可以是目录，还可以是URL：

ClassPoolpool=ClassPool.getDefault();
ClassPathcp=newURLClassPath("www.javassist.org",80,"/java/","org.javassist.");
pool.insertClassPath(cp);

上述代码将http://www.javassist.org:80/java/添加到类搜索路径。并且这个URL只能搜索org.javassist包里面的类。例如，为了加载org.javassist.test.Main，它的类文件会从获取http://www.javassist.org:80/java/org/javassist/test/Main.class获取。

此外，也可以直接传递一个byte数组给ClassPool来构造一个CtClass对象，完成这项操作，需要使用ByteArrayPath类。示例：

ClassPoolcp=ClassPool.getDefault();
byte[]b=abytearray;
Stringname=classname;
cp.insertClassPath(newByteArrayClassPath(name,b));
CtClasscc=cp.get(name);

示例中的CtClass对象表示b代表的class文件。将对应的类名传递给ClassPool的get()方法，就可以从ByteArrayClassPath中读取到对应的类文件。

如果你不知道类的全名，可以使用makeClass()方法：

ClassPoolcp=ClassPool.getDefault();
InputStreamins=aninputstreamforreadingaclassfile;
CtClasscc=cp.makeClass(ins);

makeClass()返回从给定输入流构造的CtClass对象。你可以使用makeClass()将类文件提供给ClassPool对象。如果搜索路径包含大的jar文件，这可能会提高性能。由于ClassPool对象按需读取类文件，它可能会重复搜索整个jar文件中的每个类文件。makeClass()可以用于优化此搜索。由makeClass()构造的CtClass保存在ClassPool对象中，从而使得类文件不会再被读取。

用户可以通过实现ClassPath接口来扩展类加载路径，然后调用ClassPool的insertClassPath()方法将路径添加进来。这种技术主要用于将非标准资源添加到类搜索路径中。

ClassLoader

CtClass的toClass()方法请求当前线程的上下文类加载器，加载CtClass对象所表示的类：

publicclassHello{
publicvoidsay(){
System.out.println("Hello");
}
}

publicclassTest{
publicstaticvoidmain(String[]args)throwsException{
ClassPoolcp=ClassPool.getDefault();
CtClasscc=cp.get("Hello");
CtMethodm=cc.getDeclaredMethod("say");
m.insertBefore("{System.out.println(\"Hello.say():\");}");
Classc=cc.toClass();
Helloh=(Hello)c.newInstance();
h.say();
}
}

注意：上面的程序要正常运行，Hello类在调用toClass()之前不能被加载。如果JVM在toClass()调用之前加载了原始的Hello类，后续加载修改的Hello类将会失败（LinkageError抛出）。例如，如果Test中的main()是这样的：

publicstaticvoidmain(String[]args)throwsException{
Helloorig=newHello();
ClassPoolcp=ClassPool.getDefault();
CtClasscc=cp.get("Hello");
}

那么，原始的Hello类在main的第一行被加载，toClass()调用会抛出一个异常，因为类加载器不能同时加载两个不同版本的Hello类。

如果程序在某些应用程序服务器（如JBoss和Tomcat）上运行，toClass()使用的上下文类加载器可能是不合适的。在这种情况下，你会看到一个意想不到的ClassCastException。为了避免这个异常，必须给toClass()指定一个合适的类加载器。例如：

CtClasscc=...;
Classc=cc.toClass(bean.getClass().getClassLoader());

应该给toClass()传递加载了你的程序的类加载器（上例中，bean对象的类），toClass()是为了简便而提供的方法，如果你需要更复杂的功能，你应该编写自己的类加载器。

Javassit提供一个类加载器javassist.Loader。它使用javassist.ClassPool对象来读取类文件。

例如，javassist.Loader可以用于加载用Javassist修改过的类。

publicclassMain{
publicstaticvoidmain(String[]args)throwsThrowable{
ClassPoolpool=ClassPool.getDefault();
Loadercl=newLoader(pool);

CtClassct=pool.get("test.Rectangle");
ct.setSuperclass(pool.get("test.Point"));

Classc=cl.loadClass("test.Rectangle");
Objectrect=c.newInstance();
}
}

这个程序将test.Rectangle的超类设置为test.Point。然后再加载修改的类，并创建新的test.Rectangle类的实例。

如果用户希望在加载时按需修改类，则可以向javassist.Loader添加事件监听器。当类加载器加载类时会通知监听器。事件监听器类必须实现以下接口：

publicinterfaceTranslator{
publicvoidstart(ClassPoolpool)
throwsNotFoundException,CannotCompileException;
publicvoidonLoad(ClassPoolpool,Stringclassname)
throwsNotFoundException,CannotCompileException;
}

当事件监听器通过addTranslator()添加到javassist.Loader对象时，start()方法会被调用。在javassist.Loader加载类之前，会调用onLoad()方法。可以在onLoad()方法中修改被加载的类的定义。

例如，下面的事件监听器在类加载之前，将所有类更改为public类。

publicclassMyTranslatorimplementsTranslator{
voidstart(ClassPoolpool)throwsNotFoundException,CannotCompileException{}
voidonLoad(ClassPoolpool,Stringclassname)throwsNotFoundException,CannotCompileException{
CtClasscc=pool.get(classname);
cc.setModifiers(Modifier.PUBLIC);
}
}

注意，onLoad()不必调用toBytecode()或writeFile()，因为javassist.Loader会调用这些方法来获取类文件。

示例

创建Class文件

publicclassApp{
publicstaticvoidmain(String[]args){
try{
createPerson();
}catch(Exceptione){
e.printStackTrace();
}
}

privatestaticvoidcreatePerson()throwsException{
ClassPoolpool=ClassPool.getDefault();

//1.创建一个空类
CtClasscc=pool.makeClass("com.hearing.demo.Person");

//2.新增一个字段privateStringname="hearing";
CtFieldparam=newCtField(pool.get("java.lang.String"),"name",cc);
param.setModifiers(Modifier.PRIVATE);
cc.addField(param,CtField.Initializer.constant("hearing"));

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

//4.添加无参的构造函数
CtConstructorcons=newCtConstructor(newCtClass[]{},cc);
cons.setBody("{name=\"hearing\";}");
cc.addConstructor(cons);

//5.添加有参的构造函数
cons=newCtConstructor(newCtClass[]{pool.get("java.lang.String")},cc);
//$0=this/$1,$2,$3...代表方法参数
cons.setBody("{$0.name=$1;}");
cc.addConstructor(cons);

//6.创建一个名为printName方法，无参数，无返回值，输出name值
CtMethodctMethod=newCtMethod(CtClass.voidType,"printName",newCtClass[]{},cc);
ctMethod.setModifiers(Modifier.PUBLIC);
ctMethod.setBody("{System.out.println(name);}");
cc.addMethod(ctMethod);

//这里会将这个创建的类对象编译为.class文件
cc.writeFile("/.../path/");
}
}

创建的class文件如下：

//
//Sourcecoderecreatedfroma.classfilebyIntelliJIDEA
//(poweredbyFernflowerdecompiler)
//
packagecom.hearing.demo;

publicclassPerson{
privateStringname="hearing";

publicvoidsetName(Stringvar1){
this.name=var1;
}

publicStringgetName(){
returnthis.name;
}

publicPerson(){
this.name="hearing";
}

publicPerson(Stringvar1){
this.name=var1;
}

publicvoidprintName(){
System.out.println(this.name);
}
}

调用生成的类对象

1.通过反射的方式调用：

Objectperson=cc.toClass().newInstance();
MethodsetName=person.getClass().getMethod("setName",String.class);
setName.invoke(person,"hearing1");
Methodexecute=person.getClass().getMethod("printName");
execute.invoke(person);

2.通过读取class文件的方式调用：

ClassPoolpool=ClassPool.getDefault();
//设置类路径
pool.appendClassPath("/.../path/");
CtClassctClass=pool.get("com.hearing.demo.Person");
Objectperson=ctClass.toClass().newInstance();
//下面和通过反射的方式一样去使用

3.通过接口的方式：

上面两种其实都是通过反射的方式去调用，问题在于我们的工程中其实并没有这个类对象，所以反射的方式比较麻烦，并且开销也很大。那么如果你的类对象可以抽象为一些方法的合集，就可以考虑为该类生成一个接口类。这样在newInstance()的时候我们就可以强转为接口，可以将反射的那一套省略掉了。

还拿上面的Person类来说，新建一个IPerson接口类：

publicinterfaceIPerson{
voidsetName(Stringname);
StringgetName();
voidprintName();
}

实现部分的代码如下：

ClassPoolpool=ClassPool.getDefault();
pool.appendClassPath("/.../path/");

//获取接口
CtClasscodeClassI=pool.get("com.hearing.demo.IPerson");
//获取上面生成的类
CtClassctClass=pool.get("com.hearing.demo.Person");
//使代码生成的类，实现IPerson接口
ctClass.setInterfaces(newCtClass[]{codeClassI});

//以下通过接口直接调用强转
IPersonperson=(IPerson)ctClass.toClass().newInstance();
System.out.println(person.getName());
person.setName("hearing1");
person.printName();

修改现有的类对象

有如下类对象：

publicclassTest{
publicvoidtest1(){
System.out.println("Iamtest1");
}
}

然后进行修改：

publicclassApp{
publicstaticvoidmain(String[]args){
try{
update();
}catch(Exceptione){
e.printStackTrace();
}
}

privatestaticvoidupdate()throwsException{
ClassPoolpool=ClassPool.getDefault();
CtClasscc=pool.get("com.hearing.demo.Test");

CtMethodpersonFly=cc.getDeclaredMethod("test1");
personFly.insertBefore("System.out.println(\"...before...\");");
personFly.insertAfter("System.out.println(\"...after...\");");

//新增一个方法
CtMethodctMethod=newCtMethod(CtClass.voidType,"test2",newCtClass[]{},cc);
ctMethod.setModifiers(Modifier.PUBLIC);
ctMethod.setBody("{System.out.println(\"Iamtest2\");}");
cc.addMethod(ctMethod);

Objecttest=cc.toClass().newInstance();
MethodpersonFlyMethod=test.getClass().getMethod("test1");
personFlyMethod.invoke(test);
Methodexecute=test.getClass().getMethod("test2");
execute.invoke(test);
}
}

需要注意的是：上面的insertBefore()和setBody()中的语句，如果是单行语句可以直接用双引号，但是有多行语句的情况下，需要将多行语句用{}括起来。javassist只接受单个语句或用大括号括起来的语句块。

以上就是Javassist用法详解的详细内容，更多关于Javassist用法的资料请关注毛票票其它相关文章！

声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。