ClosureParams：如何在 groovy 中为闭包参数指定泛型类型

Question

我在Java中有以下方法：

public void myMethod(
        @ClosureParams(
                value = SimpleType.class,
                options = {
                        "java.util.Map"
                }
        ) Closure<String> closure
) {
    ...
}

其中有 @ClosureParams 来指定闭包的参数类型，用于 IDEA 中的静态类型检查和类型推断。

在 Groovy 脚本中，我这样调用这个方法：

myMethod { Map<String, Object> doc ->
    ...
}

而且效果很好。但是，当我尝试在我的 java 方法中为 java.util.Map 的闭包指定 通用类型 时：

public void myMethod(
        @ClosureParams(
                value = SimpleType.class,
                options = {
                        "java.util.Map<java.lang.String,java.lang.Object>" // <-- added here
                }
        ) Closure<String> closure
) {
    ...
}

groovy 的静态类型检查器因错误而失败：

org.codehaus.groovy.control.MultipleCompilationErrorsException: startup failed:
C:\myproject\script.groovy: 1: Expected parameter of type java.util.Map<java.lang.String,java.lang.Object> but got java.util.Map <String, Object>
 @ line 1, column 8.
myMethod { Map<String, Object> doc ->

虽然 IDEA 使用 @ClosureParams 提示推断 doc 的类型而没有任何 Map 或 Map<...>。

当我查看groovy.transform.stc.SimpleType 类的源代码时，我发现这个类没有指定泛型类型的能力，因为它使用普通的Class.forName：

public class SimpleType extends SingleSignatureClosureHint {
    @Override
    public ClassNode[] getParameterTypes(final MethodNode node, final String[] options, final SourceUnit sourceUnit, final CompilationUnit unit, final ASTNode usage) {
        ClassNode[] result = new ClassNode[options.length];
        for (int i = 0; i < result.length; i++) {
            result[i] = findClassNode(sourceUnit, unit, options[i]);
        }
        return result;
    }
 }

    // findClassNode method:
    protected ClassNode findClassNode(final SourceUnit sourceUnit, final CompilationUnit compilationUnit, final String className) {
        if (className.endsWith("[]")) {
            return findClassNode(sourceUnit, compilationUnit, className.substring(0, className.length() - 2)).makeArray();
        }
        ClassNode cn = compilationUnit.getClassNode(className);
        if (cn == null) {
            try {
                cn = ClassHelper.make(Class.forName(className, false, sourceUnit.getClassLoader()));
            } catch (ClassNotFoundException e) {
                cn = ClassHelper.make(className);
            }
        }
        return cn;
    }

我的问题：如何在 groovy 中使用泛型指定闭包参数类型？最好有 IDEA 的支持。

Answer 1

您可以使用groovy.transform.stc.FromString 签名提示来使泛型类型正常工作。考虑以下示例：

JavaClass.java

import groovy.lang.Closure;
import groovy.transform.stc.ClosureParams;
import groovy.transform.stc.FromString;

import java.util.HashMap;

public class JavaClass {

    public static void processRendered(@ClosureParams(
            value = FromString.class,
            options = {"java.util.Map<java.lang.String,java.lang.Object>"}) Closure closure) {

        closure.call(new HashMap<String, Object>());
    }
}

script.groovy

import groovy.transform.CompileStatic
import static JavaClass.processRendered

@CompileStatic
def test() {
  processRendered { Map<String, Object> map ->
    map.put("test", 1)
  }

  processRendered {
    it.put("test", 2)
  }
}

test()

它编译并为您提供签名提示，也适用于隐式 it 变量。

以下示例使用 Groovy 2.5.7。