Gradle 创建 Task 的写法不是 Groovy 的标准语法吧？
Gradle 创建 Task 的写法不是 Groovy 的标准语法吧？
关键词：Gradle Groovy
任务名居然是以标识符的形式写出来的，你们难道没有觉得奇怪吗？
你一定写过这样的代码来创建一个 Task：
task clean(type: Delete) {
delete rootProject.buildDir
}
它定义了一个叫做 "clean" 的任务，这个任务的类型是 Delete。
其中 Delete 是一个类的名字，这是 Groovy 的语法，相当于 Delete.class。这个还好，至少人家语法上支持这样做。
后面的 { ... } 有 Kotlin 经验的小伙伴们自然也不会觉得陌生，这肯定是接收一个 Lambda （在 Groovy 当中就是 Closure）作为参数，里面的 delete rootProject.buildDir 则等价于 delete(rootProject.buildDir)，这也是 Groovy 的语法，在 Groovy 当中只要不引起歧义，函数的调用是可以去掉括号的，类似的例子有很多：
dependencies {
classpath 'com.android.tools.build:gradle:4.0.1'
...
}
这里的 classpath 也是如此。
这都很容易理解。那么问题来了，task clean(...){ ... } 这是个什么语法？我们定义一个名叫 "clean" 的任务，这个任务名不应该是一个字符串字面量吗，但现在按照 Groovy 的语法，它应该等价于 task(clean(...){ ... }) ，这个 clean 看上去其实是个方法名，而不是一个常量。
如果大家跟我一样一开始就绞尽脑汁地去研究这个玩意究竟是什么 Groovy 语法，那你从一开始就错了。这个答案直到我们在翻阅 Gradle 源码的时候，看到有一个叫做 TaskDefinitionScriptTransformer 的类，这个类在 Gradle 脚本编译运行的第二个阶段时被调用，它和其他几个类似的 Transformer 一样，作用就是对源代码的语法树做了一些转换。
大家在 Gradle 源码当中找到这个类之后就会发现，注释已经写的非常清晰了，例如：
if (args.getExpression(0) instanceof MapExpression && args.getExpression(1) instanceof VariableExpression) {
// Matches: task <name-value-pairs>, <identifier>, <arg>?
// Map to: task(<name-value-pairs>, '<identifier>', <arg>?)
transformVariableExpression(call, 1);
} else if (args.getExpression(0) instanceof VariableExpression) {
// Matches: task <identifier>, <arg>?
transformVariableExpression(call, 0);
}
通过注释我们可以看到，task 实际上是被当做函数来调用的，我们也确实可以在 Project 当中找到它的定义：
image-20210411072516707
这个映射实际上就是给 identifier 加了个引号，变成字符串字面量。注意到 transformVariableExpression(call, 1); 的第二个参数 1 对应的就是 <identifier>，第二个分支里面的位置则是 0。
这个方法的实现也很显而易见：
private void transformVariableExpression(MethodCallExpression call, int index) {
ArgumentListExpression args = (ArgumentListExpression) call.getArguments();
//拿到 identifier 对应的表达式
VariableExpression arg = (VariableExpression) args.getExpression(index);
if (!isDynamicVar(arg)) {
return;
}
// Matches: task args?, <identifier>, args? or task(args?, <identifier>, args?)
// Map to: task(args?, '<identifier>', args?)
String taskName = arg.getText(); // 表达式的内容就是任务名
call.setMethod(new ConstantExpression("task"));
// 创建一个以任务名为内容的字符串字面量
args.getExpressions().set(index, new ConstantExpression(taskName));
}
除了这个转换以外，还有很多其他的情况，现在我们的问题是文章一开始提到的 task clean(...){ ... }应当属于那种转换？属于嵌套方法调用的转换。前面我们已经分析到这个写法其实可以等价于 task(clean(...){ ... })，对应的转换在 maybeTransformNestedMethodCall 方法当中给出了实现，我们摘录一部分给大家了解一下：
private boolean maybeTransformNestedMethodCall(MethodCallExpression nestedMethod, MethodCallExpression target) {
...
// Matches: task <identifier> <arg-list> | task <string> <arg-list>
// Map to: task("<identifier>", <arg-list>) | task(<string>, <arg-list>)
Expression taskName = nestedMethod.getMethod();
Expression mapArg = null;
List<Expression> extraArgs = Collections.emptyList();
if (nestedMethod.getArguments() instanceof TupleExpression) {
TupleExpression nestedArgs = (TupleExpression) nestedMethod.getArguments();
if (nestedArgs.getExpressions().size() == 2 && nestedArgs.getExpression(0) instanceof MapExpression && nestedArgs.getExpression(1) instanceof ClosureExpression) {
// Matches: task <identifier>(<options-map>) <closure>
mapArg = nestedArgs.getExpression(0);
extraArgs = nestedArgs.getExpressions().subList(1, nestedArgs.getExpressions().size());
} else {
...
}
}
target.setMethod(new ConstantExpression("task"));
ArgumentListExpression args = (ArgumentListExpression) target.getArguments();
args.getExpressions().clear();
// 如果有 map 参数，放到第一个
if (mapArg != null) {
args.addExpression(mapArg);
}
// 注意，taskName 被当做参数传入
args.addExpression(taskName);
// 剩下的参数
for (Expression extraArg : extraArgs) {
args.addExpression(extraArg);
}
return true;
}
mapArg 是否为 null，对应了 task 方法的两个重载版本：
Task task(String name, Closure configureClosure);
Task task(Map<String, ?> args, String name, Closure configureClosure);
这么来看，文章开头提到的创建任务的写法，实际上相当于：
task(type: Delete, "clean") {
delete rootProject.buildDir
}
其他类似的 Transformer 大家可以自行分析。
C 语言是所有程序员应当认真掌握的基础语言，不管你是 Java 还是 Python 开发者，欢迎大家关注我的新课 《C 语言系统精讲》：
腾讯云开发者
