使用 Javassist 创建静态构造函数的克隆

jos*_*pos 5 java javassist

似乎 Javassist 的 API 允许我们创建类中声明的类初始值设定项(即静态构造函数)的精确副本:

CtClass cc = ...;
CtConstructor staticConstructor = cc.getClassInitializer();
if (staticConstructor != null) {
  CtConstructor staticConstructorClone = new CtConstructor(staticConstructor, cc, null);
  staticConstructorClone.getMethodInfo().setName(__NEW_NAME__);
  staticConstructorClone.setModifiers(Modifier.PUBLIC | Modifier.STATIC);
  cc.addConstructor(staticConstructorClone);
}
Run Code Online (Sandbox Code Playgroud)

但是,该副本还包括(公共/私有)静态最终字段。例如,以下类的静态构造函数:

public class Example {
  public static final Example ex1 = new Example("__EX_1__");

  private String name;

  private Example(String name) {
    this.name = name;
  }
}
Run Code Online (Sandbox Code Playgroud)

实际上是:

static {
  Example.ex1 = "__NAME__";
}
Run Code Online (Sandbox Code Playgroud)

因此,静态构造函数的精确副本也将包括对最终字段“名称”的调用。

有没有办法创建不包括对 final 字段的调用的静态构造函数的副本?

- 谢谢

pab*_*tes 5

介绍

作为您的驱动器重置类的静态状态但删除最终字段,关键是ExprEditor类。此类基本上允许您使用 Javassist 的高级 API 轻松转换某些操作,而不必费心处理所有字节码。

即使我们将在高级 API 中完成所有这些工作,我仍然会转储一些字节码,以便我们也可以看到该级别的更改。

工作基地

让我们抓住你的 Example 类,但有一个转折:

public class Example {
 public static final Example ex1 = new Example("__EX_1__");
 public static String DEFAULT_NAME = "Paulo"; // <-- change 1

 private String name;

 static {
     System.out.println("Class inited");  // <-- change 2
 }

 public Example(String name) {
     this.name = name;
 }
}
Run Code Online (Sandbox Code Playgroud)

我添加了一个非最终的静态字段,所以我们可以更改它,我们应该能够重置它。我还添加了一个带有一些代码的静态块,在这种情况下它只是一个 System.out 但请记住,其他类可能有不打算多次运行的代码,您可能会发现自己调试奇怪的行为(但我我相信你可能知道这一点)。

为了测试我们的修改,我还使用以下代码创建了一个测试类:

public class Test {

   public static void main(String[] args) throws Throwable {
    System.out.println(Example.DEFAULT_NAME);
    Example.DEFAULT_NAME = "Jose";
    System.out.println(Example.DEFAULT_NAME);
    try {
        reset();
    } catch (Throwable t) {
        System.out.println("Problems calling reset, maybe not injected?");
    }
    System.out.println(Example.DEFAULT_NAME);
   }

   private static void reset() throws Throwable {
    Method declaredMethod = Example.class.getDeclaredMethod("__NEW_NAME__", new Class[] {});
    declaredMethod.invoke(null, new Object[] {});
   }
}
Run Code Online (Sandbox Code Playgroud)

如果我们开箱即用地运行这个类,我们会得到以下输出:

Class inited
Paulo
Jose
Problems calling reset, maybe not injected?
Jose
Run Code Online (Sandbox Code Playgroud)

主要目标是再次让这个打印圣保罗(是的,有时我能太以自我为中心,我知道:P)

开始吧

我们必须问自己的第一个问题是静态初始化器中发生了什么?为此,我们将使用 javap 使用以下命令获取 Example 的类字节码:

javap -c -l -v -p Example.class

如果您不习惯开关,请快速记下它们。

  • c: 显示字节码
  • l:显示局部变量表
  • v: be verbose 显示行表、异常表等
  • p: 包括私有方法

初始化程序的代码是(我剪掉了其他所有内容):

 static {};
    descriptor: ()V
    flags: ACC_STATIC
    Code:
      stack=3, locals=0, args_size=0
         0: new           #1                  // class test7/Example
         3: dup
         4: ldc           #13                 // String __EX_1__
         6: invokespecial #15                 // Method "<init>":(Ljava/lang/String;)V
         9: putstatic     #19                 // Field ex1:Ltest7/Example;
        12: ldc           #21                 // String Paulo
        14: putstatic     #23                 // Field DEFAULT_NAME:Ljava/lang/String;
        17: getstatic     #25                 // Field java/lang/System.out:Ljava/io/PrintStream;
        20: ldc           #31                 // String Class inited
        22: invokevirtual #33                 // Method java/io/PrintStream.println:(Ljava/lang/String;)V
        25: return
      LineNumberTable:
        line 4: 0
        line 5: 12
        line 10: 17
        line 11: 25
      LocalVariableTable:
        Start  Length  Slot  Name   Signature
Run Code Online (Sandbox Code Playgroud)

查看此代码,我们看到我们的目标是堆栈帧 9,其中 aputstatic已完成到我们实际上知道是 final 的字段 ex1 中,我们只对更改对这些字段的写入感兴趣,仍然应该进行读取。

