Zip

API 文档Zip
已知子类型
Jar

组装 ZIP 归档文件。默认会压缩 zip 的内容。

属性

属性描述
archiveAppendix

归档文件名称的附录部分(如果有)。

archiveBaseName

归档文件的基本名称。

archiveClassifier

归档文件名称的分类器部分(如果有)。

archiveExtension

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

archiveFile

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

archiveFileName

归档文件名。如果名称尚未显式设置,则名称的模式为:[archiveBaseName]-[archiveAppendix]-[archiveVersion]-[archiveClassifier].[archiveExtension]

archiveVersion

归档文件名称的版本部分。

caseSensitive

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

destinationDirectory

归档文件将放置的目录。

dirPermissions

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

duplicatesStrategy

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

entryCompression

归档文件中条目的压缩级别。如果设置为 ZipEntryCompression.DEFLATED(默认值),则每个条目都使用 DEFLATE 算法压缩。如果设置为 ZipEntryCompression.STORED,则归档文件的条目将保持未压缩状态。

excludes

排除模式的集合。

filePermissions

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

includeEmptyDirs

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

includes

包含模式的集合。

metadataCharset

用于编码 ZIP 元数据(如文件名)的字符集。默认为平台的默认字符集。

preserveFileTimestamps

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

reproducibleFileOrder

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

source

此任务的源文件。

zip64

zip 是否可以包含超过 65535 个文件和/或支持大于 4GB 的文件大小。

方法

方法描述
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,并应返回一个字符串以替换该行,或返回 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,并应返回一个字符串以替换该行,或返回 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

ZipEntryCompression entryCompression

归档文件中条目的压缩级别。如果设置为 ZipEntryCompression.DEFLATED(默认值),则每个条目都使用 DEFLATE 算法压缩。如果设置为 ZipEntryCompression.STORED,则归档文件的条目将保持未压缩状态。

默认
ZipEntryCompression.DEFLATED

Set<String> excludes

排除模式的集合。

使用 java 插件时的默认值
[]

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

使用 java 插件时的默认值
null

boolean includeEmptyDirs

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

使用 java 插件时的默认值
true

Set<String> includes

包含模式的集合。

使用 java 插件时的默认值
[]

String metadataCharset

用于编码 ZIP 元数据(如文件名)的字符集。默认为平台的默认字符集。

默认
平台默认编码

boolean preserveFileTimestamps

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

如果为 false,则确保归档条目在不同机器、Java 版本和操作系统之间的构建中具有相同的时间。

使用 java 插件时的默认值
true

boolean reproducibleFileOrder

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

然后,Gradle 将以可重现的顺序遍历磁盘上作为此归档文件一部分的目录,而与文件系统和操作系统无关。这有助于 Gradle 可靠地生成字节对字节可重现的归档文件。

使用 java 插件时的默认值
false

FileCollection source (只读)

此任务的源文件。

使用 java 插件时的默认值
[]

boolean zip64

zip 是否可以包含超过 65535 个文件和/或支持大于 4GB 的文件大小。

标准 zip 格式对文件大小和计数有硬性限制。Zip64 格式扩展 实际上消除了这些限制,因此是构建大型 zip 所必需的。

但是,并非所有 Zip 读取器都支持 Zip64 扩展。值得注意的是,ZipInputStream JDK 类在 Java 7 之前的版本中不支持 Zip64。这意味着如果要构建用于 Java 6 和更早版本运行时的 JAR,则不应启用此属性。

默认
false

方法详情

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,并应返回一个字符串以替换该行,或返回 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 映射语法指定过滤器属性。

示例

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

基于提供的转换器添加内容过滤器。将使用每一行(去除行尾符)调用 Closure,并应返回一个字符串以替换该行,或返回 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
}