Creating a class from scratch（从头开始创建一个类）

原文地址：点击打开链接

首先，我们需要创建一个类，为了创建一个类文件（class file），需要下面这些步骤

加载 java.lang.Object 和库类（Library Classes）

     加载 java.lang.Object，它是java类层次的根。

    当我们通过扩展（extends）Soot的框架时，这步并非是必须的，因为在这种情况下，当用户代码被调用时类文件的加载就已经完成了。

        Scene.v().loadClassAndSupport("java.lang.Object");   

     这行代码使得Soot去加载 java.lang.Object 类同时创建 java.lang.Object 中对应的 SootClass 对象，还有 SootMethod 和 SootFields 。当然，java.lang.Object 对象会引用其他对象。调用 loadClassAndSupport 会加载指定类的传递闭包（the transitive closure），故而为了加载 java.lang.Object 所需的其他所有类型也被加载了（译者注：明白点就是被加载的指定类所引用的类也会被加载）。

     这个过程称之为 resolution。

由于我们的 HelloWorld 程序将会使用到标准库里的类，我们必须解决这些：

Scene.v().loadClassAndSupport("java.lang.System");

这一行代码引用了 Scene.v()。Scene是一个容器（译者注：这里指的是它的作用像容器），它包含了整个程序里所有的 SootClass ，并且提供了许多实用的方法。Scene是一个单例（singleton），通过调用 Scene.v()访问。

  注意：Soot要么从类文件加载类，要么从 .jimple输入文件中加载类。当从类文件加载类时，Soot会加载每个类文件的常量池中含有的类名（load all class names referred to in the constant pool of each class file）；从 .jimple文件加载则只会加载必要的类型。

    创建一个新的 SootClass 对象

创建 HelloWorld对应的SootClass，并将它的超类设为 java.lang.Object

   SootClass sClass=new SootClass("HelloWorld", Modifier.PUBLIC);

这行代码给名为HelloWorld的公有类创建了一个SootClass对象。

   sClass.setSuperclass(Scene.v().getSootClass("java.lang.Object"));

该代码将新创建的类的超类设置为 java.lang.Object 对应的 SootClass 对象（译者注：Soot里使用SootClass代表java中的类）。注意Scene里 getSootClass 方法的使用。

   Scene.v().addClass(sClass);

这行代码把新建的 HelloWorld类添加到 Scene里，所有的类一旦它们被创建，都应该属于Scene。

向 SootClass 里添加方法

    为HelloWorld创建一个 main() 方法，该方法有一个空的方法体（empty body）。

注意到我们已经有一个 SootClass 了，我们需要往里面添加方法

SootMethod method = new SootMethod("main",                 
    Arrays.asList(new Type[] {ArrayType.v(RefType.v("java.lang.String"), 1)}),
    VoidType.v(), Modifier.PUBLIC | Modifier.STATIC);

我们创建了一个新的方法 main，它的访问类型是 public static，同时声明带有 java.lang.String对象的数组类型参数，同时返回 void。

因为 SootMethod 的构造方法需要一个List参数，我们调用Java里的方法 Arrays.asList 从使用new Type[] 动态生成的只含一个元素的数组中创建一个列表。我们通过调用 RefType来获取对应于 java.lang.String 类的类型（指Soot里对应的类型），通过ArrayType来创建对应于 java.lang.String 对象的一维 ArrayType。

类型：每一个SootClass代表一个Java对象，给定一个具有给定类型的对象，我们可以实例化类。type和class这两个概念密切相关但是不同，为了通过名字获得 java.lang.String 类的类型我们调用 RefType.v("java.lang.String")（译者注：结果为 java.lang.String）。给定一个SootClass对象 sc，我们可以调用 sc.getType()（译者注：对于例子中的sClass，其结果为 HelloWorld）来获得对应的类型。   

sClass.addMethod(method);

这句代码将这个方法添加到对应的类中。

给方法添加代码

 一个方法如果不包含任何代码那么它是没有作用的。我们接在给main方法添加一些代码。为了添加代码，我们必须选择一个表示这些代码的中间表示（iintermediate representation）。

