无需@TypeChecked/@CompileStatic实现Groovy编译时错误检查问询

我们有一个用Groovy编写的SpringBoot网关项目，所有Controller和Service均为*.groovy文件，代码完全是Java风格，仅借助Groovy实现热更新，无需其动态特性。但Groovy的动态特性导致代码存在未定义变量、调用不存在方法、类型不匹配等错误时，编译和运行阶段均不报错，仅在调用对应Controller时才暴露问题。

虽然@TypeChecked或@CompileStatic可满足编译时错误检查需求，但领导不允许给每个类添加该注解。目前考虑使用Maven插件或AST转换方案，已尝试编写AST转换脚本，但不清楚如何配置GMavenPlus插件使其在编译时生效，也不明确脚本逻辑该如何编写，特咨询：

1. 如何使用AST脚本？能否配置GMavenPlus插件让其在编译时执行？
2. AST脚本的逻辑应如何编写？

1. 配置GMavenPlus插件让AST脚本在编译时执行 #

完全可以通过GMavenPlus插件配置AST转换，让它在Groovy编译阶段自动生效，无需手动给每个类加注解。具体步骤如下：

• 第一步：准备AST转换代码
  把AST转换代码放在项目源码目录（比如src/main/groovy/com/yourcompany/ast/），或者打包成独立JAR引入项目。
• 第二步：配置GMavenPlus插件
  在pom.xml中配置插件，指定AST转换的路径或类，示例如下：

  <plugin>
    <groupId>org.codehaus.gmavenplus</groupId>
    <artifactId>gmavenplus-plugin</artifactId>
    <version>1.13.1</version> <!-- 使用与项目Groovy版本兼容的最新稳定版 -->
    <executions>
      <execution>
        <goals>
          <goal>compile</goal>
          <goal>testCompile</goal>
        </goals>
      </execution>
    </executions>
    <configuration>
      <!-- 若用Groovy脚本形式的AST转换，使用scripts标签 -->
      <scripts>
        <script>src/main/groovy/com/yourcompany/ast/StaticTypeCheckTransform.groovy</script>
      </scripts>
      <!-- 若用编译后的AST转换类，使用transformers标签（推荐更稳定） -->
      <transformers>
        <transformer>com.yourcompany.ast.StaticTypeCheckTransform</transformer>
      </transformers>
    </configuration>
    <dependencies>
      <dependency>
        <groupId>org.codehaus.groovy</groupId>
        <artifactId>groovy-all</artifactId>
        <version>3.0.17</version> <!-- 和项目Groovy版本保持一致 -->
        <type>pom</type>
      </dependency>
    </dependencies>
  </plugin>
  

  说明：
  • scripts和transformers二选一即可，类形式的转换稳定性更高。
  • 需确保GMavenPlus版本与项目Groovy版本兼容，可参考插件官方文档的版本对应表。
• 第三步：验证生效
  执行mvn compile，若配置生效，编译阶段会自动触发静态类型检查，抛出类型不匹配、方法不存在等错误。

2. AST转换脚本/类的编写逻辑 #

核心是通过AST API给目标Groovy类自动添加@CompileStatic或@TypeChecked注解的效果，无需手动编写。具体实现：

基于Groovy AST API编写转换类 #

实现ASTTransformation接口并添加@GroovyASTTransformation注解指定触发阶段，示例代码：

package com.yourcompany.ast

import groovy.transform.CompileStatic
import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.control.CompilePhase
import org.codehaus.groovy.control.SourceUnit
import org.codehaus.groovy.transform.ASTTransformation
import org.codehaus.groovy.transform.GroovyASTTransformation

@GroovyASTTransformation(phase = CompilePhase.SEMANTIC_ANALYSIS)
class StaticTypeCheckTransform implements ASTTransformation {

    @Override
    void visit(ASTNode[] nodes, SourceUnit sourceUnit) {
        // 遍历当前源文件的所有类
        sourceUnit.ast.classes.each { ClassNode classNode ->
            // 只处理项目自有包下的类，避免影响第三方依赖
            if (classNode.packageName.startsWith("com.yourcompany")) {
                // 给类添加@CompileStatic注解
                ClassNode compileStaticAnn = new ClassNode(CompileStatic)
                classNode.addAnnotation(compileStaticAnn)
                
                // 若需要更灵活的检查规则，可替换为@TypeChecked：
                // ClassNode typeCheckedAnn = new ClassNode(TypeChecked)
                // classNode.addAnnotation(typeCheckedAnn)
            }
        }
    }
}

关键逻辑说明 #

• 编译阶段选择：指定CompilePhase.SEMANTIC_ANALYSIS，在类结构解析完成后、代码生成前执行转换，保证类型检查生效。
• 范围控制：通过包名过滤目标类，避免修改Groovy核心类或第三方依赖类。
• 注解添加：直接通过AST API给类节点添加静态检查注解，效果与手动添加完全一致。
• 可选优化：可添加判断逻辑，避免给已存在@CompileStatic的类重复添加注解，减少编译冗余。

脚本形式的AST转换（简化版） #

若用Groovy脚本编写，逻辑类似，无需编译类，直接通过GMavenPlus引入：

import org.codehaus.groovy.ast.ClassNode
import org.codehaus.groovy.control.SourceUnit

def visit = { ASTNode[] nodes, SourceUnit sourceUnit ->
    sourceUnit.ast.classes.each { ClassNode classNode ->
        if (classNode.packageName.startsWith("com.yourcompany")) {
            def compileStaticAnn = new ClassNode(Class.forName('groovy.transform.CompileStatic'))
            classNode.addAnnotation(compileStaticAnn)
        }
    }
}

// 注册AST转换逻辑
this.metaClass.mixin(org.codehaus.groovy.transform.ASTTransformation)

内容的提问来源于stack exchange，提问作者dim-strong