Java 中的屠龍之術(shù)：如何修改語法樹？

作者：不學(xué)無數(shù)的程序員?

來源：https://my.oschina.net/u/4030990/blog/3211858

在網(wǎng)上關(guān)于如何修改Java的抽象語法樹的相關(guān)API文檔并不多，于是本篇記錄一下相關(guān)的知識點，以便隨后查閱。

JCTree的介紹

JCTree是語法樹元素的基類，包含一個重要的字段pos，該字段用于指明當(dāng)前語法樹節(jié)點（JCTree）在語法樹中的位置，因此我們不能直接用new關(guān)鍵字來創(chuàng)建語法樹節(jié)點，即使創(chuàng)建了也沒有意義。

此外，結(jié)合訪問者模式，將數(shù)據(jù)結(jié)構(gòu)與數(shù)據(jù)的處理進(jìn)行解耦，部分源碼如下：

public?abstract?class?JCTree?implements?Tree,?Cloneable,?DiagnosticPosition?{

????public?int?pos?=?-1;

????...

????public?abstract?void?accept(JCTree.Visitor?visitor);

????...
}

我們可以看到JCTree是一個抽象類，這里重點介紹幾個JCTree的子類

1. JCStatement：聲明語法樹節(jié)點，常見的子類如下

2. 
   
• JCBlock：語句塊語法樹節(jié)點
• JCReturn：return語句語法樹節(jié)點
• JCClassDecl：類定義語法樹節(jié)點
• JCVariableDecl：字段/變量定義語法樹節(jié)點

3. JCMethodDecl：方法定義語法樹節(jié)點

4. JCModifiers：訪問標(biāo)志語法樹節(jié)點

5. JCExpression：表達(dá)式語法樹節(jié)點，常見的子類如下

6. 
   
• JCAssign：賦值語句語法樹節(jié)點
• JCIdent：標(biāo)識符語法樹節(jié)點，可以是變量，類型，關(guān)鍵字等等

TreeMaker介紹

TreeMaker用于創(chuàng)建一系列的語法樹節(jié)點，我們上面說了創(chuàng)建JCTree不能直接使用new關(guān)鍵字來創(chuàng)建，所以Java為我們提供了一個工具，就是TreeMaker，它會在創(chuàng)建時為我們創(chuàng)建的JCTree對象設(shè)置pos字段，所以必須使用上下文相關(guān)的TreeMaker對象來創(chuàng)建語法樹節(jié)點。

具體的API介紹可以參照，TreeMakerAPI，接下來著重介紹一下常用的幾個方法。

TreeMaker.Modifiers

TreeMaker.Modifiers方法用于創(chuàng)建訪問標(biāo)志語法樹節(jié)點（JCModifiers），源碼如下

public?JCModifiers?Modifiers(long?flags)?{
????return?Modifiers(flags,?List.nil());
}

public?JCModifiers?Modifiers(long?flags,
????List?annotations)?{
????????JCModifiers?tree?=?new?JCModifiers(flags,?annotations);
????????boolean?noFlags?=?(flags?&?(Flags.ModifierFlags?|?Flags.ANNOTATION))?==?0;
????????tree.pos?=?(noFlags?&&?annotations.isEmpty())???Position.NOPOS?:?pos;
????????return?tree;
}

1. flags：訪問標(biāo)志
2. annotations：注解列表

其中flags可以使用枚舉類com.sun.tools.javac.code.Flags來表示，例如我們可以這樣用，就生成了下面的訪問標(biāo)志了。

treeMaker.Modifiers(Flags.PUBLIC?+?Flags.STATIC?+?Flags.FINAL);

public?static?final

TreeMaker.ClassDef

TreeMaker.ClassDef用于創(chuàng)建類定義語法樹節(jié)點（JCClassDecl）,源碼如下：

public?JCClassDecl?ClassDef(JCModifiers?mods,
????Name?name,
????List?typarams,
????JCExpression?extending,
????List?implementing,
????List?defs)?{
????????JCClassDecl?tree?=?new?JCClassDecl(mods,
?????????????????????????????????????name,
?????????????????????????????????????typarams,
?????????????????????????????????????extending,
?????????????????????????????????????implementing,
?????????????????????????????????????defs,
?????????????????????????????????????null);
????????tree.pos?=?pos;
????????return?tree;
}

