AST Transformations


Although at times, it may sound like a good idea to extend the syntax of Groovy to implement new features (like this is the case for instance for multiple assignments), most of the time, we can't just add a new keyword to the grammar, or create some new syntax construct to represent a new concept. However, with the idea of AST (Abstract Syntax Tree) Transformations, we are able to tackle new and innovative ideas without necessary grammar changes.

時々ではあるが、Groovyの構文を拡張して新しい機能を実装すること(複数割り当てのインスタンスの場合のように)はよいアイデアと思われるようです。ほとんどの場合、新しい概念を表現するために新しい構文を構築したり、文法に新しいキーワードを追加したりすることはできません。新しい機能を実装するために、Groovyの構文を拡張することをお勧めのように聞こえるかもしれないが、ほとんどの時間、私たちは、新しいキーワードを追加することはできません文法は、またはいくつかの新しい構文は新しいコンセプトを表現するために構築を作成します。しかしながら、AST (Abstract Syntax Tree:抽象構文木)変換のアイデアを用いることにより、文法を変更すること無しに、新しい革新的なアイデアに取り組むことができるのです。

When the Groovy compiler compiles Groovy scripts and classes, at some point in the process, the source code will end up being represented in memory in the form of a Concrete Syntax Tree, then transformed into an Abstract Syntax Tree. The purpose of AST Transformations is to let developers hook into the compilation process to be able to modify the AST before it is turned into bytecode that will be run by the JVM.


AST Transformations provides Groovy with improved compile-time metaprogramming capabilities allowing powerful flexibility at the language level, without a runtime performance penalty.


There are two kinds of transformations: global and local transformations.


  • Global transformations are applied to by the compiler on the code being compiled, wherever the transformation apply. A JAR added to the classpath of the compiler should contain a service locator file at META-INF/services/org.codehaus.groovy.transform.ASTTransformation with a line with the name of the transformation class. The transformation class must have a no-args constructor and implement the org.codehaus.groovy.transform.ASTTransformationinterface. It will be run against every source in the compilation, so be sure to not create transformations which scan all the AST in an expansive and time-consuming manner, to keep the compiler fast.

グローバル変換は、コンパイル開始時にコンパイラによって適用されます。コードのどこにいても変換が適用されます。コンパイラのクラスパスに追加されたJARファイルは META-INF/services/org.codehaus.groovy.transform へのサービスロケーターファイルを含んでいる必要があります。ASTTransformationという名前の行情報を持ったクラスです。変換クラスは、引数なしのコンストラクタを持ち、org.codehaus.groovy.transform.ASTTransformation インタフェースを実装している必要があります。すべてのソースに対してコンパイル時に実行されるので、コンパイラの高速を維持するために、時間がかかるASTのスキャン時には変換を行わないようにしています。

  • Local transformations are transformations applied locally by annotating code elements you want to transform. For this, we reuse the annotation notation, and those annotations should implement org.codehaus.groovy.transform.ASTTransformation. The compiler will discover them and apply the transformation on these code elements.

ローカル変換は、変換したいコード要素にアノテーションを付けることによって、局所的に変換が適用されます。このために、アノテーション表記を再利用します。そして、アノテーションは org.codehaus.groovy.transform.ASTTransformation を実装している必要があります。コンパイラはそれらを検出し、これらのコード要素に対して変換を適用します。

One hook for accessing this capability is via annotations (for local AST transformations). In your Groovy code you will make use of one of more annotations. Behind the scenes, an AST processor relevant to the annotation you are using is inserted into the compiler phases at the appropriate point. You can explore some of the more popular Annotations below:


Grape also provides its own transformation with @Grab.

Japanese Grapeも@Grabというアノテーションでそれ自身の変換を提供しています。

Implementing your own AST Transformations


There are two kinds of AST Transformations, local and global transformations:


When writing an AST Transformation, you may find the following guides helpful: