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` 作为参数被调用。操作按添加顺序执行，并从父 Spec 继承。
`eachFile(action)`	添加一个操作，该操作将应用于每个文件在即将复制到其目标时。该操作可以更改文件的目标路径、过滤文件内容或完全从结果中排除文件。操作按添加顺序执行，并从父 Spec 继承。
`exclude(excludeSpec)`	添加一个排除 Spec。此方法可以多次调用以附加新的 Spec。给定的闭包会以 `FileTreeElement` 作为参数传递。闭包应返回 true 或 false。示例
`exclude(excludes)`	添加 ANT 风格的排除模式。此方法可以多次调用以附加新的模式，也可以在一次调用中指定多个模式。如果没有提供 excludes，则不排除任何文件。如果提供了 excludes，则文件必须不匹配任何排除模式才能被处理。
`exclude(excludes)`	添加 ANT 风格的排除模式。此方法可以多次调用以附加新的模式，也可以在一次调用中指定多个模式。如果没有提供 excludes，则不排除任何文件。如果提供了 excludes，则文件必须不匹配任何排除模式才能被处理。
`exclude(excludeSpec)`	添加一个排除 Spec。此方法可以多次调用以附加新的 Spec。如果没有提供 excludes，则不排除任何文件。如果提供了 excludes，则文件必须不匹配任何排除模式才能被处理。
`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(' ')}`。可以使用提供的 action 配置模板引擎。
`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)`	添加一个基于提供的 transformer 的内容过滤器。该 Closure 将以每一行（去掉行尾字符）作为参数被调用，并应返回一个 String 来替换该行，或返回 `null` 来删除该行。如果删除了所有行，结果将是一个空文件，而不是不存在的文件。
`from(sourcePath, c)`	指定复制的源文件或目录，并创建一个子 `CopySourceSpec`。给定的 source path 根据 `Project.files(java.lang.Object[])` 进行评估。
`from(sourcePath, configureAction)`	指定复制的源文件或目录，并创建一个子 `CopySpec`。给定的 source path 根据 `Project.files(java.lang.Object[])` 进行评估。
`from(sourcePaths)`	指定复制的源文件或目录。给定的 path 根据 `Project.files(java.lang.Object[])` 进行评估。
`include(includeSpec)`	添加一个包含 Spec。此方法可以多次调用以附加新的 Spec。给定的闭包会以 `FileTreeElement` 作为参数传递。如果没有提供 includes，则此容器中的所有文件都将被包含。如果提供了 includes，则文件必须至少匹配一个包含模式或 Spec 才能被包含。
`include(includes)`	添加 ANT 风格的包含模式。此方法可以多次调用以附加新的模式，也可以在一次调用中指定多个模式。如果没有提供 includes，则此容器中的所有文件都将被包含。如果提供了 includes，则文件必须至少匹配一个包含模式才能被处理。
`include(includes)`	添加 ANT 风格的包含模式。此方法可以多次调用以附加新的模式，也可以在一次调用中指定多个模式。如果没有提供 includes，则此容器中的所有文件都将被包含。如果提供了 includes，则文件必须至少匹配一个包含模式才能被处理。
`include(includeSpec)`	添加一个包含 Spec。此方法可以多次调用以附加新的 Spec。如果没有提供 includes，则此容器中的所有文件都将被包含。如果提供了 includes，则文件必须至少匹配一个包含模式或 Spec 才能被包含。
`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)`	将给定的 Spec 添加为此 Spec 的子项。

脚本块

没有脚本块

属性详情

`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` （只读）

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

默认值: 空

`FileCollection` `source` （只读）

此任务的源文件。

默认值: []

方法详情

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

添加一个操作，该操作将应用于每个文件在复制到其目标之前。给定的闭包会以 FileCopyDetails 作为参数被调用。操作按添加顺序执行，并从父 Spec 继承。

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

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

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

添加一个排除 Spec。此方法可以多次调用以附加新的 Spec。给定的闭包会以 FileTreeElement 作为参数传递。闭包应返回 true 或 false。示例

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

如果没有提供 excludes，则不排除任何文件。如果提供了 excludes，则文件必须不匹配任何排除模式才能被处理。

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

添加 ANT 风格的排除模式。此方法可以多次调用以附加新的模式，也可以在一次调用中指定多个模式。如果没有提供 excludes，则不排除任何文件。如果提供了 excludes，则文件必须不匹配任何排除模式才能被处理。

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

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

添加一个排除 Spec。此方法可以多次调用以附加新的 Spec。如果没有提供 excludes，则不排除任何文件。如果提供了 excludes，则文件必须不匹配任何排除模式才能被处理。

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

添加一个基于提供的闭包的内容过滤器。该 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)

可以使用 Groovy map 语法指定过滤器属性。

示例

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

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

添加一个基于提供的 transformer 的内容过滤器。该 Closure 将以每一行（去掉行尾字符）作为参数被调用，并应返回一个 String 来替换该行，或返回 null 来删除该行。如果删除了所有行，结果将是一个空文件，而不是不存在的文件。

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

指定复制的源文件或目录，并创建一个子 CopySourceSpec。给定的 source path 根据 Project.files(java.lang.Object[]) 进行评估。

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

指定复制的源文件或目录，并创建一个子 CopySpec。给定的 source path 根据 Project.files(java.lang.Object[]) 进行评估。

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

指定复制的源文件或目录。给定的 path 根据 Project.files(java.lang.Object[]) 进行评估。

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

添加一个包含 Spec。此方法可以多次调用以附加新的 Spec。给定的闭包会以 FileTreeElement 作为参数传递。如果没有提供 includes，则此容器中的所有文件都将被包含。如果提供了 includes，则文件必须至少匹配一个包含模式或 Spec 才能被包含。

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

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

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

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

添加一个包含 Spec。此方法可以多次调用以附加新的 Spec。如果没有提供 includes，则此容器中的所有文件都将被包含。如果提供了 includes，则文件必须至少匹配一个包含模式或 Spec 才能被包含。

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

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

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

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

将给定的 Spec 添加为此 Spec 的子项。

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 （只读）

FileCollection source （只读）

方法详情

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)