1. mods：訪問標(biāo)志，可以通過TreeMaker.Modifiers來創(chuàng)建
2. name：類名
3. typarams：泛型參數(shù)列表
4. extending：父類
5. implementing：實現(xiàn)的接口
6. defs：類定義的詳細(xì)語句，包括字段、方法的定義等等

TreeMaker.MethodDef

TreeMaker.MethodDef用于創(chuàng)建方法定義語法樹節(jié)點（JCMethodDecl），源碼如下

public?JCMethodDecl?MethodDef(JCModifiers?mods,
????Name?name,
????JCExpression?restype,
????List?typarams,
????List?params,
????List?thrown,
????JCBlock?body,
????JCExpression?defaultValue)?{
????????JCMethodDecl?tree?=?new?JCMethodDecl(mods,
???????????????????????????????????????name,
???????????????????????????????????????restype,
???????????????????????????????????????typarams,
???????????????????????????????????????params,
???????????????????????????????????????thrown,
???????????????????????????????????????body,
???????????????????????????????????????defaultValue,
???????????????????????????????????????null);
????????tree.pos?=?pos;
????????return?tree;
}

public?JCMethodDecl?MethodDef(MethodSymbol?m,
????Type?mtype,
????JCBlock?body)?{
????????return?(JCMethodDecl)
????????????new?JCMethodDecl(
????????????????Modifiers(m.flags(),?Annotations(m.getAnnotationMirrors())),
????????????????m.name,
????????????????Type(mtype.getReturnType()),
????????????????TypeParams(mtype.getTypeArguments()),
????????????????Params(mtype.getParameterTypes(),?m),
????????????????Types(mtype.getThrownTypes()),
????????????????body,
????????????????null,
????????????????m).setPos(pos).setType(mtype);
}

1. mods：訪問標(biāo)志
2. name：方法名
3. restype：返回類型
4. typarams：泛型參數(shù)列表
5. params：參數(shù)列表
6. thrown：異常聲明列表
7. body：方法體
8. defaultValue：默認(rèn)方法（可能是interface中的哪個default）
9. m：方法符號
10. mtype：方法類型。包含多種類型，泛型參數(shù)類型、方法參數(shù)類型、異常參數(shù)類型、返回參數(shù)類型。

返回類型restype填寫null或者treeMaker.TypeIdent(TypeTag.VOID)都代表返回void類型。

TreeMaker.VarDef

TreeMaker.VarDef用于創(chuàng)建字段/變量定義語法樹節(jié)點（JCVariableDecl），源碼如下

public?JCVariableDecl?VarDef(JCModifiers?mods,
????Name?name,
????JCExpression?vartype,
????JCExpression?init)?{
????????JCVariableDecl?tree?=?new?JCVariableDecl(mods,?name,?vartype,?init,?null);
????????tree.pos?=?pos;
????????return?tree;
}

public?JCVariableDecl?VarDef(VarSymbol?v,
????JCExpression?init)?{
????????return?(JCVariableDecl)
????????????new?JCVariableDecl(
????????????????Modifiers(v.flags(),?Annotations(v.getAnnotationMirrors())),
????????????????v.name,
????????????????Type(v.type),
????????????????init,
????????????????v).setPos(pos).setType(v.type);
}

1. mods：訪問標(biāo)志
2. name：參數(shù)名稱
3. vartype：類型
4. init：初始化語句
5. v：變量符號

TreeMaker.Ident

TreeMaker.Ident用于創(chuàng)建標(biāo)識符語法樹節(jié)點（JCIdent），源碼如下

public?JCIdent?Ident(Name?name)?{
????????JCIdent?tree?=?new?JCIdent(name,?null);
????????tree.pos?=?pos;
????????return?tree;
}

public?JCIdent?Ident(Symbol?sym)?{
????????return?(JCIdent)new?JCIdent((sym.name?!=?names.empty)
??????????????????????????????????sym.name
????????????????????????????????:?sym.flatName(),?sym)
????????????.setPos(pos)
????????????.setType(sym.type);
}

public?JCExpression?Ident(JCVariableDecl?param)?{
????????return?Ident(param.sym);
}

TreeMaker.Return

TreeMaker.Return用于創(chuàng)建return語句（JCReturn），源碼如下

public?JCReturn?Return(JCExpression?expr)?{
????????JCReturn?tree?=?new?JCReturn(expr);
????????tree.pos?=?pos;
????????return?tree;
}

