任務 (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 會以 QUIET 記錄層級重新導向至 Gradle 記錄系統，而 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"
}

對於每個提供的任務，此動作會新增一個任務「排序 (ordering)」，並且不指定任務之間的「相依性 (dependency)」。因此，即使範例中沒有先執行 'taskX'，仍然可以執行 'taskY'。

請這裡參閱可用於指定排序關係的物件類型描述。

僅當給定的閉包傳回 true 時，才執行任務。閉包將在任務執行時而非組態期間評估。閉包將傳遞單一參數，即此任務。如果閉包傳回 false，則將跳過任務。

您可以新增多個此類謂詞 (predicate)。如果任何謂詞傳回 false，則會略過該任務。

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

僅當給定的規格滿足時，才執行任務。規格將在任務執行時而非組態期間評估。如果規格不滿足，則將跳過任務。

您可以新增多個此類謂詞 (predicate)。如果任何謂詞傳回 false，則會略過該任務。

典型用法 (來自 Java)

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

僅當給定的規格滿足時，才執行任務。規格將在任務執行時而非組態期間評估。如果規格不滿足，則將跳過任務。

您可以新增多個此類謂詞 (predicate)。如果任何謂詞傳回 false，則會略過該任務。

典型用法 (來自 Java)

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

傳回此任務給定屬性的值。此方法依以下方式查找屬性

設定此任務的屬性。此方法在以下位置搜尋具有給定名稱的屬性，並在找到屬性的第一個位置設定屬性。

如果找不到該屬性，則會拋出 MissingPropertyException。

指定此任務應在所有提供的任務之後執行。

task taskY {
    shouldRunAfter "taskX"
}

對於每個提供的任務，此動作會新增一個任務「排序 (ordering)」，並且不指定任務之間的「相依性 (dependency)」。因此，即使範例中沒有先執行 'taskX'，仍然可以執行 'taskY'。

請這裡參閱可用於指定排序關係的物件類型描述。

註冊此任務使用的 BuildService，以便可以遵守 BuildServiceRegistration.getMaxParallelUsages()。

對於宣告為 ServiceReference 的任務屬性，這並非必要。