创建 JimpleBody

 在Soot里，为了把代码与方法联系起来，我们给SootMethod 附上（attach）一个 Body。每个 Body 都知道它对应于哪个 SootMethod，然而，一个SootMethod每次只能有一个活动的Body（active Body），可以通过 SootMethod.getActivityBody()来访问。不同类型的 Body 由不同中间表示来提供；Soot有 JimpleBody、ShimpleBody、BafBody和GrimpBody。

准确地说，一个Body有三个重要的特征：Local链、Trap链和Unit链。链（Chain）有点类似列表结构，插入和删除元素的复杂度为O(1)。Locals是Body里的局部变量（译者注：Jimple里面会把每个方法需要用到的变量在方法体的最开始全部定义好）；Traps表明哪个Unit捕获了哪个异常；Units就是语句本身（译者注：在Jimple里，一个Unit就表示一条Jimple语句）。

注意： Unit既可以表示语句（比如在Jimple里）也可以表示指令（比如在Baf里）。

给 main方法创建一个Jimple Body，并添加局部变量（Locals）和指令

JimpleBody body = Jimple.v().newBody(method);
method.setActiveBody(body);

我们调用 Jimple的单例对象（singleton object）获得一个新的JimpleBody，并将它关联我们的方法，同时将其设为这个方法的活动Body。

添加 Local 

Local arg = Jimple.v().newLocal("l0", ArrayType.v(RefType.v("java.lang.String"), 1));
body.getLocals().add(arg);

我们创建一个新的Jimple里的Local并将它添加到我们的Body。

添加一个单元（Unit）

units.add(Jimple.v().newIdentityStmt(arg, 
      Jimple.v().newParameterRef(ArrayType.v
        (RefType.v("java.lang.String"), 1), 0)));

SootMethod 声明它有参数，但这些参数并没有绑定到 Body里的Locals。IdentityStmt做了这些工作，它把第一个参数的值付给了arg，arg的类型为String数组。

// insert "tmpRef.println("Hello world!")"
{
    SootMethod toCall = Scene.v().getMethod
      ("<java.io.PrintStream: void println(java.lang.String)>");
    units.add(Jimple.v().newInvokeStmt
        (Jimple.v().newVirtualInvokeExpr
           (tmpRef, toCall.makeRef(), StringConstant.v("Hello world!"))));
}

我们获得签名为<java.io.PrintStream: void println(java.lang.String)>的方法（这个方法的名称为 println，属于 PrintStream，返回void类型，参数为 String。这足够唯一标识这个方法），同时我们通过传递 String常量“Hello World”来调用它。

写入 类文件（class file）

  为了将这个程序写入到.class文件。方法体必须由Jimple转换成Jasmin，然后再组装成字节码。组装成字节码通过 JasminOutputStream实现。

我们首先构造一个输出流，它需要一个Jasmin源，并输出 .class文件。我们可以人为指定文件名，或者让Soot来决定正确的文件名。这里我们使用后者

String fileName = SourceLocator.v().getFileNameFor(sClass, Options.output_format_class);
OutputStream streamOut = new JasminOutputStream(new FileOutputStream(fileName));
PrintWriter writerOut = new PrintWriter(new OutputStreamWriter(streamOut));

如果我们希望输出Jimple文件而不是.class文件，我们使用如下代码：

String fileName = SourceLocator.v().getFileNameFor(sClass, Options.output_format_jimple);
OutputStream streamOut = new FileOutputStream(fileName);
PrintWriter writerOut = new PrintWriter(new OutputStreamWriter(streamOut));
Printer.v().printTo(sClass, writerOut);
writerOut.flush();
streamOut.close();

我们忽略 JasminOutputStream，调用Printer的printTo方法。

HelloWorld 类对应的Jimple代码如下：

public class HelloWorld extends java.lang.Object
{

