Jar

目录

属性
方法
Script 块
属性详情
方法详情
API文档： Jar
已知亚型：
Ear
War

组装 JAR 存档。

属性

Property 描述
archiveAppendix

存档名称的附录部分（如果有）。
archiveBaseName

存档的基本名称。
archiveClassifier

存档名称的分类器部分（如果有）。
archiveExtension

存档名称的扩展部分。
archiveFile

构建存档的RegularFile。路径只是 destinationDirectory 加上 archiveFileName 。
archiveFileName

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

存档名称的版本部分。
caseSensitive

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

将放置存档的目录。
dirMode

用于目标目录的 Unix 权限。 null 表示保留现有权限。是否实际应用这些权限取决于复制操作的实现。
duplicatesStrategy

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

存档条目的压缩级别。如果设置为 ZipEntryCompression.DEFLATED（默认值），则使用 DEFLATE 算法压缩每个条目。如果设置为 ZipEntryCompression.STORED，存档的条目将保持未压缩状态。
excludes

排除模式集。
fileMode

用于目标文件的 Unix 权限。 null 表示保留现有权限。是否实际应用这些权限取决于复制操作的实现。
includeEmptyDirs

告知空目标目录是否将包含在副本中。
includes

包含模式集。
manifest

此 JAR 存档的清单。
metadataCharset

用于对文件名等 JAR 元数据进行编码的字符集。默认为 UTF-8。您可以更改此属性，但不建议这样做，因为 JVM 期望使用 UTF-8 对 JAR 元数据进行编码
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)

添加基于提供的闭包的内容过滤器。闭包将在每一行（去除行尾）时被调用，并且应该返回一个 String 来替换该行或返回 null 以删除该行。如果删除每一行，结果将是一个空文件，而不是一个不存在的文件。
filter(filterType)

添加要在复制期间使用的内容过滤器。多次调用过滤器，向过滤器链添加额外的过滤器。每个过滤器都应该实现 java.io.FilterReader 。包含 org.apache.tools.ant.filters.* 以访问所有标准 Ant 过滤器。
filter(properties, filterType)

