Jar

目录

属性
方法
脚本块
属性详情
方法详情
API 文档Jar
已知子类型
Ear
War

组装 JAR 存档。

属性

属性描述
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

包含模式集。

manifest

此JAR归档文件的清单。

metadataCharset

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

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)

基于提供的闭包添加内容过滤器。闭包将用每一行（去除行尾）调用，并应返回一个字符串替换该行，或返回 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() 混淆。

manifest(configureClosure)

配置此JAR归档文件的清单。

manifest(configureAction)

配置此JAR归档文件的清单。

metaInf(configureClosure)

将内容添加到此JAR归档文件的META-INF目录中。

metaInf(configureAction)

将内容添加到此JAR归档文件的META-INF目录中。

rename(closure)

重命名源文件。闭包将使用单个参数，即文件名。闭包应返回一个带有新目标名称的字符串对象。闭包可以返回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.base.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

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

该值可以通过枚举值的忽略大小写的字符串设置（例如，DuplicatesStrategy.EXCLUDE 的 '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插件一起使用
[]

Manifest manifest

此JAR归档文件的清单。

String metadataCharset

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

默认值
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 扩展。值得注意的是，Java 7 之前的 JDK 类 ZipInputStream 不支持 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)

基于提供的闭包添加内容过滤器。闭包将用每一行（去除行尾）调用，并应返回一个字符串替换该行，或返回 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'])

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

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

重命名源文件。闭包将使用单个参数，即文件名。闭包应返回一个带有新目标名称的字符串对象。闭包可以返回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
}