复制

特性
方法
脚本块
物业详情
方法详情

API文档：	`Copy`

已知亚型：

ProcessResources

将文件复制到目标目录中。此任务还可以在复制时重命名和过滤文件。该任务实现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
}

特性

财产	描述
`caseSensitive`	指定是否应使用区分大小写的模式匹配。
`destinationDir`	将文件复制到的目录。
`dirPermissions`	用于配置目录访问权限的属性。详细信息请参见`ConfigurableFilePermissions`。
`duplicatesStrategy`	尝试将多个文件复制到同一目标时使用的策略。
`excludes`	排除模式集。
`filePermissions`	用于配置文件访问权限的属性。详细信息请参见`ConfigurableFilePermissions`。
`includeEmptyDirs`	告知空目标目录是否将包含在副本中。
`includes`	包含模式集。
`source`	此任务的源文件。

方法

方法	描述
`eachFile(closure)`	添加一个要在每个文件将被复制到其目标时应用的操作。给定的闭包以 a`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)`	`FileCopyDetails`为其路径与任何指定 Ant 样式模式匹配的每个文件配置。这相当于使用eachFile()并根据文件的路径有选择地应用配置。
`filesMatching(pattern, action)`	`FileCopyDetails`为每个路径与指定 Ant 样式模式匹配的文件配置。这相当于使用eachFile()并根据文件的路径有选择地应用配置。
`filesNotMatching(patterns, action)`	`FileCopyDetails`为每个其路径与任何指定 Ant 样式模式不匹配的文件配置。这相当于使用eachFile()并根据文件的路径有选择地应用配置。
`filesNotMatching(pattern, action)`	`FileCopyDetails`为每个路径与指定 Ant 样式模式不匹配的文件配置。这相当于使用eachFile()并根据文件的路径有选择地应用配置。
`filter(closure)`	根据提供的闭包添加内容过滤器。闭包将在每一行中被调用（go除行结尾），并且应该返回一个字符串来替换该行或`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)`	基于提供的转换器添加内容过滤器。闭包将在每一行中被调用（go除行结尾），并且应该返回一个字符串来替换该行或`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)`	添加包含规范。可以多次调用此方法来附加新规范。给定的闭包将 a`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)`	重命名源文件。将使用单个参数（文件名）调用闭包。闭包应该返回一个带有新目标名称的 String 对象。闭包可能返回 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` `caseSensitive`

指定是否应使用区分大小写的模式匹配。

默认：: true

`File` `destinationDir`

将文件复制到的目录。

默认：: null

`Property<ConfigurableFilePermissions>` `dirPermissions`

用于配置目录访问权限的属性。详细信息请参见ConfigurableFilePermissions。

默认：: null

`DuplicatesStrategy` `duplicatesStrategy`

尝试将多个文件复制到同一目标时使用的策略。

该值可以使用枚举值的不区分大小写的字符串来设置（例如'exclude'for DuplicatesStrategy.EXCLUDE）。

CopySpec.eachFile(org.gradle.api.Action)可以使用或为单个文件覆盖此策略CopySpec.filesMatching(java.lang.String, org.gradle.api.Action)。

默认：: DuplicatesStrategy.INHERIT

`Set<String>` `excludes`

排除模式集。

默认：: []

`Property<ConfigurableFilePermissions>` `filePermissions`

用于配置文件访问权限的属性。详细信息请参见ConfigurableFilePermissions。

默认：: null

`boolean` `includeEmptyDirs`

告知空目标目录是否将包含在副本中。

默认：: true

`Set<String>` `includes`

包含模式集。

默认：: []

`FileCollection` `source`（只读）

此任务的源文件。

默认：: []

方法详情

`AbstractCopyTask` `eachFile`（`Closure`关闭）

添加一个要在每个文件将被复制到其目标时应用的操作。给定的闭包以 aFileCopyDetails作为参数来调用。操作按照添加的顺序执行，并且继承自父规范。

`AbstractCopyTask` `eachFile`（行动）`Action<? super FileCopyDetails>`

添加要在每个文件即将复制到其目标时应用于该文件的操作。该操作可以更改文件的目标路径、过滤文件的内容或从结果中完全排除文件。操作按照添加的顺序执行，并且继承自父规范。

`AbstractCopyTask` `exclude`（`Closure`不包括规格）

添加排除规范。可以多次调用此方法来附加新规范。给定的闭包将 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>`

添加 ANT 样式排除模式。可以多次调用此方法以附加新模式，并且可以在一次调用中指定多个模式。如果未提供排除，则不会排除任何文件。如果提供了排除，则文件不得与要处理的任何排除模式匹配。

