如何让Groovy @TypeChecked识别JetBrains GDSL中定义的方法？

针对你用GDSL定义Jenkins流水线方法、想让Groovy的@TypeChecked注解识别这些方法的需求，以下是几种可行方案，避免重复实现StaticTypeCheckingVisitor的核心逻辑：

1. 生成静态存根类（最直接的方案） #

GDSL仅用于IDE提示，本身不参与编译。你可以将GDSL中定义的方法转换成空实现的存根类，让Groovy编译器在@TypeChecked检查时能找到这些方法的定义：

• 手动或通过脚本生成存根类：比如针对Jenkins流水线步骤，创建JenkinsPipelineStubs.groovy，把GDSL里的方法都写成空实现（或抛出UnsupportedOperationException）。例如：

  class JenkinsPipelineStubs {
      void sh(String command) {
          throw new UnsupportedOperationException("Stub for @TypeChecked only")
      }
      // 其他GDSL中定义的方法，如echo、git等
  }
  

• Gradle配置：将存根类所在目录添加为Groovy源集，比如在build.gradle中：

  sourceSets {
      main {
          groovy {
              srcDirs += 'src/stubs/groovy'
          }
      }
  }
  

  这样Groovy编译时会加载这些存根类，@TypeChecked就能识别到方法的存在。

2. 利用Groovy扩展模块 #

Groovy的扩展模块可以为现有类添加方法，编译和运行时都能生效，刚好匹配GDSL的场景：

• 编写扩展类：创建扩展类，定义GDSL中的所有方法（空实现用于类型检查）。例如：

  class JenkinsPipelineExtensions {
      static void sh(Object delegate, String command) {
          // 空实现或抛出异常
      }
  }
  

• 配置扩展模块文件：在src/main/resources/META-INF/services下创建org.codehaus.groovy.runtime.ExtensionModule文件，内容如下：

  moduleName=jenkins-pipeline-extensions
  moduleVersion=1.0
  extensionClasses=com.yourcompany.JenkinsPipelineExtensions
  

• Gradle中确保资源文件被正确打包，这样@TypeChecked编译时会自动识别这些扩展方法。

3. 定制StaticTypeCheckingExtension（灵活但稍复杂） #

如果不想生成额外的存根类，可以直接扩展Groovy的静态类型检查扩展，复用内置的方法搜索和类型匹配逻辑：

• 编写自定义扩展类：继承StaticTypeCheckingExtension，在setup方法中解析GDSL文件，将方法注册到类型检查上下文。例如：

  class GDSLTypeCheckExtension extends StaticTypeCheckingExtension {
      @Override
      void setup() {
          // 解析GDSL文件，获取方法元数据
          def gdslMethods = parseGDSL('path/to/your.gdsl')
          gdslMethods.each { method ->
              // 注册静态方法到当前上下文，复用Groovy的类型检查逻辑
              addStaticMethod(
                  currentClassNode,
                  method.name,
                  method.returnType,
                  method.parameters,
                  null
              )
          }
      }
  
      private List<MethodMeta> parseGDSL(String path) {
          // 执行GDSL代码，提取方法定义的元数据
          // GDSL本身是Groovy代码，可通过GroovyShell执行并获取其定义的方法信息
      }
  }
  

• Gradle配置：在Groovy编译任务中指定扩展类：

  groovyCompile {
      options.compilerArgs += [
          '-Dgroovy.static.typecheck.extensions=com.yourcompany.GDSLTypeCheckExtension'
      ]
  }
  

  这种方式直接复用StaticTypeCheckingVisitor的内置逻辑，不用重复实现方法搜索、参数匹配等功能。

4. Gradle任务自动生成存根 #

如果GDSL内容较多，可以写一个Gradle任务自动解析GDSL并生成存根类：

• 编写Gradle任务：利用GroovyShell执行GDSL文件，提取其中定义的方法、参数、返回类型等元数据，然后自动生成存根类文件到指定目录。
• 依赖配置：让groovyCompile任务依赖这个生成任务，确保存根类在编译前生成。

内容的提问来源于stack exchange，提问作者Mark