TreeMaker.Select

TreeMaker.Select用于創(chuàng)建域訪問/方法訪問（這里的方法訪問只是取到名字，方法的調(diào)用需要用TreeMaker.Apply）語法樹節(jié)點（JCFieldAccess），源碼如下

public?JCFieldAccess?Select(JCExpression?selected,
????Name?selector)?
{
????????JCFieldAccess?tree?=?new?JCFieldAccess(selected,?selector,?null);
????????tree.pos?=?pos;
????????return?tree;
}

public?JCExpression?Select(JCExpression?base,
????Symbol?sym)?{
????????return?new?JCFieldAccess(base,?sym.name,?sym).setPos(pos).setType(sym.type);
}

1. selected：.運算符左邊的表達(dá)式
2. selector：.運算符右邊的表達(dá)式

下面給出一個例子，一語句生成的Java語句就是二語句

一.?TreeMaker.Select(treeMaker.Ident(names.fromString("this")),?names.fromString("name"));

二.?this.name

TreeMaker.NewClass

TreeMaker.NewClass用于創(chuàng)建new語句語法樹節(jié)點（JCNewClass）,源碼如下：

public?JCNewClass?NewClass(JCExpression?encl,
????List?typeargs,
????JCExpression?clazz,
????List?args,
????JCClassDecl?def)?{
????????JCNewClass?tree?=?new?JCNewClass(encl,?typeargs,?clazz,?args,?def);
????????tree.pos?=?pos;
????????return?tree;
}

1. encl：不太明白此參數(shù)的含義，我看很多例子中此參數(shù)都設(shè)置為null
2. typeargs：參數(shù)類型列表
3. clazz：待創(chuàng)建對象的類型
4. args：參數(shù)列表
5. def：類定義

TreeMaker.Apply

TreeMaker.Apply用于創(chuàng)建方法調(diào)用語法樹節(jié)點（JCMethodInvocation），源碼如下：

public?JCMethodInvocation?Apply(List?typeargs,
????JCExpression?fn,
????List?args)?{
????????JCMethodInvocation?tree?=?new?JCMethodInvocation(typeargs,?fn,?args);
????????tree.pos?=?pos;
????????return?tree;
}

1. typeargs：參數(shù)類型列表
2. fn：調(diào)用語句
3. args：參數(shù)列表

TreeMaker.Assign

TreeMaker.Assign用戶創(chuàng)建賦值語句語法樹節(jié)點（JCAssign），源碼如下：

ublic?JCAssign?Assign(JCExpression?lhs,
????JCExpression?rhs)?{
????????JCAssign?tree?=?new?JCAssign(lhs,?rhs);
????????tree.pos?=?pos;
????????return?tree;
}

1. lhs：賦值語句左邊表達(dá)式
2. rhs：賦值語句右邊表達(dá)式

TreeMaker.Exec

TreeMaker.Exec用于創(chuàng)建可執(zhí)行語句語法樹節(jié)點（JCExpressionStatement），源碼如下：

public?JCExpressionStatement?Exec(JCExpression?expr)?{
????????JCExpressionStatement?tree?=?new?JCExpressionStatement(expr);
????????tree.pos?=?pos;
????????return?tree;
}

TreeMaker.Apply以及TreeMaker.Assign就需要外面包一層TreeMaker.Exec來獲得一個JCExpressionStatement。

TreeMaker.Block

TreeMaker.Block用于創(chuàng)建組合語句的語法樹節(jié)點（JCBlock），源碼如下：

public?JCBlock?Block(long?flags,
????List?stats)?{
????????JCBlock?tree?=?new?JCBlock(flags,?stats);
????????tree.pos?=?pos;
????????return?tree;
}

1. flags：訪問標(biāo)志
2. stats：語句列表

com.sun.tools.javac.util.List介紹

在我們操作抽象語法樹的時候，有時會涉及到關(guān)于List的操作，但是這個List不是我們經(jīng)常使用的java.util.List而是com.sun.tools.javac.util.List，這個List比較奇怪，是一個鏈?zhǔn)降慕Y(jié)構(gòu)，有頭結(jié)點和尾節(jié)點，但是只有尾節(jié)點是一個List，這里作為了解就行了。

public?class?List?extends?AbstractCollection?implements?java.util.List?{
????public?A?head;
????public?List?tail;
????private?static?final?List?EMPTY_LIST?=?new?List