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)`	添加一个基于所提供闭包的内容过滤器。闭包将用每行（去除行尾符）调用，并应返回一个字符串替换该行或 `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)` 进行评估。
`preserve(action)`	配置定义要在目标目录中保留哪些文件的过滤器。
`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` `caseSensitive`

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

默认值: true

`File` `destinationDir`

要将文件复制到的目录。

默认值: null

`Property<ConfigurableFilePermissions>` `dirPermissions`

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

默认值: null

`DuplicatesStrategy` `duplicatesStrategy`

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

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

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

默认值: DuplicatesStrategy.INHERIT

`Property<ConfigurableFilePermissions>` `filePermissions`

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

默认值: null

`boolean` `includeEmptyDirs`

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

默认值: true

`PatternFilterable` `preserve` (read-only)

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

默认值: empty

`FileCollection` `source` (read-only)

此任务的源文件。

默认值: []

方法详情

`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映射语法指定过滤器属性。

示例

   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) 进行评估。

`Sync` `preserve`(`Action<? super PatternFilterable>` action)

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

`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
}

Sync

属性

方法

脚本块

属性详情

boolean caseSensitive

File destinationDir

Property<ConfigurableFilePermissions> dirPermissions

DuplicatesStrategy duplicatesStrategy

Set<String> excludes

Property<ConfigurableFilePermissions> filePermissions

boolean includeEmptyDirs

Set<String> includes

PatternFilterable preserve (read-only)

FileCollection source (read-only)

方法详情

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)

Sync preserve(Action<? super PatternFilterable> action)

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)