Task

一个 Task 有 4 个属性“范围”。您可以通过构建文件中的名称或调用 Task.property(java.lang.String) 方法来访问这些属性。您可以通过调用 Task.setProperty(java.lang.String, java.lang.Object) 方法来更改这些属性的值。

默认情况下，任务不会并行执行，除非某个任务正在等待异步工作并且另一个（非依赖）任务已准备好执行。可以通过构建启动时的 --parallel 标志启用并行执行。在并行模式下，不同项目（即多项目构建中）的任务可以并行执行。

将由该任务执行的 Action 对象序列，按执行顺序排列。

此任务的 AntBuilder。您可以在构建文件使用它来执行 ant 任务。

此任务的 Convention 对象。一个 Plugin 可以使用约定对象为该任务贡献属性和方法。

此任务的依赖项。

此任务的描述。

此任务的可销毁资源。

检查任务是否实际执行了任何工作。即使任务执行了，它也可能确定无事可做。例如，编译任务可能确定自上次运行以来源文件没有改变。

返回此任务是否已启用。

扩展容器。

返回将最终化此任务的任务。

此任务所属的任务组。任务组在报告和用户界面中用于在向用户呈现任务列表时将相关任务分组在一起。

此任务的输入项。

此任务的本地状态。

此任务的日志记录器。您可以在构建文件使用它来写入日志消息。

此任务的 LoggingManager，可用于接收日志和控制此任务的标准输出/错误捕获。默认情况下，System.out 被重定向到 Gradle 日志系统的 QUIET 日志级别，System.err 被重定向到 ERROR 日志级别。

返回此任务必须在其后运行的任务。

此任务的名称。该名称在其所属的 Project 中唯一标识该任务。

此任务的输出项。

任务的路径，是任务的完全限定名称。任务的路径是其所属 Project 的路径加上任务的名称，用 : 分隔。

此任务所属的 Project。

当配置缓存启用时，不支持从任务操作中调用此方法。

返回此任务应在其后运行的任务。

此任务的执行状态。这提供有关此任务执行的信息，例如它是否已执行、是否已跳过、是否已失败等。

返回一个 TaskDependency，其中包含此任务依赖的所有任务。

当配置缓存启用时，不支持从任务操作中调用此方法。

返回此任务可用于写入临时文件的目录。每个任务实例都有一个单独的临时目录。不保证此目录的内容在任务执行完成后保留。

此任务的超时时间。

  task myTask {
      timeout = Duration.ofMinutes(10)
  }

如果任务运行时间超过指定时间，执行此任务的线程将被中断。为了使任务能正确使用此功能，它需要对中断做出反应，并且必须清理它打开的任何资源。

默认情况下，任务永远不会超时。

为此任务添加指定的依赖项。有关可用作任务依赖项的对象类型的描述，请参见此处。

将给定的闭包添加到此任务操作列表的开头。执行时，将把该任务作为参数传递给闭包。

将给定的 Action 添加到此任务操作列表的开头。

将给定的 Action 添加到此任务操作列表的开头。

将给定的闭包添加到此任务操作列表的末尾。执行时，将把该任务作为参数传递给闭包。

将给定的 Action 添加到此任务操作列表的末尾。

将给定的 Action 添加到此任务操作列表的末尾。

不跟踪任务的状态。

指示 Gradle 将任务视为未跟踪状态。

为此任务添加指定的最终化任务。

task taskY {
    finalizedBy "taskX"
}

有关可用于指定最终化任务的对象类型的描述，请参见此处。

确定此任务是否具有指定的属性。有关任务可用属性的详细信息，请参见此处。

指定此任务必须在所有提供的任务之后运行。

task taskY {
    mustRunAfter "taskX"
}

对于提供的每个任务，此操作添加任务“排序”，但不指定任务之间的“依赖关系”。因此，在示例中仍然可以在不先执行“taskX”的情况下执行“taskY”。

有关可用于指定排序关系的对象的类型说明，请参阅此处。

仅当给定的闭包返回 true 时才执行任务。该闭包将在任务执行时评估，而不是在配置时评估。该闭包将接收一个参数，即此任务。如果闭包返回 false，则任务将被跳过。

您可以添加多个此类断言。如果任何断言返回 false，则跳过该任务。

典型用法：myTask.onlyIf { isProductionEnvironment() }

仅当给定的规范 (spec) 满足时才执行任务。该规范将在任务执行时评估，而不是在配置时评估。如果规范不满足，任务将被跳过。

您可以添加多个此类断言。如果任何断言返回 false，则跳过该任务。

典型用法（Java）

myTask.onlyIf("run only in production environment", new Spec<Task>() {
   boolean isSatisfiedBy(Task task) {
      return isProductionEnvironment();
   }
});

仅当给定的规范 (spec) 满足时才执行任务。该规范将在任务执行时评估，而不是在配置时评估。如果规范不满足，任务将被跳过。

您可以添加多个此类断言。如果任何断言返回 false，则跳过该任务。

典型用法（Java）

myTask.onlyIf(new Spec<Task>() {
   boolean isSatisfiedBy(Task task) {
      return isProductionEnvironment();
   }
});

返回此任务指定属性的值。此方法按如下方式查找属性

设置此任务的一个属性。此方法在以下位置搜索具有指定名称的属性，并在找到该属性的第一个位置上设置该属性。

如果未找到该属性，则抛出 MissingPropertyException。

指定此任务应在所有提供的任务之后运行。

task taskY {
    shouldRunAfter "taskX"
}

对于提供的每个任务，此操作添加任务“排序”，但不指定任务之间的“依赖关系”。因此，在示例中仍然可以在不先执行“taskX”的情况下执行“taskY”。

有关可用于指定排序关系的对象的类型说明，请参阅此处。

注册此任务使用的 BuildService，以便遵守 BuildServiceRegistration.getMaxParallelUsages()。

对于声明为 ServiceReference 的任务属性，这不是必需的。