Groovy技术问题：如何从AST获取静态推断的返回类型

这个需求太贴合实际了——毕竟谁也不想等用户脚本跑起来才发现返回类型不对！好在Groovy的静态编译体系里已经藏着解决这个问题的工具，咱们可以直接复用它的静态类型推断能力，不用真的执行脚本就能做检查。下面一步步来拆解：

核心思路：复用Groovy的静态类型检查框架 #

Groovy的静态编译不是黑盒，它依赖内置的静态类型检查器在编译阶段分析代码的抽象语法树（AST），推断每个方法的返回类型、变量类型等信息。我们可以直接调用这个检查器的API，针对用户脚本的入口方法（也就是Groovy脚本自动生成的run方法），校验其推断返回类型是否始终为boolean（或Boolean）。

具体实现步骤 #

1. 配置编译器启用静态类型检查 #

首先要创建一个启用了静态类型检查的编译器配置，确保检查器能正常工作：

import org.codehaus.groovy.control.CompilerConfiguration
import org.codehaus.groovy.transform.stc.StaticTypeCheckingExtension

def config = new CompilerConfiguration()
// 启用静态类型检查扩展
config.addCompilationCustomizers(new StaticTypeCheckingExtension())
// 临时目录用于编译中间文件（可选，不影响类型检查逻辑）
config.setTargetDirectory(new File(System.getProperty("java.io.tmpdir")))

2. 分析脚本AST并获取推断返回类型 #

通过SourceUnit加载用户脚本，再用StaticTypeCheckingVisitor遍历AST，最终获取run方法的推断返回类型：

import org.codehaus.groovy.control.SourceUnit
import org.codehaus.groovy.transform.stc.StaticTypeCheckingVisitor
import org.codehaus.groovy.ast.MethodNode
import groovy.lang.GroovyClassLoader

def checkBooleanReturnType(String scriptCode) {
    def classLoader = new GroovyClassLoader(Thread.currentThread().contextClassLoader, config)
    def sourceUnit = SourceUnit.create("UserScript.groovy", scriptCode, config, classLoader)
    
    // 初始化静态类型检查访问器
    def visitor = new StaticTypeCheckingVisitor(sourceUnit)
    visitor.visitClass(sourceUnit.getAST())

    // 找到脚本的run方法（Groovy脚本会被编译为继承Script的类，run是执行入口）
    MethodNode runMethod = sourceUnit.getAST().methods.find { it.name == "run" }
    if (!runMethod) return false

    // 获取run方法的推断返回类型
    def inferredReturnType = visitor.getInferredReturnType(runMethod)
    def booleanType = ClassNode.make(Boolean.TYPE)
    def booleanWrapperType = ClassNode.make(Boolean.class)

    // 检查是否为boolean基本类型或Boolean包装类型
    return inferredReturnType.isDerivedFrom(booleanType) || inferredReturnType.isDerivedFrom(booleanWrapperType)
}

3. 测试与错误提示 #

调用上面的方法就能快速校验脚本返回类型，要是不通过，还可以进一步分析AST或检查器收集的错误，给用户精准提示：

// 测试用例
def validScript = """
if (someCondition) {
    return true
} else {
    return false
}
"""

def invalidScript = """
if (Math.random() > 0.5) {
    return true
} else {
    return "oops, wrong type"
}
"""

println checkBooleanReturnType(validScript) // 输出true
println checkBooleanReturnType(invalidScript) // 输出false

注意事项与优化点 #

• 覆盖所有分支：Groovy的静态类型检查器会自动分析if-else、switch、try-catch等所有可能的执行路径，只要有一个分支返回非boolean类型，就能被检测到。
• 空值处理：如果允许脚本返回null，要把预期类型改为Boolean.class（包装类型），而不是boolean（基本类型），因为null无法赋值给基本类型。
• 精准报错：可以通过sourceUnit.getErrorCollector()获取检查器收集的错误信息，或者遍历AST节点定位到具体错误行，给用户更友好的提示，比如："第6行：返回值类型为String，预期是boolean"。

内容的提问来源于stack exchange，提问作者Martin Häusler