`AbstractCopyTask` `exclude`（`String...`不包括）

`AbstractCopyTask` `exclude`（不包括规格）`Spec<FileTreeElement>`

添加排除规范。可以多次调用此方法来附加新规范。如果未提供排除，则不会排除任何文件。如果提供了排除，则文件不得与要处理的任何排除模式匹配。

`AbstractCopyTask` `expand`（特性）`Map<String, ?>`

在复制每个文件时扩展其属性引用。更具体地说，每个文件都使用 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, ?>Action<? super ExpandDetails>`

请注意，默认情况下，所有转义序列（\n、\t、\\等）都会转换为它们表示的符号，例如，\n变成换行符。此行为受属性控制 ExpandDetails.getEscapeBackslash()。应将其设置为true禁用转义序列转换：

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

`AbstractCopyTask` `filesMatching`（模式、动作）`Iterable<String>Action<? super FileCopyDetails>`

FileCopyDetails为其路径与任何指定 Ant 样式模式匹配的每个文件配置。这相当于使用eachFile()并根据文件的路径有选择地应用配置。

`AbstractCopyTask` `filesMatching`（`String`模式、动作）`Action<? super FileCopyDetails>`

FileCopyDetails为每个路径与指定 Ant 样式模式匹配的文件配置。这相当于使用eachFile()并根据文件的路径有选择地应用配置。

`AbstractCopyTask` `filesNotMatching`（模式、动作）`Iterable<String>Action<? super FileCopyDetails>`

FileCopyDetails为每个其路径与任何指定 Ant 样式模式不匹配的文件配置。这相当于使用eachFile()并根据文件的路径有选择地应用配置。

`AbstractCopyTask` `filesNotMatching`（`String`模式、动作）`Action<? super FileCopyDetails>`

FileCopyDetails为每个路径与指定 Ant 样式模式不匹配的文件配置。这相当于使用eachFile()并根据文件的路径有选择地应用配置。

`AbstractCopyTask` `filter`（`Closure`关闭）

根据提供的闭包添加内容过滤器。闭包将在每一行中被调用（go除行结尾），并且应该返回一个字符串来替换该行或null删除该行。如果删除每一行，结果将是一个空文件，而不是缺失的文件。

`AbstractCopyTask` `filter`（过滤器类型）`Class<? extends FilterReader>`

添加要在复制过程中使用的内容过滤器。多次调用filter，将额外的过滤器添加到过滤器链中。每个过滤器都应该实现java.io.FilterReader.包括org.apache.tools.ant.filters.*用于访问所有标准 Ant 过滤器。

例子：

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

`AbstractCopyTask` `filter`（属性，过滤器类型）`Map<String, ?>Class<? extends FilterReader>`

过滤器属性可以使用常规映射语法来指定。

例子：

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

`AbstractCopyTask` `filter`（变压器）`Transformer<String, String>`

基于提供的转换器添加内容过滤器。闭包将在每一行中被调用（go除行结尾），并且应该返回一个字符串来替换该行或null删除该行。如果删除每一行，结果将是一个空文件，而不是缺失的文件。

`AbstractCopyTask` `from`（`Object`源路径，`Closure`c）

指定副本的源文件或目录并创建子副本CopySourceSpec。给定的源路径按照进行评估Project.files(java.lang.Object[])。

`AbstractCopyTask` `from`（`Object`源路径、配置操作）`Action<? super CopySpec>`

指定副本的源文件或目录并创建子副本CopySpec。给定的源路径按照进行评估Project.files(java.lang.Object[])。

`AbstractCopyTask` `from`（`Object...`源路径）

指定副本的源文件或目录。给定的路径按照进行评估Project.files(java.lang.Object[])。

`AbstractCopyTask` `include`（`Closure`包括规格）

添加包含规范。可以多次调用此方法来附加新规范。给定的闭包将 aFileTreeElement作为其参数传递。如果未提供包含，则将包含此容器中的所有文件。如果提供了包含，则文件必须至少匹配要包含的包含模式或规范之一。

`AbstractCopyTask` `include`（包括）`Iterable<String>`

添加 ANT 样式包含模式。可以多次调用此方法以附加新模式，并且可以在一次调用中指定多个模式。如果未提供包含，则将包含此容器中的所有文件。如果提供了包含，则文件必须至少匹配要处理的包含模式之一。

`AbstractCopyTask` `include`（`String...`包括）

`AbstractCopyTask` `include`（包括规格）`Spec<FileTreeElement>`

添加包含规范。可以多次调用此方法来附加新规范。如果未提供包含，则将包含此容器中的所有文件。如果提供了包含，则文件必须至少匹配要包含的包含模式或规范之一。

`AbstractCopyTask` `into`（`Object`目标目录）

指定副本的目标目录。目的地按照进行评估Project.file(java.lang.Object)。

`AbstractCopyTask` `into`（`Object`目标路径，`Closure`configureClosure）

CopySpec使用给定的目标路径创建并配置子项。目的地按照进行评估Project.file(java.lang.Object)。

`CopySpec` `into`（`Object`目标路径，复制规范）`Action<? super CopySpec>`

CopySpec使用给定的目标路径创建并配置子项。目的地按照进行评估Project.file(java.lang.Object)。

`AbstractCopyTask` `rename`（`Closure`关闭）

重命名源文件。将使用单个参数（文件名）调用闭包。闭包应该返回一个带有新目标名称的 String 对象。闭包可能返回 null，在这种情况下将使用原始名称。

`AbstractCopyTask` `rename`（`String`源正则表达式，`String`replaceWith）

根据正则表达式重命名文件。使用 java.util.regex 类型的正则表达式。请注意，替换字符串应使用“$1”语法来引用源正则表达式中的捕获组。与源正则表达式不匹配的文件将使用原始名称进行复制。

例子：

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

会将文件“style_OEM_BLUE_.css”映射到“style.css”

`AbstractCopyTask` `rename`（`Pattern`源正则表达式，`String`replaceWith）

根据正则表达式重命名文件。看CopyProcessingSpec.rename(java.lang.String, java.lang.String)。

`AbstractCopyTask` `rename`（重命名）`Transformer<String, String>`

重命名源文件。该函数将使用单个参数（文件名）进行调用。该函数应返回一个新的目标名称。该函数可能返回 null，在这种情况下将使用原始名称。

`CopySpec` `with`（`CopySpec...`来源规格）

将给定规格添加为该规格的子项。

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

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

复制

特性

方法

脚本块

物业详情

boolean caseSensitive

File destinationDir

Property<ConfigurableFilePermissions> dirPermissions

DuplicatesStrategy duplicatesStrategy

Set<String> excludes

Property<ConfigurableFilePermissions> filePermissions

boolean includeEmptyDirs

Set<String> includes

FileCollection source（只读）

方法详情

AbstractCopyTask eachFile（Closure关闭）

AbstractCopyTask eachFile（行动）Action<? super FileCopyDetails>

AbstractCopyTask exclude（Closure不包括规格）

AbstractCopyTask exclude（不包括）Iterable<String>

AbstractCopyTask exclude（String...不包括）

AbstractCopyTask exclude（不包括规格）Spec<FileTreeElement>

AbstractCopyTask expand（特性）Map<String, ?>

AbstractCopyTask expand（属性、动作）Map<String, ?>Action<? super ExpandDetails>

AbstractCopyTask filesMatching（模式、动作）Iterable<String>Action<? super FileCopyDetails>

AbstractCopyTask filesMatching（String模式、动作）Action<? super FileCopyDetails>

AbstractCopyTask filesNotMatching（模式、动作）Iterable<String>Action<? super FileCopyDetails>

AbstractCopyTask filesNotMatching（String模式、动作）Action<? super FileCopyDetails>

AbstractCopyTask filter（Closure关闭）

AbstractCopyTask filter（过滤器类型）Class<? extends FilterReader>

AbstractCopyTask filter（属性，过滤器类型）Map<String, ?>Class<? extends FilterReader>

AbstractCopyTask filter（变压器）Transformer<String, String>

AbstractCopyTask from（Object源路径，Closurec）

AbstractCopyTask from（Object源路径、配置操作）Action<? super CopySpec>

AbstractCopyTask from（Object...源路径）

AbstractCopyTask include（Closure包括规格）

AbstractCopyTask include（包括）Iterable<String>

AbstractCopyTask include（String...包括）

AbstractCopyTask include（包括规格）Spec<FileTreeElement>

AbstractCopyTask into（Object目标目录）

AbstractCopyTask into（Object目标路径，ClosureconfigureClosure）

CopySpec into（Object目标路径，复制规范）Action<? super CopySpec>

AbstractCopyTask rename（Closure关闭）

AbstractCopyTask rename（String源正则表达式，StringreplaceWith）

AbstractCopyTask rename（Pattern源正则表达式，StringreplaceWith）

AbstractCopyTask rename（重命名）Transformer<String, String>

CopySpec with（CopySpec...来源规格）