複製

屬性
方法
腳本區塊
屬性詳細資訊
方法詳細資訊

API 文件	`複製`

已知子類型

處理資源

將檔案複製到目標目錄。此任務也可以在複製時重新命名和過濾檔案。此任務實作 CopySpec 以指定要複製的內容。

範例

task copyDocs(type: Copy) {
    from 'src/main/doc'
    into 'build/target/doc'
}

//for Ant filter
import org.apache.tools.ant.filters.ReplaceTokens

//for including in the copy task
def dataContent = copySpec {
    from 'src/data'
    include '*.data'
}

task initConfig(type: Copy) {
    from('src/main/config') {
        include '**/*.properties'
        include '**/*.xml'
        filter(ReplaceTokens, tokens: [version: '2.3.1'])
    }
    from('src/main/config') {
        exclude '**/*.properties', '**/*.xml'
    }
    from('src/main/languages') {
        rename 'EN_US_(.*)', '$1'
    }
    into 'build/target/config'
    exclude '**/*.bak'

    includeEmptyDirs = false

    with dataContent
}

屬性

屬性	描述
`區分大小寫`	指定是否應使用區分大小寫的模式比對。
`目標目錄`	要將檔案複製到的目錄。
`目錄權限`	用於查詢和配置目錄存取權限的屬性。如果屬性未設定值，則表示保留現有的權限。這些權限是否實際應用取決於複製動作的實作。詳情請參閱 `ConfigurableFilePermissions`。
`重複策略`	嘗試將多個檔案複製到相同目標時使用的策略。
`排除`	排除模式的集合。
`檔案權限`	用於查詢和配置檔案存取權限的屬性。如果屬性未設定值，則表示保留現有的權限。這些權限是否實際應用取決於複製動作的實作。詳情請參閱 `ConfigurableFilePermissions`。
`包含空目錄`	指示是否將空目標目錄包含在複製中。
`包含`	包含模式的集合。
`來源`	此任務的來源檔案。

方法