添加要在复制期间使用的内容过滤器。多次调用过滤器，向过滤器链添加额外的过滤器。每个过滤器都应该实现 java.io.FilterReader 。包含 org.apache.tools.ant.filters.* 以访问所有标准 Ant 过滤器。
filter(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() 混淆。
manifest(configureClosure)

为此 JAR 存档配置清单。
manifest(configureAction)

为此 JAR 存档配置清单。
metaInf(configureClosure)

将内容添加到此 JAR 存档的 META-INF 目录。
metaInf(configureAction)

将内容添加到此 JAR 存档的 META-INF 目录。
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

Integer dirMode

用于目标目录的 Unix 权限。 null 表示保留现有权限。是否实际应用这些权限取决于复制操作的实现。

默认使用 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 插件：
[]

Integer fileMode

用于目标文件的 Unix 权限。 null 表示保留现有权限。是否实际应用这些权限取决于复制操作的实现。

默认使用 java 插件：
null

boolean includeEmptyDirs

告知空目标目录是否将包含在副本中。

默认使用 java 插件：
true

Set<String> includes

包含模式集。

默认使用 java 插件：
[]

Manifest manifest

此 JAR 存档的清单。

String metadataCharset

用于对文件名等 JAR 元数据进行编码的字符集。默认为 UTF-8。您可以更改此属性，但不建议这样做，因为 JVM 期望使用 UTF-8 对 JAR 元数据进行编码

默认：
UTF-8

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。这意味着如果您正在构建 JAR 以用于 Java 6 和更早的运行时，则不应启用此属性。

默认：
false

方法细节

AbstractCopyTask eachFile (Closure 关闭)

添加要应用于每个文件的操作，因为它即将被复制到其目的地。使用 FileCopyDetails 作为参数调用给定的闭包。动作按照添加的顺序执行，并从父规范继承。

AbstractCopyTask eachFile（Action<? super FileCopyDetails> 动作）

添加要应用于每个文件的操作，因为它即将被复制到其目标位置。该操作可以更改文件的目标路径、过滤文件的内容或从结果中完全排除文件。动作按照添加的顺序执行，并从父规范继承。

AbstractCopyTask exclude (Closure excludeSpec)

添加排除规范。可以多次调用此方法以附加新规范。给定的闭包将 FileTreeElement 作为其参数传递。闭包应该返回 true 或 false。例子：

@Input
java.util.Set<java.lang.String> getExcludePatterns()

如果未提供排除项，则不会排除任何文件。如果提供排除项，则文件不得匹配任何要处理的排除模式。

AbstractCopyTask exclude (Iterable<String> 不包括)

添加 ANT 样式排除模式。可以多次调用此方法以附加新模式，并且可以在一次调用中指定多个模式。如果未提供排除项，则不会排除任何文件。如果提供排除项，则文件不得匹配任何要处理的排除模式。

AbstractCopyTask exclude (String... 不包括)

添加 ANT 样式排除模式。可以多次调用此方法以附加新模式，并且可以在一次调用中指定多个模式。如果未提供排除项，则不会排除任何文件。如果提供排除项，则文件不得匹配任何要处理的排除模式。

AbstractCopyTask exclude (Spec<FileTreeElement> excludeSpec)

添加排除规范。可以多次调用此方法以附加新规范。如果未提供排除项，则不会排除任何文件。如果提供排除项，则文件不得匹配任何要处理的排除模式。

AbstractCopyTask expand（Map<String, ?> 属性）

在复制每个文件时扩展属性引用。更具体地说，每个文件都使用 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, ?> 属性，Action<? super ExpandDetails> 动作）

在复制每个文件时扩展属性引用。更具体地说，每个文件都使用 Groovy 的 SimpleTemplateEngine 进行转换。这意味着您可以在文件中使用简单的属性引用，例如 $property 或 ${property}。您还可以在文件中包含任意 Groovy 代码，例如 ${version ?: 'unknown'} 或 ${classpath*.name.join(' ')} 。可以使用提供的操作配置模板引擎。

请注意，默认情况下，所有转义序列（\n、\t、\\ 等）都转换为它们所代表的符号，因此，例如，\n 变为换行符。此行为由 ExpandDetails.getEscapeBackslash() 属性控制。它应该设置为 true 以禁用转义序列转换：

public abstract class IvyPublishPlugin
extends java.lang.Object
implements Plugin<Project>

AbstractCopyTask filesMatching（Iterable<String> 模式，Action<? super FileCopyDetails> 动作）

为每个路径匹配任何指定的 Ant 样式模式的文件配置 FileCopyDetails。这相当于使用 eachFile() 并根据文件路径有选择地应用配置。

AbstractCopyTask filesMatching（String 模式，Action<? super FileCopyDetails> 动作）

为每个路径匹配指定 Ant 样式模式的文件配置 FileCopyDetails。这相当于使用 eachFile() 并根据文件路径有选择地应用配置。

AbstractCopyTask filesNotMatching（Iterable<String> 模式，Action<? super FileCopyDetails> 动作）

为路径不匹配任何指定 Ant 样式模式的每个文件配置 FileCopyDetails。这相当于使用 eachFile() 并根据文件路径有选择地应用配置。

AbstractCopyTask filesNotMatching（String 模式，Action<? super FileCopyDetails> 动作）

为路径与指定的 Ant 样式模式不匹配的每个文件配置 FileCopyDetails。这相当于使用 eachFile() 并根据文件路径有选择地应用配置。

AbstractCopyTask filter (Closure 关闭)

添加基于提供的闭包的内容过滤器。闭包将在每一行（去除行尾）时被调用，并且应该返回一个 String 来替换该行或返回 null 以删除该行。如果删除每一行，结果将是一个空文件，而不是一个不存在的文件。

AbstractCopyTask filter (Class<? extends FilterReader> filterType)

添加要在复制期间使用的内容过滤器。多次调用过滤器，向过滤器链添加额外的过滤器。每个过滤器都应该实现 java.io.FilterReader 。包含 org.apache.tools.ant.filters.* 以访问所有标准 Ant 过滤器。

示例：

public java.io.File getContentRoot()

AbstractCopyTask filter (Map<String, ?> 属性, Class<? extends FilterReader> filterType)

添加要在复制期间使用的内容过滤器。多次调用过滤器，向过滤器链添加额外的过滤器。每个过滤器都应该实现 java.io.FilterReader 。包含 org.apache.tools.ant.filters.* 以访问所有标准 Ant 过滤器。

可以使用 groovy 映射语法指定过滤器属性。

示例：

public void generatePluginDescriptors()

AbstractCopyTask filter (Transformer<String, String> 变压器)

添加基于提供的转换器的内容过滤器。闭包将在每一行（去除行尾）时被调用，并且应该返回一个 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> 包括）

添加 ANT 样式包含模式。可以多次调用此方法以附加新模式，并且可以在一次调用中指定多个模式。如果未提供包含，则将包含此容器中的所有文件。如果提供了包含，则文件必须至少匹配要处理的包含模式之一。

AbstractCopyTask include（String... 包括）

添加 ANT 样式包含模式。可以多次调用此方法以附加新模式，并且可以在一次调用中指定多个模式。如果未提供包含，则将包含此容器中的所有文件。如果提供了包含，则文件必须至少匹配要处理的包含模式之一。

AbstractCopyTask include (Spec<FileTreeElement> includeSpec)

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

AbstractArchiveTask into (Object destPath)

指定目标目录*内部*文件的存档。目的地根据 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() 混淆。

Jar manifest (Closure<?> configureClosure)

为此 JAR 存档配置清单。

执行给定的闭包以配置清单。 Manifest 作为其委托传递给闭包。

Jar manifest (Action<? super Manifest> configureAction)

为此 JAR 存档配置清单。

执行给定的操作以配置清单。

CopySpec metaInf (Closure<?> configureClosure)

将内容添加到此 JAR 存档的 META-INF 目录。

执行给定的闭包以配置 CopySpec 。 CopySpec 作为其委托传递给闭包。

CopySpec metaInf (Action<? super CopySpec> configureAction)

将内容添加到此 JAR 存档的 META-INF 目录。

执行给定的操作以配置 CopySpec 。

AbstractCopyTask rename (Closure 闭包)

重命名源文件。将使用单个参数调用闭包，即文件名。闭包应该返回一个带有新目标名称的 String 对象。闭包可能返回 null，在这种情况下将使用原始名称。

AbstractCopyTask rename (String sourceRegEx, String replaceWith)

根据正则表达式重命名文件。使用 java.util.regex 类型的正则表达式。请注意，替换字符串应使用“$1”语法来引用源正则表达式中的捕获组。与源正则表达式不匹配的文件将使用原始名称进行复制。

示例：

@Deprecated
@DisableCachingByDefault(because="Produces only non-cacheable console output")
public abstract class DependentComponentsReport
extends DefaultTask

会将文件“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> 重命名)

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

CopySpec with (CopySpec... sourceSpecs)

将给定的规格添加为该规格的子项。

public class UnsupportedFeatureException
extends java.lang.RuntimeException