如何防止Groovy函数作用域创建全局变量及批量修正方法？

问题场景 #

在Groovy脚本中，函数内直接给未声明的变量赋值会自动创建全局变量，示例如下：

def defineGlobalVariable() {
    z = "hello"
}

defineGlobalVariable()
println(z)
// 输出 "hello"

当多个函数并发运行时，这类意外创建的全局变量会被交叉修改，引发数据不一致问题。我们需要实现两个目标：

1. 阻止函数内创建新的全局变量
2. 允许函数对已存在的全局变量进行赋值

可行解决方案 #

1. 编译时强制检查（推荐） #

通过Groovy的编译自定义器实现AST转换，在编译阶段检查函数内的变量赋值行为：

• 若变量未在局部作用域声明，也未作为全局变量预先定义，则抛出编译错误
• 不影响对已存在全局变量的赋值操作

示例代码：

import org.codehaus.groovy.ast.*
import org.codehaus.groovy.ast.expr.*
import org.codehaus.groovy.ast.stmt.*
import org.codehaus.groovy.control.*
import org.codehaus.groovy.control.customizers.*

// 配置编译规则
def compilerConfig = new CompilerConfiguration()
compilerConfig.addCompilationCustomizers(new ASTTransformationCustomizer() {
    @Override
    void call(SourceUnit sourceUnit, GeneratorContext genContext, ClassNode classNode) {
        // 遍历所有函数
        classNode.methods.each { method ->
            method.code.visit(new CodeVisitorSupport() {
                @Override
                void visitAssignmentExpression(AssignmentExpression expr) {
                    def varExpr = expr.leftExpression
                    if (varExpr instanceof VariableExpression) {
                        String varName = varExpr.name
                        // 检查是否是当前函数的局部变量
                        boolean isLocal = method.variables.any { it.name == varName }
                        // 检查是否是全局脚本变量（脚本类的字段）
                        boolean isGlobalField = classNode.fields.any { it.name == varName }
                        
                        if (!isLocal && !isGlobalField) {
                            sourceUnit.addError("变量 '$varName' 未声明局部变量，也未预先定义为全局变量", expr)
                        }
                    }
                    super.visitAssignmentExpression(expr)
                }
            })
        }
    }
})

// 使用自定义配置执行脚本
def groovyShell = new GroovyShell(compilerConfig)
groovyShell.evaluate('''
def shouldWork = "hi"

def assignToGlobalVariable() {
    shouldWork = "hello" // 允许：全局变量已存在
}

def defineGlobalVariable() {
    shouldFail = "hello" // 编译报错：未声明局部或全局变量
}

assignToGlobalVariable()
println(shouldWork)
defineGlobalVariable()
println(shouldFail)
''')

这种方式能在运行前拦截非法的全局变量创建，从根源避免并发问题。

2. 正则表达式批量替换 #

如果无法使用编译时检查，可以通过正则替换将函数内未声明的变量赋值改为局部变量声明。操作步骤如下：

1. 提取全局变量列表：先找出脚本中所有预先定义的全局变量，比如用正则匹配：

   ^def\s+([a-zA-Z_]\w*)
   

2. 替换函数内的非法赋值：匹配函数体中未在全局列表内的变量赋值，添加def修饰符。推荐使用的正则（需结合全局变量列表过滤）：

   (?<=\{|\s)([a-zA-Z_]\w*)\s*=\s*(?!=)
   

   替换为：def $1 =

   注意：正则替换存在误判风险，替换后需要逐一验证，避免修改合法的全局变量赋值或已有局部变量。

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