方法	描述
`eachFile(closure)`	新增一個動作，用於應用於每個即將複製到目標位置的檔案。給定的閉包會以 `FileCopyDetails` 作為參數呼叫。動作會按照新增的順序執行，並從父規範繼承。
`eachFile(action)`	新增一個動作，用於應用於每個即將複製到目標位置的檔案。此動作可以變更檔案的目標路徑、過濾檔案的內容，或將檔案完全排除在結果之外。動作會按照新增的順序執行，並從父規範繼承。
`exclude(excludeSpec)`	新增一個排除規範。此方法可以多次呼叫以附加新的規範。給定的閉包會傳遞一個 `FileTreeElement` 作為其參數。閉包應傳回 true 或 false。範例
`exclude(excludes)`	新增一個 ANT 風格的排除模式。此方法可以多次呼叫以附加新的模式，並且可以在單次呼叫中指定多個模式。如果未提供排除模式，則不會排除任何檔案。如果提供了排除模式，則檔案不得符合任何排除模式才能被處理。
`exclude(excludes)`	新增一個 ANT 風格的排除模式。此方法可以多次呼叫以附加新的模式，並且可以在單次呼叫中指定多個模式。如果未提供排除模式，則不會排除任何檔案。如果提供了排除模式，則檔案不得符合任何排除模式才能被處理。
`exclude(excludeSpec)`	新增一個排除規範。此方法可以多次呼叫以附加新的規範。如果未提供排除模式，則不會排除任何檔案。如果提供了排除模式，則檔案不得符合任何排除模式才能被處理。
`expand(properties)`	在複製每個檔案時展開屬性參考。更具體地說，每個檔案都使用 Groovy 的 `SimpleTemplateEngine` 進行轉換。這表示您可以在檔案中使用簡單的屬性參考，例如 `$property` 或 `${property}`。您也可以在檔案中包含任意 Groovy 程式碼，例如 `${version ?: 'unknown'}` 或 `${classpath*.name.join(' ')}`。
`expand(properties, action)`	在複製每個檔案時展開屬性參考。更具體地說，每個檔案都使用 Groovy 的 `SimpleTemplateEngine` 進行轉換。這表示您可以在檔案中使用簡單的屬性參考，例如 `$property` 或 `${property}`。您也可以在檔案中包含任意 Groovy 程式碼，例如 `${version ?: 'unknown'}` 或 `${classpath*.name.join(' ')}`。可以使用提供的動作來配置模板引擎。
`filesMatching(patterns, action)`	為路徑符合任何指定 Ant 風格模式的每個檔案配置 `FileCopyDetails`。這相當於使用 eachFile() 並根據檔案的路徑選擇性地應用配置。
`filesMatching(pattern, action)`	為路徑符合指定 Ant 風格模式的每個檔案配置 `FileCopyDetails`。這相當於使用 eachFile() 並根據檔案的路徑選擇性地應用配置。
`filesNotMatching(patterns, action)`	為路徑不符合任何指定 Ant 風格模式的每個檔案配置 `FileCopyDetails`。這相當於使用 eachFile() 並根據檔案的路徑選擇性地應用配置。
`filesNotMatching(pattern, action)`	為路徑不符合指定 Ant 風格模式的每個檔案配置 `FileCopyDetails`。這相當於使用 eachFile() 並根據檔案的路徑選擇性地應用配置。
`filter(closure)`	根據提供的閉包新增內容過濾器。將使用每一行（去除行尾符號）呼叫閉包，並應傳回一個字串以替換該行，或傳回 `null` 以移除該行。如果移除每一行，結果將會是一個空檔案，而不是一個不存在的檔案。
`filter(filterType)`	新增一個要在複製期間使用的內容過濾器。多次呼叫 filter 會將額外的過濾器新增到過濾器鏈。每個過濾器都應實作 `java.io.FilterReader`。包含 `org.apache.tools.ant.filters.*` 以存取所有標準 Ant 過濾器。
`filter(properties, filterType)`	新增一個要在複製期間使用的內容過濾器。多次呼叫 filter 會將額外的過濾器新增到過濾器鏈。每個過濾器都應實作 `java.io.FilterReader`。包含 `org.apache.tools.ant.filters.*` 以存取所有標準 Ant 過濾器。
`filter(transformer)`	根據提供的轉換器新增內容過濾器。將使用每一行（去除行尾符號）呼叫閉包，並應傳回一個字串以替換該行，或傳回 `null` 以移除該行。如果移除每一行，結果將會是一個空檔案，而不是一個不存在的檔案。
`from(sourcePath, c)`	指定複製的來源檔案或目錄，並建立子 `CopySourceSpec`。給定的來源路徑會根據 `Project.files(java.lang.Object[])` 進行評估。
`from(sourcePath, configureAction)`	指定複製的來源檔案或目錄，並建立子 `CopySpec`。給定的來源路徑會根據 `Project.files(java.lang.Object[])` 進行評估。
`from(sourcePaths)`	指定複製的來源檔案或目錄。給定的路徑會根據 `Project.files(java.lang.Object[])` 進行評估。
`include(includeSpec)`	新增一個包含規範。此方法可以多次呼叫以附加新的規範。給定的閉包會傳遞一個 `FileTreeElement` 作為其參數。如果未提供包含模式，則將包含此容器中的所有檔案。如果提供了包含模式，則檔案必須符合至少一個包含模式或規範才能被包含。
`include(includes)`	新增一個 ANT 風格的包含模式。此方法可以多次呼叫以附加新的模式，並且可以在單次呼叫中指定多個模式。如果未提供包含模式，則將包含此容器中的所有檔案。如果提供了包含模式，則檔案必須符合至少一個包含模式才能被處理。
`include(includes)`	新增一個 ANT 風格的包含模式。此方法可以多次呼叫以附加新的模式，並且可以在單次呼叫中指定多個模式。如果未提供包含模式，則將包含此容器中的所有檔案。如果提供了包含模式，則檔案必須符合至少一個包含模式才能被處理。
`include(includeSpec)`	新增一個包含規範。此方法可以多次呼叫以附加新的規範。如果未提供包含模式，則將包含此容器中的所有檔案。如果提供了包含模式，則檔案必須符合至少一個包含模式或規範才能被包含。
`into(destDir)`	指定複製的目標目錄。目標會根據 `Project.file(java.lang.Object)` 進行評估。
`into(destPath, configureClosure)`	使用給定的目標路徑建立並配置子 `CopySpec`。目標會根據 `Project.file(java.lang.Object)` 進行評估。
`into(destPath, copySpec)`	使用給定的目標路徑建立並配置子 `CopySpec`。目標會根據 `Project.file(java.lang.Object)` 進行評估。
`rename(closure)`	重新命名來源檔案。將使用單一參數（檔案名稱）呼叫閉包。閉包應傳回一個字串物件，其中包含新的目標名稱。閉包可以傳回 null，在這種情況下將使用原始名稱。
`rename(sourceRegEx, replaceWith)`	根據正則表達式重新命名檔案。使用 java.util.regex 類型的正則表達式。請注意，替換字串應使用 '$1' 語法來引用來源正則表達式中的捕獲群組。不符合來源正則表達式的檔案將以原始名稱複製。
`rename(sourceRegEx, replaceWith)`	根據正則表達式重新命名檔案。請參閱 `CopyProcessingSpec.rename(java.lang.String, java.lang.String)`。
`rename(renamer)`	重新命名來源檔案。將使用單一參數（檔案名稱）呼叫函數。函數應傳回一個新的目標名稱。函數可以傳回 null，在這種情況下將使用原始名稱。
`with(sourceSpecs)`	將給定的規範新增為此規範的子規範。