    public static void main(java.lang.String[])
    {
        java.lang.String l0;
        java.io.PrintStream tempRef;

        l0 := @parameter0: java.lang.String[];

        tempRef = <java.lang.System: java.io.PrintStream out>;

        virtualinvoke tempRef.<java.io.PrintStream: void println(java.lang.String)>("Hello World!");

        return;
    }
}

上述例子完整代码如下：

import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.util.Arrays;

import soot.ArrayType;
import soot.Local;
import soot.Modifier;
import soot.Printer;
import soot.RefType;
import soot.Scene;
import soot.SootClass;
import soot.SootMethod;
import soot.SourceLocator;
import soot.Type;
import soot.Unit;
import soot.VoidType;
import soot.jimple.Jimple;
import soot.jimple.JimpleBody;
import soot.jimple.StringConstant;
import soot.options.Options;
import soot.util.Chain;


public class CreateHelloWorldInJimple {
	public static void main(String[] args) throws IOException {
		SootMethod method;
		SootClass sClass=new SootClass("HelloWorld",Modifier.PUBLIC);
		//Scene代表一个容器，包含了一个程序里所有的SootClass
		Scene.v().loadClassAndSupport("java.lang.Object");
		Scene.v().loadClassAndSupport("java.lang.System");
		sClass.setSuperclass(Scene.v().getSootClass("java.lang.Object"));
		Scene.v().addClass(sClass);
		
		//add method
		//RefType代表引用类型
		method=new SootMethod("main",Arrays.asList(new Type[]{ArrayType.v(RefType.v("java.lang.String"),1)}),VoidType.v(),Modifier.PUBLIC|Modifier.STATIC);
		sClass.addMethod(method);
		
		//add code to method
		JimpleBody body=Jimple.v().newBody(method);//attach the body to method
		method.setActiveBody(body);
		
		Local arg=Jimple.v().newLocal("l0",RefType.v("java.lang.String"));
		//Local arg=Jimple.v().newLocal("l0",ArrayType.v(RefType.v("java.lang.String"),1));
		body.getLocals().add(arg);
		
		//add unit,Units are the statements themselves
		Chain<Unit> units=body.getUnits();
		Unit u=Jimple.v().newIdentityStmt(arg,Jimple.v().newParameterRef(ArrayType.v(RefType.v("java.lang.String"),1),0));
		units.add(u);
		
		Local tmpRef=Jimple.v().newLocal("tempRef",RefType.v(Scene.v().getSootClass("java.io.PrintStream")));
		//Local tmpRef=Jimple.v().newLocal("tempRef",RefType.v("java.io.PrintStream"));
		body.getLocals().add(tmpRef);
		units.add(Jimple.v().newAssignStmt(tmpRef,Jimple.v().newStaticFieldRef(Scene.v().getField("<java.lang.System: java.io.PrintStream out>").makeRef())));
		{
			SootMethod toCallMethod=Scene.v().getMethod("<java.io.PrintStream: void println(java.lang.String)>");
			units.add(Jimple.v().newInvokeStmt(Jimple.v().newVirtualInvokeExpr(tmpRef,toCallMethod.makeRef(),StringConstant.v("Hello World!"))));
		}
		
		//insert "return"
		units.add(Jimple.v().newReturnVoidStmt());
		//write to class file
		String fileName=SourceLocator.v().getFileNameFor(sClass, Options.output_format_jimple);
		OutputStream streamOut=new FileOutputStream(fileName);
		PrintWriter writerOut=new PrintWriter(new OutputStreamWriter(streamOut));
		
		//covert from Jimple to Jasmin
		/*
		JasminClass jasminClass=new JasminClass(sClass);
		jasminClass.print(writerOut);
		writerOut.flush();
		streamOut.close();
		*/
		//output jimple source
		
		Printer.v().printTo(sClass, writerOut);
		writerOut.flush();
		streamOut.close();
		//System.out.println(RefType.v("java.lang.String").toString());
		//System.out.println(RefType.v("java.lang.String").getClassName());	
		//System.out.println(method.getActiveBody());
		//System.out.println(sClass.getType());
	}

}