复制

目录

属性
方法
脚本块
属性详情
方法详情
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(闭包)

添加一个操作，应用于每个文件即将复制到其目标时。给定的闭包以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(闭包)

添加基于提供的闭包的内容过滤器。闭包将与每一行（剥离行结束符）一起调用，并应返回一个字符串以替换该行或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(闭包)

重命名源文件。闭包将使用单个参数，即文件名。闭包应返回一个带有新目标名称的字符串对象。闭包可以返回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

用于查询和配置目录访问权限的属性。如果属性未设置值，则表示保留现有权限。这些权限是否实际应用取决于复制操作的实现。有关详细信息，请参阅ConfigurableFilePermissions。

默认值
null

DuplicatesStrategy duplicatesStrategy

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

该值可以使用枚举值的忽略大小写的字符串设置（例如，DuplicatesStrategy.EXCLUDE 的'exclude'）。

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

默认值
DuplicatesStrategy.INHERIT

Set<String> excludes

排除模式集。

默认值
[]

用于查询和配置文件访问权限的属性。如果属性未设置值，则表示保留现有权限。这些权限是否实际应用取决于复制操作的实现。有关详细信息，请参阅ConfigurableFilePermissions。

默认值
null

boolean includeEmptyDirs

指示是否在复制中包含空目标目录。

默认值
true

Set<String> includes

包含模式集。

默认值
[]

FileCollection source (只读)

此任务的源文件。

默认值
[]

方法详情

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)

添加一个ANT风格的排除模式。此方法可以多次调用以追加新的模式，并且可以在一次调用中指定多个模式。如果未提供排除，则不会排除任何文件。如果提供了排除，则文件必须不匹配任何排除模式才能进行处理。

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)

复制时扩展每个文件中的属性引用。更具体地说，每个文件都使用Groovy的SimpleTemplateEngine进行转换。这意味着您可以使用简单的属性引用，例如$property或${property}。您还可以包含任意Groovy代码，例如${version ?: 'unknown'}或${classpath*.name.join(' ')}。模板引擎可以使用提供的操作进行配置。

请注意，默认情况下，所有转义序列（\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)

添加一个内容过滤器，用于复制期间。多次调用filter会向过滤器链中添加额外的过滤器。每个过滤器都应实现java.io.FilterReader。包含org.apache.tools.ant.filters.*以访问所有标准Ant过滤器。

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

示例

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

添加基于提供的转换器内容过滤器。闭包将与每一行（剥离行结束符）一起调用，并应返回一个字符串以替换该行或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)

添加一个ANT风格的包含模式。此方法可以多次调用以追加新的模式，并且可以在一次调用中指定多个模式。如果未提供包含，则此容器中的所有文件都将包含在内。如果提供了包含，则文件必须匹配至少一个包含模式才能进行处理。

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)。

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

CopySpec with(CopySpec... sourceSpecs)

将给定规范作为此规范的子级添加。

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

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