腳本區塊

沒有腳本區塊

屬性詳細資訊

`boolean` `區分大小寫`

指定是否應使用區分大小寫的模式比對。

預設值: true

`File` `目標目錄`

要將檔案複製到的目錄。

預設值: null

`Property<ConfigurableFilePermissions>` `目錄權限`

用於查詢和配置目錄存取權限的屬性。如果屬性未設定值，則表示保留現有的權限。這些權限是否實際應用取決於複製動作的實作。詳情請參閱 ConfigurableFilePermissions。

預設值: null

`DuplicatesStrategy` `重複策略`

嘗試將多個檔案複製到相同目標時使用的策略。

可以使用列舉值的區分大小寫字串來設定此值（例如，'exclude' 代表 DuplicatesStrategy.EXCLUDE）。

可以使用 CopySpec.eachFile(org.gradle.api.Action) 或 CopySpec.filesMatching(java.lang.String, org.gradle.api.Action) 來覆寫個別檔案的此策略。

預設值: DuplicatesStrategy.INHERIT

`Property<ConfigurableFilePermissions>` `檔案權限`

用於查詢和配置檔案存取權限的屬性。如果屬性未設定值，則表示保留現有的權限。這些權限是否實際應用取決於複製動作的實作。詳情請參閱 ConfigurableFilePermissions。

預設值: null

`boolean` `包含空目錄`

指示是否將空目標目錄包含在複製中。

預設值: true

`FileCollection` `來源` (唯讀)

此任務的來源檔案。

預設值: []

方法詳細資訊

`AbstractCopyTask` `eachFile`(`Closure` closure)

新增一個動作，用於應用於每個即將複製到目標位置的檔案。給定的閉包會以 FileCopyDetails 作為參數呼叫。動作會按照新增的順序執行，並從父規範繼承。

`AbstractCopyTask` `eachFile`(`Action<? super FileCopyDetails>` action)

新增一個動作，用於應用於每個即將複製到目標位置的檔案。此動作可以變更檔案的目標路徑、過濾檔案的內容，或將檔案完全排除在結果之外。動作會按照新增的順序執行，並從父規範繼承。

