Sync

目录

属性
方法
脚本块
属性详情
方法详情
API 文档Sync

将目标目录的内容与一些源目录和文件同步。

此任务类似于 Copy 任务，但目标目录将仅包含复制的文件。除非指定了 Sync.preserve(org.gradle.api.Action)，否则目标目录中存在的所有文件将在复制文件之前被删除。

示例

// Sync can be used like a Copy task
// See the Copy documentation for more examples
task syncDependencies(type: Sync) {
    from 'my/shared/dependencyDir'
    into 'build/deps/compile'
}

// You can preserve output that already exists in the
// destination directory. Files matching the preserve
// filter will not be deleted.
task sync(type: Sync) {
    from 'source'
    into 'dest'
    preserve {
        include 'extraDir/**'
        include 'dir1/**'
        exclude 'dir1/extra.txt'
    }
}

属性

属性描述
caseSensitive

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

destinationDir

要将文件复制到的目录。

dirPermissions

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

duplicatesStrategy

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

excludes

排除模式的集合。

filePermissions

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

includeEmptyDirs

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

includes

包含模式的集合。

preserve

定义要在目标目录中保留哪些文件的过滤器。

source

此任务的源文件。

方法

方法描述
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)

基于提供的闭包添加内容过滤器。将使用每一行（去除行尾）调用 Closure，并应返回一个 String 以替换该行，或返回 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)

基于提供的转换器添加内容过滤器。将使用每一行（去除行尾）调用 Closure，并应返回一个 String 以替换该行，或返回 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) 进行评估。

preserve(action)

配置过滤器，该过滤器定义要在目标目录中保留哪些文件。

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

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

默认
null

DuplicatesStrategy duplicatesStrategy

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

可以使用枚举值的不区分大小写的字符串设置该值（例如，'exclude' 表示 DuplicatesStrategy.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

包含模式的集合。

默认
[]

PatternFilterable preserve (只读)

定义要在目标目录中保留哪些文件的过滤器。

默认
empty

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)

基于提供的闭包添加内容过滤器。将使用每一行（去除行尾）调用 Closure，并应返回一个 String 以替换该行，或返回 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 Map 语法指定过滤器属性。

示例

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

基于提供的转换器添加内容过滤器。将使用每一行（去除行尾）调用 Closure，并应返回一个 String 以替换该行，或返回 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) 进行评估。

Sync preserve(Action<? super PatternFilterable> action)

配置过滤器，该过滤器定义要在目标目录中保留哪些文件。

AbstractCopyTask rename(Closure closure)

重命名源文件。将使用单个参数（文件名）调用闭包。闭包应返回一个 String 对象，其中包含新的目标名称。闭包可以返回 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
}