Tar

目录

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

组装一个 TAR 归档文件。

属性

属性描述
archiveAppendix

归档文件名的附录部分（如果有）。

archiveBaseName

归档文件的基本名称。

archiveClassifier

归档文件名的分类器部分（如果有）。

archiveExtension

归档文件名的扩展名部分。

archiveFile

构造归档文件的 RegularFile。路径就是 destinationDirectory 加上 archiveFileName。

archiveFileName

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

archiveVersion

归档文件名的版本部分。

caseSensitive

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

compression

此归档文件使用的压缩方式。

destinationDirectory

归档文件将放置的目录。

dirPermissions

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

duplicatesStrategy

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

excludes

排除模式集合。

filePermissions

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

includeEmptyDirs

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

includes

包含模式集合。

preserveFileTimestamps

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

reproducibleFileOrder

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

source

此任务的源文件。

方法

方法描述
eachFile(closure)

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

eachFile(action)

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

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(' ')}。模板引擎可以通过提供的 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)

添加基于提供的闭包的内容过滤器。闭包将以每行（去除行尾符）作为参数调用，应返回一个 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 的内容过滤器。闭包将以每行（去除行尾符）作为参数调用，应返回一个 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(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)

将给定的 specs 作为此 spec 的子级添加。

脚本块

无脚本块

属性详情

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

Compression compression

此归档文件使用的压缩方式。

使用 java 插件时的默认值
Compression.NONE

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 作为参数调用。操作按添加顺序执行，并从父 spec 继承。

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

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

如果未提供 exclude 模式，则不会排除任何文件。如果提供了 exclude 模式，则文件必须不匹配任何 exclude 模式才会被处理。

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(' ')}。模板引擎可以通过提供的 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)

添加基于提供的闭包的内容过滤器。闭包将以每行（去除行尾符）作为参数调用，应返回一个 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'])

添加基于提供的 transformer 的内容过滤器。闭包将以每行（去除行尾符）作为参数调用，应返回一个 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)

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

指定文件在归档文件*内部*的目标目录。目标目录将按照 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)

将给定的 specs 作为此 spec 的子级添加。

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

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