`AbstractCopyTask` `exclude`(`Closure` excludeSpec)

新增一個排除規範。此方法可以多次呼叫以附加新的規範。給定的閉包會傳遞一個 FileTreeElement 作為其參數。閉包應傳回 true 或 false。範例

copySpec {
  from 'source'
  into 'destination'
  //an example of excluding files from certain configuration:
  exclude { it.file in configurations.someConf.files }
}

如果未提供排除模式，則不會排除任何檔案。如果提供了排除模式，則檔案不得符合任何排除模式才能被處理。

`AbstractCopyTask` `exclude`(`Iterable<String>` excludes)

新增一個 ANT 風格的排除模式。此方法可以多次呼叫以附加新的模式，並且可以在單次呼叫中指定多個模式。如果未提供排除模式，則不會排除任何檔案。如果提供了排除模式，則檔案不得符合任何排除模式才能被處理。

`AbstractCopyTask` `exclude`(`String...` excludes)

`AbstractCopyTask` `exclude`(`Spec<FileTreeElement>` excludeSpec)

新增一個排除規範。此方法可以多次呼叫以附加新的規範。如果未提供排除模式，則不會排除任何檔案。如果提供了排除模式，則檔案不得符合任何排除模式才能被處理。

`AbstractCopyTask` `expand`(`Map<String, ?>` properties)

在複製每個檔案時展開屬性參考。更具體地說，每個檔案都使用 Groovy 的 SimpleTemplateEngine 進行轉換。這表示您可以在檔案中使用簡單的屬性參考，例如 $property 或 ${property}。您也可以在檔案中包含任意 Groovy 程式碼，例如 ${version ?: 'unknown'} 或 ${classpath*.name.join(' ')}。

請注意，所有跳脫序列 (\n、\t、\\ 等) 都會轉換為它們所代表的符號，因此，例如，\n 會變成換行符號。如果這是不可取的，則應使用 ContentFilterable.expand(java.util.Map, org.gradle.api.Action) 來停用此行為。

`AbstractCopyTask` `expand`(`Map<String, ?>` properties, `Action<? super ExpandDetails>` action)

請注意，預設情況下，所有跳脫序列 (\n、\t、\\ 等) 都會轉換為它們所代表的符號，因此，例如，\n 會變成換行符號。此行為由 ExpandDetails.getEscapeBackslash() 屬性控制。應將其設定為 true 以停用跳脫序列轉換

 expand(one: '1', two: 2) {
     escapeBackslash = true
 }

`AbstractCopyTask` `filesMatching`(`Iterable<String>` patterns, `Action<? super FileCopyDetails>` action)

為路徑符合任何指定 Ant 風格模式的每個檔案配置 FileCopyDetails。這相當於使用 eachFile() 並根據檔案的路徑選擇性地應用配置。

`AbstractCopyTask` `filesMatching`(`String` pattern, `Action<? super FileCopyDetails>` action)

為路徑符合指定 Ant 風格模式的每個檔案配置 FileCopyDetails。這相當於使用 eachFile() 並根據檔案的路徑選擇性地應用配置。

`AbstractCopyTask` `filesNotMatching`(`Iterable<String>` patterns, `Action<? super FileCopyDetails>` action)

為路徑不符合任何指定 Ant 風格模式的每個檔案配置 FileCopyDetails。這相當於使用 eachFile() 並根據檔案的路徑選擇性地應用配置。

`AbstractCopyTask` `filesNotMatching`(`String` pattern, `Action<? super FileCopyDetails>` action)

為路徑不符合指定 Ant 風格模式的每個檔案配置 FileCopyDetails。這相當於使用 eachFile() 並根據檔案的路徑選擇性地應用配置。

`AbstractCopyTask` `filter`(`Closure` closure)