所以现在让我们在编码时运行注入器并再次检查字节码。下面是NEW_NAME () 方法字节码:

 public static void __NEW_NAME__();
    descriptor: ()V
    flags: ACC_PUBLIC, ACC_STATIC
    Code:
      stack=3, locals=0, args_size=0
         0: new           #1                  // class test7/Example
         3: dup
         4: ldc           #13                 // String __EX_1__
         6: invokespecial #15                 // Method "<init>":(Ljava/lang/String;)V
         9: putstatic     #19                 // Field ex1:Ltest7/Example;
        12: ldc           #21                 // String Paulo
        14: putstatic     #23                 // Field DEFAULT_NAME:Ljava/lang/String;
        17: getstatic     #25                 // Field java/lang/System.out:Ljava/io/PrintStream;
        20: ldc           #31                 // String Class inited
        22: invokevirtual #33                 // Method java/io/PrintStream.println:(Ljava/lang/String;)V
        25: return
      LineNumberTable:
        line 4: 0
        line 5: 12
        line 10: 17
        line 11: 25
      LocalVariableTable:
        Start  Length  Slot  Name   Signature
Run Code Online (Sandbox Code Playgroud)

正如预期的那样,Stackframe 9 仍然存在。

好奇心:您是否知道字节码验证器不会检查有关 final 关键字的非法赋值。这意味着您已经可以在没有“问题”的情况下运行此方法,对吗?我说“问题”是因为如果您希望最终变量具有某种永久状态,那么您会遇到很多麻烦:)

好的,但回到正轨,让我们最终重写你的注入器来做你想做的事。这是我修改后的代码:

public class Injector {

 public static void main(String[] args) throws Throwable {
    CtClass cc = ClassPool.getDefault().get(Example.class.getName());
    CtConstructor staticConstructor = cc.getClassInitializer();
    if (staticConstructor != null) {
        CtConstructor staticConstructorClone = new CtConstructor(staticConstructor, cc, null);
        staticConstructorClone.getMethodInfo().setName("__NEW_NAME__");
        staticConstructorClone.setModifiers(Modifier.PUBLIC | Modifier.STATIC);
        cc.addConstructor(staticConstructorClone);

        // Here's the trick :-)

        staticConstructorClone.instrument(new ExprEditor() {

            @Override
            public void edit(FieldAccess f) throws CannotCompileException {
                try {
                    if (f.isStatic() && f.isWriter() && Modifier.isFinal(f.getField().getModifiers())) {
                        System.out.println("Found field");
                        f.replace("{  }");
                    }
                } catch (NotFoundException e) {
                    // TODO Auto-generated catch block
                    e.printStackTrace();
                }
            }
        });

        cc.writeFile("...);
    }
  }
}
Run Code Online (Sandbox Code Playgroud)

我们已经克隆了静态构造函数,我们经过仪器用了ExprEditor该编辑字段访问。因此,每当我们发现一个字段访问静态字段的写入并且修饰符是 final 时,我们将代码替换为“{}”,这基本上意味着“什么都不做”。

当运行新的注入器并检查字节码时,我们得到以下信息:

  public static void __NEW_NAME__();
    descriptor: ()V
    flags: ACC_PUBLIC, ACC_STATIC
    Code:
      stack=3, locals=2, args_size=0
         0: new           #1                  // class test7/Example
         3: dup
         4: ldc           #13                 // String __EX_1__
         6: invokespecial #15                 // Method "<init>":(Ljava/lang/String;)V
         9: astore_1
        10: aconst_null
        11: astore_0
        12: ldc           #21                 // String Paulo
        14: putstatic     #23                 // Field DEFAULT_NAME:Ljava/lang/String;
        17: getstatic     #25                 // Field java/lang/System.out:Ljava/io/PrintStream;
        20: ldc           #31                 // String Class inited
        22: invokevirtual #33                 // Method java/io/PrintStream.println:(Ljava/lang/String;)V
        25: return
      LineNumberTable:
        line 4: 0
        line 5: 12
        line 10: 17
        line 11: 25
      LocalVariableTable:
        Start  Length  Slot  Name   Signature
Run Code Online (Sandbox Code Playgroud)

如您所见,stackframe 9 不再是 putstatic 而是 astore_1,实际上 javassist 注入了 3 个新的 stackframe,从 9 到 11:

         9: astore_1
        10: aconst_null
        11: astore_0
Run Code Online (Sandbox Code Playgroud)

现在,如果我们再次运行 Test 类,我们会得到以下输出:

Class inited
Paulo
Jose
Class inited
Paulo
Run Code Online (Sandbox Code Playgroud)

尾注

请记住,即使在这种沙盒场景中一切正常,但在现实世界中执行这种魔法时,可能会因意外情况而适得其反……您很可能需要创建一个更智能的 ExprEditor 来处理更多场景,但你的基点将是这个。

如果您实际上可以实现 resetState() 方法,那将是一个更好的选择,但我很确定您可能无法做到,这就是您正在研究字节码解决方案的原因。

很抱歉这篇长文章,但我想引导你完成我所有的思考过程。希望你觉得它有帮助。