时髦的 AST 转换 - 如何使用 Gradle 和 Intellij IDEA 编译 Java 注释类

Question

我想开发一个Groovy AST转换，在某些类上添加一些方法。所以我写了一个注释类和相应的转换类。然后，我用我的Groovy AST注释来注释一个java类。

当我使用嵌入式时髦编译器编译 java 注释类时（例如，通过以下代码段：类增强类 = 新 GroovyClassLoader（）.parseClass（新文件（“...”））;），执行转换并将方法添加到代码段中称为增强类的已编译类中。

但我无法用Gradle groovy插件和Intellij IDEA正确编译java类。

问题:每个人都可以帮助我在Gradle和Intellij IDEA中使用Groovy AST转换吗？

注1:我用的是Intellij IDEA 14旗舰版。

注2:我的Groovy AST类、java注释类和我的“build.gradle”文件如下：

注释类：

@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.TYPE)
@GroovyASTTransformationClass(classes = {MyASTTransformation.class})
public @interface MyAST {
}

和转换类：

@CompileStatic
@GroovyASTTransformation(phase = CompilePhase.SEMANTIC_ANALYSIS)
public class MyASTTransformation implements ASTTransformation {
   @Override
   public void visit(ASTNode[] nodes, SourceUnit sourceUnit) {
      ...
   }
}

java注释类：

@MyAST
public class A {
   ...
}

"build.gradle"文件：

apply plugin: 'groovy'
sourceSets {
    main {
       groovy {
          srcDirs = ['src/main/groovy', 'src/main/java']
       }
        java {
          srcDirs = []
      }
   }
}

dependencies {
    compile 'org.codehaus.groovy:groovy-all:2.4.4'
}

Answer 1

我创建了我的第一个自定义AST转换，我也遇到了类似的问题，因此分享了我有限的经验。我正在使用Groovy 2.4.7和IntelliJ IDEA 2016.3.2。我只能在以下情况下使用自定义转换注释：

1. 它是作为一个单独的工件（项目）创建的，另一个使用注释的项目引用了它
2. 在与使用自定义注释的Groovy代码运行GroovyShell的自定义AST转换代码相同的项目中运行Groov测试脚本

我第一次尝试在同一项目中这样做，但这不起作用。我相信这是因为AST转换发生在编译时。这是我的例子：

AST改造项目

注释

@Retention (RetentionPolicy.SOURCE)
@Target ([ElementType.TYPE, ElementType.METHOD])
@GroovyASTTransformationClass (classes = [SqlAssistTransform])
@interface SqlAssist {
}

转型

@GroovyASTTransformation(phase=CompilePhase.SEMANTIC_ANALYSIS)
class SqlAssistTransform extends AbstractASTTransformation {
...
}

settings.gradle

rootProject.name = 'groovy-sql-transform'

build.gradle

...
group = 'com.company.groovy.transform'
version = '1.0-groovy-2.4'
description = 'Groovy AST transformation for SQL syntax'
...

使用 AST 注释的项目

带注释的类

@SqlAssist
class Something {
...
}

依赖关系示例#1-依赖于存储库中的AST工件

build.gradle

...
dependencies {
     ...
    // As long as your local repository (or remote repository) has the AST transformation project installed. i.e. Run '.\gradlew install' in AST project to install to local repository
    compile group:'com.company.groovy.transform', name:'groovy-sql-transform', version: '1.0.0-groovy-2-4'
    ...
}
...

依赖关系示例#2-依赖于AST项目

build.gradle

...
dependencies {
    ...
    compile project(':groovy-sql-transform')
    ...
}
...

settings.gradle

rootProject.name = 'project-name'

// Assumption that AST project lives at the same level as this project
include "groovy-sql-transform"
project(":groovy-sql-transform").projectDir = new File("../groovy-sql-transform")

测试

我没有创建适当的单元测试，但我确实使用了以下内容在IntelliJ中进行测试和调试，这样我就可以在AST转换代码的不同位置查看AST。AST转换项目中的示例测试Groovy脚本：

new GroovyShell(getClass().classLoader).evaluate '''

import com.company.groovy.transform.SqlAssist

@SqlAssist
class Testing {
...
}

'''