根據提供的閉包新增內容過濾器。將使用每一行（去除行尾符號）呼叫閉包，並應傳回一個字串以替換該行，或傳回 null 以移除該行。如果移除每一行，結果將會是一個空檔案，而不是一個不存在的檔案。

`AbstractCopyTask` `filter`(`Class<? extends FilterReader>` filterType)

新增一個要在複製期間使用的內容過濾器。多次呼叫 filter 會將額外的過濾器新增到過濾器鏈。每個過濾器都應實作 java.io.FilterReader。包含 org.apache.tools.ant.filters.* 以存取所有標準 Ant 過濾器。

範例

   filter(StripJavaComments)
   filter(com.mycompany.project.CustomFilter)

`AbstractCopyTask` `filter`(`Map<String, ?>` properties, `Class<? extends FilterReader>` filterType)

可以使用 groovy map 語法指定過濾器屬性。

範例

   filter(HeadFilter, lines:25, skip:2)
   filter(ReplaceTokens, tokens:[copyright:'2009', version:'2.3.1'])

`AbstractCopyTask` `filter`(`Transformer<String, String>` transformer)

根據提供的轉換器新增內容過濾器。將使用每一行（去除行尾符號）呼叫閉包，並應傳回一個字串以替換該行，或傳回 null 以移除該行。如果移除每一行，結果將會是一個空檔案，而不是一個不存在的檔案。

`AbstractCopyTask` `from`(`Object` sourcePath, `Closure` c)

指定複製的來源檔案或目錄，並建立子 CopySourceSpec。給定的來源路徑會根據 Project.files(java.lang.Object[]) 進行評估。

`AbstractCopyTask` `from`(`Object` sourcePath, `Action<? super CopySpec>` configureAction)

指定複製的來源檔案或目錄，並建立子 CopySpec。給定的來源路徑會根據 Project.files(java.lang.Object[]) 進行評估。

`AbstractCopyTask` `from`(`Object...` sourcePaths)

指定複製的來源檔案或目錄。給定的路徑會根據 Project.files(java.lang.Object[]) 進行評估。

`AbstractCopyTask` `include`(`Closure` includeSpec)

新增一個包含規範。此方法可以多次呼叫以附加新的規範。給定的閉包會傳遞一個 FileTreeElement 作為其參數。如果未提供包含模式，則將包含此容器中的所有檔案。如果提供了包含模式，則檔案必須符合至少一個包含模式或規範才能被包含。

`AbstractCopyTask` `include`(`Iterable<String>` includes)

新增一個 ANT 風格的包含模式。此方法可以多次呼叫以附加新的模式，並且可以在單次呼叫中指定多個模式。如果未提供包含模式，則將包含此容器中的所有檔案。如果提供了包含模式，則檔案必須符合至少一個包含模式才能被處理。

`AbstractCopyTask` `include`(`String...` includes)

`AbstractCopyTask` `include`(`Spec<FileTreeElement>` includeSpec)

新增一個包含規範。此方法可以多次呼叫以附加新的規範。如果未提供包含模式，則將包含此容器中的所有檔案。如果提供了包含模式，則檔案必須符合至少一個包含模式或規範才能被包含。

`AbstractCopyTask` `into`(`Object` destDir)

指定複製的目標目錄。目標會根據 Project.file(java.lang.Object) 進行評估。

`AbstractCopyTask` `into`(`Object` destPath, `Closure` configureClosure)

使用給定的目標路徑建立並配置子 CopySpec。目標會根據 Project.file(java.lang.Object) 進行評估。

`CopySpec` `into`(`Object` destPath, `Action<? super CopySpec>` copySpec)

使用給定的目標路徑建立並配置子 CopySpec。目標會根據 Project.file(java.lang.Object) 進行評估。

`AbstractCopyTask` `rename`(`Closure` closure)

重新命名來源檔案。將使用單一參數（檔案名稱）呼叫閉包。閉包應傳回一個字串物件，其中包含新的目標名稱。閉包可以傳回 null，在這種情況下將使用原始名稱。

