AbstractArchiveTask

目录

属性
方法
脚本块
属性详情
方法详情
API 文档AbstractArchiveTask
已知子类型
Zip
Tar

AbstractArchiveTask 是所有归档任务的基类。

属性

属性描述
archiveAppendix

归档名称的附加部分（如果存在）。

archiveBaseName

归档的基础名称。

archiveClassifier

归档名称的分类器部分（如果存在）。

archiveExtension

归档名称的扩展名部分。

archiveFile

构建归档的 RegularFile。路径就是 destinationDirectory 加上 archiveFileName。

archiveFileName

归档名称。如果名称未明确设置，则名称模式为：[archiveBaseName]-[archiveAppendix]-[archiveVersion]-[archiveClassifier].[archiveExtension]

archiveVersion

归档名称的版本部分。

caseSensitive

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

destinationDirectory

归档将放置的目录。

dirPermissions

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

duplicatesStrategy

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

excludes

排除模式集合。

filePermissions

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

includeEmptyDirs

指示是否包含空目标目录。

includes

包含模式集合。

preserveFileTimestamps

指定在归档中是否保留文件时间戳。

reproducibleFileOrder

指定在从目录读取文件时是否强制执行可重现的文件顺序。

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(destPath)

指定文件在归档 *内部* 的目标目录。目标目录按照 Project.file(java.lang.Object) 进行评估。不要将其与指定归档输出目录的 AbstractArchiveTask.getDestinationDirectory() 混淆。

into(destPath, configureClosure)

创建一个子 CopySpec 并配置其文件在归档 *内部* 的目标目录。目标目录按照 Project.file(java.lang.Object) 进行评估。不要将其与指定归档输出目录的 AbstractArchiveTask.getDestinationDirectory() 混淆。

into(destPath, copySpec)

创建一个子 CopySpec 并配置其文件在归档 *内部* 的目标目录。目标目录按照 Project.file(java.lang.Object) 进行评估。不要将其与指定归档输出目录的 AbstractArchiveTask.getDestinationDirectory() 混淆。

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)

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

脚本块

无脚本块

属性详情

Property<String> archiveAppendix

归档名称的附加部分（如果存在）。

Java 插件默认值
""

Property<String> archiveBaseName

归档的基础名称。

Java 插件默认值
project.archivesBaseName

Property<String> archiveClassifier

归档名称的分类器部分（如果存在）。

Java 插件默认值
""

Property<String> archiveExtension

归档名称的扩展名部分。

Provider<RegularFile> archiveFile

构建归档的 RegularFile。路径就是 destinationDirectory 加上 archiveFileName。

Java 插件默认值
${destinationDirectory}/${archiveFileName}

Property<String> archiveFileName

归档名称。如果名称未明确设置，则名称模式为：[archiveBaseName]-[archiveAppendix]-[archiveVersion]-[archiveClassifier].[archiveExtension]

Java 插件默认值
${archiveBaseName}-${archiveAppendix}-${archiveVersion}-${archiveClassifier}.${archiveExtension}

Property<String> archiveVersion

归档名称的版本部分。

Java 插件默认值
project.version

boolean caseSensitive

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

Java 插件默认值
true

DirectoryProperty destinationDirectory

归档将放置的目录。

Java 插件默认值
project.distsDir

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

Java 插件默认值
null

DuplicatesStrategy duplicatesStrategy

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

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

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

Java 插件默认值
DuplicatesStrategy.INHERIT

Set<String> excludes

排除模式集合。

Java 插件默认值
[]

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

Java 插件默认值
null

boolean includeEmptyDirs

指示是否包含空目标目录。

Java 插件默认值
true

Set<String> includes

包含模式集合。

Java 插件默认值
[]

boolean preserveFileTimestamps

指定在归档中是否保留文件时间戳。

如果设置为 false，这将确保在不同机器、Java 版本和操作系统之间构建的归档条目具有相同的时间戳。

Java 插件默认值
true

boolean reproducibleFileOrder

指定在从目录读取文件时是否强制执行可重现的文件顺序。

Gradle 将以独立于文件系统和操作系统的可重现顺序遍历作为此归档一部分的磁盘目录。这有助于 Gradle 可靠地生成字节级可重现的归档文件。

Java 插件默认值
false

FileCollection source (只读)

此任务的源文件。

Java 插件默认值
[]

方法详情

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 map 语法指定过滤属性。

示例

   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)

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

指定文件在归档 *内部* 的目标目录。目标目录按照 Project.file(java.lang.Object) 进行评估。不要将其与指定归档输出目录的 AbstractArchiveTask.getDestinationDirectory() 混淆。

AbstractArchiveTask into(Object destPath, Closure configureClosure)

创建一个子 CopySpec 并配置其文件在归档 *内部* 的目标目录。目标目录按照 Project.file(java.lang.Object) 进行评估。不要将其与指定归档输出目录的 AbstractArchiveTask.getDestinationDirectory() 混淆。

CopySpec into(Object destPath, Action<? super CopySpec> copySpec)

创建一个子 CopySpec 并配置其文件在归档 *内部* 的目标目录。目标目录按照 Project.file(java.lang.Object) 进行评估。不要将其与指定归档输出目录的 AbstractArchiveTask.getDestinationDirectory() 混淆。

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
}