`AbstractCopyTask` `rename`(`String` sourceRegEx, `String` replaceWith)

根據正則表達式重新命名檔案。使用 java.util.regex 類型的正則表達式。請注意，替換字串應使用 '$1' 語法來引用來源正則表達式中的捕獲群組。不符合來源正則表達式的檔案將以原始名稱複製。

範例

rename '(.*)_OEM_BLUE_(.*)', '$1$2'

會將檔案 'style_OEM_BLUE_.css' 對應到 'style.css'

`AbstractCopyTask` `rename`(`Pattern` sourceRegEx, `String` replaceWith)

根據正則表達式重新命名檔案。請參閱 CopyProcessingSpec.rename(java.lang.String, java.lang.String)。

`AbstractCopyTask` `rename`(`Transformer<String, String>` renamer)

重新命名來源檔案。將使用單一參數（檔案名稱）呼叫函數。函數應傳回一個新的目標名稱。函數可以傳回 null，在這種情況下將使用原始名稱。

`CopySpec` `with`(`CopySpec...` sourceSpecs)

將給定的規範新增為此規範的子規範。

def contentSpec = copySpec {
  from("content") {
    include "**/*.txt"
  }
}

task copy(type: Copy) {
  into "$buildDir/copy"
  with contentSpec
}

複製

屬性

方法

腳本區塊

屬性詳細資訊

boolean 區分大小寫

File 目標目錄

Property<ConfigurableFilePermissions> 目錄權限

DuplicatesStrategy 重複策略

Set<String> 排除

Property<ConfigurableFilePermissions> 檔案權限

boolean 包含空目錄

Set<String> 包含

FileCollection 來源 (唯讀)

方法詳細資訊

AbstractCopyTask eachFile(Closure closure)

AbstractCopyTask eachFile(Action<? super FileCopyDetails> action)

AbstractCopyTask exclude(Closure excludeSpec)

AbstractCopyTask exclude(Iterable<String> excludes)

AbstractCopyTask exclude(String... excludes)

AbstractCopyTask exclude(Spec<FileTreeElement> excludeSpec)

AbstractCopyTask expand(Map<String, ?> properties)

AbstractCopyTask expand(Map<String, ?> properties, Action<? super ExpandDetails> action)

AbstractCopyTask filesMatching(Iterable<String> patterns, Action<? super FileCopyDetails> action)

AbstractCopyTask filesMatching(String pattern, Action<? super FileCopyDetails> action)

AbstractCopyTask filesNotMatching(Iterable<String> patterns, Action<? super FileCopyDetails> action)

AbstractCopyTask filesNotMatching(String pattern, Action<? super FileCopyDetails> action)

AbstractCopyTask filter(Closure closure)

AbstractCopyTask filter(Class<? extends FilterReader> filterType)

AbstractCopyTask filter(Map<String, ?> properties, Class<? extends FilterReader> filterType)

AbstractCopyTask filter(Transformer<String, String> transformer)

AbstractCopyTask from(Object sourcePath, Closure c)

AbstractCopyTask from(Object sourcePath, Action<? super CopySpec> configureAction)

AbstractCopyTask from(Object... sourcePaths)

AbstractCopyTask include(Closure includeSpec)

AbstractCopyTask include(Iterable<String> includes)

AbstractCopyTask include(String... includes)

AbstractCopyTask include(Spec<FileTreeElement> includeSpec)

AbstractCopyTask into(Object destDir)

AbstractCopyTask into(Object destPath, Closure configureClosure)

CopySpec into(Object destPath, Action<? super CopySpec> copySpec)

AbstractCopyTask rename(Closure closure)

AbstractCopyTask rename(String sourceRegEx, String replaceWith)

AbstractCopyTask rename(Pattern sourceRegEx, String replaceWith)

AbstractCopyTask rename(Transformer<String, String> renamer)

CopySpec with(CopySpec... sourceSpecs)